Skip to content

Commit

Permalink
Migrate save participant tests to JUnit 5 eclipse-platform#903
Browse files Browse the repository at this point in the history 
This migrates the SaveManagerTest to JUnit 5, using the
SessionTestExtension with the CustomSessionWorkspace. It consists of the
following changes:
- the individual test suites in the subclasses of SaveManagerTest were
unused and are thus removed
- further unused functionality in those subclasses is removed
- JUnit 4 dependencies are replaced with JUnit 5 dependencies in the
plug-in org.eclipse.core.tests.resources.saveparticipant
- the plug-in org.eclipse.core.tests.resources.saveparticipant is
declared as a test plug-in and tests are enabled for the Maven build
- the SaveParticipantTest, which executed the SaveManagerTest from the
central org.eclipse.core.tests.resources plug-in, is removed as it was
not part of any test suite (and thus not executed) anyway

Contributes to
eclipse-platform#903
  • Loading branch information
@HeikoKlare
HeikoKlare committed May 20, 2024
1 parent e47558e commit 40c9740
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 328 deletions.
3 changes: 2 additions & 1 deletion resources/tests/org.eclipse.core.tests.resources.saveparticipant/META-INF/MANIFEST.MF
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ Export-Package: org.eclipse.core.tests.resources.saveparticipant
Require-Bundle: org.eclipse.core.resources,
org.eclipse.core.tests.harness,
org.eclipse.core.runtime,
org.junit,
org.eclipse.core.tests.resources,
org.eclipse.core.tests.resources.saveparticipant1,
org.eclipse.core.tests.resources.saveparticipant2,
org.eclipse.core.tests.resources.saveparticipant3,
org.eclipse.core.filesystem
Import-Package: org.junit.jupiter.api,
org.junit.jupiter.api.extension
Bundle-RequiredExecutionEnvironment: JavaSE-17
Bundle-ActivationPolicy: lazy
2 changes: 2 additions & 0 deletions resources/tests/org.eclipse.core.tests.resources.saveparticipant/build.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ bin.includes = .,\
about.html
src.includes = about.html

pom.model.packaging = eclipse-test-plugin
pom.model.property.testClass = org.eclipse.core.tests.resources.saveparticipant.SaveManagerTest
29 changes: 0 additions & 29 deletions resources/tests/org.eclipse.core.tests.resources.saveparticipant/pom.xml
View file

This file was deleted.

256 changes: 96 additions & 160 deletions ...aveparticipant/src/org/eclipse/core/tests/resources/saveparticipant/SaveManager1Test.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,37 @@
*******************************************************************************/
package org.eclipse.core.tests.resources.saveparticipant;

import junit.framework.Test;
import junit.framework.TestSuite;

import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import static org.eclipse.core.resources.ResourcesPlugin.getWorkspace;
import static org.eclipse.core.tests.resources.ResourceTestUtil.assertExistsInFileSystem;
import static org.eclipse.core.tests.resources.ResourceTestUtil.assertExistsInWorkspace;
import static org.eclipse.core.tests.resources.ResourceTestUtil.buildResources;
import static org.eclipse.core.tests.resources.ResourceTestUtil.createInWorkspace;
import static org.eclipse.core.tests.resources.ResourceTestUtil.createRandomContentsStream;
import static org.eclipse.core.tests.resources.ResourceTestUtil.createTestMonitor;
import static org.eclipse.core.tests.resources.ResourceTestUtil.setAutoBuilding;
import static org.eclipse.core.tests.resources.ResourceTestUtil.waitForBuild;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.eclipse.core.resources.ICommand;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.ISaveContext;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.tests.internal.builders.DeltaVerifierBuilder;
import org.eclipse.core.tests.resources.regression.SimpleBuilder;
import org.eclipse.core.tests.resources.saveparticipant1.SaveParticipant1Plugin;
import org.eclipse.core.tests.resources.saveparticipant2.SaveParticipant2Plugin;
import org.eclipse.core.tests.resources.saveparticipant3.SaveParticipant3Plugin;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleException;
import static org.eclipse.core.resources.ResourcesPlugin.getWorkspace;
import static org.eclipse.core.tests.resources.ResourceTestUtil.assertExistsInFileSystem;
import static org.eclipse.core.tests.resources.ResourceTestUtil.assertExistsInWorkspace;
import static org.eclipse.core.tests.resources.ResourceTestUtil.createTestMonitor;
import static org.eclipse.core.tests.resources.ResourceTestUtil.buildResources;
import static org.eclipse.core.tests.resources.ResourceTestUtil.waitForBuild;
import static org.eclipse.core.tests.resources.ResourceTestUtil.*;

