Changeset 18694 in josm for trunk/test/unit/org/openstreetmap/josm/testutils

Timestamp:

2023-03-16T22:09:01+01:00 (2 years ago)

Author:

taylor.smock

Message:

Fix #22381: Try to automatically install newly required plugins on plugin update

This additionally updates the plugin tests to JUnit 5 (see #16567). Some tests
required fixing (for example, MinimapDialogTest fails if the system of
measurement is metric).

Location:

trunk/test/unit/org/openstreetmap/josm/testutils

Files:

• PluginServer.java (modified) (7 diffs)
• annotations/AssertionsInEDT.java (added)
• annotations/AssumeRevision.java (added)
• annotations/BasicPreferences.java (modified) (6 diffs)
• annotations/FullPreferences.java (modified) (3 diffs)
• annotations/I18n.java (modified) (3 diffs)
• annotations/JosmDefaults.java (added)
• annotations/JosmHome.java (modified) (3 diffs)
• annotations/Logging.java (added)
• annotations/Main.java (added)
• annotations/ThreadSync.java (added)
• annotations/Timezone.java (added)

trunk/test/unit/org/openstreetmap/josm/testutils/PluginServer.java

@@ -16 +16 @@
 import java.util.stream.StreamSupport;
 
-import org.junit.runner.Description;
-import org.junit.runners.model.Statement;
-import org.openstreetmap.josm.TestUtils;
-import org.openstreetmap.josm.tools.Logging;
-
-import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.MappingBuilder;
 import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.core.Options;
-import com.github.tomakehurst.wiremock.junit.WireMockRule;
+import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
+import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
+import org.openstreetmap.josm.TestUtils;
+import org.openstreetmap.josm.tools.Logging;
 
 public class PluginServer {
@@ -138 +135 @@
         }
 
-        public String getPluginURL(WireMockServer wireMockServer) {
+        public String getPluginURL(WireMockRuntimeInfo wireMock) {
             if (this.pluginURL != null) {
                 return this.pluginURL;
-            } else if (wireMockServer != null && this.getJarPathBeneathFilesDir() != null) {
-                return wireMockServer.url(this.getPluginURLPath());
+            } else if (wireMock != null && this.getJarPathBeneathFilesDir() != null) {
+                return wireMock.getHttpBaseUrl() + this.getPluginURLPath();
             }
             return "http://example.com" + this.getPluginURLPath();
@@ -156 +153 @@
         }
 
-        public String getRemotePluginsListSection(WireMockServer wireMockServer) {
+        public String getRemotePluginsListSection(WireMockRuntimeInfo wireMock) {
             return String.format(
                 "%s.jar;%s\n%s",
                 this.getName(),
-                this.getPluginURL(wireMockServer),
+                this.getPluginURL(wireMock),
                 this.getRemotePluginsListManifestSection()
             );
@@ -192 +189 @@
     }
 
-    public void applyToWireMockServer(WireMockServer wireMockServer) {
+    public void applyToWireMockServer(WireMockRuntimeInfo wireMock) {
+        final WireMock wireMockServer = wireMock.getWireMock();
         // first add the plugins list
-        wireMockServer.stubFor(
+        wireMockServer.register(
             WireMock.get(WireMock.urlEqualTo("/plugins")).willReturn(
                 WireMock.aResponse().withStatus(200).withHeader("Content-Type", "text/plain").withBody(
                     this.pluginList.stream().map(
-                        remotePlugin -> remotePlugin.getRemotePluginsListSection(wireMockServer)
+                        remotePlugin -> remotePlugin.getRemotePluginsListSection(wireMock)
                     ).collect(Collectors.joining())
                 )
@@ -210 +208 @@
 
             if (mappingBuilder != null && responseDefinitionBuilder != null) {
-                wireMockServer.stubFor(
+                wireMockServer.register(
                     remotePlugin.getMappingBuilder().willReturn(remotePlugin.getResponseDefinitionBuilder())
                 );
@@ -228 +226 @@
     }
 
-    public class PluginServerRule extends WireMockRule {
+    public class PluginServerRule extends WireMockExtension {
         public PluginServerRule(Options ruleOptions, boolean failOnUnmatchedRequests) {
-            super(ruleOptions, failOnUnmatchedRequests);
+            super(extensionOptions().options(ruleOptions).failOnUnmatchedRequests(failOnUnmatchedRequests));
         }
 
@@ -238 +236 @@
 
         @Override
-        public Statement apply(Statement base, Description description) {
-            return super.apply(new Statement() {
-                @Override
-                public void evaluate() throws Throwable {
-                    PluginServer.this.applyToWireMockServer(PluginServerRule.this);
-                    base.evaluate();
-                }
-            }, description);
+        protected void onBeforeEach(WireMockRuntimeInfo wireMockRuntimeInfo) {
+            PluginServer.this.applyToWireMockServer(wireMockRuntimeInfo);
         }
     }

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/BasicPreferences.java

@@ -4 +4 @@
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.Map;
 
 import org.junit.jupiter.api.extension.AfterAllCallback;
@@ -15 +17 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
+import org.junit.platform.commons.support.AnnotationSupport;
+import org.openstreetmap.josm.TestUtils;
 import org.openstreetmap.josm.data.Preferences;
 import org.openstreetmap.josm.data.preferences.JosmBaseDirectories;
 import org.openstreetmap.josm.data.preferences.JosmUrls;
 import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.spi.preferences.Setting;
 import org.openstreetmap.josm.testutils.JOSMTestRules;
 
@@ -32 +37 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE, ElementType.METHOD})
+@Inherited
 @ExtendWith(BasicPreferences.BasicPreferencesExtension.class)
 public @interface BasicPreferences {
@@ -47 +53 @@
         @Override
         public void afterEach(ExtensionContext context) throws Exception {
-            if (context.getElement().isPresent() && context.getElement().get().isAnnotationPresent(BasicPreferences.class)) {
+            if (AnnotationSupport.isAnnotated(context.getElement(), BasicPreferences.class)) {
                 this.afterAll(context);
             }
@@ -57 +63 @@
             // Disable saving on put, just to avoid overwriting pref files
             pref.enableSaveOnPut(false);
-            pref.resetToDefault();
+            pref.resetToInitialState();
+            pref.enableSaveOnPut(false);
+            @SuppressWarnings("unchecked")
+            final Map<String, Setting<?>> defaultsMap = (Map<String, Setting<?>>) TestUtils.getPrivateField(pref, "defaultsMap");
+            defaultsMap.clear();
             Config.setPreferencesInstance(pref);
             Config.setBaseDirectoriesProvider(JosmBaseDirectories.getInstance());
@@ -70 +80 @@
         @Override
         public void beforeEach(ExtensionContext context) throws Exception {
-            if (AnnotationUtils.elementIsAnnotated(context.getElement(), BasicPreferences.class) || Config.getPref() == null) {
+            if (AnnotationSupport.isAnnotated(context.getElement(), BasicPreferences.class) || Config.getPref() == null) {
                 this.beforeAll(context);
             }

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/FullPreferences.java

@@ -7 +7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import java.util.Map;
 
-import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.BeforeEachCallback;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
-import org.openstreetmap.josm.TestUtils;
 import org.openstreetmap.josm.data.Preferences;
+import org.openstreetmap.josm.data.preferences.JosmBaseDirectories;
 import org.openstreetmap.josm.spi.preferences.Config;
-import org.openstreetmap.josm.spi.preferences.Setting;
 import org.openstreetmap.josm.testutils.JOSMTestRules;
 import org.openstreetmap.josm.testutils.annotations.BasicPreferences.BasicPreferencesExtension;
@@ -37 +34 @@
      * Initialize preferences.
      */
-    class UsePreferencesExtension implements BeforeAllCallback, BeforeEachCallback {
+    class UsePreferencesExtension implements BeforeEachCallback {
         @Override
-        public void beforeAll(ExtensionContext context) throws Exception {
+        public void beforeEach(ExtensionContext context) throws Exception {
             Preferences pref = context.getStore(Namespace.create(BasicPreferencesExtension.class)).get("preferences", Preferences.class);
-            @SuppressWarnings("unchecked")
-            final Map<String, Setting<?>> defaultsMap = (Map<String, Setting<?>>) TestUtils.getPrivateField(pref, "defaultsMap");
-            defaultsMap.clear();
+            if (pref.getDirs() instanceof JosmBaseDirectories) {
+                ((JosmBaseDirectories) pref.getDirs()).clearMemos();
+            }
+            pref.enableSaveOnPut(false);
             pref.resetToInitialState();
             pref.enableSaveOnPut(false);
@@ -50 +48 @@
             Config.getPref().put("osm-server.url", "http://invalid");
         }
-
-        @Override
-        public void beforeEach(ExtensionContext context) throws Exception {
-            if (AnnotationUtils.elementIsAnnotated(context.getElement(), FullPreferences.class)) {
-                this.beforeAll(context);
-            }
-        }
     }
 }

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/I18n.java

@@ -7 +7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.Locale;
 
 import org.junit.jupiter.api.extension.AfterEachCallback;
@@ -13 +14 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.platform.commons.support.AnnotationSupport;
+import org.openstreetmap.josm.tools.LanguageInfo;
 
 /**
@@ -41 +43 @@
         public void beforeEach(ExtensionContext context) {
             String language = AnnotationSupport.findAnnotation(context.getElement(), I18n.class).map(I18n::value).orElse("en");
-            org.openstreetmap.josm.tools.I18n.set(language);
+            if (!Locale.getDefault().equals(LanguageInfo.getLocale(language, false))) {
+                org.openstreetmap.josm.tools.I18n.set(language);
+            }
         }
 
         @Override
         public void afterEach(ExtensionContext context) {
-            org.openstreetmap.josm.tools.I18n.set("en");
-            org.openstreetmap.josm.tools.I18n.set(org.openstreetmap.josm.tools.I18n.getOriginalLocale().getLanguage());
+            if (!Locale.ENGLISH.equals(Locale.getDefault())) {
+                org.openstreetmap.josm.tools.I18n.set("en");
+                org.openstreetmap.josm.tools.I18n.set(org.openstreetmap.josm.tools.I18n.getOriginalLocale().getLanguage());
+                Locale.setDefault(Locale.ENGLISH);
+            }
         }
     }

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/JosmHome.java

@@ -16 +16 @@
 import java.util.UUID;
 
-import org.junit.jupiter.api.extension.AfterAllCallback;
-import org.junit.jupiter.api.extension.BeforeAllCallback;
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.extension.ExtensionContext;
@@ -40 +40 @@
      * @author Taylor Smock
      */
-    class JosmHomeExtension implements BeforeAllCallback, AfterAllCallback {
+    class JosmHomeExtension implements BeforeEachCallback, AfterEachCallback {
         @Override
-        public void afterAll(ExtensionContext context) throws Exception {
+        public void afterEach(ExtensionContext context) throws Exception {
             Path tempDir = context.getStore(Namespace.create(JosmHome.class)).get("home", Path.class);
             Files.walkFileTree(tempDir, new SimpleFileVisitor<Path>() {
@@ -57 +57 @@
                 }
             });
+            System.clearProperty("josm.home");
         }
 
         @Override
-        public void beforeAll(ExtensionContext context) throws Exception {
+        public void beforeEach(ExtensionContext context) throws Exception {
             Path tempDir = Files.createTempDirectory(UUID.randomUUID().toString());
             context.getStore(Namespace.create(JosmHome.class)).put("home", tempDir);