Changeset 16984 in josm for trunk

Timestamp:

2020-08-30T21:27:14+02:00 (4 years ago)

Author:

simon04

Message:

see #18694 - Migrate ImageProviderTest to JUnit 5, mock bestCursorSize, compare cursors with reference images

Location:

trunk

Files:

• src/org/openstreetmap/josm/tools/ImageProvider.java (modified) (4 diffs)
• test/data/ImageProviderTest/cursor-crosshair-10.png (added)
• test/data/ImageProviderTest/cursor-crosshair-15.png (added)
• test/data/ImageProviderTest/cursor-crosshair-30.png (added)
• test/data/ImageProviderTest/cursor-normal-selection-10.png (added)
• test/data/ImageProviderTest/cursor-normal-selection-15.png (added)
• test/data/ImageProviderTest/cursor-normal-selection-30.png (added)
• test/functional/org/openstreetmap/josm/tools/ImageProviderTest.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/tools/ImageProvider.java

@@ -48 +48 @@
 import java.util.concurrent.Executors;
 import java.util.function.Consumer;
+import java.util.function.UnaryOperator;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -1331 +1332 @@
 
         Point hotSpot = new Point();
-        Image image = getCursorImage(name, overlay, hotSpot);
+        Image image = getCursorImage(name, overlay, dim -> Toolkit.getDefaultToolkit().getBestCursorSize(dim.width, dim.height), hotSpot);
 
         return Toolkit.getDefaultToolkit().createCustomCursor(image, hotSpot, name);
@@ -1348 +1349 @@
      * @param name the cursor image filename in "cursor" directory
      * @param overlay optional overlay image
