GH-1494 - Include bean definitions from @TestConfiguration classes in test run.

Author: odrotbohm

spring-modulith-integration-test/src/main/java/com/acme/myproject/moduleE/AnotherServiceComponentE.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2018-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.acme.myproject.moduleE;
+
+import org.springframework.stereotype.Component;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Component
+public class AnotherServiceComponentE {}

spring-modulith-integration-test/src/test/java/com/acme/myproject/moduleD/ModuleDTest.java

@@ -18,10 +18,15 @@
 import static org.assertj.core.api.Assertions.*;
 
 import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import org.mockito.internal.util.MockUtil;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Bean;
 
 import com.acme.myproject.NonVerifyingModuleTest;
+import com.acme.myproject.moduleE.AnotherServiceComponentE;
 import com.acme.myproject.moduleE.ServiceComponentE;
 
 /**
@@ -36,4 +41,21 @@ public class ModuleDTest {
 	void dropsManuallyDeclaredBeanOfNonIncludedModule() {
 		assertThat(context.getBeanNamesForType(ServiceComponentE.class)).isEmpty();
 	}
+
+	@Test // GH-1494
+	void considersBeanFromTestConfiguration() {
+
+		assertThat(context.getBean(AnotherServiceComponentE.class))
+				.extracting(MockUtil::isMock)
+				.isEqualTo(true);
+	}
+
+	@TestConfiguration
+	static class TestConfig {
+
+		@Bean
+		AnotherServiceComponentE mock() {
+			return Mockito.mock(AnotherServiceComponentE.class);
+		}
+	}
 }

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

@@ -15,7 +15,9 @@
  */
 package org.springframework.modulith.test;
 
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Predicate;
@@ -29,10 +31,12 @@
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.modulith.core.ApplicationModule;
 import org.springframework.modulith.core.ApplicationModuleIdentifier;
-import org.springframework.modulith.core.JavaPackage;
+import org.springframework.modulith.core.ApplicationModules;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
@@ -238,38 +242,80 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) t
 
 			for (String name : registry.getBeanDefinitionNames()) {
 
-				var type = factory.getType(name, false);
-				var module = modules.getModuleByType(type)
-						.filter(Predicate.not(ApplicationModule::isRootModule));
-
-				// Not a module type -> pass
-				if (module.isEmpty()) {
+				if (include(name, modules, factory)) {
 					continue;
 				}
 
-				var packagesIncludedInTestRun = execution.getBasePackages().toList();
+				var type = factory.getType(name, false);
 
-				// A type of a module bootstrapped -> pass
-				if (module.map(ApplicationModule::getBasePackage)
-						.map(JavaPackage::getName)
-						.filter(packagesIncludedInTestRun::contains).isPresent()) {
-					continue;
+				if (type != null) {
+					LOGGER.trace(
+							"Dropping bean definition {} for type {} as it is not included in an application module to be bootstrapped!",
+							name, type.getName());
 				}
 
-				LOGGER.trace(
-						"Dropping bean definition {} for type {} as it is not included in an application module to be bootstrapped!",
-						name, type.getName());
-
 				// Remove bean definition from bootstrap
 				registry.removeBeanDefinition(name);
 			}
 		}
 
+		private boolean include(String beanDefinitionName, ApplicationModules modules,
+				ConfigurableListableBeanFactory factory) {
+
+			var types = getTypeOrTestConfigurationFactoryBean(beanDefinitionName, factory);
+
+			var result = modules.stream()
+					.filter(Predicate.not(ApplicationModule::isRootModule))
+					.filter(it -> types.stream().anyMatch(type -> it.couldContain(type)))
+					.map(ApplicationModule::getBasePackage)
+					.map(execution.getBasePackages()::contains)
+					.toList();
+
+			return result.isEmpty() || result.contains(true);
+		}
+
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.beans.factory.config.BeanFactoryPostProcessor#postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory)
 		 */
 		@Override
 		public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {}
+
+		/**
+		 * Returns the type of the {@link org.springframework.beans.factory.config.BeanDefinition} of the given name and
+		 * optionally its factory bean's type if annotated with {@link TestConfiguration}.
+		 *
+		 * @param beanDefinitionName must not be {@literal null} or empty.
+		 * @param factory must not be {@literal null}.
+		 * @return will never be {@literal null}.
+		 */
+		private static Collection<Class<?>> getTypeOrTestConfigurationFactoryBean(String beanDefinitionName,
+				ConfigurableListableBeanFactory factory) {
+
+			var result = new ArrayList<Class<?>>();
+			var type = factory.getType(beanDefinitionName, false);
+
+			if (type != null) {
+				result.add(type);
+			}
+
+			var factoryName = factory.getBeanDefinition(beanDefinitionName).getFactoryBeanName();
+
+			if (factoryName == null) {
+				return result;
+			}
+
+			var factoryType = factory.getType(factoryName, false);
+
+			if (factoryType == null) {
+				return result;
+			}
+
+			if (AnnotatedElementUtils.hasAnnotation(factoryType, TestConfiguration.class)) {
+				result.add(factoryType);
+			}
+
+			return result;
+		}
 	}
 }

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

