From f7d85a4799fbcaef069eeac79399852f87bec0b4 Mon Sep 17 00:00:00 2001 From: Robert Scott Date: Sat, 12 May 2018 11:25:27 +0100 Subject: [PATCH v2 28/28] tests: add PluginPreferenceHighLevelTest --- .../plugin/PluginPreferenceHighLevelTest.java | 826 +++++++++++++++++++++ 1 file changed, 826 insertions(+) create mode 100644 test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java diff --git a/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java b/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java new file mode 100644 index 000000000..b490ca00c --- /dev/null +++ b/test/unit/org/openstreetmap/josm/gui/preferences/plugin/PluginPreferenceHighLevelTest.java @@ -0,0 +1,826 @@ +// License: GPL. For details, see LICENSE file. +package org.openstreetmap.josm.gui.preferences.plugin; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.assertFalse; + +import org.junit.Rule; +import org.junit.Test; + +import java.io.File; +import java.nio.file.Files; +import java.awt.Component; +import java.awt.Window; +import javax.swing.JOptionPane; +import java.util.Collection; + +import static java.util.concurrent.TimeUnit.MILLISECONDS; + +import org.junit.After; +import org.junit.Before; +import org.openstreetmap.josm.Main; +import org.openstreetmap.josm.TestUtils; +import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane; +import org.openstreetmap.josm.gui.util.GuiHelper; +import org.openstreetmap.josm.plugins.PluginHandler; +import org.openstreetmap.josm.plugins.PluginProxy; +import org.openstreetmap.josm.spi.preferences.Config; +import org.openstreetmap.josm.testutils.HelpAwareOptionPaneMocker; +import org.openstreetmap.josm.testutils.JOptionPaneSimpleMocker; +import org.openstreetmap.josm.testutils.JOSMTestRules; +import org.openstreetmap.josm.testutils.PluginServer; + +import org.awaitility.Awaitility; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; + +import com.github.tomakehurst.wiremock.client.WireMock; +import com.github.tomakehurst.wiremock.junit.WireMockRule; + +import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; + +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; + + + +/** + * Higher level tests of {@link PluginPreference} class. + */ +public class PluginPreferenceHighLevelTest { + @Rule + @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD") + public JOSMTestRules test = new JOSMTestRules().assumeRevision( + "Revision: 10000\n" + ).preferences().main().assertionsInEDT().platform(); + + /** + * Plugin server mock. + */ + @Rule + public WireMockRule pluginServerRule = new WireMockRule( + options().dynamicPort().usingFilesUnderDirectory(TestUtils.getTestDataRoot()) + ); + + @Before + public void setUp() throws Exception { + if (!java.awt.GraphicsEnvironment.isHeadless()) { + originalMainParent = Main.parent; + Main.parent = new Window(null); + } + + // some other tests actually go ahead and load plugins (notably at time of writing, + // MainApplicationTest$testUpdateAndLoadPlugins), which really isn't a reversible operation. + // it is, however, possible to pretend to our tests temporarily that they *aren't* loaded by + // setting the PluginHandler#pluginList to empty for the duration of this test. ideally these + // other tests wouldn't be so badly behaved or would at least do this from a separate batch + // but this works for now + @SuppressWarnings("unchecked") + final Collection pluginList = (Collection) TestUtils.getPrivateStaticField( + PluginHandler.class, + "pluginList" + ); + this.originalPluginList = ImmutableList.copyOf(pluginList); + pluginList.clear(); + + Config.getPref().putInt("pluginmanager.version", 999); + Config.getPref().put("pluginmanager.lastupdate", "999"); + Config.getPref().putList("pluginmanager.sites", + ImmutableList.of(String.format("http://localhost:%s/plugins", this.pluginServerRule.port())) + ); + + this.referenceDummyJarOld = new File(TestUtils.getTestDataRoot(), "__files/plugin/dummy_plugin.v31701.jar"); + this.referenceDummyJarNew = new File(TestUtils.getTestDataRoot(), "__files/plugin/dummy_plugin.v31772.jar"); + this.referenceBazJarOld = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v6.jar"); + this.referenceBazJarNew = new File(TestUtils.getTestDataRoot(), "__files/plugin/baz_plugin.v7.jar"); + this.pluginDir = Main.pref.getPluginsDirectory(); + this.targetDummyJar = new File(this.pluginDir, "dummy_plugin.jar"); + this.targetDummyJarNew = new File(this.pluginDir, "dummy_plugin.jar.new"); + this.targetBazJar = new File(this.pluginDir, "baz_plugin.jar"); + this.targetBazJarNew = new File(this.pluginDir, "baz_plugin.jar.new"); + this.pluginDir.mkdirs(); + } + + @After + public void tearDown() throws Exception { + // restore actual PluginHandler#pluginList + @SuppressWarnings("unchecked") + final Collection pluginList = (Collection) TestUtils.getPrivateStaticField( + PluginHandler.class, + "pluginList" + ); + pluginList.clear(); + pluginList.addAll(this.originalPluginList); + + if (!java.awt.GraphicsEnvironment.isHeadless()) { + Main.parent = originalMainParent; + } + } + + private Collection originalPluginList; + + private Component originalMainParent; + + private File pluginDir; + private File referenceDummyJarOld; + private File referenceDummyJarNew; + private File referenceBazJarOld; + private File referenceBazJarNew; + private File targetDummyJar; + private File targetDummyJarNew; + private File targetBazJar; + private File targetBazJarNew; + + /** + * Tests choosing a new plugin to install without upgrading an already-installed plugin + */ + @Test + public void testInstallWithoutUpdate() throws Exception { + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarNew), + new PluginServer.RemotePlugin(this.referenceBazJarOld), + new PluginServer.RemotePlugin(null, ImmutableMap.of("Plugin-Version", "2"), "irrelevant_plugin") + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("dummy_plugin")); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker( + ImmutableMap.of( + "The following plugin has been downloaded successfully:" + + "
  • baz_plugin (6)
