Add support for configuring expected outcomes

See gh-210

Author: wilkinsona

gradle/plugins/aot-smoke-test-plugin/src/main/java/org/springframework/aot/gradle/AotSmokeTestPlugin.java

@@ -17,7 +17,9 @@
 package org.springframework.aot.gradle;
 
 import java.net.URI;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
@@ -48,6 +50,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinJvmCompile;
 
 import org.springframework.aot.gradle.dsl.AotSmokeTestExtension;
+import org.springframework.aot.gradle.dsl.AotSmokeTestExtension.Outcome;
 import org.springframework.aot.gradle.tasks.AppTest;
 import org.springframework.aot.gradle.tasks.DescribeSmokeTest;
 import org.springframework.aot.gradle.tasks.StartApplication;
@@ -130,7 +133,20 @@ private void configureBootJavaProject(Project project) {
 				.getAllSource()
 				.isEmpty();
 			boolean appTests = !appTest.getAllSource().isEmpty();
-			return new SmokeTest(project.getName(), project.getParent().getName(), project.getPath(), tests, appTests);
+			List<String> expectedToFail = new ArrayList<String>();
+			if (extension.getAppTest().getOutcome().get() == Outcome.FAILURE) {
+				expectedToFail.add("appTest");
+			}
+			if (extension.getNativeAppTest().getOutcome().get() == Outcome.FAILURE) {
+				expectedToFail.add("nativeAppTest");
+			}
+			if (extension.getTest().getOutcome().get() == Outcome.FAILURE) {
+				expectedToFail.add("test");
+			}
+			if (extension.getNativeTest().getOutcome().get() == Outcome.FAILURE) {
+				expectedToFail.add("nativeTest");
+			}
+			return new SmokeTest(project.getName(), project.getParent().getName(), project.getPath(), tests, appTests, expectedToFail);
 		});
 		TaskProvider<DescribeSmokeTest> describeSmokeTest = project.getTasks()
 			.register("describeSmokeTest", DescribeSmokeTest.class);

gradle/plugins/aot-smoke-test-plugin/src/main/java/org/springframework/aot/gradle/SmokeTest.java

@@ -17,6 +17,7 @@
 package org.springframework.aot.gradle;
 
 import java.io.Serializable;
+import java.util.List;
 import java.util.Properties;
 
 /**
@@ -28,13 +29,9 @@
  * @param path path of the smoke test project
  * @param tests whether the smoke test contains any unit tests
  * @param appTests whether the smoke test contains any app tests
+ * @param expectedToFail names of tasks that are expected to fail
  */
 public record SmokeTest(String name, String group, String path, boolean tests,
-		boolean appTests) implements Serializable {
-
-	SmokeTest(Properties properties) {
-		this(properties.getProperty("name"), properties.getProperty("group"), properties.getProperty("path"),
-				Boolean.valueOf(properties.getProperty("tests")), Boolean.valueOf(properties.getProperty("appTests")));
-	}
+		boolean appTests, List<String> expectedToFail) implements Serializable {
 
 }

gradle/plugins/aot-smoke-test-plugin/src/main/java/org/springframework/aot/gradle/dsl/AotSmokeTestExtension.java

@@ -18,7 +18,9 @@
 
 import javax.inject.Inject;
 
+import org.gradle.api.Action;
 import org.gradle.api.Project;
+import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.Property;
 
 /**
@@ -30,9 +32,22 @@ public class AotSmokeTestExtension {
 
 	private final Property<Boolean> webApplication;
 
+	private final Expectation appTest;
+
+	private final Expectation nativeAppTest;
+
+	private final Expectation test;
+
+	private final Expectation nativeTest;
+
 	@Inject
 	public AotSmokeTestExtension(Project project) {
-		this.webApplication = project.getObjects().property(Boolean.class);
+		ObjectFactory objects = project.getObjects();
+		this.webApplication = objects.property(Boolean.class);
+		this.appTest = objects.newInstance(Expectation.class, project);
+		this.nativeAppTest = objects.newInstance(Expectation.class, project);
+		this.test = objects.newInstance(Expectation.class, project);
+		this.nativeTest = objects.newInstance(Expectation.class, project);
 	}
 
 	/**
@@ -43,4 +58,100 @@ public Property<Boolean> getWebApplication() {
 		return this.webApplication;
 	}
 
+	/**
+	 * Expectations for {@code appTest}.
+	 */
+	public Expectation getAppTest() {
+		return this.appTest;
+	}
+
+	/**
+	 * Configure expectations for {@code appTest}.
+	 */
+	public void appTest(Action<Expectation> action) {
+		action.execute(this.appTest);
+	}
+
+	/**
+	 * Expectations for {@code nativeAppTest}.
+	 */
+	public Expectation getNativeAppTest() {
+		return this.nativeAppTest;
+	}
+
+	/**
+	 * Configure expectations for {@code nativeAppTest}.
+	 */
+	public void nativeAppTest(Action<Expectation> action) {
+		action.execute(this.nativeAppTest);
+	}
+
+	/**
+	 * Expectations for {@code test}.
+	 */
+	public Expectation getTest() {
+		return this.test;
+	}
+
+	/**
+	 * Configure expectations for {@code test}.
+	 */
+	public void test(Action<Expectation> action) {
+		action.execute(this.test);
+	}
+
+	/**
+	 * Expectations for {@code nativeTest}.
+	 */
+	public Expectation getNativeTest() {
+		return this.nativeTest;
+	}
+
+	/**
+	 * Configure expectations for {@code nativeTest}.
+	 */
+	public void nativeTest(Action<Expectation> action) {
+		action.execute(this.nativeTest);
+	}
+
+	public static class Expectation {
+
+		private final Property<Outcome> outcome;
+
+		@Inject
+		public Expectation(Project project) {
+			this.outcome = project.getObjects().property(Outcome.class);
+			this.outcome.convention(Outcome.SUCCESS);
+		}
+
+		/**
+		 * The expected outcome.
+		 */
+		public Property<Outcome> getOutcome() {
+			return this.outcome;
+		}
+
+		/**
+		 * Note that expected outcome is failure
+		 */
+		public void expectedToFail(Action<Object> action) {
+			this.outcome.set(Outcome.FAILURE);
+		}
+
+	}
+
+	public static enum Outcome {
+
+		/**
+		 * The expected outcome is failure.
+		 */
+		FAILURE,
+
+		/**
+		 * The expected outcome is success.
+		 */
+		SUCCESS
+
+	}
+
 }

gradle/plugins/aot-smoke-test-plugin/src/main/java/org/springframework/aot/gradle/tasks/DescribeSmokeTest.java

@@ -61,6 +61,7 @@ void describeSmokeTest() throws IOException {
 		properties.add("name=" + smokeTest.name());
 		properties.add("path=" + smokeTest.path());
 		properties.add("tests=" + smokeTest.tests());
+		properties.add("expectedToFail=" + String.join(",", smokeTest.expectedToFail()));
 		Files.write(propertiesFile.toPath(), properties);
 	}