GH-136 - Introduce Scenario as application module integration test API.

See the Javadoc of Scenario for details.

Author: odrotbohm

spring-modulith-test/pom.xml

@@ -39,6 +39,11 @@
 			<artifactId>spring-test</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-tx</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>org.assertj</groupId>
 			<artifactId>assertj-core</artifactId>
@@ -59,7 +64,6 @@
 		<dependency>
 			<groupId>org.awaitility</groupId>
 			<artifactId>awaitility</artifactId>
-			<scope>test</scope>
 		</dependency>
 
 	</dependencies>

spring-modulith-test/src/main/java/org/springframework/modulith/test/ApplicationModuleTest.java

@@ -47,8 +47,7 @@
 @BootstrapWith(SpringBootTestContextBootstrapper.class)
 @TypeExcludeFilters(ModuleTypeExcludeFilter.class)
 @ImportAutoConfiguration(ModuleTestAutoConfiguration.class)
-@ExtendWith(SpringExtension.class)
-@ExtendWith(PublishedEventsParameterResolver.class)
+@ExtendWith({ SpringExtension.class, PublishedEventsParameterResolver.class, ScenarioParameterResolver.class })
 @TestInstance(Lifecycle.PER_CLASS)
 @TestConstructor(autowireMode = AutowireMode.ALL)
 public @interface ApplicationModuleTest {

spring-modulith-test/src/main/java/org/springframework/modulith/test/DefaultPublishedEvents.java

@@ -100,13 +100,13 @@ private static <T> SimpleTypedPublishedEvents<T> of(Stream<T> stream) {
 
 		/*
 		 * (non-Javadoc)
-		 * @see org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents#ofSubType(java.lang.Class)
+		 * @see org.springframework.modulith.test.PublishedEvents.TypedPublishedEvents#ofType(java.lang.Class)
 		 */
 		@Override
-		public <S extends T> TypedPublishedEvents<S> ofSubType(Class<S> subType) {
+		public <S> TypedPublishedEvents<S> ofType(Class<S> type) {
 
-			return SimpleTypedPublishedEvents.of(getFilteredEvents(subType::isInstance) //
-					.map(subType::cast));
+			return SimpleTypedPublishedEvents.of(getFilteredEvents(type::isInstance) //
+					.map(type::cast));
 		}
 
 		/*

spring-modulith-test/src/main/java/org/springframework/modulith/test/PublishedEvents.java

@@ -28,7 +28,7 @@
  *
  * @author Oliver Drotbohm
  */
-public interface PublishedEvents {
+public interface PublishedEvents extends TypedEvents {
 
 	/**
 	 * Creates a new {@link PublishedEvents} instance for the given events.
@@ -53,35 +53,19 @@ public static PublishedEvents of(Collection<? extends Object> events) {
 		return new DefaultPublishedEvents(events);
 	}
 
-	/**
-	 * Returns all application events of the given type that were fired during the test execution.
-	 *
-	 * @param <T> the event type
-	 * @param type must not be {@literal null}.
-	 * @return
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.modulith.test.TypedEvents#ofType(java.lang.Class)
 	 */
 	<T> TypedPublishedEvents<T> ofType(Class<T> type);
 
-	/**
-	 * Returns whether an event of the given type was published.
-	 *
-	 * @param type must not be {@literal null}.
-	 * @return whether an event of the given type was published.
-	 */
-	default boolean eventOfTypeWasPublished(Class<?> type) {
-
-		Assert.notNull(type, "Event type must not be null!");
-
-		return ofType(type).iterator().hasNext();
-	}
-
 	/**
 	 * All application events of a given type that were fired during a test execution.
 	 *
 	 * @author Oliver Drotbohm
 	 * @param <T> the event type
 	 */
-	interface TypedPublishedEvents<T> extends Iterable<T> {
+	interface TypedPublishedEvents<T> extends Iterable<T>, TypedEvents {
 
 		/**
 		 * Further constrain the event type for downstream assertions.
@@ -90,7 +74,16 @@ interface TypedPublishedEvents<T> extends Iterable<T> {
 		 * @param subType the sub type
 		 * @return will never be {@literal null}.
 		 */
-		<S extends T> TypedPublishedEvents<S> ofSubType(Class<S> subType);
+		default <S extends T> TypedPublishedEvents<S> ofSubType(Class<S> subType) {
+			return ofType(subType);
+		}
+
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.modulith.test.TypedEvents#ofType(java.lang.Class)
+		 */
+		@Override
+		<S> TypedPublishedEvents<S> ofType(Class<S> type);
 
 		/**
 		 * Returns all {@link TypedPublishedEvents} that match the given predicate.

spring-modulith-test/src/main/java/org/springframework/modulith/test/PublishedEventsAssert.java

@@ -31,14 +31,14 @@
  * @author Oliver Drotbohm
  * @see AssertablePublishedEvents
  */
-public class PublishedEventsAssert extends AbstractAssert<PublishedEventsAssert, PublishedEvents> {
+public class PublishedEventsAssert extends AbstractAssert<PublishedEventsAssert, TypedEvents> {
 
 	/**
 	 * Creates a new {@link PublishedEventsAssert}
 	 *
 	 * @param actual must not be {@literal null}.
 	 */
-	PublishedEventsAssert(AssertablePublishedEvents actual) {
+	PublishedEventsAssert(TypedEvents actual) {
 		super(actual, PublishedEventsAssert.class);
 	}