GH-1262 - Avoid referring to the source class in ModuleTypeExcludeFilter.equals(…) and ….hashCode().

MTEF's equals(…) and hashCode() methods is depended on by the application context caching facilities of Spring Framework's test context framework. Previously, it referred to the class under test in those methods, thus effectively disabling the cache, even if the application module test bootstrap setup was identical but used on different test classes.

We now avoid this by solely referring to the equals(…) and hashCode() methods of ModuleTestExecution, which in turn only considers the base package and the @ApplicationModuleTest annotation.

Author: odrotbohm

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

@@ -105,7 +105,7 @@ private ModuleTestExecution(ApplicationModuleTest annotation, ApplicationModules
 
 	public static Supplier<ModuleTestExecution> of(Class<?> type) {
 
-		return () -> {
+		return SingletonSupplier.of(() -> {
 
 			var annotation = AnnotatedElementUtils.findMergedAnnotation(type, ApplicationModuleTest.class);
 			var packageName = type.getPackage().getName();
@@ -120,7 +120,7 @@ public static Supplier<ModuleTestExecution> of(Class<?> type) {
 
 			return EXECUTIONS.computeIfAbsent(new Key(module.getBasePackage().getName(), annotation),
 					it -> new ModuleTestExecution(annotation, modules, module));
-		};
+		});
 	}
 
 	/**

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

@@ -25,19 +25,20 @@
 import org.springframework.util.Assert;
 
 /**
+ * A {@link TypeExcludeFilter} that only selects types included in a {@link ModuleTestExecution}, i.e. from the modules
+ * included in a particular test run.
+ *
  * @author Oliver Drotbohm
  */
 class ModuleTypeExcludeFilter extends TypeExcludeFilter {
 
 	private final Supplier<ModuleTestExecution> execution;
-	private final Class<?> source;
 
 	public ModuleTypeExcludeFilter(Class<?> testClass) {
 
 		Assert.notNull(testClass, "Test class must not be null!");
 
 		this.execution = ModuleTestExecution.of(testClass);
-		this.source = testClass;
 	}
 
 	/*
@@ -64,7 +65,7 @@ public boolean equals(Object obj) {
 			return false;
 		}
 
-		return Objects.equals(source, that.source);
+		return Objects.equals(execution.get(), that.execution.get());
 	}
 
 	/*
@@ -73,6 +74,6 @@ public boolean equals(Object obj) {
 	 */
 	@Override
 	public int hashCode() {
-		return Objects.hash(source);
+		return Objects.hash(execution.get());
 	}
 }

spring-modulith-test/src/test/java/org/springframework/modulith/test/ModuleTypeExcludeFilterUnitTests.java

@@ -26,14 +26,45 @@
  */
 class ModuleTypeExcludeFilterUnitTests {
 
-	@Test
+	@Test // GH-725, GH-1216
 	void instancesForSameTargetTypeAreEqual() {
 
-		var left = new ModuleTypeExcludeFilter(Object.class);
-		var right = new ModuleTypeExcludeFilter(Object.class);
+		var left = new ModuleTypeExcludeFilter(First.class);
+		var right = new ModuleTypeExcludeFilter(First.class);
 
 		assertThat(left).isEqualTo(right);
 		assertThat(right).isEqualTo(left);
 		assertThat(left).hasSameHashCodeAs(right);
 	}
+
+	@Test // GH-1216
+	void instancesForDifferentTargetButSameTestSetupTypeAreEqual() {
+
+		var left = new ModuleTypeExcludeFilter(First.class);
+		var right = new ModuleTypeExcludeFilter(Second.class);
+
+		assertThat(left).isEqualTo(right);
+		assertThat(right).isEqualTo(left);
+		assertThat(left).hasSameHashCodeAs(right);
+	}
+
+	@Test // GH-1216
+	void instancesForDifferentTargetAndDifferentTestSetupTypeAreNotEqual() {
+
+		var left = new ModuleTypeExcludeFilter(Second.class);
+		var right = new ModuleTypeExcludeFilter(Third.class);
+
+		assertThat(left).isNotEqualTo(right);
+		assertThat(right).isNotEqualTo(left);
+		assertThat(left).doesNotHaveSameHashCodeAs(right);
+	}
+
+	@ApplicationModuleTest
+	static class First {}
+
+	@ApplicationModuleTest
+	static class Second {}
+
+	@ApplicationModuleTest(extraIncludes = "foo")
+	static class Third {}
 }