Changeset 16982 in josm for trunk/test/functional/org

Timestamp:

2020-08-30T21:05:07+02:00 (4 years ago)

Author:

simon04

Message:

see #19706, see #19725 - ImageProviderTest: add tests comparing the result with reference images

Location:

trunk/test/functional/org/openstreetmap/josm

Files:

• gui/mappaint/MapCSSRendererTest.java (modified) (8 diffs)
• tools/ImageProviderTest.java (moved) (moved from trunk/test/unit/org/openstreetmap/josm/tools/ImageProviderTest.java ) (2 diffs)

trunk/test/functional/org/openstreetmap/josm/gui/mappaint/MapCSSRendererTest.java

@@ -11 +11 @@
 import java.io.File;
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
@@ -20 +21 @@
 import java.util.List;
 import java.util.Locale;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -217 +219 @@
         BufferedImage image = rh.render();
 
+        assertImageEquals(testConfig.testDirectory,
+                testConfig.getReference(), image,
+                testConfig.thresholdPixels, testConfig.thresholdTotalColorDiff, diffImage -> {
+                    try {
+                        // You can use this to debug:
+                        ImageIO.write(image, "png", new File(testConfig.getTestDirectory() + "/test-output.png"));
+                        ImageIO.write(diffImage, "png", new File(testConfig.getTestDirectory() + "/test-differences.png"));
+                    } catch (IOException ex) {
+                        throw new UncheckedIOException(ex);
+                    }
+                });
+    }
+
+    /**
+     * Compares the reference image file with the actual images given as {@link BufferedImage}.
+     * @param testIdentifier a test identifier for error messages
+     * @param referenceImageFile the reference image file to be read using {@link ImageIO#read(File)}
+     * @param image the actual image
+     * @param thresholdPixels maximum number of differing pixels
+     * @param thresholdTotalColorDiff maximum sum of color value differences
+     * @param diffImageConsumer a consumer for a rendered image highlighting the differing pixels, may be null
+     * @throws IOException in case of I/O error
+     */
+    public static void assertImageEquals(
+            String testIdentifier, File referenceImageFile, BufferedImage image,
+            int thresholdPixels, int thresholdTotalColorDiff, Consumer<BufferedImage> diffImageConsumer) throws IOException {
+
+        // TODO move to separate class ImageTestUtils
         if (UPDATE_ALL) {
-            ImageIO.write(image, "png", new File(testConfig.getTestDirectory() + "/reference.png"));
+            ImageIO.write(image, "png", referenceImageFile);
             return;
         }
-
-        BufferedImage reference = testConfig.getReference();
-
-        // now compute differences:
+        final BufferedImage reference = ImageIO.read(referenceImageFile);
         assertEquals(image.getWidth(), reference.getWidth());
         assertEquals(image.getHeight(), reference.getHeight());
@@ -236 +263 @@
                 int expected = reference.getRGB(x, y);
                 int result = image.getRGB(x, y);
-                if (!colorsAreSame(expected, result)) {
+                int expectedAlpha = expected >> 24;
+                boolean colorsAreSame = expectedAlpha == 0 ? result >> 24 == 0 : expected == result;
+                if (!colorsAreSame) {
                     Color expectedColor = new Color(expected, true);
                     Color resultColor = new Color(result, true);
@@ -274 +303 @@
         }
 
-        if (differencePoints.size() > testConfig.thresholdPixels || colorDiffSum > testConfig.thresholdTotalColorDiff) {
-            // You can use this to debug:
-            ImageIO.write(image, "png", new File(testConfig.getTestDirectory() + "/test-output.png"));
-
+        if (differencePoints.size() > thresholdPixels || colorDiffSum > thresholdTotalColorDiff) {
             // Add a nice image that highlights the differences:
             BufferedImage diffImage = new BufferedImage(image.getWidth(), image.getHeight(), BufferedImage.TYPE_INT_ARGB);
@@ -283 +309 @@
                 diffImage.setRGB(p.x, p.y, 0xffff0000);
             }
-            ImageIO.write(diffImage, "png", new File(testConfig.getTestDirectory() + "/test-differences.png"));
-
-            if (differencePoints.size() > testConfig.thresholdPixels) {
+            if (diffImageConsumer != null) {
+                diffImageConsumer.accept(diffImage);
+            }
+
+            if (differencePoints.size() > thresholdPixels) {
                 fail(MessageFormat.format("Images for test {0} differ at {1} points, threshold is {2}: {3}",
-                        testConfig.testDirectory, differencePoints.size(), testConfig.thresholdPixels, differences.toString()));
+                        testIdentifier, differencePoints.size(), thresholdPixels, differences.toString()));
             } else {
                 fail(MessageFormat.format("Images for test {0} differ too much in color, value is {1}, permitted threshold is {2}: {3}",
-                        testConfig.testDirectory, colorDiffSum, testConfig.thresholdTotalColorDiff, differences.toString()));
+                        testIdentifier, colorDiffSum, thresholdTotalColorDiff, differences.toString()));
             }
         }
