-
Notifications
You must be signed in to change notification settings - Fork 902
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit adds support to add Spring Modulith to a project. We add the Event Publication Registry matching the (optionally) also selected persistence flavor (JPA, JDBC, MongoDB). Also, the observability support in case any of the supported observability backends is selected as dependency. See gh-1228
- Loading branch information
Showing
6 changed files
with
289 additions
and
0 deletions.
There are no files selected for viewing
104 changes: 104 additions & 0 deletions
104
.../spring/start/site/extension/dependency/springmodulith/SpringModulithBuildCustomizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
/* | ||
* Copyright 2012-2023 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 io.spring.start.site.extension.dependency.springmodulith; | ||
|
||
import java.util.Collection; | ||
import java.util.List; | ||
|
||
import io.spring.initializr.generator.buildsystem.Build; | ||
import io.spring.initializr.generator.buildsystem.Dependency; | ||
import io.spring.initializr.generator.buildsystem.Dependency.Builder; | ||
import io.spring.initializr.generator.buildsystem.DependencyContainer; | ||
import io.spring.initializr.generator.buildsystem.DependencyScope; | ||
import io.spring.initializr.generator.spring.build.BuildCustomizer; | ||
|
||
/** | ||
* Registers Spring Modulith dependencies to the build file of the project to be created, | ||
* in particular registering integration dependencies depending on others registered for | ||
* inclusion as well (observability and persistence). | ||
* | ||
* @author Oliver Drotbohm | ||
*/ | ||
class SpringModulithBuildCustomizer implements BuildCustomizer<Build> { | ||
|
||
static final String GROUP_ID = "org.springframework.experimental"; | ||
static final String BOM_ARTIFACT_ID = "spring-modulith-bom"; | ||
|
||
static final Collection<String> OBSERVABILITY_DEPENDENCIES = List.of("datadog", "graphite", "influx", "new-relic", | ||
"prometheus", "wavefront", "zipkin"); | ||
|
||
private static final String ARTIFACT_PREFIX = "spring-modulith-"; | ||
|
||
private static final Builder<?> ACTUATOR = Dependency.withCoordinates(GROUP_ID, ARTIFACT_PREFIX + "actuator") | ||
.scope(DependencyScope.RUNTIME); | ||
|
||
private static final Builder<?> OBSERVABILITY = Dependency | ||
.withCoordinates(GROUP_ID, ARTIFACT_PREFIX + "observability") | ||
.scope(DependencyScope.RUNTIME); | ||
|
||
private static final Builder<?> STARTER_JDBC = Dependency.withCoordinates(GROUP_ID, | ||
ARTIFACT_PREFIX + "starter-jdbc"); | ||
|
||
private static final Builder<?> STARTER_JPA = Dependency.withCoordinates(GROUP_ID, ARTIFACT_PREFIX + "starter-jpa"); | ||
|
||
private static final Builder<?> STARTER_MONGODB = Dependency.withCoordinates(GROUP_ID, | ||
ARTIFACT_PREFIX + "starter-mongodb"); | ||
|
||
private static final Builder<?> TEST = Dependency.withCoordinates(GROUP_ID, ARTIFACT_PREFIX + "starter-test") | ||
.scope(DependencyScope.TEST_COMPILE); | ||
|
||
@Override | ||
public void customize(Build build) { | ||
DependencyContainer dependencies = build.dependencies(); | ||
|
||
// Actuator | ||
|
||
if (dependencies.has("actuator")) { | ||
dependencies.add("modulith-actuator", ACTUATOR); | ||
} | ||
|
||
// Observability | ||
|
||
if (OBSERVABILITY_DEPENDENCIES.stream().anyMatch(dependencies::has)) { | ||
dependencies.add("modulith-observability", OBSERVABILITY); | ||
} | ||
|
||
// Event publication registry support | ||
|
||
addEventPublicationRegistryBackend(build); | ||
|
||
dependencies.add("modulith-starter-test", TEST); | ||
} | ||
|
||
private void addEventPublicationRegistryBackend(Build build) { | ||
|
||
DependencyContainer dependencies = build.dependencies(); | ||
|
||
if (dependencies.has("data-mongodb")) { | ||
dependencies.add("modulith-starter-mongodb", STARTER_MONGODB); | ||
} | ||
|
||
if (dependencies.has("data-jdbc")) { | ||
dependencies.add("modulith-starter-jdbc", STARTER_JDBC); | ||
} | ||
|
||
if (dependencies.has("data-jpa")) { | ||
dependencies.add("modulith-starter-jpa", STARTER_JPA); | ||
} | ||
} | ||
|
||
} |
39 changes: 39 additions & 0 deletions
39
...ite/extension/dependency/springmodulith/SpringModulithProjectGenerationConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
/* | ||
* Copyright 2012-2023 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 io.spring.start.site.extension.dependency.springmodulith; | ||
|
||
import io.spring.initializr.generator.condition.ConditionalOnRequestedDependency; | ||
import io.spring.initializr.generator.project.ProjectGenerationConfiguration; | ||
|
||
import org.springframework.context.annotation.Bean; | ||
|
||
/** | ||
* Registers {@link SpringModulithBuildCustomizer} with the context to allow selecting | ||
* Spring Modulith dependencies. | ||
* | ||
* @author Oliver Drotbohm | ||
*/ | ||
@ProjectGenerationConfiguration | ||
@ConditionalOnRequestedDependency("modulith") | ||
class SpringModulithProjectGenerationConfiguration { | ||
|
||
@Bean | ||
SpringModulithBuildCustomizer springModulithBuildCustomizer() { | ||
return new SpringModulithBuildCustomizer(); | ||
} | ||
|
||
} |
20 changes: 20 additions & 0 deletions
20
.../src/main/java/io/spring/start/site/extension/dependency/springmodulith/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
/* | ||
* Copyright 2012-2023 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. | ||
*/ | ||
|
||
/** | ||
* Extensions for generation of projects that depend on Spring Modulith. | ||
*/ | ||
package io.spring.start.site.extension.dependency.springmodulith; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
...ng/start/site/extension/dependency/springmodulith/SpringModulithBuildCustomizerTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
/* | ||
* Copyright 2012-2023 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 io.spring.start.site.extension.dependency.springmodulith; | ||
|
||
import java.util.Collection; | ||
|
||
import io.spring.initializr.generator.buildsystem.Build; | ||
import io.spring.initializr.generator.buildsystem.maven.MavenBuild; | ||
import io.spring.initializr.generator.version.Version; | ||
import io.spring.initializr.metadata.InitializrMetadata; | ||
import io.spring.initializr.metadata.support.MetadataBuildItemResolver; | ||
import io.spring.start.site.extension.AbstractExtensionTests; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.params.ParameterizedTest; | ||
import org.junit.jupiter.params.provider.MethodSource; | ||
import org.junit.jupiter.params.provider.ValueSource; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link SpringModulithBuildCustomizer}. | ||
* | ||
* @author Oliver Drotbohm | ||
*/ | ||
class SpringModulithBuildCustomizerTests extends AbstractExtensionTests { | ||
|
||
private final SpringModulithBuildCustomizer customizer = new SpringModulithBuildCustomizer(); | ||
|
||
@Test | ||
void registersCoreStarterByDefault() { | ||
Build build = createBuild(); | ||
this.customizer.customize(build); | ||
|
||
assertThat(build.dependencies().ids()).contains("modulith"); | ||
} | ||
|
||
@Test | ||
void registersTestStarterByDefault() { | ||
Build build = createBuild(); | ||
this.customizer.customize(build); | ||
|
||
assertThat(build.dependencies().ids()).contains("modulith-starter-test"); | ||
} | ||
|
||
@Test | ||
void registersActuatorStarterIfActuatorsIsPresent() { | ||
Build build = createBuild(); | ||
build.dependencies().add("actuator"); | ||
|
||
this.customizer.customize(build); | ||
|
||
assertThat(build.dependencies().ids()).contains("modulith-actuator"); | ||
} | ||
|
||
@ParameterizedTest | ||
@MethodSource("observabilityDependencies") | ||
void registersObservabilityStarterIfObservabilityDependencyIsPresent(String dependency) { | ||
Build build = createBuild(); | ||
build.dependencies().add(dependency); | ||
|
||
this.customizer.customize(build); | ||
|
||
assertThat(build.dependencies().ids()).contains("modulith-observability"); | ||
} | ||
|
||
@ParameterizedTest | ||
@ValueSource(strings = { "jdbc", "jpa", "mongodb" }) | ||
void presenceOfSpringDataModuleAddsModuleEventStarter(String store) { | ||
Build build = createBuild(); | ||
build.dependencies().add("data-" + store); | ||
|
||
this.customizer.customize(build); | ||
|
||
assertThat(build.dependencies().ids()).contains("modulith-starter-" + store); | ||
assertThat(build.boms().has("spring-modulith")); | ||
} | ||
|
||
private Build createBuild() { | ||
InitializrMetadata metadata = getMetadata(); | ||
|
||
Build build = new MavenBuild(new MetadataBuildItemResolver(metadata, getDefaultPlatformVersion(metadata))); | ||
build.dependencies().add("modulith"); | ||
|
||
return build; | ||
} | ||
|
||
private static Version getDefaultPlatformVersion(InitializrMetadata metadata) { | ||
return Version.parse(metadata.getBootVersions().getDefault().getId()); | ||
} | ||
|
||
private static Collection<String> observabilityDependencies() { | ||
return SpringModulithBuildCustomizer.OBSERVABILITY_DEPENDENCIES; | ||
} | ||
|
||
} |