Ensure focus after each opening of a find/replace UI

Author: HeikoKlare

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/FindReplaceTestUtil.java

@@ -13,10 +13,16 @@
  *******************************************************************************/
 package org.eclipse.ui.internal.findandreplace;
 
+import static org.junit.Assert.fail;
+
+import java.util.function.Supplier;
+
 import org.eclipse.swt.widgets.Display;
 
 import org.eclipse.ui.PlatformUI;
 
+import org.eclipse.ui.workbench.texteditor.tests.ScreenshotTest;
+
 public final class FindReplaceTestUtil {
 
 	private FindReplaceTestUtil() {
@@ -36,4 +42,22 @@ public static void runEventQueue() {
 		}
 	}
 
+	public static void waitForFocus(Supplier<Boolean> hasFocusValidator, String testName) {
+		int focusAttempts= 0;
+		while (!hasFocusValidator.get() && focusAttempts < 10) {
+			focusAttempts++;
+			PlatformUI.getWorkbench().getDisplay().readAndDispatch();
+			if (!hasFocusValidator.get()) {
+				try {
+					Thread.sleep(50);
+				} catch (InterruptedException e) {
+				}
+			}
+		}
+		if (!hasFocusValidator.get()) {
+			String screenshotPath= ScreenshotTest.takeScreenshot(FindReplaceUITest.class, testName, System.out);
+			fail("The find/replace UI did not receive focus. Screenshot: " + screenshotPath);
+		}
+	}
+
 }

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/FindReplaceUITest.java

@@ -22,6 +22,7 @@
 import java.util.ResourceBundle;
 
 import org.junit.After;
+import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TestName;
@@ -51,6 +52,11 @@ public abstract class FindReplaceUITest<AccessType extends IFindReplaceUIAccess>
 
 	private AccessType dialog;
 
+	@Before
+	public final void ensureWorkbenchWindowIsActive() {
+		PlatformUI.getWorkbench().getWorkbenchWindows()[0].getShell().forceActive();
+	}
+
 	protected FindReplaceAction getFindReplaceAction() {
 		return findReplaceAction;
 	}
@@ -159,7 +165,6 @@ public void testShiftEnterReversesSearchDirection() {
 
 		dialog.select(SearchOptions.INCREMENTAL);
 		dialog.setFindText("line");
-		ensureHasFocusOnGTK();
 		IFindReplaceTarget target= getFindReplaceTarget();
 
 		assertEquals(0, (target.getSelection()).x);
@@ -308,7 +313,6 @@ public void testSearchTextSelectedWhenOpeningDialog() {
 
 		fTextViewer.setSelection(new TextSelection(0, 4));
 		initializeFindReplaceUIForTextViewer();
-		ensureHasFocusOnGTK();
 
 		assertEquals("test", dialog.getFindText());
 		assertEquals(dialog.getSelectedFindText(), dialog.getFindText());
@@ -321,7 +325,6 @@ public void testSearchTextSelectedWhenSwitchingFocusToDialog() {
 
 		dialog.setFindText("text");
 		initializeFindReplaceUIForTextViewer();
-		ensureHasFocusOnGTK();
 
 		assertEquals("text", dialog.getFindText());
 		assertEquals(dialog.getSelectedFindText(), dialog.getFindText());

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/overlay/FindReplaceOverlayTest.java

@@ -13,6 +13,7 @@
  *******************************************************************************/
 package org.eclipse.ui.internal.findandreplace.overlay;
 
+import static org.eclipse.ui.internal.findandreplace.FindReplaceTestUtil.waitForFocus;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 import static org.junit.Assert.assertEquals;
@@ -46,7 +47,9 @@ public OverlayAccess openUIFromTextViewer(TextViewer viewer) {
 		Accessor actionAccessor= new Accessor(getFindReplaceAction(), FindReplaceAction.class);
 		actionAccessor.invoke("showOverlayInEditor", null);
 		FindReplaceOverlay overlay= (FindReplaceOverlay) actionAccessor.get("overlay");
-		return new OverlayAccess(getFindReplaceTarget(), overlay);
+		OverlayAccess uiAccess= new OverlayAccess(getFindReplaceTarget(), overlay);
+		waitForFocus(uiAccess::hasFocus, testName.getMethodName());
+		return uiAccess;
 	}
 
 	@Test

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/overlay/OverlayAccess.java

@@ -103,7 +103,7 @@ private void restoreInitialConfiguration() {
 	public void closeAndRestore() {
 		restoreInitialConfiguration();
 		assertInitialConfiguration();
-		overlay.close();
+		close();
 	}
 
 	@Override

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/workbench/texteditor/tests/FindReplaceDialogTest.java

@@ -14,6 +14,7 @@
 package org.eclipse.ui.workbench.texteditor.tests;
 
 import static org.eclipse.ui.internal.findandreplace.FindReplaceTestUtil.runEventQueue;
+import static org.eclipse.ui.internal.findandreplace.FindReplaceTestUtil.waitForFocus;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
 import static org.junit.Assert.assertEquals;
@@ -52,7 +53,9 @@ public DialogAccess openUIFromTextViewer(TextViewer viewer) {
 		Accessor fFindReplaceDialogStubAccessor= new Accessor(fFindReplaceDialogStub, "org.eclipse.ui.texteditor.FindReplaceAction$FindReplaceDialogStub", getClass().getClassLoader());
 
 		Dialog dialog= (Dialog) fFindReplaceDialogStubAccessor.invoke("getDialog", null);
-		return new DialogAccess(getFindReplaceTarget(), dialog);
+		DialogAccess uiAccess= new DialogAccess(getFindReplaceTarget(), dialog);
+		waitForFocus(uiAccess::hasFocus, testName.getMethodName());
+		return uiAccess;
 	}
 
 	@Test