Move static utility functionality from UITestCase to UITestUtil

The UITestCase currently contains a bunch of static utility
functionality. Since UITestCase is a leftover from JUnit 3 times where
test cases were defined in inheritance hierarchies, this class is about
to be removed. In order to prepare for that, this moves the utility
functions to a separate UITestUtil class. This also includes making some
methods static that were effectively static before.

Author: HeikoKlare

tests/org.eclipse.ui.genericeditor.tests/src/org/eclipse/ui/genericeditor/tests/AbstratGenericEditorTest.java

@@ -14,6 +14,9 @@
 package org.eclipse.ui.genericeditor.tests;
 
 import static org.eclipse.ui.tests.harness.util.DisplayHelper.runEventLoop;
+import static org.eclipse.ui.tests.harness.util.UITestUtil.forceActive;
+import static org.eclipse.ui.tests.harness.util.UITestUtil.processEvents;
+import static org.eclipse.ui.tests.harness.util.UITestUtil.waitForJobs;
 
 import java.io.ByteArrayInputStream;
 import java.nio.charset.StandardCharsets;
@@ -34,7 +37,6 @@
 import org.eclipse.ui.internal.genericeditor.ExtensionBasedTextEditor;
 import org.eclipse.ui.intro.IIntroPart;
 import org.eclipse.ui.part.FileEditorInput;
-import org.eclipse.ui.tests.harness.util.UITestCase;
 
 /**
  * Closes intro, create {@link #project}, create {@link #file} and open {@link #editor}; and clean up.
@@ -59,9 +61,9 @@ public void setUp() throws Exception {
 		project.create(null);
 		project.open(null);
 		project.setDefaultCharset(StandardCharsets.UTF_8.name(), null);
-		UITestCase.waitForJobs(100, 5000);
+		waitForJobs(100, 5000);
 		window= PlatformUI.getWorkbench().getActiveWorkbenchWindow();
-		UITestCase.forceActive(window.getShell());
+		forceActive(window.getShell());
 		createAndOpenFile();
 	 }
 
@@ -128,4 +130,13 @@ private static void closeIntro() {
 			runEventLoop(PlatformUI.getWorkbench().getDisplay(),0);
 		}
 	}
+
+	public static void waitAndDispatch(long milliseconds) {
+		long timeout = milliseconds; //ms
+		long start = System.currentTimeMillis();
+		while (start + timeout > System.currentTimeMillis()) {
+			processEvents();
+		}
+	}
+
 }

tests/org.eclipse.ui.tests.harness/src/org/eclipse/ui/tests/harness/util/CloseTestWindowsRule.java

@@ -15,6 +15,8 @@
 
 package org.eclipse.ui.tests.harness.util;
 
+import static org.eclipse.ui.tests.harness.util.UITestUtil.processEvents;
+
 import java.util.ArrayList;
 import java.util.List;
 
@@ -43,9 +45,9 @@ protected void before() throws Exception {
 	@Override
 	protected void after() {
 		removeWindowListener();
-		UITestCase.processEvents();
+		processEvents();
 		closeAllTestWindows();
-		UITestCase.processEvents();
+		processEvents();
 	}
 
 	/**

tests/org.eclipse.ui.tests.harness/src/org/eclipse/ui/tests/harness/util/DialogCheck.java

@@ -14,6 +14,7 @@
  *******************************************************************************/
 package org.eclipse.ui.tests.harness.util;
 
+import static org.eclipse.ui.tests.harness.util.UITestUtil.processEvents;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.fail;
 
