From 79bd413f605f502bbfa3d36afe4f0916fe88af5e Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Tue, 13 Aug 2024 21:58:57 +0200 Subject: [PATCH] GH-766 - Prevent ApplicationModuleInformation from picking up info from nested packages. --- .../core/ApplicationModuleInformation.java | 13 +++---- .../springframework/modulith/core/Types.java | 4 +- ...ApplicationModuleInformationUnitTests.java | 39 +++++++++++++++++++ .../test/java/reproducers/gh764/Entry.java | 21 ++++++++++ .../gh764/nested/package-info.java | 2 + 5 files changed, 70 insertions(+), 9 deletions(-) create mode 100644 spring-modulith-core/src/test/java/org/springframework/modulith/core/ApplicationModuleInformationUnitTests.java create mode 100644 spring-modulith-core/src/test/java/reproducers/gh764/Entry.java create mode 100644 spring-modulith-core/src/test/java/reproducers/gh764/nested/package-info.java diff --git a/spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModuleInformation.java b/spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModuleInformation.java index 1773fe93..be6fa324 100644 --- a/spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModuleInformation.java +++ b/spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModuleInformation.java @@ -21,10 +21,9 @@ import java.util.Optional; import java.util.function.Supplier; import java.util.stream.Stream; -import org.jmolecules.ddd.annotation.Module; import org.springframework.modulith.ApplicationModule; +import org.springframework.modulith.core.Types.JMoleculesTypes; import org.springframework.util.Assert; -import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** @@ -43,13 +42,11 @@ interface ApplicationModuleInformation { */ public static ApplicationModuleInformation of(JavaPackage javaPackage) { - if (ClassUtils.isPresent("org.jmolecules.ddd.annotation.Module", - ApplicationModuleInformation.class.getClassLoader()) - && JMoleculesModule.supports(javaPackage)) { - return new JMoleculesModule(javaPackage); - } + var rootPackage = javaPackage.toSingle(); - return new SpringModulithModule(javaPackage); + return JMoleculesTypes.isPresent() && JMoleculesModule.supports(rootPackage) + ? new JMoleculesModule(rootPackage) + : new SpringModulithModule(rootPackage); } /** diff --git a/spring-modulith-core/src/main/java/org/springframework/modulith/core/Types.java b/spring-modulith-core/src/main/java/org/springframework/modulith/core/Types.java index 7b037a7e..88fa0e56 100644 --- a/spring-modulith-core/src/main/java/org/springframework/modulith/core/Types.java +++ b/spring-modulith-core/src/main/java/org/springframework/modulith/core/Types.java @@ -50,12 +50,14 @@ class Types { private static final String ARCHUNIT_RULES = BASE_PACKAGE + ".archunit.JMoleculesDddRules"; private static final String MODULE = ANNOTATION_PACKAGE + ".Module"; + private static final boolean PRESENT = ClassUtils.isPresent(AT_ENTITY, JMoleculesTypes.class.getClassLoader()); + static final String AT_DOMAIN_EVENT_HANDLER = BASE_PACKAGE + ".event.annotation.DomainEventHandler"; static final String AT_DOMAIN_EVENT = BASE_PACKAGE + ".event.annotation.DomainEvent"; static final String DOMAIN_EVENT = BASE_PACKAGE + ".event.types.DomainEvent"; public static boolean isPresent() { - return ClassUtils.isPresent(AT_ENTITY, JMoleculesTypes.class.getClassLoader()); + return PRESENT; } @Nullable diff --git a/spring-modulith-core/src/test/java/org/springframework/modulith/core/ApplicationModuleInformationUnitTests.java b/spring-modulith-core/src/test/java/org/springframework/modulith/core/ApplicationModuleInformationUnitTests.java new file mode 100644 index 00000000..ec3be45e --- /dev/null +++ b/spring-modulith-core/src/test/java/org/springframework/modulith/core/ApplicationModuleInformationUnitTests.java @@ -0,0 +1,39 @@ +/* + * Copyright 2024 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 org.springframework.modulith.core; + +import static org.assertj.core.api.Assertions.*; + +import reproducers.gh764.Entry; + +import org.junit.jupiter.api.Test; + +/** + * Unit tests for {@link ApplicationModuleInformation}. + * + * @author Oliver Drotbohm + */ +class ApplicationModuleInformationUnitTests { + + @Test // GH-764 + void doesNotConsiderAnnotationOnNestedPackageInfos() { + + var pkg = TestUtils.getPackage(Entry.class); + var info = ApplicationModuleInformation.of(pkg); + + assertThat(info.getDisplayName()).isEmpty(); + } +} diff --git a/spring-modulith-core/src/test/java/reproducers/gh764/Entry.java b/spring-modulith-core/src/test/java/reproducers/gh764/Entry.java new file mode 100644 index 00000000..5a3a54d0 --- /dev/null +++ b/spring-modulith-core/src/test/java/reproducers/gh764/Entry.java @@ -0,0 +1,21 @@ +/* + * Copyright 2024 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 reproducers.gh764; + +/** + * @author Oliver Drotbohm + */ +public class Entry {} diff --git a/spring-modulith-core/src/test/java/reproducers/gh764/nested/package-info.java b/spring-modulith-core/src/test/java/reproducers/gh764/nested/package-info.java new file mode 100644 index 00000000..2528e11c --- /dev/null +++ b/spring-modulith-core/src/test/java/reproducers/gh764/nested/package-info.java @@ -0,0 +1,2 @@ +@org.springframework.modulith.ApplicationModule(displayName = "Nested") +package reproducers.gh764.nested;