GH-46 - Bootstrap dependencies must only contain DependencyType.USES_COMPONENT.

This commit is contained in:
Oliver Drotbohm
2022-10-21 00:45:14 +02:00
parent 1b06b8b689
commit 2430dc90e2
4 changed files with 54 additions and 9 deletions

View File

@@ -177,7 +177,7 @@ public class ApplicationModule {
Assert.notNull(modules, "Modules must not be null!");
Assert.notNull(depth, "Dependency depth must not be null!");
return streamDependencies(modules, depth);
return streamBootstrapDependencies(modules, depth);
}
/**
@@ -187,12 +187,12 @@ public class ApplicationModule {
* @param depth must not be {@literal null}.
* @return
*/
public Stream<JavaPackage> getBasePackages(ApplicationModules modules, DependencyDepth depth) {
public Stream<JavaPackage> getBootstrapBasePackages(ApplicationModules modules, DependencyDepth depth) {
Assert.notNull(modules, "Modules must not be null!");
Assert.notNull(depth, "Dependency depth must not be null!");
Stream<ApplicationModule> dependencies = streamDependencies(modules, depth);
Stream<ApplicationModule> dependencies = streamBootstrapDependencies(modules, depth);
return Stream.concat(Stream.of(this), dependencies) //
.map(ApplicationModule::getBasePackage);
@@ -380,27 +380,28 @@ public class ApplicationModule {
.flatMap(it -> getModuleDependenciesOf(it, modules));
}
private Stream<ApplicationModule> streamDependencies(ApplicationModules modules, DependencyDepth depth) {
private Stream<ApplicationModule> streamBootstrapDependencies(ApplicationModules modules, DependencyDepth depth) {
switch (depth) {
case NONE:
return Stream.empty();
case IMMEDIATE:
return getDirectModuleDependencies(modules);
return getDirectModuleBootstrapDependencies(modules);
case ALL:
default:
return getDirectModuleDependencies(modules) //
.flatMap(it -> Stream.concat(Stream.of(it), it.streamDependencies(modules, DependencyDepth.ALL))) //
return getDirectModuleBootstrapDependencies(modules) //
.flatMap(it -> Stream.concat(Stream.of(it), it.streamBootstrapDependencies(modules, DependencyDepth.ALL))) //
.distinct();
}
}
private Stream<ApplicationModule> getDirectModuleDependencies(ApplicationModules modules) {
private Stream<ApplicationModule> getDirectModuleBootstrapDependencies(ApplicationModules modules) {
return getSpringBeansInternal().stream() //
.flatMap(it -> ModuleDependency.fromType(it)) //
.filter(it -> isDependencyToOtherModule(it.target, modules)) //
.filter(it -> it.hasType(DependencyType.USES_COMPONENT)) //
.map(it -> modules.getModuleByType(it.target)) //
.distinct() //
.flatMap(it -> it.map(Stream::of).orElseGet(Stream::empty));

View File

@@ -0,0 +1,31 @@
/*
* Copyright 2022 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.moduleD;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
import com.acme.myproject.moduleA.SomeEventA;
/**
* @author Oliver Drotbohm
*/
@Component
class EventListenerD {
@EventListener
void on(SomeEventA event) {}
}

View File

@@ -18,6 +18,7 @@ package com.acme.myproject;
import static org.assertj.core.api.Assertions.*;
import org.junit.jupiter.api.Test;
import org.springframework.modulith.model.ApplicationModule;
import org.springframework.modulith.model.ApplicationModules;
import org.springframework.modulith.model.ApplicationModules.Filters;
import org.springframework.modulith.model.Violations;
@@ -71,4 +72,16 @@ class ModulithTest {
.withMessageContaining("CycleA") //
.withMessageContaining("CycleB");
}
@Test // GH-46
void doesNotIncludeEventListenerDependencyInBootstrapOnes() {
var modules = ApplicationModules.of(Application.class, DEFAULT_EXCLUSIONS);
assertThat(modules.getModuleByName("moduleD")).hasValueSatisfying(it -> {
assertThat(it.getBootstrapDependencies(modules))
.map(ApplicationModule::getName)
.doesNotContain("moduleA");
});
}
}

View File

@@ -72,7 +72,7 @@ public class ModuleTestExecution implements Iterable<ApplicationModule> {
this.basePackages = Suppliers.memoize(() -> {
Stream<JavaPackage> moduleBasePackages = module.getBasePackages(modules, bootstrapMode.getDepth());
Stream<JavaPackage> moduleBasePackages = module.getBootstrapBasePackages(modules, bootstrapMode.getDepth());
Stream<JavaPackage> sharedBasePackages = modules.getSharedModules().stream().map(it -> it.getBasePackage());
Stream<JavaPackage> extraPackages = extraIncludes.stream().map(ApplicationModule::getBasePackage);