@@ -299 +327 @@
         if (n.isKeyTrue("disabled")) {
             n.setDisabledState(false);
-        }
-    }
-
-    /**
-     * Check if two colors differ
-     * @param expected The expected color
-     * @param actual The actual color
-     * @return <code>true</code> if they differ.
-     */
-    private boolean colorsAreSame(int expected, int actual) {
-        int expectedAlpha = expected >> 24;
-        if (expectedAlpha == 0) {
-            return actual >> 24 == 0;
-        } else {
-            return expected == actual;
         }
     }
@@ -369 +382 @@
         }
 
-        public BufferedImage getReference() throws IOException {
-            return ImageIO.read(new File(getTestDirectory() + "/reference.png"));
+        public File getReference() {
+            return new File(getTestDirectory() + "/reference.png");
         }
 

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

@@ -8 +8 @@
 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.Color;
@@ -180 +181 @@
 
     /**
+     * Unit test of {@link ImageResource#getImageIcon(java.awt.Dimension)}
+     * @throws IOException if an I/O error occurs
+     */
+    @Test
+    public void testImageIcon() throws IOException {
+        ImageResource resource = new ImageProvider("presets/misc/housenumber_small").getResource();
+        testImage(12, 9, "housenumber_small-AUTO-null", resource.getImageIcon());
+        testImage(12, 9, "housenumber_small-AUTO-default", resource.getImageIcon(ImageResource.DEFAULT_DIMENSION));
+        testImage(8, 8, "housenumber_small-AUTO-08x08", resource.getImageIcon(new Dimension(8, 8)));
+        testImage(16, 16, "housenumber_small-AUTO-16x16", resource.getImageIcon(new Dimension(16, 16)));
+        testImage(24, 24, "housenumber_small-AUTO-24x24", resource.getImageIcon(new Dimension(24, 24)));
+        testImage(36, 27, "housenumber_small-AUTO-36x27", resource.getImageIcon(new Dimension(36, 27)));
+    }
+
+    /**
+     * Unit test of {@link ImageResource#getImageIconBounded(java.awt.Dimension)}
+     * @throws IOException if an I/O error occurs
+     */
+    @Test
+    public void testImageIconBounded() throws IOException {
+        ImageResource resource = new ImageProvider("presets/misc/housenumber_small").getResource();
+        testImage(8, 6, "housenumber_small-BOUNDED-08x08", resource.getImageIconBounded(new Dimension(8, 8)));
+        testImage(12, 9, "housenumber_small-BOUNDED-16x16", resource.getImageIconBounded(new Dimension(16, 16)));
+        testImage(12, 9, "housenumber_small-BOUNDED-24x24", resource.getImageIconBounded(new Dimension(24, 24)));
+    }
+
+    /**
+     * Unit test of {@link ImageResource#getPaddedIcon(java.awt.Dimension)}
+     * @throws IOException if an I/O error occurs
+     */
+    @Test
+    public void testImageIconPadded() throws IOException {
+        ImageResource resource = new ImageProvider("presets/misc/housenumber_small").getResource();
+        testImage(8, 8, "housenumber_small-PADDED-08x08", resource.getPaddedIcon(new Dimension(8, 8)));
+        testImage(16, 16, "housenumber_small-PADDED-16x16", resource.getPaddedIcon(new Dimension(16, 16)));
+        testImage(24, 24, "housenumber_small-PADDED-24x24", resource.getPaddedIcon(new Dimension(24, 24)));
+    }
+
+    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");
+        assertEquals("width", width, image.getWidth(null));
+        assertEquals("height", height, image.getHeight(null));
+        assertImageEquals(reference, referenceFile, image, 0, 0, null);
+    }
+
+    /**
      * Test getting a bounded icon given some UI scaling configured.
      */