" + + "You have to restart JOSM for some settings to take effect." + + "

Would you like to restart now?", + "Cancel" + ) + ); + + Files.copy(this.referenceDummyJarOld.toPath(), this.targetDummyJar.toPath()); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + Awaitility.await().atMost(2000, MILLISECONDS).until(() -> Config.getPref().getInt("pluginmanager.version", 999) != 999); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + // questionably correct + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin", "irrelevant_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("dummy_plugin"), + model.getSelectedPlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("(null)", "31701", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31772", "2"), + model.getAvailablePlugins().stream().map((pi) -> pi.version).collect(ImmutableList.toImmutableList()) + ); + + // now we're going to choose to install baz_plugin + model.setPluginSelected("baz_plugin", true); + + assertEquals( + ImmutableList.of("baz_plugin"), + model.getNewlyActivatedPlugins().stream().map( + (pi) -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("baz_plugin"), + model.getPluginsScheduledForUpdateOrDownload().stream().map( + (pi) -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + assertEquals(1, haMocker.getInvocationLog().size()); + Object[] invocationLogEntry = haMocker.getInvocationLog().get(0); + assertEquals(2, (int) invocationLogEntry[0]); + assertEquals("Restart", (String) invocationLogEntry[2]); + + // dummy_plugin jar shouldn't have been updated + TestUtils.assertFileContentsEqual(this.referenceDummyJarOld, this.targetDummyJar); + // baz_plugin jar should have been installed + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + + // neither of these .jar.new files should have been left hanging round + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // the advertized version of dummy_plugin shouldn't have been fetched + this.pluginServerRule.verify(0, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + // but the advertized version of baz_plugin *should* have + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/baz_plugin.v6.jar"))); + + // pluginmanager.version has been set to the current version + // questionably correct + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // however pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + + // baz_plugin should have been added to the plugins list + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + Config.getPref().getList("plugins", null).stream().sorted().collect(ImmutableList.toImmutableList()) + ); + } + + /** + * Tests a plugin being disabled without applying available upgrades + */ + @Test + public void testDisablePluginWithUpdatesAvailable() throws Exception { + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarNew), + new PluginServer.RemotePlugin(this.referenceBazJarNew), + new PluginServer.RemotePlugin(null, null, "irrelevant_plugin") + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("baz_plugin", "dummy_plugin")); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker( + ImmutableMap.of( + "You have to restart JOSM for some settings to take effect." + + "

