Add executionCondition() to Configuration interface

Issue: #4620

Author: marcphilipp

junit-jupiter-api/src/main/java/org/junit/jupiter/api/DynamicContainer.java

@@ -16,11 +16,14 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
 import org.apiguardian.api.API;
 import org.jspecify.annotations.Nullable;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.parallel.ExecutionMode;
 import org.junit.platform.commons.util.Preconditions;
 
@@ -131,6 +134,10 @@ public interface Configuration extends DynamicNode.Configuration {
 		@Override
 		Configuration source(@Nullable URI testSourceUri);
 
+		@Override
+		Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition);
+
 		@Override
 		Configuration executionMode(ExecutionMode executionMode);
 
@@ -173,6 +180,13 @@ public Configuration source(@Nullable URI testSourceUri) {
 			return this;
 		}
 
+		@Override
+		public Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition) {
+			super.executionCondition(condition);
+			return this;
+		}
+
 		@Override
 		public Configuration executionMode(ExecutionMode executionMode) {
 			super.executionMode(executionMode);

junit-jupiter-api/src/main/java/org/junit/jupiter/api/DynamicNode.java

@@ -14,9 +14,12 @@
 
 import java.net.URI;
 import java.util.Optional;
+import java.util.function.Function;
 
 import org.apiguardian.api.API;
 import org.jspecify.annotations.Nullable;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.parallel.ExecutionMode;
 import org.junit.platform.commons.util.Preconditions;
 import org.junit.platform.commons.util.ToStringBuilder;
@@ -38,11 +41,13 @@ public abstract class DynamicNode {
 	private final @Nullable URI testSourceUri;
 
 	private final @Nullable ExecutionMode executionMode;
+	private final @Nullable Function<? super ExtensionContext, ? extends ConditionEvaluationResult> executionCondition;
 
 	DynamicNode(AbstractConfiguration configuration) {
 		this.displayName = Preconditions.notBlank(configuration.displayName, "displayName must not be null or blank");
 		this.testSourceUri = configuration.testSourceUri;
 		this.executionMode = configuration.executionMode;
+		this.executionCondition = configuration.executionCondition;
 	}
 
 	/**
@@ -69,6 +74,10 @@ public Optional<ExecutionMode> getExecutionMode() {
 		return Optional.ofNullable(executionMode);
 	}
 
+	public Optional<Function<? super ExtensionContext, ? extends ConditionEvaluationResult>> getExecutionCondition() {
+		return Optional.ofNullable(executionCondition);
+	}
+
 	@Override
 	public String toString() {
 		return new ToStringBuilder(this) //
@@ -83,6 +92,9 @@ public interface Configuration {
 
 		Configuration source(@Nullable URI testSourceUri);
 
+		Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition);
+
 		Configuration executionMode(ExecutionMode executionMode);
 
 		Configuration executionMode(ExecutionMode executionMode, String reason);
@@ -94,6 +106,7 @@ abstract static class AbstractConfiguration implements Configuration {
 		private @Nullable String displayName;
 		private @Nullable URI testSourceUri;
 		private @Nullable ExecutionMode executionMode;
+		private Function<? super ExtensionContext, ? extends ConditionEvaluationResult> executionCondition;
 
 		@Override
 		public Configuration displayName(String displayName) {
@@ -107,6 +120,14 @@ public Configuration source(@Nullable URI testSourceUri) {
 			return this;
 		}
 
+		@Override
+		public Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition) {
+			// TODO Handle multiple calls
+			this.executionCondition = condition;
+			return this;
+		}
+
 		@Override
 		public Configuration executionMode(ExecutionMode executionMode) {
 			this.executionMode = executionMode;

junit-jupiter-api/src/main/java/org/junit/jupiter/api/DynamicTest.java

@@ -24,6 +24,8 @@
 
 import org.apiguardian.api.API;
 import org.jspecify.annotations.Nullable;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.function.Executable;
 import org.junit.jupiter.api.function.ThrowingConsumer;
 import org.junit.jupiter.api.parallel.ExecutionMode;
@@ -319,6 +321,10 @@ public interface Configuration extends DynamicNode.Configuration {
 		@Override
 		Configuration source(@Nullable URI testSourceUri);
 
+		@Override
+		Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition);
+
 		@Override
 		Configuration executionMode(ExecutionMode executionMode);
 
@@ -344,6 +350,13 @@ public Configuration source(@Nullable URI testSourceUri) {
 			return this;
 		}
 
+		@Override
+		public Configuration executionCondition(
+				Function<? super ExtensionContext, ? extends ConditionEvaluationResult> condition) {
+			super.executionCondition(condition);
+			return this;
+		}
+
 		@Override
 		public Configuration executionMode(ExecutionMode executionMode) {
 			super.executionMode(executionMode);

junit-jupiter-api/src/main/java/org/junit/jupiter/api/extension/ConditionEvaluationResult.java

@@ -15,6 +15,7 @@
 import java.util.Optional;
 
 import org.apiguardian.api.API;
+import org.jspecify.annotations.Nullable;
 import org.junit.platform.commons.util.StringUtils;
 import org.junit.platform.commons.util.ToStringBuilder;
 
@@ -32,7 +33,7 @@ public class ConditionEvaluationResult {
 	 * @param reason the reason why the container or test should be enabled
 	 * @return an enabled {@code ConditionEvaluationResult} with the given reason
 	 */
-	public static ConditionEvaluationResult enabled(String reason) {
+	public static ConditionEvaluationResult enabled(@Nullable String reason) {
 		return new ConditionEvaluationResult(true, reason);
 	}
 
@@ -42,7 +43,7 @@ public static ConditionEvaluationResult enabled(String reason) {
 	 * @param reason the reason why the container or test should be disabled
 	 * @return a disabled {@code ConditionEvaluationResult} with the given reason
 	 */
-	public static ConditionEvaluationResult disabled(String reason) {
+	public static ConditionEvaluationResult disabled(@Nullable String reason) {
 		return new ConditionEvaluationResult(false, reason);
 	}
 
@@ -67,7 +68,7 @@ public static ConditionEvaluationResult disabled(String reason, String customRea
 
 	private final Optional<String> reason;
 
-	private ConditionEvaluationResult(boolean enabled, String reason) {
+	private ConditionEvaluationResult(boolean enabled, @Nullable String reason) {
 		this.enabled = enabled;
 		this.reason = Optional.ofNullable(reason);
 	}

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/DynamicNodeTestDescriptor.java

@@ -11,9 +11,11 @@
 package org.junit.jupiter.engine.descriptor;
 
 import java.util.Optional;
+import java.util.function.Function;
 
 import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.DynamicNode;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.engine.config.JupiterConfiguration;
 import org.junit.jupiter.engine.execution.JupiterEngineExecutionContext;
@@ -30,12 +32,14 @@ abstract class DynamicNodeTestDescriptor extends JupiterTestDescriptor {
 
 	protected final int index;
 	private final Optional<ExecutionMode> executionMode;
+	private final Optional<Function<? super ExtensionContext, ? extends ConditionEvaluationResult>> executionCondition;
 
 	DynamicNodeTestDescriptor(UniqueId uniqueId, int index, DynamicNode dynamicNode, @Nullable TestSource testSource,
 			JupiterConfiguration configuration) {
 		super(uniqueId, dynamicNode.getDisplayName(), testSource, configuration);
 		this.index = index;
 		this.executionMode = dynamicNode.getExecutionMode().map(JupiterTestDescriptor::toExecutionMode);
+		this.executionCondition = dynamicNode.getExecutionCondition();
 	}
 
 	@Override
@@ -67,7 +71,10 @@ public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext conte
 
 	@Override
 	public SkipResult shouldBeSkipped(JupiterEngineExecutionContext context) {
-		return SkipResult.doNotSkip();
+		return this.executionCondition //
+				.map(condition -> condition.apply(context.getExtensionContext())) //
+				.map(this::toSkipResult) //
+				.orElse(SkipResult.doNotSkip());
 	}
 
 }

junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/JupiterTestDescriptor.java

@@ -191,7 +191,7 @@ public SkipResult shouldBeSkipped(JupiterEngineExecutionContext context) {
 		return toSkipResult(evaluationResult);
 	}
 
-	private SkipResult toSkipResult(ConditionEvaluationResult evaluationResult) {
+	protected SkipResult toSkipResult(ConditionEvaluationResult evaluationResult) {
 		if (evaluationResult.isDisabled()) {
 			return SkipResult.skip(evaluationResult.getReason().orElse("<unknown>"));
 		}