Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-189 - Better artifact names for example projects.

Browse Source
This commit is contained in:
Oliver Drotbohm
2023-05-02 14:36:57 +02:00
parent d7ef7c9dea
commit f0fb242b5b
45 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/asciidoc/index.adoc Normal file
View File

@@ -0,0 +1,16 @@
= Spring Modulith Example Documentation
:modulith-docs: ../../../target/spring-modulith-docs
== Overview
plantuml::{modulith-docs}/components.puml[format="svg"]
== Inventory
plantuml::{modulith-docs}/module-inventory.puml[format="svg"]
include::{modulith-docs}/module-inventory.adoc[]
== Orders
plantuml::{modulith-docs}/module-order.puml[format="svg"]
include::{modulith-docs}/module-order.adoc[]

29
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/Application.java Normal file
View File

@@ -0,0 +1,29 @@
/*
* Copyright 2022-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 example;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* Spring Modulith example application
*
* @author Oliver Drotbohm
*/
@SpringBootApplication
public class Application {
public static void main(String... args) {}
}

53
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/inventory/InventoryManagement.java Normal file
View File

@@ -0,0 +1,53 @@
/*
* Copyright 2022-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 example.inventory;
import example.order.OrderCompleted;
import lombok.RequiredArgsConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.modulith.ApplicationModuleListener;
import org.springframework.stereotype.Service;
/**
* A Spring {@link Service} exposed by the inventory module.
*
* @author Oliver Drotbohm
*/
@Service
@RequiredArgsConstructor
class InventoryManagement {
private static final Logger LOG = LoggerFactory.getLogger(InventoryManagement.class);
private final ApplicationEventPublisher events;
@ApplicationModuleListener
void on(OrderCompleted event) throws InterruptedException {
var orderId = event.orderId();
LOG.info("Received order completion for {}.", orderId);
// Simulate busy work
Thread.sleep(1000);
events.publishEvent(new InventoryUpdated(orderId));
LOG.info("Finished order completion for {}.", orderId);
}
}

23
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/inventory/InventoryUpdated.java Normal file
View File

@@ -0,0 +1,23 @@
/*
* Copyright 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 example.inventory;
import java.util.UUID;
/**
* @author Oliver Drotbohm
*/
public record InventoryUpdated(UUID orderId) {}

8
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/inventory/package-info.java Normal file
View File

@@ -0,0 +1,8 @@
/**
* The logical application module inventory implemented as a single-package module. Allows to hide application
* components inside the module by using package scoped types.
*
* @see example.inventory.InventoryInternal
*/
@org.springframework.lang.NonNullApi
package example.inventory;

25
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/order/OrderCompleted.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* Copyright 2022-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 example.order;
import java.util.UUID;
import org.jmolecules.event.types.DomainEvent;
/**
* @author Oliver Drotbohm
*/
public record OrderCompleted(UUID orderId) implements DomainEvent {}

40
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/order/OrderManagement.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* Copyright 2022-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 example.order;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import java.util.UUID;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
/**
* @author Oliver Drotbohm
*/
@Service
@RequiredArgsConstructor
public class OrderManagement {
private final @NonNull ApplicationEventPublisher events;
@Transactional
public void complete() {
events.publishEvent(new OrderCompleted(UUID.randomUUID()));
}
}

8
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/main/java/example/order/package-info.java Normal file
View File

@@ -0,0 +1,8 @@
/**
* The logical application module order implemented as a multi-package module. Internal components located in nested
* packages are prevented from being accessed by the {@link org.springframework.modulith.core.ApplicationModules} type.
*
* @see example.ModularityTests
*/
@org.springframework.lang.NonNullApi
package example.order;

83
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/test/java/example/ApplicationIntegrationTests.java Normal file
View File

@@ -0,0 +1,83 @@
/*
* Copyright 2022-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 example;
import example.inventory.InventoryUpdated;
import example.order.OrderManagement;
import java.util.Collection;
import org.bson.UuidRepresentation;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;
import org.springframework.modulith.events.EventPublicationRegistry;
import org.springframework.modulith.test.EnableScenarios;
import org.springframework.modulith.test.Scenario;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.junit.jupiter.Testcontainers;
import com.mongodb.ConnectionString;
import com.mongodb.MongoClientSettings;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
/**
* Integration test for the overall application.
*
* @author Oliver Drotbohm
*/
@SpringBootTest
@EnableScenarios
@Testcontainers(disabledWithoutDocker = true)
class ApplicationIntegrationTests {
@TestConfiguration
static class MongoDbInfrastructureConfiguration {
@Bean
@ServiceConnection
MongoDBContainer mongoDBContainer() {
return new MongoDBContainer("mongo:6.0.3");
}
@Bean
public MongoClient mongoClient(MongoDBContainer container) {
var settings = MongoClientSettings.builder()
.uuidRepresentation(UuidRepresentation.STANDARD)
.applyConnectionString(new ConnectionString(container.getReplicaSetUrl()))
.build();
return MongoClients.create(settings);
}
}
@Autowired OrderManagement orders;
@Autowired EventPublicationRegistry registry;
@Test
void bootstrapsApplication(Scenario scenario) throws Exception {
scenario.stimulate(() -> orders.complete())
.andWaitForStateChange(() -> registry.findIncompletePublications(), Collection::isEmpty)
.andExpect(InventoryUpdated.class)
.toArrive();
}
}

40
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/test/java/example/ModularityTests.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* Copyright 2022-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 example;
import org.junit.jupiter.api.Test;
import org.springframework.modulith.core.ApplicationModules;
import org.springframework.modulith.docs.Documenter;
/**
* Tests to verify the modular structure and generate documentation for the modules.
*
* @author Oliver Drotbohm
*/
class ModularityTests {
ApplicationModules modules = ApplicationModules.of(Application.class);
@Test
void verifiesModularStructure() {
modules.verify();
}
@Test
void createModuleDocumentation() {
new Documenter(modules).writeDocumentation();
}
}

16
spring-modulith-examples/spring-modulith-example-epr-mongodb/src/test/resources/logback.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="INFO">
<appender-ref ref="CONSOLE" />
</root>
<logger name="org.springframework.data.mongodb" level="DEBUG"/>
<logger name="org.springframework.modulith" level="DEBUG"/>
<logger name="com.github.dockerjava" level="WARN" />
<logger name="example" level="INFO" />
</configuration>