Remove workbench field and getter from UITestCase

The workbench can just be retrieved from PlatformUI and should not be
unnecessarily stored in a to-be-removed abstract test class. This gets
rid of the field by different means for different usage contexts:
- Replace unnecessary reimplementations of spinning the event loop
- Directly access the workbench via PlatformUI
- Store the field in the actual test class

Author: HeikoKlare

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

@@ -32,7 +32,6 @@
 import org.eclipse.jface.preference.PreferenceMemento;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
-import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
@@ -71,7 +70,6 @@ public static IAdaptable getPageInput() {
 	 */
 	private final CloseTestWindowsRule closeTestWindows = new CloseTestWindowsRule();
 
-	protected IWorkbench fWorkbench;
 	private Set<Shell> preExistingShells;
 
 	/** Preference helper to restore changed preference values after test run. */
@@ -177,8 +175,7 @@ protected void trace(String msg) {
 	public final void setUp() throws Exception {
 		super.setUp();
 		closeTestWindows.before();
-		fWorkbench = PlatformUI.getWorkbench();
-		this.preExistingShells = Set.of(fWorkbench.getDisplay().getShells());
+		this.preExistingShells = Set.of(PlatformUI.getWorkbench().getDisplay().getShells());
 		String name = runningTest != null ? runningTest : this.getName();
 		trace(TestRunLogUtil.formatTestStartMessage(name));
 		doSetUp();
@@ -214,14 +211,13 @@ public final void tearDown() throws Exception {
 
 		// Check for shell leak.
 		List<String> leakedModalShellTitles = new ArrayList<>();
-		Shell[] shells = fWorkbench.getDisplay().getShells();
+		Shell[] shells = PlatformUI.getWorkbench().getDisplay().getShells();
 		for (Shell shell : shells) {
 			if (!shell.isDisposed() && !preExistingShells.contains(shell)) {
 				leakedModalShellTitles.add(shell.getText());
 				shell.close();
 			}
 		}
-		fWorkbench = null;
 		assertEquals("Test leaked modal shell: [" + String.join(", ", leakedModalShellTitles) + "]", 0,
 				leakedModalShellTitles.size());
 	}
@@ -447,16 +443,6 @@ protected void manageWindows(boolean manage) {
 		closeTestWindows.setEnabled(manage);
 	}
 
-	/**
-	 * Returns the workbench.
-	 *
-	 * @return the workbench
-	 * @since 3.1
-	 */
-	protected IWorkbench getWorkbench() {
-		return fWorkbench;
-	}
-
 	/**
 	 * Change a preference value for this test run. The preference will be reset to
 	 * its value before test started automatically on {@link #tearDown()}.

tests/org.eclipse.ui.tests.performance/src/org/eclipse/ui/tests/performance/GenerateIdentifiersTest.java

@@ -14,6 +14,8 @@
 
 package org.eclipse.ui.tests.performance;
 
+import static org.eclipse.ui.PlatformUI.getWorkbench;
+
 import org.eclipse.ui.activities.IActivityManager;
 import org.junit.Test;
 
@@ -30,7 +32,7 @@ public GenerateIdentifiersTest() {
 
 	@Test
 	public void test() throws Throwable {
-		final IActivityManager activityManager = fWorkbench.getActivitySupport().getActivityManager();
+		final IActivityManager activityManager = getWorkbench().getActivitySupport().getActivityManager();
 
 		exercise(() -> {
 			// construct the Identifiers to test

tests/org.eclipse.ui.tests.performance/src/org/eclipse/ui/tests/performance/OpenClosePerspectiveTest.java

@@ -15,6 +15,8 @@
 
 package org.eclipse.ui.tests.performance;
 
+import static org.eclipse.ui.PlatformUI.getWorkbench;
+
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
@@ -116,8 +118,7 @@ public void test() throws Throwable {
 	private void closePerspective(IWorkbenchPage activePage) {
 		IPerspectiveDescriptor persp = activePage.getPerspective();
 
-		ICommandService commandService = fWorkbench
-				.getService(ICommandService.class);
+		ICommandService commandService = getWorkbench().getService(ICommandService.class);
 		Command command = commandService
 				.getCommand("org.eclipse.ui.window.closePerspective");
 
@@ -128,8 +129,7 @@ private void closePerspective(IWorkbenchPage activePage) {
 		ParameterizedCommand pCommand = ParameterizedCommand.generateCommand(
 				command, parameters);
 
-		IHandlerService handlerService = fWorkbench
-				.getService(IHandlerService.class);
+		IHandlerService handlerService = getWorkbench().getService(IHandlerService.class);
 		try {
 			handlerService.executeCommand(pCommand, null);
 		} catch (ExecutionException | NotDefinedException | NotEnabledException | NotHandledException e1) {

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/adaptable/WorkingSetTestCase.java

@@ -13,6 +13,8 @@
  *******************************************************************************/
 package org.eclipse.ui.tests.adaptable;
 
+import static org.eclipse.ui.PlatformUI.getWorkbench;
+
 import org.eclipse.core.internal.propertytester.ResourceMappingPropertyTester;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/api/IAggregateWorkingSetTest.java

@@ -27,8 +27,10 @@
 import org.eclipse.jface.util.IPropertyChangeListener;
 import org.eclipse.ui.IAggregateWorkingSet;
 import org.eclipse.ui.IMemento;
+import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkingSet;
 import org.eclipse.ui.IWorkingSetManager;
+import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.XMLMemento;
 import org.eclipse.ui.internal.AbstractWorkingSet;
 import org.eclipse.ui.internal.AbstractWorkingSetManager;
@@ -47,6 +49,7 @@ public class IAggregateWorkingSetTest extends UITestCase {
 	static final String AGGREGATE_WORKING_SET_NAME_ = "testaggregatews";
 	static final String WSET_PAGE_ID="org.eclipse.ui.resourceWorkingSetPage";
 	IWorkspace fWorkspace;
+	IWorkbench fWorkbench;
 
 	IWorkingSet[] components;
 	List<IWorkingSet> backup;
@@ -59,11 +62,11 @@ public IAggregateWorkingSetTest() {
 	@Override
 	protected void doSetUp() throws Exception {
 		super.doSetUp();
-		IWorkingSetManager workingSetManager = fWorkbench
-		.getWorkingSetManager();
+		IWorkingSetManager workingSetManager = PlatformUI.getWorkbench().getWorkingSetManager();
 		backup = Arrays.asList(workingSetManager.getAllWorkingSets());
 
 		fWorkspace = ResourcesPlugin.getWorkspace();
+		fWorkbench = PlatformUI.getWorkbench();
 		components = new IWorkingSet[4];
 		for (int i = 0; i < 4; i++) {
 			components[i] = workingSetManager.createWorkingSet(WORKING_SET_NAME
@@ -89,6 +92,7 @@ protected void doTearDown() throws Exception {
 				workingSetManager.removeWorkingSet(wset);
 			}
 		}
+		fWorkbench = null;
 		super.doTearDown();
 	}
 

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/api/IDeprecatedWorkbenchPageTest.java

@@ -22,6 +22,7 @@
 import org.eclipse.ui.IPageLayout;
 import org.eclipse.ui.IPerspectiveDescriptor;
 import org.eclipse.ui.IViewPart;
+import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
@@ -40,6 +41,8 @@
 @RunWith(JUnit4.class)
 public class IDeprecatedWorkbenchPageTest extends UITestCase {
 
+	private IWorkbench fWorkbench;
+
 	private IWorkbenchPage fActivePage;
 
 	private IWorkbenchWindow fWin;
@@ -53,6 +56,7 @@ public IDeprecatedWorkbenchPageTest() {
 	@Override
 	protected void doSetUp() throws Exception {
 		super.doSetUp();
+		fWorkbench = PlatformUI.getWorkbench();
 		fWin = openTestWindow();
 		fActivePage = fWin.getActivePage();
 	}
@@ -64,6 +68,7 @@ protected void doTearDown() throws Exception {
 			FileUtil.deleteProject(proj);
 			proj = null;
 		}
+		fWorkbench = null;
 	}
 
 	/**

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/api/IPerspectiveListenerTest.java

@@ -15,8 +15,10 @@
 
 import org.eclipse.ui.IPerspectiveDescriptor;
 import org.eclipse.ui.IPerspectiveListener;
+import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.tests.harness.util.EmptyPerspective;
 import org.eclipse.ui.tests.harness.util.UITestCase;
 import org.junit.Ignore;
@@ -29,6 +31,8 @@ public class IPerspectiveListenerTest extends UITestCase implements
 		IPerspectiveListener {
 	private int fEvent;
 
+	private IWorkbench fWorkbench;
+
 	private IWorkbenchWindow fWindow;
 
 	private IWorkbenchPage fPageMask;
@@ -49,13 +53,15 @@ public IPerspectiveListenerTest() {
 	protected void doSetUp() throws Exception {
 		super.doSetUp();
 		fEvent = NONE;
+		fWorkbench = PlatformUI.getWorkbench();
 		fWindow = openTestWindow();
 		fWindow.addPerspectiveListener(this);
 	}
 
 	@Override
 	protected void doTearDown() throws Exception {
 		fWindow.removePerspectiveListener(this);
+		fWorkbench = null;
 		super.doTearDown();
 	}
 

tests/org.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/api/IWorkbenchPageTest.java

@@ -15,6 +15,8 @@
  *******************************************************************************/
 package org.eclipse.ui.tests.api;
 
+import static org.eclipse.ui.PlatformUI.getWorkbench;
+
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -89,6 +91,8 @@
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class IWorkbenchPageTest extends UITestCase {
 
+	private IWorkbench fWorkbench;
+
 	private IWorkbenchPage fActivePage;
 
 	private IWorkbenchWindow fWin;
@@ -160,6 +164,7 @@ public IWorkbenchPageTest() {
 	@Override
 	protected void doSetUp() throws Exception {
 		super.doSetUp();
+		fWorkbench = PlatformUI.getWorkbench();
 		fWin = openTestWindow();
 		fActivePage = fWin.getActivePage();
 		logStatus = null;
@@ -175,6 +180,7 @@ protected void doTearDown() throws Exception {
 			FileUtil.deleteProject(proj);
 			proj = null;
 		}
+		fWorkbench = null;
 	}
 
 	/**
@@ -836,7 +842,7 @@ public void testGetPerspective() throws Throwable {
 
 	@Test
 	public void testSetPerspective() throws Throwable {
-		IPerspectiveDescriptor per = PlatformUI.getWorkbench()
+		IPerspectiveDescriptor per = getWorkbench()
 				.getPerspectiveRegistry().findPerspectiveWithId(
 						EmptyPerspective.PERSP_ID);
 		fActivePage.setPerspective(per);
@@ -1152,7 +1158,7 @@ public void testFindViewReferenceAfterShowViewCommand() throws Throwable {
 		showViewViaCommand(MockViewPart.ID2);
 
 		Assume.assumeTrue(fWin.getShell().isVisible());
-		Assume.assumeTrue(PlatformUI.getWorkbench().getActiveWorkbenchWindow() == fWin);
+		Assume.assumeTrue(getWorkbench().getActiveWorkbenchWindow() == fWin);
 		Assume.assumeTrue(shellIsActive.get());
 
 		assertNotNull(fActivePage.findView(MockViewPart.ID2));
@@ -1206,7 +1212,7 @@ public void testFindHistoryViewReferenceAfterShowViewCommand() throws Throwable
 		showViewViaCommand(historyView);
 
 		Assume.assumeTrue(fWin.getShell().isVisible());
-		Assume.assumeTrue(PlatformUI.getWorkbench().getActiveWorkbenchWindow() == fWin);
+		Assume.assumeTrue(getWorkbench().getActiveWorkbenchWindow() == fWin);
 		Assume.assumeTrue(shellIsActive.get());
 
 		assertNotNull(fActivePage.findView(historyView));
@@ -2591,7 +2597,7 @@ public void testRelativeViewVisibility() throws WorkbenchException {
 	public void testBug76285() throws PartInitException {
 		IWorkbenchPage page = fActivePage;
 		IPerspectiveDescriptor originalPersp = page.getPerspective();
-		IPerspectiveDescriptor resourcePersp = PlatformUI.getWorkbench()
+		IPerspectiveDescriptor resourcePersp = getWorkbench()
 				.getPerspectiveRegistry().findPerspectiveWithId(
 						IDE.RESOURCE_PERSPECTIVE_ID);
 		// test requires switching between two different perspectives