|
| 1 | +package org.eclipse.xpect.dynamic; |
| 2 | + |
| 3 | +import java.util.List; |
| 4 | +import java.util.concurrent.atomic.AtomicBoolean; |
| 5 | +import java.util.concurrent.atomic.AtomicInteger; |
| 6 | + |
| 7 | +import org.eclipse.emf.common.util.URI; |
| 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.runner.ValidatingSetup; |
| 15 | +import org.eclipse.xpect.setup.ThisRootTestClass; |
| 16 | +import org.eclipse.xpect.state.Creates; |
| 17 | +import org.eclipse.xpect.state.StateContainer; |
| 18 | +import org.junit.jupiter.api.DynamicTest; |
| 19 | + |
| 20 | +import com.google.common.collect.Iterables; |
| 21 | +import com.google.common.collect.Lists; |
| 22 | + |
| 23 | +public class XpectDynamicTestCase { |
| 24 | + private List<DynamicTest> children; |
| 25 | + private final StateContainer state; |
| 26 | + private final XpectFile xpectFile; |
| 27 | + |
| 28 | + public XpectDynamicTestCase(StateContainer state, XpectFile file) { |
| 29 | + this.xpectFile = file; |
| 30 | + this.state = state; |
| 31 | + } |
| 32 | + |
| 33 | + @Creates |
| 34 | + public XpectDynamicTestCase create() { |
| 35 | + return this; |
| 36 | + } |
| 37 | + |
| 38 | + /** |
| 39 | + * <p> |
| 40 | + * To run code before an Xpect test begins, extend this class and annotate the extending class with: |
| 41 | + * {@code @org.eclipse.xpect.XpectReplace(org.eclipse.xpect.dynamic.XpectDynamicTestCase)} |
| 42 | + * </p> |
| 43 | + * <p> |
| 44 | + * The extended class must then be included in the values of the annotation of the test case: |
| 45 | + * {@code @org.eclipse.xpect.XpectImport({...class})} |
| 46 | + * </p> |
| 47 | + */ |
| 48 | + public void setUp() throws Throwable { |
| 49 | + // nothing to set up |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * <p> |
| 54 | + * To run code after an Xpect test finishes, extend this class and annotate the extending class with: |
| 55 | + * {@code @org.eclipse.xpect.XpectReplace(org.eclipse.xpect.dynamic.XpectDynamicTestCase)} |
| 56 | + * </p> |
| 57 | + * <p> |
| 58 | + * The extended class must then be included in the values of the annotation of the test case: |
| 59 | + * {@code @org.eclipse.xpect.XpectImport({...class})} |
| 60 | + * </p> |
| 61 | + */ |
| 62 | + public void tearDown() throws Throwable { |
| 63 | + // nothing to tear down |
| 64 | + } |
| 65 | + |
| 66 | + protected List<DynamicTest> createChildren() { |
| 67 | + List<DynamicTest> tests = Lists.newArrayList(); |
| 68 | + if (xpectFile != null) { |
| 69 | + /* |
| 70 | + * With JUnit 4 runners, we can do setup validation before children run and state clean-up after children are done. |
| 71 | + * With JUnit 5 we cannot. |
| 72 | + * So the first test does setup validation and the last test does clean-up. |
| 73 | + * Meaning their execution times will likely increase notably, when compared to the JUnit 4 reported time. |
| 74 | + * Alternatively we can add a first and last test, for setup validation resp. clean-up. This means extra test nodes in the result, as well as extra test results. We then also have the problem of running tests if the setup validation failed. |
| 75 | + * XXX: does JUnit 5 offer anything for dynamic tests, to improve this situation? |
| 76 | + * As of writing this code, @BeforeEach and @AfterEach are only called before and after the factory method runs. |
| 77 | + * We have a factory method with every URL we must run an Xpect test for, as those URLs are known only via an annotation. |
| 78 | + */ |
| 79 | + AtomicBoolean setupValidated = new AtomicBoolean(false); |
| 80 | + AtomicBoolean setupValidationFailed = new AtomicBoolean(false); |
| 81 | + AtomicInteger finishedChildren = new AtomicInteger(0); |
| 82 | + XpectJavaModel xjm = xpectFile.getJavaModel(); |
| 83 | + XjmTestMethod[] methods = xjm.getMethods().values().stream().filter(m -> m instanceof XjmTestMethod).toArray(XjmTestMethod[]::new); |
| 84 | + XpectInvocation[] invocations = Iterables.toArray(xpectFile.getInvocations(), XpectInvocation.class); |
| 85 | + int childrenCount = methods.length + invocations.length; |
| 86 | + for (XjmTestMethod method : methods) { |
| 87 | + DynamicTest test = createDynamicTest(method); |
| 88 | + tests.add(wrapTest(test, childrenCount, setupValidated, setupValidationFailed, finishedChildren)); |
| 89 | + } |
| 90 | + for (XpectInvocation inv : invocations) { |
| 91 | + DynamicTest test = createDynamicTest(inv); |
| 92 | + tests.add(wrapTest(test, childrenCount, setupValidated, setupValidationFailed, finishedChildren)); |
| 93 | + } |
| 94 | + } |
| 95 | + return tests; |
| 96 | + } |
| 97 | + |
| 98 | + protected DynamicTest createDynamicTest(XjmTestMethod method) { |
| 99 | + StateContainer childState = TestExecutor.createState(state, TestExecutor.createTestConfiguration(method)); |
| 100 | + return childState.get(XpectDynamicTest.class).get().test(); |
| 101 | + } |
| 102 | + |
| 103 | + protected DynamicTest createDynamicTest(XpectInvocation invocation) { |
| 104 | + StateContainer childState = TestExecutor.createState(state, TestExecutor.createXpectConfiguration(invocation)); |
| 105 | + DynamicTest test = childState.get(XpectInvocationDynamicTest.class).get().test(); |
| 106 | + return test; |
| 107 | + } |
| 108 | + |
| 109 | + protected DynamicTest wrapTest(DynamicTest test, final int childrenCount, AtomicBoolean validatedSetup, AtomicBoolean setupValidationFailed, AtomicInteger finishedChildren) { |
| 110 | + return DynamicTest.dynamicTest(test.getDisplayName(), () -> { |
| 111 | + try { |
| 112 | + if (!validatedSetup.getAndSet(true)) { |
| 113 | + // first test is running, validate setup |
| 114 | + try { |
| 115 | + state.get(ValidatingSetup.class).get().validate(); |
| 116 | + } catch (Throwable t) { |
| 117 | + setupValidationFailed.set(true); |
| 118 | + throw t; |
| 119 | + } |
| 120 | + } |
| 121 | + if (setupValidationFailed.get()) { |
| 122 | + throw new AssertionError("Setup validation failed"); |
| 123 | + } |
| 124 | + try { |
| 125 | + setUp(); |
| 126 | + test.getExecutable().execute(); |
| 127 | + } finally { |
| 128 | + tearDown(); |
| 129 | + } |
| 130 | + } finally { |
| 131 | + int finished = finishedChildren.incrementAndGet(); |
| 132 | + if (finished >= childrenCount) { |
| 133 | + // last test is done, do clean-up |
| 134 | + state.invalidate(); |
| 135 | + } |
| 136 | + } |
| 137 | + }); |
| 138 | + } |
| 139 | + |
| 140 | + protected List<DynamicTest> getChildren() { |
| 141 | + if (children == null) |
| 142 | + children = createChildren(); |
| 143 | + return children; |
| 144 | + } |
| 145 | + |
| 146 | + public Class<?> getJavaTestClass() { |
| 147 | + return state.get(Class.class, ThisRootTestClass.class).get(); |
| 148 | + } |
| 149 | + |
| 150 | + public IXpectURIProvider getURIProvider() { |
| 151 | + return state.get(IXpectURIProvider.class).get(); |
| 152 | + } |
| 153 | + |
| 154 | + public StateContainer getState() { |
| 155 | + return state; |
| 156 | + } |
| 157 | + |
| 158 | + public URI getUri() { |
| 159 | + return xpectFile.eResource().getURI(); |
| 160 | + } |
| 161 | + |
| 162 | + public XpectFile getXpectFile() { |
| 163 | + return xpectFile; |
| 164 | + } |
| 165 | + |
| 166 | + public String getName() { |
| 167 | + IXpectURIProvider uriProvider = getURIProvider(); |
| 168 | + URI uri = getUri(); |
| 169 | + URI deresolved = uriProvider.deresolveToProject(uri); |
| 170 | + String pathInProject = deresolved.trimSegments(1).toString(); |
| 171 | + String fileName = deresolved.lastSegment(); |
| 172 | + return fileName + ": " + pathInProject; |
| 173 | + } |
| 174 | +} |
0 commit comments