Spike tree-based "implementation" of JUnit5 engine

junit-team · Dec 8, 2015 · 28ffd5e · 28ffd5e
1 parent 5eb4642
commit 28ffd5e
Show file tree

Hide file tree

Showing 17 changed files with 533 additions and 50 deletions.
diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/AbstractTestDescriptor.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/AbstractTestDescriptor.java
@@ -23,15 +23,15 @@
 /**
  * @since 5.0
  */
-public abstract class AbstractTestDescriptor implements MutableTestDescriptor {
+public abstract class AbstractTestDescriptor implements TestDescriptor {
 
 	private final String uniqueId;
 
-	private MutableTestDescriptor parent;
+	private TestDescriptor parent;
 
 	private TestSource source;
 
-	private final Set<MutableTestDescriptor> children = new LinkedHashSet<>();
+	private final Set<TestDescriptor> children = new LinkedHashSet<>();
 
 	protected AbstractTestDescriptor(String uniqueId) {
 		Preconditions.notBlank(uniqueId, "uniqueId must not be null or empty");
@@ -44,17 +44,17 @@ public final String getUniqueId() {
 	}
 
 	@Override
-	public Optional<MutableTestDescriptor> getParent() {
+	public Optional<TestDescriptor> getParent() {
 		return Optional.ofNullable(this.parent);
 	}
 
 	@Override
-	public final void setParent(MutableTestDescriptor parent) {
+	public final void setParent(TestDescriptor parent) {
 		this.parent = parent;
 	}
 
 	@Override
-	public void removeChild(MutableTestDescriptor child) {
+	public void removeChild(TestDescriptor child) {
 		this.children.remove(child);
 		child.setParent(null);
 	}
@@ -82,14 +82,14 @@ public Optional<? extends TestDescriptor> findByUniqueId(String uniqueId) {
 	}
 
 	@Override
-	public final void addChild(MutableTestDescriptor child) {
+	public final void addChild(TestDescriptor child) {
 		Preconditions.notNull(child, "child must not be null");
 		child.setParent(this);
 		this.children.add(child);
 	}
 
 	@Override
-	public final Set<MutableTestDescriptor> getChildren() {
+	public Set<? extends TestDescriptor> getChildren() {
 		return Collections.unmodifiableSet(this.children);
 	}
 

diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/Child.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/Child.java
@@ -0,0 +1,8 @@
+
+package org.junit.gen5.engine;
+
+public interface Child {
+
+	Context execute(Context context) throws Throwable;
+
+}
diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/Context.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/Context.java
@@ -0,0 +1,29 @@
+
+package org.junit.gen5.engine;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class Context {
+
+	private final Map<String, Object> map;
+
+	public Context() {
+		this(new HashMap<>());
+	}
+
+	private Context(Map<String, Object> map) {
+		this.map = map;
+	}
+
+	public Context with(String key, Object value) {
+		Map<String, Object> newMap = new HashMap<>(map);
+		newMap.put(key, value);
+		return new Context(newMap);
+	}
+
+	public <T> T get(String key, Class<T> clazz) {
+		return clazz.cast(map.get(key));
+	}
+
+}
diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/EngineDescriptor.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/EngineDescriptor.java
@@ -32,6 +32,11 @@ public final boolean isTest() {
 		return false;
 	}
 
+	@Override
+	public boolean isContainer() {
+		return true;
+	}
+
 	public TestEngine getEngine() {
 		return engine;
 	}

diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/MutableTestDescriptor.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/MutableTestDescriptor.java
diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/Parent.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/Parent.java
@@ -0,0 +1,10 @@
+
+package org.junit.gen5.engine;
+
+public interface Parent {
+
+	Context beforeAll(Context context);
+
+	Context afterAll(Context context);
+
+}
diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/TestDescriptor.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/TestDescriptor.java
@@ -30,10 +30,14 @@ public interface TestDescriptor {
 
 	String getDisplayName();
 
-	Optional<? extends TestDescriptor> getParent();
+	Optional<TestDescriptor> getParent();
+
+	void setParent(TestDescriptor parent);
 
 	boolean isTest();
 
+	boolean isContainer();
+
 	default boolean isRoot() {
 		return getParent() == null;
 	}
@@ -42,6 +46,10 @@ default boolean isRoot() {
 
 	Set<? extends TestDescriptor> getChildren();
 
+	void addChild(TestDescriptor descriptor);
+
+	void removeChild(TestDescriptor descriptor);
+
 	default Set<? extends TestDescriptor> allDescendants() {
 		Set<TestDescriptor> all = new HashSet<>();
 		all.addAll(getChildren());

diff --git a/junit-engine-api/src/main/java/org/junit/gen5/engine/TreeBasedTestEngine.java b/junit-engine-api/src/main/java/org/junit/gen5/engine/TreeBasedTestEngine.java
@@ -0,0 +1,47 @@
+
+package org.junit.gen5.engine;
+
+public abstract class TreeBasedTestEngine implements TestEngine {
+
+	@Override
+	public abstract TestDescriptor discoverTests(TestPlanSpecification specification);
+
+	@Override
+	public final void execute(ExecutionRequest request) {
+		try {
+			TestDescriptor rootTestDescriptor = request.getRootTestDescriptor();
+			executeAll(rootTestDescriptor, request.getEngineExecutionListener(), new Context());
+		}
+		catch (Exception e) {
+			// TODO Auto-generated catch block
+			e.printStackTrace();
+		}
+	}
+
+	private <T> void executeAll(TestDescriptor parentDescriptor, EngineExecutionListener listener,
+			Context parentContext) throws Exception {
+		Context context = parentContext;
+		if (parentDescriptor instanceof Parent) {
+			context = ((Parent) parentDescriptor).beforeAll(context);
+		}
+		for (TestDescriptor childDescriptor : parentDescriptor.getChildren()) {
+			if (childDescriptor instanceof Child) {
+				Child child = (Child) childDescriptor;
+				try {
+					listener.testStarted(childDescriptor);
+					context = child.execute(context);
+					listener.testSucceeded(childDescriptor);
+				}
+				catch (Throwable t) {
+					listener.testFailed(childDescriptor, t);
+					context = context.with("Throwable", t);
+				}
+			}
+			executeAll(childDescriptor, listener, context);
+		}
+		if (parentDescriptor instanceof Parent) {
+			context = ((Parent) parentDescriptor).afterAll(context);
+		}
+	}
+
+}
diff --git a/junit-launcher/src/main/java/org/junit/gen5/launcher/RootTestDescriptor.java b/junit-launcher/src/main/java/org/junit/gen5/launcher/RootTestDescriptor.java
@@ -118,4 +118,24 @@ public String toString() {
 		return engineRootTestDescriptors.values().toString();
 	}
 
+	@Override
+	public void setParent(TestDescriptor parent) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	public boolean isContainer() {
+		return true;
+	}
+
+	@Override
+	public void addChild(TestDescriptor descriptor) {
+		// TODO Auto-generated method stub
+	}
+
+	@Override
+	public void removeChild(TestDescriptor descriptor) {
+		// TODO Auto-generated method stub
+	}
+
 }
diff --git a/junit-tests/src/test/java/org/junit/gen5/engine/AbstractTestDescriptorTest.java b/junit-tests/src/test/java/org/junit/gen5/engine/AbstractTestDescriptorTest.java
@@ -115,6 +115,11 @@ public String getDisplayName() {
 	public boolean isTest() {
 		return false;
 	}
+
+	@Override
+	public boolean isContainer() {
+		return true;
+	}
 }
 
 class LeafDescriptor extends AbstractTestDescriptor {
@@ -132,4 +137,9 @@ public String getDisplayName() {
 	public boolean isTest() {
 		return true;
 	}
+
+	@Override
+	public boolean isContainer() {
+		return false;
+	}
 }
diff --git a/junit-tests/src/test/java/org/junit/gen5/engine/DummyTestDescriptor.java b/junit-tests/src/test/java/org/junit/gen5/engine/DummyTestDescriptor.java
@@ -31,4 +31,9 @@ public boolean isTest() {
 		return getChildren().isEmpty();
 	}
 
+	@Override
+	public boolean isContainer() {
+		return !isTest();
+	}
+
 }