Ticket #16010: v2-0001-unit-tests-replace-isHeadless-checks-in-Navigatab.patch

build.xml

@@ -500 +500 @@
                 inclbootstrapclasses="${jacoco.inclbootstrapclasses}" inclnolocationclasses="${jacoco.inclnolocationclasses}">
                 <junit printsummary="yes" fork="true" forkmode="once">
                     <jvmarg value="-Dfile.encoding=UTF-8"/>
+                    <jvmarg value="-javaagent:${test.dir}/lib/jmockit-1.38.jar"/>
                     <jvmarg value="--add-modules" if:set="isJava9" unless:set="isJava11" />
                     <jvmarg value="java.activation,java.se.ee" if:set="isJava9" unless:set="isJava11" />
                     <jvmarg value="--add-exports" if:set="isJava9" />

src/org/openstreetmap/josm/gui/MapViewState.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui;
 
 import java.awt.Container;
-import java.awt.GraphicsEnvironment;
 import java.awt.Point;
 import java.awt.geom.AffineTransform;
 import java.awt.geom.Area;
@@ -145 +144 @@
     }
 
     private static Point findTopLeftOnScreen(JComponent position) {
-        if (GraphicsEnvironment.isHeadless()) {
-            // in our imaginary universe the window is always (10, 10) from the top left of the screen
-            Point topLeftInWindow = findTopLeftInWindow(position);
-            return new Point(topLeftInWindow.x + 10, topLeftInWindow.y + 10);
-        } else {
-            try {
-                return position.getLocationOnScreen();
-            } catch (JosmRuntimeException | IllegalArgumentException | IllegalStateException e) {
-                throw BugReport.intercept(e).put("position", position).put("parent", position::getParent);
-            }
+        try {
+            return position.getLocationOnScreen();
+        } catch (JosmRuntimeException | IllegalArgumentException | IllegalStateException e) {
+            throw BugReport.intercept(e).put("position", position).put("parent", position::getParent);
         }
     }
 

src/org/openstreetmap/josm/gui/NavigatableComponent.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui;
 
 import java.awt.Cursor;
-import java.awt.GraphicsEnvironment;
 import java.awt.Point;
 import java.awt.Rectangle;
 import java.awt.event.ComponentAdapter;
@@ -325 +324 @@
     }
 
     protected boolean isVisibleOnScreen() {
-        return GraphicsEnvironment.isHeadless() || (
-            SwingUtilities.getWindowAncestor(this) != null && isShowing()
-        );
+        return SwingUtilities.getWindowAncestor(this) != null && isShowing();
     }
 
     /**

test/unit/org/openstreetmap/josm/testutils/JOSMTestRules.java

@@ -63 +63 @@
     private TileSourceRule tileSourceRule;
     private String assumeRevisionString;
     private Version originalVersion;
+    private Runnable mapViewStateMockingRunnable;
+    private Runnable navigableComponentMockingRunnable;
     private boolean platform;
     private boolean useProjection;
     private boolean useProjectionNadGrids;
@@ -296 +298 @@
      * @since 12557
      */
     public JOSMTestRules main() {
+        return this.main(
+            WindowlessMapViewStateMocker::new,
+            WindowlessNavigatableComponentMocker::new
+        );
+    }
+
+    /**
+     * Use the {@link Main#main}, {@code Main.contentPanePrivate}, {@code Main.mainPanel},
+     *         global variables in this test.
+     * @param mapViewStateMockingRunnable Runnable to use for mocking out any required parts of
+     *        {@link org.openstreetmap.josm.gui.MapViewState}, null to skip.
+     * @param navigableComponentMockingRunnable Runnable to use for mocking out any required parts
+     *        of {@link org.openstreetmap.josm.gui.NavigableComponent}, null to skip.
+     *
+     * @return this instance, for easy chaining
+     */
+    public JOSMTestRules main(
+        final Runnable mapViewStateMockingRunnable,
+        final Runnable navigableComponentMockingRunnable
+    ) {
         platform();
-        main = true;
+        this.main = true;
+        this.mapViewStateMockingRunnable = mapViewStateMockingRunnable;
+        this.navigableComponentMockingRunnable = navigableComponentMockingRunnable;
         return this;
     }
 
@@ -452 +476 @@
             JOSMFixture.createUnitTestFixture().init(true);
         } else {
             if (main) {
+                // apply mockers to MapViewState and NavigableComponent whether we're headless or not
+                // as we generally don't create the josm main window even in non-headless mode.
+                if (this.mapViewStateMockingRunnable != null) {
+                    this.mapViewStateMockingRunnable.run();
+                }
+                if (this.navigableComponentMockingRunnable != null) {
+                    this.navigableComponentMockingRunnable.run();
+                }
+
                 new MainApplication();
                 JOSMFixture.initContentPane();
                 JOSMFixture.initMainPanel(true);

new file test/unit/org/openstreetmap/josm/testutils/mockers/WindowlessMapViewStateMocker.java

@@ +1 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.testutils;
+
+import javax.swing.JComponent;
+import java.awt.Point;
+
+import org.openstreetmap.josm.gui.MapViewState;
+
+import mockit.Mock;
+import mockit.MockUp;
+
+/**
+ * MockUp for allowing a {@link MapViewState} to be fully initialized in either headless or
+ * windowless tests
+ */
+public class WindowlessMapViewStateMocker extends MockUp<MapViewState> {
+    @Mock
+    private static Point findTopLeftInWindow(JComponent position) {
+        return new Point();
+    }
+
+    @Mock
+    private static Point findTopLeftOnScreen(JComponent position) {
+        // in our imaginary universe the window is always (10, 10) from the top left of the screen
+        Point topLeftInWindow = findTopLeftInWindow(position);
+        return new Point(topLeftInWindow.x + 10, topLeftInWindow.y + 10);
+    }
+}

new file test/unit/org/openstreetmap/josm/testutils/mockers/WindowlessNavigatableComponentMocker.java

@@ +1 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.testutils;
+
+import org.openstreetmap.josm.gui.NavigatableComponent;
+
+import mockit.Mock;
+import mockit.MockUp;
+
+/**
+ * MockUp for allowing a {@link NavigatableComponent} to be used in either headless or windowless
+ * tests.
+ */
+public class WindowlessNavigatableComponentMocker extends MockUp<NavigatableComponent> {
+    @Mock
+    private boolean isVisibleOnScreen() {
+        return true;
+    }
+}