/**
* This class needs to be used with SaveManager2Test. Basically this
Expand All @@ -42,124 +54,108 @@
* @see SaveManager2Test
* @see SaveManager3Test
*/
public class SaveManager1Test extends SaveManagerTest {
public class SaveManager1Test {

/**
* Need a zero argument constructor to satisfy the test harness.
* This constructor should not do any real work nor should it be
* called by user code.
* Create some resources and save the workspace.
*/
public SaveManager1Test() {
}
public void testCreateMyProject() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(SaveManagerTest.PROJECT_1);
project.create(null);
project.open(null);
assertTrue(project.exists());
assertTrue(project.isOpen());

public SaveManager1Test(String name) {
super(name);
}
project.close(null);
assertTrue(project.exists());
assertFalse(project.isOpen());

// when closing and opening the project again, it should still exist
project = getWorkspace().getRoot().getProject(SaveManagerTest.PROJECT_1);
project.open(null);
assertTrue(project.exists());
assertTrue(project.isOpen());

// copy and paste into the scrapbook
public static void doIt() throws Exception {
String[] testIds = {"saveparticipant.SaveManager1Test", "saveparticipant.SaveManager2Test", "saveparticipant.SaveManager3Test"};
for (int i = 0; i < testIds.length; i++) {
Process p = Runtime.getRuntime().exec(new String[] {"java", "org.eclipse.core.tests.harness.launcher.Main", "-test", testIds[i], "-data", "c:/temp/save_manager", (i < (testIds.length - 1) ? "-nocleanup" : "")});
p.waitFor();
java.io.InputStream input = p.getInputStream();
int c;
while ((c = input.read()) != -1)
System.out.print((char) c);
input.close();
input = p.getErrorStream();
while ((c = input.read()) != -1)
System.out.print((char) c);
input.close();
}
System.exit(-1);
// create some children
IResource[] resources = buildResources(project, SaveManagerTest.defineHierarchy(SaveManagerTest.PROJECT_1));
createInWorkspace(resources);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

project.close(null);
project.open(null);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);
}

public static Test suite() {
// we do not add the whole class because the order is important
TestSuite suite = new TestSuite();
suite.addTest(new SaveManager1Test("saveWorkspace"));
suite.addTest(new SaveManager1Test("testCreateMyProject"));
suite.addTest(new SaveManager1Test("testCreateProject2"));
suite.addTest(new SaveManager1Test("testAddSaveParticipant"));
suite.addTest(new SaveManager1Test("testBuilder"));
suite.addTest(new SaveManager1Test("saveWorkspace"));
suite.addTest(new SaveManager1Test("testPostSave"));
return suite;
/**
* Create another project and leave it closed for next session.
*/
public void testCreateProject2() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(SaveManagerTest.PROJECT_2);
project.create(null);
project.open(null);
assertTrue(project.exists());
assertTrue(project.isOpen());

// create some children
IResource[] resources = buildResources(project, SaveManagerTest.defineHierarchy(SaveManagerTest.PROJECT_2));
createInWorkspace(resources);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

// add a builder to this project
IProjectDescription description = project.getDescription();
ICommand command = description.newCommand();
command.setBuilderName(SimpleBuilder.BUILDER_ID);
description.setBuildSpec(new ICommand[] { command });
project.setDescription(description, null);
project.build(IncrementalProjectBuilder.FULL_BUILD, null);

project.close(null);
assertTrue(project.exists());
assertFalse(project.isOpen());
}

public void testAddSaveParticipant() throws Exception {
// get plugin
Bundle bundle = Platform.getBundle(PI_SAVE_PARTICIPANT_1);
assertTrue("0.1", bundle != null);
Bundle bundle = Platform.getBundle(SaveManagerTest.PI_SAVE_PARTICIPANT_1);
assertNotNull(bundle);
bundle.start();
SaveParticipant1Plugin plugin1 = SaveParticipant1Plugin.getInstance();

// prepare plugin to the save operation
plugin1.resetDeltaVerifier();
IStatus status;
status = plugin1.registerAsSaveParticipant();
assertTrue("Registering save participant failed with message: " + status.getMessage(), status.isOK());
assertTrue(status.isOK(), "Registering save participant failed with message: " + status.getMessage());
plugin1.setExpectedSaveKind(ISaveContext.FULL_SAVE);

// SaveParticipant2Plugin
bundle = Platform.getBundle(PI_SAVE_PARTICIPANT_2);
assertTrue("5.1", bundle != null);
bundle = Platform.getBundle(SaveManagerTest.PI_SAVE_PARTICIPANT_2);
assertNotNull(bundle);
bundle.start();
SaveParticipant2Plugin plugin2 = SaveParticipant2Plugin.getInstance();

// prepare plugin to the save operation
plugin2.getDeltaVerifier().reset();
status = plugin2.registerAsSaveParticipant();
assertTrue("Registering save participant failed with message: " + status.getMessage(), status.isOK());
assertTrue(status.isOK(), "Registering save participant failed with message: " + status.getMessage());
plugin1.setExpectedSaveKind(ISaveContext.FULL_SAVE);

// SaveParticipant3Plugin
bundle = Platform.getBundle(PI_SAVE_PARTICIPANT_3);
assertTrue("7.1", bundle != null);
bundle = Platform.getBundle(SaveManagerTest.PI_SAVE_PARTICIPANT_3);
assertNotNull(bundle);
bundle.start();
SaveParticipant3Plugin plugin3 = SaveParticipant3Plugin.getInstance();

status = plugin3.registerAsSaveParticipant();
assertTrue("Registering save participant failed with message: " + status.getMessage(), status.isOK());
}

/**
* Create another project and leave it closed for next session.
*/
public void testAnotherProject() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(PROJECT_1);
project.create(null);
project.open(null);
assertTrue("0.1", project.exists());
assertTrue("0.2", project.isOpen());

project.close(null);
assertTrue("1.1", project.exists());
assertTrue("1.2", !project.isOpen());

// when closing and opening the project again, it should still exist
project = getWorkspace().getRoot().getProject(PROJECT_1);
project.open(null);
assertTrue("2.1", project.exists());
assertTrue("2.2", project.isOpen());

// create some children
IResource[] resources = buildResources(project, defineHierarchy(PROJECT_1));
createInWorkspace(resources);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

project.close(null);
project.open(null);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

getWorkspace().save(true, null);
assertTrue(status.isOK(), "Registering save participant failed with message: " + status.getMessage());
}

