Move trace information from UITestCase to CloseTestWindowsRule

The tracing information for UI tests (test name printed at start/end of
each test to stdout) is the only remaining functionality of UITestCase.
When the CloseTestWindowsRule has been extracted out of this test case,
the test classes that have been adapted to only use that rule miss that
tracing information since this.

This change moves the tracing to the CloseTestWindowsRule as the central
test rule for UI-related tests. This implicitly readds the tracing
information to tests that use the rule.
With this change, the inheritance to UITestCase can simply be replaced
with the use of the CloseWindowsTestRule in all plain JUnit 4 tests.

Author: HeikoKlare

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

@@ -27,13 +27,21 @@
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
 import org.junit.rules.ExternalResource;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
 
 /**
- * Rule that close windows opened during the test case and checks for shells
- * unintentionally leaked from the test case.
+ * Rule for UI tests to clean up windows/shells:
+ * <ul>
+ * <li>prints the test name to the log before and after each test case
+ * <li>closes windows opened during the test case
+ * <li>checks for shells unintentionally leaked from the test case
+ * </ul>
  */
 public class CloseTestWindowsRule extends ExternalResource {
 
+	private String testName;
+
 	private final List<IWorkbenchWindow> testWindows;
 
 	private TestWindowListener windowListener;
@@ -46,21 +54,39 @@ public CloseTestWindowsRule() {
 		testWindows = new ArrayList<>(3);
 	}
 
+	@Override
+	public Statement apply(Statement base, Description description) {
+		this.testName = description.getDisplayName();
+		return super.apply(base, description);
+	}
+
 	@Override
 	protected void before() throws Exception {
 		addWindowListener();
 		storeInitialShells();
+		trace(TestRunLogUtil.formatTestStartMessage(testName));
 	}
 
 	@Override
 	protected void after() {
+		trace(TestRunLogUtil.formatTestFinishedMessage(testName));
 		removeWindowListener();
 		processEvents();
 		closeAllTestWindows();
 		processEvents();
 		checkForLeakedShells();
 	}
 
+	/**
+	 * Outputs a trace message to the trace output device, if enabled. By default,
+	 * trace messages are sent to <code>System.out</code>.
+	 *
+	 * @param msg the trace message
+	 */
+	private static void trace(String msg) {
+		System.out.println(msg);
+	}
+
 	/**
 	 * Adds a window listener to the workbench to keep track of opened test windows.
 	 */
@@ -134,4 +160,12 @@ public void disableLeakChecks() {
 		this.leakChecksDisabled = true;
 	}
 
+	/**
+	 * Ability to set the test name if the rule is not used as an ordinary JUnit 4
+	 * rules. Temporarily necessary until JUnit 3 compatibility is dropped.
+	 */
+	void setTestName(String testName) {
+		this.testName = testName;
+	}
+
 }

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

@@ -65,16 +65,6 @@ public UITestCase(String testName) {
 		super(testName);
 	}
 
-	/**
-	 * Outputs a trace message to the trace output device, if enabled.
-	 * By default, trace messages are sent to <code>System.out</code>.
-	 *
-	 * @param msg the trace message
-	 */
-	protected void trace(String msg) {
-		System.out.println(msg);
-	}
-
 	/**
 	 * Simple implementation of setUp. Subclasses are prevented from overriding this
 	 * method to maintain logging consistency. doSetUp() should be overridden
@@ -88,9 +78,9 @@ protected void trace(String msg) {
 	@Override
 	public final void setUp() throws Exception {
 		super.setUp();
-		closeTestWindows.before();
 		String name = runningTest != null ? runningTest : this.getName();
-		trace(TestRunLogUtil.formatTestStartMessage(name));
+		closeTestWindows.setTestName(name);
+		closeTestWindows.before();
 		doSetUp();
 	}
 
@@ -116,8 +106,6 @@ protected void doSetUp() throws Exception {
 	@After
 	@Override
 	public final void tearDown() throws Exception {
-		String name = runningTest != null ? runningTest : this.getName();
-		trace(TestRunLogUtil.formatTestFinishedMessage(name));
 		doTearDown();
 		closeTestWindows.after();
 	}