@@ -29,6 +29,7 @@
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.Ordered;
 import org.springframework.core.type.AnnotationMetadata;
+import org.springframework.modulith.core.JavaPackage;
 import org.springframework.util.StringUtils;
 
 /**
@@ -58,7 +59,7 @@ static class AutoConfigurationAndEntityScanPackageCustomizer implements ImportBe
 		public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 
 			var execution = ((BeanFactory) registry).getBean(ModuleTestExecution.class);
-			var basePackages = execution.getBasePackages().toList();
+			var basePackages = execution.getBasePackages().stream().map(JavaPackage::getName).toList();
 
 			LOGGER.info("Re-configuring auto-configuration and entity scan packages to: {}.",
 					StringUtils.collectionToDelimitedString(basePackages, ", "));

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

@@ -35,8 +35,7 @@
 import org.springframework.modulith.core.ApplicationModule;
 import org.springframework.modulith.core.ApplicationModules;
 import org.springframework.modulith.core.ApplicationModulesFactory;
-import org.springframework.modulith.core.JavaPackage;
-import org.springframework.modulith.core.PackageName;
+import org.springframework.modulith.core.JavaPackages;
 import org.springframework.modulith.test.ApplicationModuleTest.BootstrapMode;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
@@ -69,7 +68,7 @@ public class ModuleTestExecution implements Iterable<ApplicationModule> {
 	private final ApplicationModules modules;
 	private final List<ApplicationModule> extraIncludes;
 
-	private final Supplier<List<JavaPackage>> basePackages;
+	private final Supplier<JavaPackages> basePackages;
 	private final Supplier<List<ApplicationModule>> dependencies;
 
 	private ModuleTestExecution(ApplicationModuleTest annotation, ApplicationModules modules, ApplicationModule module) {
@@ -89,7 +88,8 @@ private ModuleTestExecution(ApplicationModuleTest annotation, ApplicationModules
 
 			var intermediate = Stream.concat(moduleBasePackages, extraPackages);
 
-			return Stream.concat(intermediate, sharedBasePackages).distinct().toList();
+			return Stream.concat(intermediate, sharedBasePackages).distinct()
+					.collect(Collectors.collectingAndThen(Collectors.toList(), JavaPackages::new));
 		});
 
 		this.dependencies = SingletonSupplier.of(() -> {
@@ -129,8 +129,8 @@ public static Supplier<ModuleTestExecution> of(Class<?> type) {
 	 *
 	 * @return
 	 */
-	public Stream<String> getBasePackages() {
-		return basePackages.get().stream().map(JavaPackage::getName);
+	public JavaPackages getBasePackages() {
+		return basePackages.get();
 	}
 
 	public boolean includes(String className) {
@@ -240,14 +240,7 @@ public int hashCode() {
 	}
 
 	private boolean isLocatedInRootPackageOrContainedInBasePackages(String className) {
-
-		if (modules.withinRootPackages(className)) {
-			return true;
-		}
-
-		var candidate = PackageName.ofType(className);
-
-		return basePackages.get().stream().map(JavaPackage::getPackageName).anyMatch(it -> it.contains(candidate));
+		return modules.withinRootPackages(className) || basePackages.get().couldContain(className);
 	}
 
 	private static Stream<ApplicationModule> getExtraModules(ApplicationModuleTest annotation,