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("this test does not work on GTK unless the runtime workbench has focus. Screenshot: " + screenshotPath);
+		}
+	}
+
 }

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

@@ -159,7 +159,6 @@ public void testShiftEnterReversesSearchDirection() {
 
 		dialog.select(SearchOptions.INCREMENTAL);
 		dialog.setFindText("line");
-		ensureHasFocusOnGTK();
 		IFindReplaceTarget target= getFindReplaceTarget();
 
 		assertEquals(0, (target.getSelection()).x);
@@ -308,7 +307,6 @@ public void testSearchTextSelectedWhenOpeningDialog() {
 
 		fTextViewer.setSelection(new TextSelection(0, 4));
 		initializeFindReplaceUIForTextViewer();
-		ensureHasFocusOnGTK();
 
 		assertEquals("test", dialog.getFindText());
 		assertEquals(dialog.getSelectedFindText(), dialog.getFindText());
@@ -321,7 +319,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

@@ -54,6 +54,7 @@ public void disableFirstTimeUseNotification() {
 				.getDialogSettingsProvider(FrameworkUtil.getBundle(FindReplaceOverlayFirstTimePopup.class))
 				.getDialogSettings();
 		settings.put(SETTING_POPUP_WAS_SHOWN_BEFORE, true);
+		PlatformUI.getWorkbench().getWorkbenchWindows()[0].getShell().forceActive();
 	}
 
 	@Override
@@ -63,7 +64,7 @@ public OverlayAccess openUIFromTextViewer(TextViewer viewer) {
 		actionAccessor.invoke("showOverlayInEditor", null);
 		FindReplaceOverlay overlay= (FindReplaceOverlay) actionAccessor.get("overlay");
 		System.out.println("Focus test: " + overlay.getContainerControl().getDisplay().getFocusControl());
-		return new OverlayAccess(getFindReplaceTarget(), overlay);
+		return new OverlayAccess(getFindReplaceTarget(), overlay, testName.getMethodName());
 	}
 
 	@Test

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

@@ -14,6 +14,7 @@
 package org.eclipse.ui.internal.findandreplace.overlay;
 
 import static org.eclipse.ui.internal.findandreplace.FindReplaceTestUtil.runEventQueue;
+import static org.eclipse.ui.internal.findandreplace.FindReplaceTestUtil.waitForFocus;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
@@ -63,7 +64,7 @@ class OverlayAccess implements IFindReplaceUIAccess {
 
 	private final FindReplaceOverlay overlay;
 
-	OverlayAccess(IFindReplaceTarget findReplaceTarget, FindReplaceOverlay findReplaceOverlay) {
+	OverlayAccess(IFindReplaceTarget findReplaceTarget, FindReplaceOverlay findReplaceOverlay, String testName) {
 		this.findReplaceTarget= findReplaceTarget;
 		overlay= findReplaceOverlay;
 		WidgetExtractor widgetExtractor= new WidgetExtractor(FindReplaceOverlay.ID_DATA_KEY, findReplaceOverlay.getContainerControl());
@@ -76,6 +77,7 @@ class OverlayAccess implements IFindReplaceUIAccess {
 		searchBackward= widgetExtractor.findToolItem("searchBackward");
 		openReplaceDialog= widgetExtractor.findToolItem("replaceToggle");
 		extractReplaceWidgets();
+		waitForFocus(this::hasFocus, testName);
 	}
 
 	private void extractReplaceWidgets() {
@@ -103,7 +105,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/DialogAccess.java

@@ -11,6 +11,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.hasItems;
 import static org.hamcrest.Matchers.not;
@@ -71,7 +72,7 @@ class DialogAccess implements IFindReplaceUIAccess {
 
 	private final Button replaceAllButton;
 
-	DialogAccess(IFindReplaceTarget findReplaceTarget, Dialog findReplaceDialog) {
+	DialogAccess(IFindReplaceTarget findReplaceTarget, Dialog findReplaceDialog, String testName) {
 		this.findReplaceTarget= findReplaceTarget;
 		this.findReplaceDialog= findReplaceDialog;
 		WidgetExtractor widgetExtractor= new WidgetExtractor(DATA_ID, findReplaceDialog.getShell());
@@ -89,6 +90,8 @@ class DialogAccess implements IFindReplaceUIAccess {
 		replaceButton= widgetExtractor.findButton("replaceOne");
 		replaceFindButton= widgetExtractor.findButton("replaceFindOne");
 		replaceAllButton= widgetExtractor.findButton("replaceAll");
+
+		waitForFocus(this::hasFocus, testName);
 	}
 
 	void restoreInitialConfiguration() {

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

@@ -52,7 +52,7 @@ 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);
+		return new DialogAccess(getFindReplaceTarget(), dialog, testName.getMethodName());
 	}
 
 	@Test