Would you like to restart now?", + "Cancel" + ) + ); + + Files.copy(this.referenceDummyJarOld.toPath(), this.targetDummyJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + Awaitility.await().atMost(2000, MILLISECONDS).until(() -> Config.getPref().getInt("pluginmanager.version", 999) != 999); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + // questionably correct + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin", "irrelevant_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getSelectedPlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31701", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("7", "31772", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.version == null ? "(null)" : pi.version + ).collect(ImmutableList.toImmutableList()) + ); + + // now we're going to choose to disable baz_plugin + model.setPluginSelected("baz_plugin", false); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("baz_plugin"), + model.getNewlyDeactivatedPlugins().stream().map( + (pi) -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + // questionably correct + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + assertEquals(1, haMocker.getInvocationLog().size()); + Object[] invocationLogEntry = haMocker.getInvocationLog().get(0); + assertEquals(2, (int) invocationLogEntry[0]); + assertEquals("Restart", (String) invocationLogEntry[2]); + + // dummy_plugin jar shouldn't have been updated + TestUtils.assertFileContentsEqual(this.referenceDummyJarOld, this.targetDummyJar); + // baz_plugin jar shouldn't have been deleted + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + + // neither of these .jar.new files have a reason to be here + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // neither of the new jars have been fetched + this.pluginServerRule.verify(0, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + this.pluginServerRule.verify(0, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/baz_plugin.v6.jar"))); + + // pluginmanager.version has been set to the current version + // questionably correct + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // however pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + + // baz_plugin should have been removed from the installed plugins list + assertEquals( + ImmutableList.of("dummy_plugin"), + Config.getPref().getList("plugins", null).stream().sorted().collect(ImmutableList.toImmutableList()) + ); + } + + /** + * Demonstrates behaviour exhibited when attempting to update a single plugin when multiple updates + * are available by deselecting it before clicking the update button then reselecting it. + * + * This is probably NOT desirable and should be fixed, however this test documents the behaviour. + */ + @Test + public void testUpdateOnlySelectedPlugin() throws Exception { + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarNew), + new PluginServer.RemotePlugin(this.referenceBazJarNew) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("baz_plugin", "dummy_plugin")); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker(); + final JOptionPaneSimpleMocker jopsMocker = new JOptionPaneSimpleMocker(); + + Files.copy(this.referenceDummyJarOld.toPath(), this.targetDummyJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + // questionably correct + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getSelectedPlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31701"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("7", "31772"), + model.getAvailablePlugins().stream().map((pi) -> pi.version).collect(ImmutableList.toImmutableList()) + ); + + // now we're going to choose not to update baz_plugin + model.setPluginSelected("baz_plugin", false); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("baz_plugin"), + model.getNewlyDeactivatedPlugins().stream().map( + pi -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + // questionably correct + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + + // prepare haMocker to handle this message + haMocker.getMockResultMap().put( + "The following plugin has been downloaded successfully:" + + "
  • dummy_plugin (31772)
Please restart JOSM to activate the " + + "downloaded plugins.", + "OK" + ); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "updatePluginsButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + assertTrue(jopsMocker.getInvocationLog().isEmpty()); + assertEquals(1, haMocker.getInvocationLog().size()); + Object[] invocationLogEntry = haMocker.getInvocationLog().get(0); + assertEquals(0, (int) invocationLogEntry[0]); + assertEquals("Update plugins", (String) invocationLogEntry[2]); + + // dummy_plugin jar should have been updated + TestUtils.assertFileContentsEqual(this.referenceDummyJarNew, this.targetDummyJar); + // but baz_plugin jar shouldn't have been + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + + // any .jar.new files should have been removed + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // the plugin list was rechecked + // questionably necessary + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + // dummy_plugin has been fetched + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + // baz_plugin has not + this.pluginServerRule.verify(0, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/baz_plugin.v7.jar"))); + WireMock.resetAllRequests(); + + // pluginmanager.version has been set to the current version + // questionably correct + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // however pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + + // plugins list shouldn't have been altered, we haven't hit save yet + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + Config.getPref().getList("plugins", null).stream().sorted().collect(ImmutableList.toImmutableList()) + ); + + // the model's selection state should be largely as before + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("baz_plugin"), + model.getNewlyDeactivatedPlugins().stream().map( + (pi) -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + + // but now we re-select baz_plugin so that it isn't removed/disabled + model.setPluginSelected("baz_plugin", true); + + // this has caused baz_plugin to be interpreted as a plugin "for download" + // questionably correct + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("baz_plugin"), + model.getPluginsScheduledForUpdateOrDownload().stream().map( + (pi) -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + + // prepare jopsMocker to handle this message + jopsMocker.getMockResultMap().put( + "The following plugin has been downloaded successfully:" + + "
  • baz_plugin (7)
