Replace Consumer<TestDescriptor> with custom interface

Issue: #14
junit-team · Feb 24, 2017 · fc3c61b · fc3c61b
1 parent 0448e81
commit fc3c61b
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 25 deletions.
diff --git a/...r-engine/src/main/java/org/junit/jupiter/engine/descriptor/DynamicTestTestDescriptor.java b/...r-engine/src/main/java/org/junit/jupiter/engine/descriptor/DynamicTestTestDescriptor.java
@@ -10,8 +10,6 @@
 
 package org.junit.jupiter.engine.descriptor;
 
-import java.util.function.Consumer;
-
 import org.junit.jupiter.api.DynamicTest;
 import org.junit.jupiter.engine.execution.JupiterEngineExecutionContext;
 import org.junit.platform.engine.TestDescriptor;
@@ -45,7 +43,7 @@ public boolean isContainer() {
 
 	@Override
 	public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
-			Consumer<TestDescriptor> dynamicTestExecutor) throws Exception {
+			DynamicTestExecutor dynamicTestExecutor) throws Exception {
 		executeAndMaskThrowable(dynamicTest.getExecutable());
 		return context;
 	}

diff --git a/...upiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/MethodTestDescriptor.java b/...upiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/MethodTestDescriptor.java
@@ -17,7 +17,6 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.BiFunction;
-import java.util.function.Consumer;
 
 import org.junit.jupiter.api.extension.AfterEachCallback;
 import org.junit.jupiter.api.extension.AfterTestExecutionCallback;
@@ -144,7 +143,7 @@ public SkipResult shouldBeSkipped(JupiterEngineExecutionContext context) throws
 
 	@Override
 	public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
-			Consumer<TestDescriptor> dynamicTestExecutor) throws Exception {
+			DynamicTestExecutor dynamicTestExecutor) throws Exception {
 		ThrowableCollector throwableCollector = context.getThrowableCollector();
 
 		// @formatter:off
@@ -203,8 +202,7 @@ private <T extends Extension> void invokeBeforeMethodsOrCallbacksUntilExceptionO
 		}
 	}
 