@@ -83,7 +84,7 @@ public static void assertDialogTexts(Dialog dialog) {
 		dialog.setBlockOnOpen(false);
 		dialog.open();
 		Shell shell = dialog.getShell();
-		UITestCase.processEvents();
+		processEvents();
 		try {
 			verifyCompositeText(shell);
 		} finally {

tests/org.eclipse.ui.tests.harness/src/org/eclipse/ui/tests/harness/util/UITestCase.java

@@ -16,26 +16,14 @@
  *******************************************************************************/
 package org.eclipse.ui.tests.harness.util;
 
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.PrintStream;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
-import org.eclipse.core.resources.ResourcesPlugin;
-import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.IAdaptable;
-import org.eclipse.core.runtime.IStatus;
-import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.preference.PreferenceMemento;
-import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
-import org.eclipse.ui.IWorkbenchPage;
-import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
-import org.eclipse.ui.WorkbenchException;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Rule;
@@ -54,16 +42,6 @@
  */
 public abstract class UITestCase extends TestCase {
 
-	/**
-	 * Returns the workbench page input to use for newly created windows.
-	 *
-	 * @return the page input to use for newly created windows
-	 * @since 3.1
-	 */
-	public static IAdaptable getPageInput() {
-		return ResourcesPlugin.getWorkspace().getRoot();
-	}
-
 	/**
 	 * Rule to close windows opened during the test case, manually called to remain
 	 * compatible with JUnit3
@@ -100,57 +78,6 @@ public UITestCase(String testName) {
 		super(testName);
 	}
 
-	/**
-	 * Fails the test due to the given throwable.
-	 */
-	public static void fail(String message, Throwable e) {
-		// If the exception is a CoreException with a multistatus
-		// then print out the multistatus so we can see all the info.
-		if (e instanceof CoreException) {
-			IStatus status = ((CoreException) e).getStatus();
-			write(status, 0);
-		} else
-			e.printStackTrace();
-		throw new AssertionError(message, e);
-	}
-
-	private static void indent(OutputStream output, int indent) {
-		for (int i = 0; i < indent; i++)
-			try {
-				output.write("\t".getBytes());
-			} catch (IOException e) {
-				// ignore
-			}
-	}
-
-	private static void write(IStatus status, int indent) {
-		PrintStream output = System.out;
-		indent(output, indent);
-		output.println("Severity: " + status.getSeverity());
-
-		indent(output, indent);
-		output.println("Plugin ID: " + status.getPlugin());
-
-		indent(output, indent);
-		output.println("Code: " + status.getCode());
-
-		indent(output, indent);
-		output.println("Message: " + status.getMessage());
-
-		if (status.getException() != null) {
-			indent(output, indent);
-			output.print("Exception: ");
-			status.getException().printStackTrace(output);
-		}
-
-		if (status.isMultiStatus()) {
-			IStatus[] children = status.getChildren();
-			for (IStatus child : children) {
-				write(child, indent + 1);
-			}
-		}
-	}
-
 	/**
 	 * Outputs a trace message to the trace output device, if enabled.
 	 * By default, trace messages are sent to <code>System.out</code>.
@@ -233,209 +160,13 @@ protected void doTearDown() throws Exception {
 		closeTestWindows.after();
 	}
 
-	public static void processEvents() {
-		Display display = PlatformUI.getWorkbench().getDisplay();
-		if (display != null)
-			while (display.readAndDispatch())
-				;
-	}
-
-	/**
-	 * Utility for waiting until the execution of jobs of any family has
-	 * finished or timeout is reached. If no jobs are running, the method waits
-	 * given minimum wait time. While this method is waiting for jobs, UI events
-	 * are processed.
-	 *
-	 * @param minTimeMs
-	 *            minimum wait time in milliseconds
-	 * @param maxTimeMs
-	 *            maximum wait time in milliseconds
-	 */
-	public static void waitForJobs(long minTimeMs, long maxTimeMs) {
-		if (maxTimeMs < minTimeMs) {
-			throw new IllegalArgumentException("Max time is smaller as min time!");
-		}
-		final long start = System.currentTimeMillis();
-		while (System.currentTimeMillis() - start < minTimeMs) {
-			processEvents();
-			sleep(10);
-		}
-		while (!Job.getJobManager().isIdle() && System.currentTimeMillis() - start < maxTimeMs) {
-			processEvents();
-			sleep(10);
-		}
-	}
-
-	/**
-	 * Pauses execution of the current thread
-	 */
-	protected static void sleep(long millis) {
-		try {
-			Thread.sleep(millis);
-		} catch (InterruptedException e) {
-			return;
-		}
-	}
-
-	/**
-	 * Tries to make given shell active.
-	 *
-	 * <p>
-	 * Note: the method runs at least 1000 milliseconds to make sure the active
-	 * window is really active, see
-	 * https://bugs.eclipse.org/bugs/show_bug.cgi?id=417258#c27
-	 *
-	 * @param shell
-	 *            non null
-	 * @return true if the given shell is active for the current display
-	 */
-	public static boolean forceActive(Shell shell) {
-		Display display = PlatformUI.getWorkbench().getDisplay();
-		Shell[] shells = display.getShells();
-		for (Shell s : shells) {
-			if (s.isVisible()) {
-				s.setMinimized(true);
-			}
-			processEvents();
-		}
-		waitForJobs(200, 3000);
-		for (Shell s : shells) {
-			if (s.isVisible()) {
-				s.setMinimized(false);
-			}
-			processEvents();
-		}
-		waitForJobs(200, 3000);
-		shell.setVisible(false);
-		processEvents();
-		shell.setMinimized(true);
-		processEvents();
-		waitForJobs(200, 3000);
-		shell.setVisible(true);
-		processEvents();
-		shell.setMinimized(false);
-		processEvents();
-		shell.forceActive();
-		processEvents();
-		shell.forceFocus();
-		processEvents();
-		waitForJobs(400, 3000);
-		return display.getActiveShell() == shell;
-	}
-
-	public static interface Condition {
-		public boolean compute();
-	}
-
-	/**
-	 *
-	 * @param condition
-	 *            , or null if this should only wait
-	 * @param timeout
-	 *            , -1 if forever
-	 * @return true if successful, false if time out or interrupted
-	 */
-	public static boolean processEventsUntil(Condition condition, long timeout) {
-		long startTime = System.currentTimeMillis();
-		Display display = PlatformUI.getWorkbench().getDisplay();
-		while (condition == null || !condition.compute()) {
-			if (timeout != -1
-					&& System.currentTimeMillis() - startTime > timeout) {
-				return false;
-			}
-			while (display.readAndDispatch())
-				;
-			try {
-				Thread.sleep(20);
-			} catch (InterruptedException e) {
-				Thread.currentThread().interrupt();
-				return false;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Open a test window with the empty perspective.
-	 */
-	public static IWorkbenchWindow openTestWindow() {
-		return openTestWindow(EmptyPerspective.PERSP_ID);
-	}
-
-	/**
-	 * Open a test window with the provided perspective.
-	 */
-	public static IWorkbenchWindow openTestWindow(String perspectiveId) {
-		try {
-			IWorkbenchWindow window = PlatformUI.getWorkbench().openWorkbenchWindow(
-					perspectiveId, getPageInput());
-			waitOnShell(window.getShell());
-			return window;
-		} catch (WorkbenchException e) {
-			fail("Problem opening test window", e);
-			return null;
-		}
-	}
-
-	/**
-	 * Try and process events until the new shell is the active shell. This may
-	 * never happen, so time out after a suitable period.
-	 *
-	 * @param shell
-	 *            the shell to wait on
-	 * @since 3.2
-	 */
-	private static void waitOnShell(Shell shell) {
-		processEvents();
-		waitForJobs(100, 5000);
-	}
-
 	/**
 	 * Close all test windows.
 	 */
 	public void closeAllTestWindows() {
 		closeTestWindows.closeAllTestWindows();
 	}
 
-	/**
-	 * Open a test page with the empty perspective in a window.
-	 */
-	public IWorkbenchPage openTestPage(IWorkbenchWindow win) {
-		IWorkbenchPage[] pages = openTestPage(win, 1);
-		if (pages != null) {
-			return pages[0];
-		}
-		return null;
-	}
-
-	/**
-	 * Open "n" test pages with the empty perspective in a window.
-	 */
-	public IWorkbenchPage[] openTestPage(IWorkbenchWindow win, int pageTotal) {
-		try {
-			IWorkbenchPage[] pages = new IWorkbenchPage[pageTotal];
-			IAdaptable input = getPageInput();
-
-			for (int i = 0; i < pageTotal; i++) {
-				pages[i] = win.openPage(EmptyPerspective.PERSP_ID, input);
-			}
-			return pages;
-		} catch (WorkbenchException e) {
-			fail("Problem opening test page", e);
-			return null;
-		}
-	}
-
-	/**
-	 * Close all pages within a window.
-	 */
-	public void closeAllPages(IWorkbenchWindow window) {
-		IWorkbenchPage[] pages = window.getPages();
-		for (IWorkbenchPage page : pages) {
-			page.close();
-		}
-	}
-
 	/**
 	 * Set whether the window listener will manage opening and closing of created windows.
 	 */