Changeset 13112 in josm

Timestamp:

2017-11-12T00:54:15+01:00 (6 years ago)

Author:

Don-vip

Message:

fix #15539 - use awaitility in MinimapDialogTest rather than Thread.sleep() (patch by ris)

Location:

trunk

Files:

• .classpath (modified) (1 diff)
• netbeans/nbproject/project.properties (modified) (2 diffs)
• src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java (modified) (1 diff)
• test/lib/awaitility-3.0.0.jar (added)
• test/unit/org/openstreetmap/josm/gui/dialogs/MinimapDialogTest.java (modified) (5 diffs)
• test/unit/org/openstreetmap/josm/gui/layer/gpx/DownloadWmsAlongTrackActionTest.java (modified) (1 diff)

trunk/.classpath

@@ -22 +22 @@
         <classpathentry kind="lib" path="test/lib/unitils-core/unitils-core-3.4.6.jar"/>
         <classpathentry kind="lib" path="test/lib/commons-testing/commons-testing-2.1.0.jar"/>
-        <classpathentry kind="lib" path="test/lib/wiremock-standalone-2.10.1.jar"/>
+        <classpathentry exported="true" kind="lib" path="test/lib/wiremock-standalone-2.10.1.jar"/>
+        <classpathentry exported="true" kind="lib" path="test/lib/awaitility-3.0.0.jar"/>
         <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
         <classpathentry exported="true" kind="con" path="GROOVY_SUPPORT"/>

trunk/netbeans/nbproject/project.properties

@@ -59 +59 @@
 file.reference.system-rules-1.16.1.jar=../test/lib/system-rules-1.16.1.jar
 file.reference.wiremock-standalone-2.10.1.jar=../test/lib/wiremock-standalone-2.10.1.jar