", + JOptionPane.OK_OPTION + ); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + // from previous haMocker invocation + assertEquals(1, haMocker.getInvocationLog().size()); + // we've been alerted that (the new version of) baz_plugin was installed + // questionably correct + assertEquals(1, jopsMocker.getInvocationLog().size()); + invocationLogEntry = jopsMocker.getInvocationLog().get(0); + assertEquals(JOptionPane.OK_OPTION, (int) invocationLogEntry[0]); + assertEquals("Warning", (String) invocationLogEntry[2]); + + // dummy_plugin jar is still the updated version + TestUtils.assertFileContentsEqual(this.referenceDummyJarNew, this.targetDummyJar); + // but now the baz_plugin jar has been too + // questionably correct + TestUtils.assertFileContentsEqual(this.referenceBazJarNew, this.targetBazJar); + + // all .jar.new files have been deleted + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // dummy_plugin was not fetched + this.pluginServerRule.verify(0, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + // baz_plugin however was fetched + // questionably correct + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/baz_plugin.v7.jar"))); + + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + } + + /** + * Tests the effect of requesting a "plugin update" when everything is up to date + */ + @Test + public void testUpdateWithNoAvailableUpdates() throws Exception { + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarOld), + new PluginServer.RemotePlugin(this.referenceBazJarOld), + new PluginServer.RemotePlugin(null, ImmutableMap.of("Plugin-Version", "123"), "irrelevant_plugin") + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of("baz_plugin", "dummy_plugin")); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker( + ImmutableMap.of( + "All installed plugins are up to date. JOSM does not have to download newer versions.", + "OK" + ) + ); + final JOptionPaneSimpleMocker jopsMocker = new JOptionPaneSimpleMocker(); + + Files.copy(this.referenceDummyJarOld.toPath(), this.targetDummyJar.toPath()); + Files.copy(this.referenceBazJarOld.toPath(), this.targetBazJar.toPath()); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin", "irrelevant_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getSelectedPlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31701", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("6", "31701", "123"), + model.getAvailablePlugins().stream().map((pi) -> pi.version).collect(ImmutableList.toImmutableList()) + ); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "updatePluginsButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + assertTrue(jopsMocker.getInvocationLog().isEmpty()); + assertEquals(1, haMocker.getInvocationLog().size()); + Object[] invocationLogEntry = haMocker.getInvocationLog().get(0); + assertEquals(0, (int) invocationLogEntry[0]); + assertEquals("Plugins up to date", (String) invocationLogEntry[2]); + + // neither jar should have changed + TestUtils.assertFileContentsEqual(this.referenceDummyJarOld, this.targetDummyJar); + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + + // no reason for any .jar.new files + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // the plugin list was rechecked + // questionably necessary + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + // that should have been the only request to our PluginServer + assertEquals(1, this.pluginServerRule.getAllServeEvents().size()); + WireMock.resetAllRequests(); + + // pluginmanager.version has been set to the current version + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + + // plugins list shouldn't have been altered + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + Config.getPref().getList("plugins", null).stream().sorted().collect(ImmutableList.toImmutableList()) + ); + + // the model's selection state should be largely as before + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + assertTrue(jopsMocker.getInvocationLog().isEmpty()); + assertEquals(1, haMocker.getInvocationLog().size()); + + // both jars are still the original version + TestUtils.assertFileContentsEqual(this.referenceDummyJarOld, this.targetDummyJar); + TestUtils.assertFileContentsEqual(this.referenceBazJarOld, this.targetBazJar); + + // no reason for any .jar.new files + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // none of PluginServer's URLs should have been touched + assertEquals(0, this.pluginServerRule.getAllServeEvents().size()); + + // pluginmanager.version has been set to the current version + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + } + + /** + * Tests installing a single plugin which is marked as "Canloadatruntime" + */ + @Test + public void testInstallWithoutRestartRequired() throws Exception { + final boolean[] loadPluginsCalled = new boolean[] {false}; + final mockit.MockUp pluginHandlerMocker = new mockit.MockUp() { + @mockit.Mock + private void loadPlugins( + final Component parent, + final Collection plugins, + final org.openstreetmap.josm.gui.progress.ProgressMonitor monitor + ) { + assertEquals(1, plugins.size()); + assertEquals("dummy_plugin", plugins.iterator().next().name); + assertEquals("31772", plugins.iterator().next().localversion); + loadPluginsCalled[0] = true; + } + }; + + final PluginServer pluginServer = new PluginServer( + new PluginServer.RemotePlugin(this.referenceDummyJarNew), + new PluginServer.RemotePlugin(this.referenceBazJarNew) + ); + pluginServer.applyToWireMockServer(this.pluginServerRule); + Config.getPref().putList("plugins", ImmutableList.of()); + + final HelpAwareOptionPaneMocker haMocker = new HelpAwareOptionPaneMocker(); + final JOptionPaneSimpleMocker jopsMocker = new JOptionPaneSimpleMocker(ImmutableMap.of( + "The following plugin has been downloaded successfully:" + + "
  • dummy_plugin (31772)
