Skip to content

Commit ab28e2f

Browse files
trancexpresstrancexpress
committed
testing JUnit 5 equivalent of XpectRunner
1 parent e27f2f2 commit ab28e2f

File tree

13 files changed

+565
-10
lines changed

13 files changed

+565
-10
lines changed

‎org.eclipse.xpect.ui/src/org/eclipse/xpect/ui/util/XpectFileAccess.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import org.eclipse.xpect.XpectFile;
3131
import org.eclipse.xpect.registry.ILanguageInfo;
3232
import org.eclipse.xpect.runner.XpectRunner;
33+
import org.eclipse.xpect.runner.XpectTestGlobalState;
3334

3435
import com.google.inject.Injector;
3536

@@ -67,8 +68,8 @@ protected static ResourceSet cloneResourceSet(ResourceSet rs) {
6768
// need delegation or nothing because of "java" protocol
6869
// result.setResourceFactoryRegistry(rs.getResourceFactoryRegistry());
6970
result.setURIConverter(rs.getURIConverter());
70-
if (XpectRunner.testClassloader != null) {
71-
result.setClasspathURIContext(XpectRunner.testClassloader);
71+
if (XpectTestGlobalState.INSTANCE.testClass() != null) {
72+
result.setClasspathURIContext(XpectTestGlobalState.INSTANCE.testClass().getClassLoader());
7273
result.setClasspathUriResolver(new ClassloaderClasspathUriResolver());
7374
} else if (rs instanceof XtextResourceSet) {
7475
XtextResourceSet xrs = (XtextResourceSet) rs;

‎org.eclipse.xpect.ui/src/org/eclipse/xpect/ui/util/XpectUtil.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import org.eclipse.xpect.XpectFile;
2929
import org.eclipse.xpect.XpectJavaModel;
3030
import org.eclipse.xpect.runner.XpectRunner;
31+
import org.eclipse.xpect.runner.XpectTestGlobalState;
3132
import org.eclipse.xpect.ui.internal.XpectActivator;
3233

3334
import com.google.inject.Injector;
@@ -40,8 +41,8 @@ public static XpectFile loadFile(IFile file) {
4041
Injector injector = XpectActivator.getInstance().getInjector(XpectActivator.ORG_ECLIPSE_XPECT_XPECT);
4142
XtextResourceSet rs = new XtextResourceSet();
4243
IJavaProject javaProject = JavaCore.create(file.getProject());
43-
if (XpectRunner.testClassloader != null) {
44-
rs.setClasspathURIContext(XpectRunner.testClassloader);
44+
if (XpectTestGlobalState.INSTANCE.testClass() != null) {
45+
rs.setClasspathURIContext(XpectTestGlobalState.INSTANCE.testClass().getClassLoader());
4546
rs.setClasspathUriResolver(new ClassloaderClasspathUriResolver());
4647
} else if (javaProject != null && javaProject.exists()) {
4748
rs.setClasspathURIContext(javaProject);

‎org.eclipse.xpect/META-INF/MANIFEST.MF‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,13 @@ Require-Bundle: org.eclipse.xtext,
1919
org.antlr.runtime;bundle-version="[3.2.0,3.2.1)",
2020
org.apache.log4j;bundle-version="1.2.24",
2121
org.junit;bundle-version="4.11.0";visibility:=reexport,
22+
junit-jupiter-api;bundle-version="5.10.2";visibility:=reexport,
2223
org.eclipse.xtext.common.types;visibility:=reexport,
2324
org.apache.log4j;bundle-version="1.2.0";visibility:=reexport,
2425
org.objectweb.asm;bundle-version="[9.5.0,10.0.0)";resolution:=optional
2526
Bundle-RequiredExecutionEnvironment: JavaSE-11
2627
Export-Package: org.eclipse.xpect,
28+
org.eclipse.xpect.dynamic,
2729
org.eclipse.xpect.expectation,
2830
org.eclipse.xpect.expectation.impl;
2931
x-friends:="org.eclipse.xpect.xtext.lib,

‎org.eclipse.xpect/src/org/eclipse/xpect/dynamic/IXpectDynamicTestFactory.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
package org.eclipse.xpect.dynamic;
2+
3+
import java.util.stream.Stream;
4+
5+
import org.eclipse.xpect.XpectImport;
6+
import org.eclipse.xpect.runner.TestTitleProvider;
7+
import org.junit.jupiter.api.DynamicContainer;
8+
import org.junit.jupiter.api.TestFactory;
9+
10+
@XpectImport(TestTitleProvider.class)
11+
public interface IXpectDynamicTestFactory {
12+
13+
@TestFactory
14+
default Stream<DynamicContainer> generateTests() {
15+
return XpectDynamicTestFactory.xpectTests(getClass());
16+
}
17+
}

‎org.eclipse.xpect/src/org/eclipse/xpect/dynamic/XpectDynamicTest.java‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package org.eclipse.xpect.dynamic;
2+
3+
import java.lang.reflect.InvocationTargetException;
4+
5+
import org.eclipse.xpect.XjmTestMethod;
6+
import org.eclipse.xpect.runner.ValidatingSetup;
7+
import org.eclipse.xpect.runner.XpectTestGlobalState;
8+
import org.eclipse.xpect.setup.ThisTestObject;
9+
import org.eclipse.xpect.state.Creates;
10+
import org.eclipse.xpect.state.StateContainer;
11+
import org.junit.jupiter.api.DynamicTest;
12+
13+
import com.google.common.base.Preconditions;
14+
15+
public class XpectDynamicTest {
16+
17+
private final String className;
18+
private XjmTestMethod method;
19+
private final StateContainer state;
20+
21+
public XpectDynamicTest(StateContainer state, XjmTestMethod method) {
22+
Preconditions.checkNotNull(method);
23+
this.className = XpectTestGlobalState.INSTANCE.testClass().getName();
24+
this.method = method;
25+
this.state = state;
26+
}
27+
28+
@Creates
29+
public XpectDynamicTest create() {
30+
return this;
31+
}
32+
33+
public XjmTestMethod getMethod() {
34+
return method;
35+
}
36+
37+
public StateContainer getState() {
38+
return state;
39+
}
40+
41+
public DynamicTest test() {
42+
String testName = getName();
43+
return DynamicTest.dynamicTest(testName, () -> runInternal());
44+
}
45+
46+
public String getName() {
47+
String testName = formatDisplayName(method.getName(), className);
48+
return testName;
49+
}
50+
51+
protected void runInternal() throws Throwable {
52+
Object test = state.get(Object.class, ThisTestObject.class).get();
53+
try {
54+
try {
55+
state.get(ValidatingSetup.class).get().validate();
56+
} catch (Throwable e) {
57+
throw new AssertionError("Setup validation failed", e);
58+
}
59+
method.getJavaMethod().invoke(test);
60+
} catch (InvocationTargetException e) {
61+
throw e.getCause();
62+
} finally {
63+
state.invalidate();
64+
}
65+
}
66+
67+
private static String formatDisplayName(String name, String className) {
68+
return String.format("%s(%s)", name, className);
69+
}
70+
71+
}

‎org.eclipse.xpect/src/org/eclipse/xpect/dynamic/XpectDynamicTestCase.java‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
package org.eclipse.xpect.dynamic;
2+
3+
import java.util.List;
4+
import java.util.stream.Stream;
5+
6+
import org.eclipse.emf.common.util.URI;
7+
import org.eclipse.xpect.XjmMethod;
8+
import org.eclipse.xpect.XjmTestMethod;
9+
import org.eclipse.xpect.XpectFile;
10+
import org.eclipse.xpect.XpectInvocation;
11+
import org.eclipse.xpect.XpectJavaModel;
12+
import org.eclipse.xpect.runner.IXpectURIProvider;
13+
import org.eclipse.xpect.runner.TestExecutor;
14+
import org.eclipse.xpect.setup.ThisRootTestClass;
15+
import org.eclipse.xpect.state.Creates;
16+
import org.eclipse.xpect.state.StateContainer;
17+
import org.junit.jupiter.api.DynamicContainer;
18+
import org.junit.jupiter.api.DynamicTest;
19+
20+
import com.google.common.collect.Lists;
21+
22+
public class XpectDynamicTestCase {
23+
private Stream<DynamicTest> children;
24+
private final StateContainer state;
25+
private final XpectFile xpectFile;
26+
27+
public XpectDynamicTestCase(StateContainer state, XpectFile file) {
28+
this.xpectFile = file;
29+
this.state = state;
30+
}
31+
32+
@Creates
33+
public XpectDynamicTestCase create() {
34+
return this;
35+
}
36+
37+
/**
38+
* <p>
39+
* To run code before an Xpect test begins, extend this class and annotate the extending class with:
40+
* {@code @org.eclipse.xpect.XpectReplace(org.eclipse.xpect.dynamic.XpectDynamicTestCase)}
41+
* </p>
42+
* <p>
43+
* The extended class must then be included in the values of the annotation of the test case:
44+
* {@code @org.eclipse.xpect.XpectImport({...class})}
45+
* </p>
46+
*/
47+
public void setUp() throws Throwable {
48+
// nothing to set up
49+
}
50+
51+
/**
52+
* <p>
53+
* To run code after an Xpect test finishes, extend this class and annotate the extending class with:
54+
* {@code @org.eclipse.xpect.XpectReplace(org.eclipse.xpect.dynamic.XpectDynamicTestCase)}
55+
* </p>
56+
* <p>
57+
* The extended class must then be included in the values of the annotation of the test case:
58+
* {@code @org.eclipse.xpect.XpectImport({...class})}
59+
* </p>
60+
*/
61+
public void tearDown() throws Throwable {
62+
// nothing to tear down
63+
}
64+
65+
public DynamicContainer dynamicContainer() {
66+
return DynamicContainer.dynamicContainer(getName(), getChildren());
67+
}
68+
69+
protected Stream<DynamicTest> createChildren() {
70+
List<DynamicTest> children = Lists.newArrayList();
71+
if (xpectFile != null) {
72+
XpectJavaModel xjm = xpectFile.getJavaModel();
73+
for (XjmMethod method : xjm.getMethods().values())
74+
if (method instanceof XjmTestMethod) {
75+
DynamicTest test = createDynamicTest((XjmTestMethod) method);
76+
if (test != null)
77+
children.add(test);
78+
}
79+
for (XpectInvocation inv : xpectFile.getInvocations()) {
80+
DynamicTest test = createDynamicTest(inv);
81+
if (test != null)
82+
children.add(test);
83+
}
84+
}
85+
return children.stream().map(test -> wrapTest(test));
86+
}
87+
88+
protected DynamicTest createDynamicTest(XjmTestMethod method) {
89+
StateContainer childState = TestExecutor.createState(state, TestExecutor.createTestConfiguration(method));
90+
return childState.get(XpectDynamicTest.class).get().test();
91+
}
92+
93+
protected DynamicTest createDynamicTest(XpectInvocation invocation) {
94+
StateContainer childState = TestExecutor.createState(state, TestExecutor.createXpectConfiguration(invocation));
95+
DynamicTest test = childState.get(XpectInvocationDynamicTest.class).get().test();
96+
return wrapTest(test);
97+
}
98+
99+
protected DynamicTest wrapTest(DynamicTest test) {
100+
return DynamicTest.dynamicTest(test.getDisplayName(), () -> {
101+
setUp();
102+
try {
103+
test.getExecutable().execute();
104+
} finally {
105+
try {
106+
state.invalidate();
107+
} finally {
108+
tearDown();
109+
}
110+
}
111+
});
112+
}
113+
114+
protected Stream<DynamicTest> getChildren() {
115+
if (children == null)
116+
children = createChildren();
117+
return children;
118+
}
119+
120+
public Class<?> getJavaTestClass() {
121+
return state.get(Class.class, ThisRootTestClass.class).get();
122+
}
123+
124+
public IXpectURIProvider getURIProvider() {
125+
return state.get(IXpectURIProvider.class).get();
126+
}
127+
128+
public StateContainer getState() {
129+
return state;
130+
}
131+
132+
public URI getUri() {
133+
return xpectFile.eResource().getURI();
134+
}
135+
136+
public XpectFile getXpectFile() {
137+
return xpectFile;
138+
}
139+
140+
public String getName() {
141+
IXpectURIProvider uriProvider = getURIProvider();
142+
URI uri = getUri();
143+
URI deresolved = uriProvider.deresolveToProject(uri);
144+
String pathInProject = deresolved.trimSegments(1).toString();
145+
String fileName = deresolved.lastSegment();
146+
return fileName + ": " + pathInProject;
147+
}
148+
}

0 commit comments

Comments
 (0)