Ensure proper cleanup after WorkspaceSessionTests

WorkspaceSessionTests overwrite the tearDown() method with an empty
implementation to avoid that cleanup is performed after each test method
(i.e., session). However, the cleanup functionality is not called after
the last of the sessions of a test class has finished, thus potentially
leaving the system in an unclean state and not ensuring test isolation.

This change adds a test method to the WorkspaceSessionTest that is
supposed to be executed after all actual test methods and executes the
tearDown() functionality to clean up. Those WorkspaceSessionTests
implementations that had overwritten the tearDown() method are adapted
to properly clean up after each of their test methods if required.

Author: HeikoKlare

resources/tests/org.eclipse.core.tests.resources.saveparticipant/src/org/eclipse/core/tests/resources/saveparticipant/SaveManager2Test.java

@@ -26,7 +26,6 @@
 import org.eclipse.core.tests.resources.saveparticipant1.SaveParticipant1Plugin;
 import org.eclipse.core.tests.resources.saveparticipant3.SaveParticipant3Plugin;
 import org.osgi.framework.Bundle;
-import org.osgi.framework.BundleException;
 
 import junit.framework.Test;
 import junit.framework.TestSuite;

resources/tests/org.eclipse.core.tests.resources/src/org/eclipse/core/tests/internal/resources/WorkspacePreferencesTest.java

@@ -43,16 +43,14 @@ protected void setUp() throws Exception {
 		workspace.setDescription(Workspace.defaultWorkspaceDescription());
 	}
 