+     * @param bestCursorSizeFunction computes the best cursor size, see {@link Toolkit#getBestCursorSize(int, int)}
      * @param hotSpot will be set to the properly scaled hotspot of the cursor
      * @return cursor with a given file name, optionally decorated with an overlay image
      */
-    static Image getCursorImage(String name, String overlay, /* out */ Point hotSpot) {
+    static Image getCursorImage(String name, String overlay, UnaryOperator<Dimension> bestCursorSizeFunction, /* out */ Point hotSpot) {
         ImageProvider imageProvider = new ImageProvider("cursor", name);
         if (overlay != null) {
@@ -1366 +1368 @@
         // AWT will resize the cursor to bestCursorSize internally anyway, but miss to scale the hotspot as well
         // (bug JDK-8238734).  So let's do this ourselves, and also scale the hotspot accordingly.
-        Dimension bestCursorSize = Toolkit.getDefaultToolkit().getBestCursorSize(width, height);
+        Dimension bestCursorSize = bestCursorSizeFunction.apply(new Dimension(width, height));
         if (bestCursorSize.width != 0 && bestCursorSize.height != 0) {
             // In principle, we could pass the MultiResolutionImage itself to AWT, but due to bug JDK-8240568,

trunk/test/functional/org/openstreetmap/josm/tools/ImageProviderTest.java

@@ -2 +2 @@
 package org.openstreetmap.josm.tools;
 
-import static java.awt.image.BufferedImage.TYPE_INT_ARGB;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.openstreetmap.josm.gui.mappaint.MapCSSRendererTest.assertImageEquals;
 
 import java.awt.Dimension;
-import java.awt.GraphicsEnvironment;
 import java.awt.Image;
 import java.awt.Point;
-import java.awt.Toolkit;
 import java.awt.Transparency;
 import java.awt.image.BufferedImage;
@@ -22 +18 @@
 import java.util.Collections;
 import java.util.List;
+import java.util.function.UnaryOperator;
 import java.util.logging.Handler;
 import java.util.logging.LogRecord;
@@ -28 +25 @@
 import javax.swing.ImageIcon;
 
-import org.junit.Before;
-import org.junit.BeforeClass;
-import org.junit.Rule;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.openstreetmap.josm.JOSMFixture;
 import org.openstreetmap.josm.TestUtils;
@@ -54 +53 @@
      * Setup test.
      */
-    @Rule
+    @RegisterExtension
     @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")
     public JOSMTestRules test = new JOSMTestRules();
@@ -80 +79 @@
      * Setup test.
      */
-    @BeforeClass
+    @BeforeAll
     public static void setUp() {
         JOSMFixture.createUnitTestFixture().init();
     }
 
-    @Before
+    @BeforeEach
     public void resetPixelDensity() {
         GuiSizesHelper.setPixelDensity(1.0f);
@@ -204 +203 @@
     private static void testImage(int width, int height, String reference, ImageIcon icon) throws IOException {
         final BufferedImage image = (BufferedImage) icon.getImage();
-        final File referenceFile = new File(
-                TestUtils.getTestDataRoot() + "/" + ImageProviderTest.class.getSimpleName() + "/" + reference + ".png");
+        final File referenceFile = getReferenceFile(reference);
         assertEquals("width", width, image.getWidth(null));
         assertEquals("height", height, image.getHeight(null));
         assertImageEquals(reference, referenceFile, image, 0, 0, null);
+    }
+
+    private static File getReferenceFile(String reference) {
+        return new File(TestUtils.getTestDataRoot() + "/" + ImageProviderTest.class.getSimpleName() + "/" + reference + ".png");
     }
 
@@ -237 +239 @@
      * Test getting an image for a crosshair cursor.
      */
-    @Test
-    public void testGetCursorImageForCrosshair() {
-        if (GraphicsEnvironment.isHeadless()) {
-            // TODO mock Toolkit.getDefaultToolkit().getBestCursorSize()
-            return;
-        }
-        Point hotSpot = new Point();
-        Image image = ImageProvider.getCursorImage("crosshair", null, hotSpot);
-        assertCursorDimensionsCorrect(new Point.Double(10.0, 10.0), image, hotSpot);
-    }
-
-    /**
-     * Test getting an image for a custom cursor with overlay.
-     */
-    @Test
-    public void testGetCursorImageWithOverlay() {
-        testCursorImageWithOverlay(1.0f);  // normal case
-        testCursorImageWithOverlay(1.5f);  // user has configured a GUI scale of 1.5 in the JOSM advanced preferences
-    }
-
-    private void testCursorImageWithOverlay(float guiScale) {
-        if (GraphicsEnvironment.isHeadless()) {
-            // TODO mock Toolkit.getDefaultToolkit().getBestCursorSize()
-            return;
-        }
+    @ParameterizedTest
+    @ValueSource(floats = {1.0f, 1.5f, 3.0f})
+    public void testGetCursorImageForCrosshair(float guiScale) throws IOException {
         GuiSizesHelper.setPixelDensity(guiScale);
         Point hotSpot = new Point();
-        Image image = ImageProvider.getCursorImage("normal", "selection", hotSpot);
-        assertCursorDimensionsCorrect(new Point.Double(3.0, 2.0), image, hotSpot);
-        BufferedImage bufferedImage = new BufferedImage(image.getWidth(null), image.getWidth(null), TYPE_INT_ARGB);
-        bufferedImage.getGraphics().drawImage(image, 0, 0, null);
-
-        // check that the square of 1/4 size right lower to the center has some non-empty pixels
-        boolean nonEmptyPixelExistsRightLowerToCenter = false;
-        for (int x = image.getWidth(null) / 2; x < image.getWidth(null) * 3 / 4; ++x) {
-            for (int y = image.getHeight(null) / 2; y < image.getWidth(null) * 3 / 4; ++y) {
-                if (bufferedImage.getRGB(x, y) != 0)
-                    nonEmptyPixelExistsRightLowerToCenter = true;
-            }
-        }
-        assertTrue(nonEmptyPixelExistsRightLowerToCenter);
-    }
-
-    private void assertCursorDimensionsCorrect(Point.Double originalHotspot, Image image, Point hotSpot) {
+        final UnaryOperator<Dimension> bestCursorSizeFunction = dim -> dim;
+        Image image = ImageProvider.getCursorImage("crosshair", null, bestCursorSizeFunction, hotSpot);
+        assertCursorDimensionsCorrect(new Point.Double(10.0, 10.0), image, bestCursorSizeFunction, hotSpot);
+        assertImageEquals("cursor", getReferenceFile("cursor-crosshair-" + Math.round(guiScale * 10)),
+                ((BufferedImage) image), 0, 0, null);
+    }
+
+    /**
+     * Test getting an image for a custom cursor with overlay.
+     */
+    @ParameterizedTest
+    @ValueSource(floats = {1.0f, 1.5f, 3.0f})
+    public void testGetCursorImageWithOverlay(float guiScale) throws IOException {
+        GuiSizesHelper.setPixelDensity(guiScale);
+        Point hotSpot = new Point();
+        final UnaryOperator<Dimension> bestCursorSizeFunction = dim -> dim;
+        Image image = ImageProvider.getCursorImage("normal", "selection", bestCursorSizeFunction, hotSpot);
+        assertCursorDimensionsCorrect(new Point.Double(3.0, 2.0), image, bestCursorSizeFunction, hotSpot);
+        assertImageEquals("cursor", getReferenceFile("cursor-normal-selection-" + Math.round(guiScale * 10)),
+                ((BufferedImage) image), 0, 0, null);
+    }
+
+    private void assertCursorDimensionsCorrect(Point.Double originalHotspot, Image image,
+                                               UnaryOperator<Dimension> bestCursorSizeFunction, Point hotSpot) {
         int originalCursorSize = ImageProvider.CURSOR_SIZE_HOTSPOT_IS_RELATIVE_TO;
-        Dimension bestCursorSize = Toolkit.getDefaultToolkit().getBestCursorSize(originalCursorSize, originalCursorSize);
+        Dimension bestCursorSize = bestCursorSizeFunction.apply(new Dimension(originalCursorSize, originalCursorSize));
         Image bestCursorImage = HiDPISupport.getResolutionVariant(image, bestCursorSize.width, bestCursorSize.height);
         int bestCursorImageWidth = bestCursorImage.getWidth(null);