-	protected void invokeTestMethod(JupiterEngineExecutionContext context,
+	protected void invokeTestMethod(JupiterEngineExecutionContext context, DynamicTestExecutor dynamicTestExecutor) {
-			Consumer<TestDescriptor> dynamicTestExecutor) {
 		TestExtensionContext testExtensionContext = (TestExtensionContext) context.getExtensionContext();
 		ThrowableCollector throwableCollector = context.getThrowableCollector();
 

diff --git a/...r-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestFactoryTestDescriptor.java b/...r-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestFactoryTestDescriptor.java
@@ -19,7 +19,6 @@
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Consumer;
 import java.util.stream.Stream;
 
 import org.junit.jupiter.api.DynamicTest;
@@ -73,8 +72,7 @@ public boolean isLeaf() {
 	}
 
 	@Override
-	protected void invokeTestMethod(JupiterEngineExecutionContext context,
+	protected void invokeTestMethod(JupiterEngineExecutionContext context, DynamicTestExecutor dynamicTestExecutor) {
-			Consumer<TestDescriptor> dynamicTestExecutor) {
 		TestExtensionContext testExtensionContext = (TestExtensionContext) context.getExtensionContext();
 
 		context.getThrowableCollector().execute(() -> {
@@ -118,11 +116,11 @@ private Stream<DynamicTest> toDynamicTestStream(TestExtensionContext testExtensi
 		throw invalidReturnTypeException(testExtensionContext);
 	}
 
-	private void registerAndExecute(DynamicTest dynamicTest, int index, Consumer<TestDescriptor> dynamicTestExecutor) {
+	private void registerAndExecute(DynamicTest dynamicTest, int index, DynamicTestExecutor dynamicTestExecutor) {
 		UniqueId uniqueId = getUniqueId().append(DYNAMIC_TEST_SEGMENT_TYPE, "#" + index);
 		TestDescriptor descriptor = new DynamicTestTestDescriptor(uniqueId, dynamicTest, getSource().get());
 		addChild(descriptor);
-		dynamicTestExecutor.accept(descriptor);
+		dynamicTestExecutor.execute(descriptor);
 	}
 
 	private JUnitException invalidReturnTypeException(TestExtensionContext testExtensionContext) {

diff --git a/.../main/java/org/junit/jupiter/engine/descriptor/TestTemplateContainerExtensionContext.java b/.../main/java/org/junit/jupiter/engine/descriptor/TestTemplateContainerExtensionContext.java
@@ -25,11 +25,11 @@
  * @since 5.0
  */
 @API(Internal)
-public final class TestTemplateContainerExtensionContext extends AbstractExtensionContext<TestTemplateTestDescriptor>
+final class TestTemplateContainerExtensionContext extends AbstractExtensionContext<TestTemplateTestDescriptor>
 		implements ContainerExtensionContext {
 
-	public TestTemplateContainerExtensionContext(ExtensionContext parent,
+	TestTemplateContainerExtensionContext(ExtensionContext parent, EngineExecutionListener engineExecutionListener,
-			EngineExecutionListener engineExecutionListener, TestTemplateTestDescriptor testDescriptor) {
+			TestTemplateTestDescriptor testDescriptor) {
 		super(parent, engineExecutionListener, testDescriptor);
 	}
 

diff --git a/...-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestTemplateTestDescriptor.java b/...-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestTemplateTestDescriptor.java
@@ -18,7 +18,6 @@
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.Consumer;
 
 import org.junit.jupiter.api.extension.ContainerExtensionContext;
 import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
@@ -116,7 +115,7 @@ public SkipResult shouldBeSkipped(JupiterEngineExecutionContext context) throws
 
 	@Override
 	public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext context,
-			Consumer<TestDescriptor> dynamicTestExecutor) throws Exception {
+			DynamicTestExecutor dynamicTestExecutor) throws Exception {
 		ContainerExtensionContext containerExtensionContext = (ContainerExtensionContext) context.getExtensionContext();
 		List<TestTemplateInvocationContextProvider> providers = validateProviders(containerExtensionContext,
 			context.getExtensionRegistry());
@@ -127,7 +126,7 @@ public JupiterEngineExecutionContext execute(JupiterEngineExecutionContext conte
 				int index = invocationIndex.incrementAndGet();
 				TestDescriptor invocationTestDescriptor = createInvocationTestDescriptor(invocationContext, index);
 				addChild(invocationTestDescriptor);
-				dynamicTestExecutor.accept(invocationTestDescriptor);
+				dynamicTestExecutor.execute(invocationTestDescriptor);
 			});
 		});
 		validateWasAtLeastInvokedOnce(invocationIndex);

diff --git a/junit-platform-engine/src/main/java/org/junit/platform/engine/support/hierarchical/Node.java b/junit-platform-engine/src/main/java/org/junit/platform/engine/support/hierarchical/Node.java
@@ -13,7 +13,6 @@
 import static org.junit.platform.commons.meta.API.Usage.Experimental;
 
 import java.util.Optional;
-import java.util.function.Consumer;
 
 import org.junit.platform.commons.meta.API;
 import org.junit.platform.commons.util.ToStringBuilder;
@@ -91,7 +90,7 @@ default C before(C context) throws Exception {
 	 * @see #before
 	 * @see #after
 	 */
-	default C execute(C context, Consumer<TestDescriptor> dynamicTestExecutor) throws Exception {
+	default C execute(C context, DynamicTestExecutor dynamicTestExecutor) throws Exception {
 		return execute(context);
 	}
 
@@ -107,7 +106,8 @@ default C execute(C context, Consumer<TestDescriptor> dynamicTestExecutor) throw
 	 *
 	 * @see #before
 	 * @see #after
-	 * @deprecated Please use {@link #execute(EngineExecutionContext, Consumer)} instead.
+	 * @deprecated Please use
+	 * {@link #execute(EngineExecutionContext, DynamicTestExecutor)} instead.
 	 */
 	@Deprecated
 	default C execute(C context) throws Exception {
@@ -197,4 +197,27 @@ public String toString() {
 		}
 	}
 
+	/**
+	 * Executor for additional, dynamic test descriptors discovered during
+	 * execution of a {@link Node}.
+	 *
+	 * <p>The test descriptors will be executed by the same
+	 * {@link HierarchicalTestExecutor} that executes the submitting node.
+	 *
+	 * <p>This interface is not intended to be implemented by clients.
+	 *
+	 * @see Node#execute(EngineExecutionContext, DynamicTestExecutor)
+	 * @see HierarchicalTestExecutor
+	 */
+	interface DynamicTestExecutor {
+
+		/**
+		 * Submit a dynamic test descriptor for immediate execution.
+		 *
+		 * @param testDescriptor the test descriptor to be executed
+		 */
+		void execute(TestDescriptor testDescriptor);
+
+	}
+
 }
diff --git a/...t/java/org/junit/platform/engine/support/hierarchical/DemoHierarchicalTestDescriptor.java b/...t/java/org/junit/platform/engine/support/hierarchical/DemoHierarchicalTestDescriptor.java
@@ -69,7 +69,7 @@ public SkipResult shouldBeSkipped(DemoEngineExecutionContext context) throws Exc
 
 	@Override
 	public DemoEngineExecutionContext execute(DemoEngineExecutionContext context,
-			Consumer<TestDescriptor> dynamicTestExecutor) {
+			DynamicTestExecutor dynamicTestExecutor) {
 		if (this.executeBlock != null) {
 			this.executeBlock.run();
 		}

diff --git a/...st/java/org/junit/platform/engine/support/hierarchical/HierarchicalTestExecutorTests.java b/...st/java/org/junit/platform/engine/support/hierarchical/HierarchicalTestExecutorTests.java
@@ -35,6 +35,7 @@
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.UniqueId;
 import org.junit.platform.engine.support.descriptor.AbstractTestDescriptor;
+import org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor;
 import org.mockito.ArgumentCaptor;
 import org.mockito.InOrder;
 import org.opentest4j.TestAbortedException;
@@ -337,8 +338,8 @@ public void executesDynamicTestDescriptors() throws Exception {
 		MyLeaf dynamicTestDescriptor = spy(new MyLeaf(leafUniqueId.append("dynamic", "child")));
 
 		when(child.execute(any(), any())).thenAnswer(invocation -> {
-			Consumer<TestDescriptor> dynamicTestExecutor = invocation.getArgument(1);
+			DynamicTestExecutor dynamicTestExecutor = invocation.getArgument(1);
-			dynamicTestExecutor.accept(dynamicTestDescriptor);
+			dynamicTestExecutor.execute(dynamicTestDescriptor);
 			return invocation.getArgument(0);
 		});
 		root.addChild(child);
@@ -430,7 +431,7 @@ protected MyLeaf(UniqueId uniqueId) {
 
 		@Override
 		public MyEngineExecutionContext execute(MyEngineExecutionContext context,
-				Consumer<TestDescriptor> dynamicTestExecutor) throws Exception {
+				DynamicTestExecutor dynamicTestExecutor) throws Exception {
 			return context;
 		}