+file.reference.awaitility-3.0.0.jar=../test/lib/awaitility-3.0.0.jar
 includes=**/*.java
 jar.compress=false
@@ -94 +95 @@
     ${file.reference.system-rules-1.16.1.jar}:\
     ${file.reference.wiremock-standalone-2.10.1.jar}:\
+        ${file.reference.awaitility-3.0.0.jar}:\
     ${file.reference.spotbugs.jar}:\
     ${file.reference.commons-testing-2.1.0.jar}

trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java

@@ -127 +127 @@
     }
 
+    @Override
+    public boolean hasOutstandingTasks() {
+        return downloadExecutor.getTaskCount() > downloadExecutor.getCompletedTaskCount();
+    }
+
     /**
      * Sets the download executor that will be used to download tiles instead of default one.

trunk/test/unit/org/openstreetmap/josm/gui/dialogs/MinimapDialogTest.java

@@ -7 +7 @@
 import static org.junit.Assert.fail;
 
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+
 import java.awt.Color;
 import java.awt.Component;
@@ -15 +17 @@
 import javax.swing.JPopupMenu;
 
+import java.util.concurrent.Callable;
+
 import org.junit.Rule;
 import org.junit.Test;
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.TestUtils;
 import org.openstreetmap.josm.gui.bbox.SlippyMapBBoxChooser;
@@ -23 +28 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import org.awaitility.Awaitility;
 
 /**
@@ -79 +86 @@
     }
 
+    protected MinimapDialog minimap;
+    protected SlippyMapBBoxChooser slippyMap;
+    protected SourceButton sourceButton;
+
+    protected static BufferedImage paintedSlippyMap;
+
+    protected void setUpMiniMap() throws Exception {
+        this.minimap = new MinimapDialog();
+        this.minimap.setSize(300, 200);
+        this.minimap.showDialog();
+        this.slippyMap = (SlippyMapBBoxChooser) TestUtils.getPrivateField(this.minimap, "slippyMap");
+        this.sourceButton = (SourceButton) TestUtils.getPrivateField(this.slippyMap, "iSourceButton");
+
+        // get dlg in a paintable state
+        this.minimap.addNotify();
+        this.minimap.doLayout();
+    }
+
+    protected void paintSlippyMap() {
+        if (paintedSlippyMap == null ||
+            paintedSlippyMap.getWidth() != this.slippyMap.getSize().width ||
+            paintedSlippyMap.getHeight() != this.slippyMap.getSize().height) {
+            paintedSlippyMap = new BufferedImage(
+                this.slippyMap.getSize().width,
+                this.slippyMap.getSize().height,
+                BufferedImage.TYPE_INT_RGB
+            );
+        } // else reuse existing one - allocation is expensive
+
+        // clear background to a recognizably "wrong" color & dispose our Graphics2D so we don't risk carrying over
+        // any state
+        Graphics2D g = paintedSlippyMap.createGraphics();
+        g.setBackground(Color.BLUE);
+        g.clearRect(0, 0, paintedSlippyMap.getWidth(), paintedSlippyMap.getHeight());
+        g.dispose();
+
+        g = paintedSlippyMap.createGraphics();
+        this.slippyMap.paintAll(g);
+    }
+
+    protected Callable<Boolean> slippyMapTasksFinished() {
+        return () -> !this.slippyMap.getTileController().getTileLoader().hasOutstandingTasks();
+    }
+
     /**
      * Tests to switch imagery source.
@@ -85 +136 @@
     @Test
     public void testSourceSwitching() throws Exception {
-        MinimapDialog dlg = new MinimapDialog();
-        dlg.setSize(300, 200);
-        dlg.showDialog();
-        SlippyMapBBoxChooser slippyMap = (SlippyMapBBoxChooser) TestUtils.getPrivateField(dlg, "slippyMap");
-        SourceButton sourceButton = (SourceButton) TestUtils.getPrivateField(slippyMap, "iSourceButton");
-
-        // get dlg in a paintable state
-        dlg.addNotify();
-        dlg.doLayout();
-
-        BufferedImage image = new BufferedImage(
-            slippyMap.getSize().width,
-            slippyMap.getSize().height,
-            BufferedImage.TYPE_INT_RGB
-        );
-
-        Graphics2D g = image.createGraphics();
+        // relevant prefs starting out empty, should choose the first source and have shown download area enabled
+        // (not that there's a data layer for it to use)
+
+        this.setUpMiniMap();
+
         // an initial paint operation is required to trigger the tile fetches
-        slippyMap.paintAll(g);
-        g.setBackground(Color.BLUE);
-        g.clearRect(0, 0, image.getWidth(), image.getHeight());
-        g.dispose();
-
-        Thread.sleep(500);
-
-        g = image.createGraphics();
-        slippyMap.paintAll(g);
-
-        assertEquals(0xffffffff, image.getRGB(0, 0));
-
-        assertSingleSelectedSourceLabel(sourceButton.getPopupMenu(), "White Tiles");
-
-        getSourceMenuItemByLabel(sourceButton.getPopupMenu(), "Magenta Tiles").doClick();
-        assertSingleSelectedSourceLabel(sourceButton.getPopupMenu(), "Magenta Tiles");
+        this.paintSlippyMap();
+
+        Awaitility.await().atMost(1000, MILLISECONDS).until(this.slippyMapTasksFinished());
+
+        this.paintSlippyMap();
+
+        assertEquals(0xffffffff, paintedSlippyMap.getRGB(0, 0));
+
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "White Tiles");
+
+        getSourceMenuItemByLabel(this.sourceButton.getPopupMenu(), "Magenta Tiles").doClick();
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "Magenta Tiles");
         // call paint to trigger new tile fetch
-        slippyMap.paintAll(g);
-
-        // clear background to a recognizably "wrong" color & dispose our Graphics2D so we don't risk carrying over
-        // any state
-        g.setBackground(Color.BLUE);
-        g.clearRect(0, 0, image.getWidth(), image.getHeight());
-        g.dispose();
-
-        Thread.sleep(500);
-
-        g = image.createGraphics();
-        slippyMap.paintAll(g);
-
-        assertEquals(0xffff00ff, image.getRGB(0, 0));
-
-        getSourceMenuItemByLabel(sourceButton.getPopupMenu(), "Green Tiles").doClick();
-        assertSingleSelectedSourceLabel(sourceButton.getPopupMenu(), "Green Tiles");
+        this.paintSlippyMap();
+
+        Awaitility.await().atMost(1000, MILLISECONDS).until(this.slippyMapTasksFinished());
+
+        this.paintSlippyMap();
+
+        assertEquals(0xffff00ff, paintedSlippyMap.getRGB(0, 0));
+
+        getSourceMenuItemByLabel(this.sourceButton.getPopupMenu(), "Green Tiles").doClick();
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "Green Tiles");
         // call paint to trigger new tile fetch
-        slippyMap.paintAll(g);
-
-        g.setBackground(Color.BLUE);
-        g.clearRect(0, 0, image.getWidth(), image.getHeight());
-        g.dispose();
-
-        Thread.sleep(500);
-
-        g = image.createGraphics();
-        slippyMap.paintAll(g);
-
-        assertEquals(0xff00ff00, image.getRGB(0, 0));
+        this.paintSlippyMap();
+
+        Awaitility.await().atMost(1000, MILLISECONDS).until(this.slippyMapTasksFinished());
+
+        this.paintSlippyMap();
+
+        assertEquals(0xff00ff00, paintedSlippyMap.getRGB(0, 0));
+
+        assertEquals("Green Tiles", Main.pref.get("slippy_map_chooser.mapstyle", "Fail"));
+    }
+
+    /**
+     * Tests minimap obeys a saved "mapstyle" preference on startup.
+     * @throws Exception if any error occurs
+     */
+    @Test
+    public void testSourcePrefObeyed() throws Exception {
+        Main.pref.put("slippy_map_chooser.mapstyle", "Green Tiles");
+
+        this.setUpMiniMap();
+
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "Green Tiles");
+
+        // an initial paint operation is required to trigger the tile fetches
+        this.paintSlippyMap();
+
+        Awaitility.await().atMost(1000, MILLISECONDS).until(this.slippyMapTasksFinished());
+
+        this.paintSlippyMap();
+
+        assertEquals(0xff00ff00, paintedSlippyMap.getRGB(0, 0));
+
+        getSourceMenuItemByLabel(this.sourceButton.getPopupMenu(), "Magenta Tiles").doClick();
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "Magenta Tiles");
+
+        assertEquals("Magenta Tiles", Main.pref.get("slippy_map_chooser.mapstyle", "Fail"));
+    }
+
+    /**
+     * Tests minimap handles an unrecognized "mapstyle" preference on startup
+     * @throws Exception if any error occurs
+     */
+    @Test
+    public void testSourcePrefInvalid() throws Exception {
+        Main.pref.put("slippy_map_chooser.mapstyle", "Hooloovoo Tiles");
+
+        this.setUpMiniMap();
+
+        assertSingleSelectedSourceLabel(this.sourceButton.getPopupMenu(), "White Tiles");
+
+        // an initial paint operation is required to trigger the tile fetches
+        this.paintSlippyMap();
+
+        Awaitility.await().atMost(1000, MILLISECONDS).until(this.slippyMapTasksFinished());
+
+        this.paintSlippyMap();
+
+        assertEquals(0xffffffff, paintedSlippyMap.getRGB(0, 0));
     }
 }

trunk/test/unit/org/openstreetmap/josm/gui/layer/gpx/DownloadWmsAlongTrackActionTest.java

@@ -29 +29 @@
     @Rule
     @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")
-    public JOSMTestRules test = new JOSMTestRules().platform().main().projection();
+    public JOSMTestRules test = new JOSMTestRules().platform().main().projection().timeout(20000);
 
     /**