", + JOptionPane.OK_OPTION + )); + + final PreferenceTabbedPane tabbedPane = new PreferenceTabbedPane(); + + tabbedPane.buildGui(); + // PluginPreference is already added to PreferenceTabbedPane by default + tabbedPane.selectTabByPref(PluginPreference.class); + + GuiHelper.runInEDTAndWait( + () -> ((javax.swing.JButton) TestUtils.getComponentByName(tabbedPane, "downloadListButton")).doClick() + ); + + TestUtils.syncEDTAndWorkerThreads(); + + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugins"))); + WireMock.resetAllRequests(); + + final PluginPreferencesModel model = (PluginPreferencesModel) TestUtils.getPrivateField( + tabbedPane.getPluginPreference(), + "model" + ); + + assertTrue(model.getNewlyActivatedPlugins().isEmpty()); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + assertTrue(model.getPluginsScheduledForUpdateOrDownload().isEmpty()); + assertEquals(model.getDisplayedPlugins(), model.getAvailablePlugins()); + + assertEquals( + ImmutableList.of("baz_plugin", "dummy_plugin"), + model.getAvailablePlugins().stream().map((pi) -> pi.getName()).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getSelectedPlugins().isEmpty()); + assertEquals( + ImmutableList.of("(null)", "(null)"), + model.getAvailablePlugins().stream().map( + (pi) -> pi.localversion == null ? "(null)" : pi.localversion + ).collect(ImmutableList.toImmutableList()) + ); + assertEquals( + ImmutableList.of("7", "31772"), + model.getAvailablePlugins().stream().map((pi) -> pi.version).collect(ImmutableList.toImmutableList()) + ); + + // now we select dummy_plugin + model.setPluginSelected("dummy_plugin", true); + + // model should now reflect this + assertEquals( + ImmutableList.of("dummy_plugin"), + model.getNewlyActivatedPlugins().stream().map( + pi -> pi.getName() + ).collect(ImmutableList.toImmutableList()) + ); + assertTrue(model.getNewlyDeactivatedPlugins().isEmpty()); + + tabbedPane.savePreferences(); + + TestUtils.syncEDTAndWorkerThreads(); + + assertEquals(1, jopsMocker.getInvocationLog().size()); + org.openstreetmap.josm.tools.Logging.error(jopsMocker.getInvocationLog().get(0)[0].toString()); + Object[] invocationLogEntry = jopsMocker.getInvocationLog().get(0); + assertEquals(JOptionPane.OK_OPTION, (int) invocationLogEntry[0]); + assertEquals("Warning", (String) invocationLogEntry[2]); + + assertTrue(haMocker.getInvocationLog().isEmpty()); + + // any .jar.new files should have been deleted + assertFalse(targetDummyJarNew.exists()); + assertFalse(targetBazJarNew.exists()); + + // dummy_plugin was fetched + this.pluginServerRule.verify(1, WireMock.getRequestedFor(WireMock.urlEqualTo("/plugin/dummy_plugin.v31772.jar"))); + + // loadPlugins(...) was called (with expected parameters) + assertTrue(loadPluginsCalled[0]); + + // pluginmanager.version has been set to the current version + assertEquals(10000, Config.getPref().getInt("pluginmanager.version", 111)); + // pluginmanager.lastupdate hasn't been updated + // questionably correct + assertEquals("999", Config.getPref().get("pluginmanager.lastupdate", "111")); + } +} -- 2.11.0