public void testBuilder() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(PROJECT_1);
assertTrue("0.0", project.isAccessible());
IProject project = getWorkspace().getRoot().getProject(SaveManagerTest.PROJECT_1);
assertTrue(project.isAccessible());

setAutoBuilding(true);
// Create and set a build spec for the project
Expand All @@ -180,82 +176,22 @@ public void testBuilder() throws CoreException {
verifier.addExpectedChange(added, project, IResourceDelta.ADDED, 0);
added.create(createRandomContentsStream(), true, null);
waitForBuild();
assertTrue("3.2", verifier.wasAutoBuild());
assertTrue("3.3", verifier.isDeltaValid());
assertTrue(verifier.wasAutoBuild());
assertTrue(verifier.isDeltaValid());
// remove the file because we don't want it to affect any other delta in the test
added.delete(true, false, null);
}

/**
* Create some resources and save the workspace.
*/
public void testCreateMyProject() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(PROJECT_1);
project.create(null);
project.open(null);
assertTrue("0.1", project.exists());
assertTrue("0.2", project.isOpen());

project.close(null);
assertTrue("1.1", project.exists());
assertTrue("1.2", !project.isOpen());

// when closing and opening the project again, it should still exist
project = getWorkspace().getRoot().getProject(PROJECT_1);
project.open(null);
assertTrue("2.1", project.exists());
assertTrue("2.2", project.isOpen());

// create some children
IResource[] resources = buildResources(project, defineHierarchy(PROJECT_1));
createInWorkspace(resources);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

project.close(null);
project.open(null);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);
}

/**
* Create another project and leave it closed for next session.
*/
public void testCreateProject2() throws CoreException {
IProject project = getWorkspace().getRoot().getProject(PROJECT_2);
project.create(null);
project.open(null);
assertTrue("0.1", project.exists());
assertTrue("0.2", project.isOpen());

// create some children
IResource[] resources = buildResources(project, defineHierarchy(PROJECT_2));
createInWorkspace(resources);
assertExistsInFileSystem(resources);
assertExistsInWorkspace(resources);

// add a builder to this project
IProjectDescription description = project.getDescription();
ICommand command = description.newCommand();
command.setBuilderName(SimpleBuilder.BUILDER_ID);
description.setBuildSpec(new ICommand[] {command});
project.setDescription(description, null);
project.build(IncrementalProjectBuilder.FULL_BUILD, null);

project.close(null);
assertTrue("5.1", project.exists());
assertTrue("5.2", !project.isOpen());
}

public void testPostSave() throws BundleException {
// get plugin
Bundle bundle = Platform.getBundle(PI_SAVE_PARTICIPANT_1);
assertTrue("0.1", bundle != null);
Bundle bundle = Platform.getBundle(SaveManagerTest.PI_SAVE_PARTICIPANT_1);
assertNotNull(bundle);
bundle.start();
SaveParticipant1Plugin plugin = SaveParticipant1Plugin.getInstance();

// look at the plugin save lifecycle
IStatus status = plugin.getSaveLifecycleLog();
assertTrue("Getting lifecycle log failed with message: " + status.getMessage(), status.isOK());
assertTrue(status.isOK(), "Getting lifecycle log failed with message: " + status.getMessage());
}

}
Loading

0 comments on commit 40c9740

Please sign in to comment.