-	@Override
-	protected void tearDown() throws Exception {
-		super.tearDown();
+	private void setDefaultWorkspaceDescription() throws CoreException {
 		workspace.setDescription(Workspace.defaultWorkspaceDescription());
 	}
 
 	/**
 	 * Tests properties state in a brand new workspace (must match defaults).
 	 */
-	public void testDefaults() {
+	public void testDefaults() throws CoreException {
 		IWorkspaceDescription description = Workspace.defaultWorkspaceDescription();
 
 		assertEquals("1.0", description, preferences);
@@ -66,13 +64,15 @@ public void testDefaults() {
 		for (String property : descriptionProperties) {
 			assertTrue("2.0 - Description property is not default: " + property, defaultPropertiesList.contains(property));
 		}
+		
+		setDefaultWorkspaceDescription();
 	}
 
 	/**
 	 * Makes changes in the preferences and ensure they are reflected in the
 	 * workspace description.
 	 */
-	public void testSetPreferences() {
+	public void testSetPreferences() throws CoreException {
 		preferences.setValue(ResourcesPlugin.PREF_AUTO_BUILDING, true);
 		assertTrue("1.0", workspace.getDescription().isAutoBuilding());
 
@@ -110,6 +110,8 @@ public void testSetPreferences() {
 
 		preferences.setValue(ResourcesPlugin.PREF_KEEP_DERIVED_STATE, true);
 		assertTrue("4.1", workspace.getDescription().isKeepDerivedState());
+
+		setDefaultWorkspaceDescription();
 	}
 
 	/**
@@ -152,6 +154,8 @@ public void testEvents() throws CoreException {
 		} finally {
 			preferences.removePropertyChangeListener(listener);
 		}
+
+		setDefaultWorkspaceDescription();
 	}
 
 	/**
@@ -204,6 +208,8 @@ public void testImportExport() throws CoreException {
 			ensureDoesNotExistInFileSystem(originalPreferencesFile.removeLastSegments(1).toFile());
 			ensureDoesNotExistInFileSystem(modifiedPreferencesFile.removeLastSegments(1).toFile());
 		}
+
+		setDefaultWorkspaceDescription();
 	}
 
 	/**
@@ -234,6 +240,8 @@ public void testSetDescription() throws CoreException {
 		// the original value should remain set
 		assertEquals("3.1", 90000, workspace.getDescription().getFileStateLongevity());
 		assertEquals("3.2", 90000, preferences.getLong(ResourcesPlugin.PREF_FILE_STATE_LONGEVITY));
+
+		setDefaultWorkspaceDescription();
 	}
 
 	/**

resources/tests/org.eclipse.core.tests.resources/src/org/eclipse/core/tests/resources/WorkspaceSessionTest.java

@@ -35,8 +35,6 @@
  * @see org.eclipse.core.tests.session.WorkspaceSessionTestSuite
  */
 public class WorkspaceSessionTest extends ResourceTest {
-	protected String testName;
-
 	/**
 	 * Constructor for WorkspaceSessionTest.
 	 */
@@ -54,9 +52,27 @@ public WorkspaceSessionTest(String name) {
 		super(name);
 	}
 
+	/**
+	 * Executes the cleanup functionality in {@link ResourceTest#tearDown()} after
+	 * the last of the session of this test class (i.e., the last <code>test*</code>
+	 * method) has finished.
+	 * <p>
+	 * The test methods are executed in lexicographic order of their names, e.g.,
+	 * <code>test1</code> before <code>test2</code>. The name of this method is
+	 * chosen so that it comes lexicographically rather safely after all other
+	 * actual test methods.
+	 */
+	public void test___cleanup() throws Exception {
+		super.tearDown();
+	}
+
+	/**
+	 * Cleanup is done after all sessions of this test class in
+	 * {@link #test___cleanup()}. This method is overwritten to do nothing in order
+	 * to not cleanup between the sessions.
+	 */
 	@Override
-	protected void tearDown() throws Exception {
-		// We should not run super.tearDown() on session tests.
-		// If needed, we should call it explicitly.
+	protected final void tearDown() throws Exception {
 	}
+
 }

resources/tests/org.eclipse.core.tests.resources/src/org/eclipse/core/tests/resources/session/FindDeletedMembersTest.java

@@ -22,6 +22,7 @@
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IWorkspaceRoot;
+import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.tests.resources.AutomatedResourceTests;
 import org.eclipse.core.tests.resources.WorkspaceSessionTest;
 import org.eclipse.core.tests.session.WorkspaceSessionTestSuite;
@@ -58,8 +59,7 @@ protected void setUp() throws Exception {
 
 	}
 
-	@Override
-	protected void tearDown() throws Exception {
+	private void saveWorkspace() throws CoreException {
 		getWorkspace().save(true, getMonitor());
 	}
 
@@ -74,6 +74,8 @@ public void test1() throws Exception {
 		// create and delete a file
 		pfile.create(getRandomContents(), true, getMonitor());
 		pfile.delete(true, true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test2() throws Exception {
@@ -102,6 +104,8 @@ public void test2() throws Exception {
 
 		// recreate the file
 		pfile.create(getRandomContents(), true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test3() throws Exception {
@@ -138,6 +142,8 @@ public void test3() throws Exception {
 		folder.create(true, true, getMonitor());
 		file.create(getRandomContents(), true, getMonitor());
 		file.delete(true, true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test4() throws Exception {
@@ -167,6 +173,8 @@ public void test4() throws Exception {
 
 		// deleting the folder should bring it back into history
 		folder.delete(true, true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test5() throws Exception {
@@ -219,6 +227,8 @@ public void test5() throws Exception {
 		file2.create(getRandomContents(), true, getMonitor());
 		file3.create(getRandomContents(), true, getMonitor());
 		folder.delete(true, true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test6() throws Exception {
@@ -271,6 +281,8 @@ public void test6() throws Exception {
 		assertEquals("3.12", 1, df.length);
 
 		project.delete(true, getMonitor());
+
+		saveWorkspace();
 	}
 
 	public void test7() throws Exception {
@@ -314,6 +326,8 @@ public void test7() throws Exception {
 
 		df = folder2.findDeletedMembersWithHistory(IResource.DEPTH_INFINITE, getMonitor());
 		assertEquals("4.12", 0, df.length);
+
+		saveWorkspace();
 	}
 
 	public static Test suite() {

resources/tests/org.eclipse.core.tests.resources/src/org/eclipse/core/tests/resources/session/ProjectPreferenceSessionTest.java

@@ -37,8 +37,7 @@ public static Test suite() {
 		//						return new ProjectPreferenceSessionTest("testDeleteFileBeforeLoad2");
 	}
 
-	@Override
-	protected void tearDown() throws Exception {
+	private void saveWorkspace() throws Exception {
 		getWorkspace().save(true, getMonitor());
 	}
 
@@ -62,6 +61,7 @@ public void testDeleteFileBeforeLoad1() throws Exception {
 		IFile file = project.getFile(IPath.fromOSString(DIR_NAME).append(qualifier).addFileExtension(FILE_EXTENSION));
 		assertTrue("2.0", file.exists());
 		assertTrue("2.1", file.getLocation().toFile().exists());
+		saveWorkspace();
 	}
 
 	public void testDeleteFileBeforeLoad2() throws Exception {
@@ -85,6 +85,7 @@ public void testDeleteFileBeforeLoad2() throws Exception {
 		} finally {
 			Platform.removeLogListener(listener);
 		}
+		saveWorkspace();
 	}
 
 	/*
@@ -98,13 +99,15 @@ public void testSaveLoad1() throws Exception {
 		Preferences node = context.getNode("test.save.load");
 		node.put("key", "value");
 		node.flush();
+		saveWorkspace();
 	}
 
-	public void testSaveLoad2() {
+	public void testSaveLoad2() throws Exception {
 		IProject project = getProject("testSaveLoad");
 		IScopeContext context = new ProjectScope(project);
 		Preferences node = context.getNode("test.save.load");
 		assertEquals("1.0", "value", node.get("key", null));
+		saveWorkspace();
 	}
 
 	private static IProject getProject(String name) {