GH-189 - Better artifact names for example projects.

spring-modulith-examples/spring-modulith-example-full/src/main/asciidoc/index.adoc

@@ -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[]

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/Application.java

@@ -0,0 +1,42 @@
+/*
+ * 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.order.Order;
+import example.order.OrderManagement;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+import org.springframework.scheduling.annotation.EnableAsync;
+
+/**
+ * Spring Modulith example application
+ *
+ * @author Oliver Drotbohm
+ */
+@EnableAsync
+@SpringBootApplication
+@ConfigurationPropertiesScan
+public class Application {
+
+	public static void main(String... args) throws Exception {
+
+		SpringApplication.run(Application.class, args)
+				.getBean(OrderManagement.class)
+				.complete(new Order());
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/inventory/InventoryInternal.java

@@ -0,0 +1,27 @@
+/*
+ * 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 org.springframework.stereotype.Component;
+
+/**
+ * Some inventory-internal application component. As it is located in the very same package, it can be protected from
+ * access by other modules by using the default visibility instead of making it public.
+ *
+ * @author Oliver Drotbohm
+ */
+@Component
+class InventoryInternal {}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/inventory/InventoryManagement.java

@@ -0,0 +1,51 @@
+/*
+ * 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.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 InventoryInternal dependency;
+
+	@ApplicationModuleListener
+	void on(OrderCompleted event) throws InterruptedException {
+
+		var orderId = event.orderId();
+
+		LOG.info("Received order completion for {}.", orderId);
+
+		// Simulate busy work
+		Thread.sleep(1000);
+
+		LOG.info("Finished order completion for {}.", orderId);
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/inventory/InventorySettings.java

@@ -0,0 +1,36 @@
+/*
+ * 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 org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * Some Spring Boot configuration properties exposed by the inventory.
+ *
+ * @author Oliver Drotbohm
+ */
+@ConfigurationProperties("example.inventory")
+record InventorySettings(int stockThreshold) {
+
+	/**
+	 * Some Javadoc.
+	 *
+	 * @return
+	 */
+	public int stockThreshold() {
+		return stockThreshold;
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/inventory/package-info.java

@@ -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;

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/order/Order.java

@@ -0,0 +1,34 @@
+/*
+ * 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 example.order.Order.OrderIdentifier;
+import lombok.Getter;
+
+import java.util.UUID;
+
+import org.jmolecules.ddd.types.AggregateRoot;
+import org.jmolecules.ddd.types.Identifier;
+
+/**
+ * @author Oliver Drotbohm
+ */
+public class Order implements AggregateRoot<Order, OrderIdentifier> {
+
+	private @Getter OrderIdentifier id = new OrderIdentifier(UUID.randomUUID());
+
+	public static record OrderIdentifier(UUID id) implements Identifier {}
+}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/order/OrderCompleted.java

@@ -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 example.order.Order.OrderIdentifier;
+
+import org.jmolecules.event.types.DomainEvent;
+
+/**
+ * @author Oliver Drotbohm
+ */
+public record OrderCompleted(OrderIdentifier orderId) implements DomainEvent {}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/order/OrderManagement.java

@@ -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 example.order.internal.OrderInternal;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+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;
+	private final @NonNull OrderInternal dependency;
+
+	@Transactional
+	public void complete(Order order) {
+		events.publishEvent(new OrderCompleted(order.getId()));
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/order/internal/OrderInternal.java

@@ -0,0 +1,27 @@
+/*
+ * 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.internal;
+
+import org.springframework.stereotype.Component;
+
+/**
+ * Some order-internal application component. Referring to it from the inventory module would be captured by
+ * {@link example.ModularityTests}.
+ *
+ * @author Oliver Drotbohm
+ */
+@Component
+public class OrderInternal {}

spring-modulith-examples/spring-modulith-example-full/src/main/java/example/order/package-info.java

@@ -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;

spring-modulith-examples/spring-modulith-example-full/src/main/resources/application.properties

@@ -0,0 +1,3 @@
+spring.jpa.show-sql=true
+
+management.endpoints.web.exposure.include=health,applicationmodules

spring-modulith-examples/spring-modulith-example-full/src/main/resources/logback.xml

@@ -0,0 +1,14 @@
+<?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.modulith" level="DEBUG"/>
+	<logger name="example" level="INFO" />
+	
+</configuration>

spring-modulith-examples/spring-modulith-example-full/src/test/java/example/ApplicationIntegrationTests.java

@@ -0,0 +1,42 @@
+/*
+ * 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.order.Order;
+import example.order.OrderManagement;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+/**
+ * Integration test for the overall application.
+ *
+ * @author Oliver Drotbohm
+ */
+@SpringBootTest
+class ApplicationIntegrationTests {
+
+	@Autowired OrderManagement orders;
+
+	@Test
+	void completesOrder() throws Exception {
+
+		orders.complete(new Order());
+
+		Thread.sleep(2000);
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/test/java/example/ModularityTests.java

@@ -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();
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/test/java/example/order/EventPublicationRegistryTests.java

@@ -0,0 +1,78 @@
+/*
+ * 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 static org.assertj.core.api.Assertions.*;
+
+import example.order.EventPublicationRegistryTests.FailingAsyncTransactionalEventListener;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.context.annotation.Import;
+import org.springframework.modulith.ApplicationModuleListener;
+import org.springframework.modulith.events.EventPublicationRegistry;
+import org.springframework.modulith.test.ApplicationModuleTest;
+import org.springframework.modulith.test.Scenario;
+import org.springframework.test.annotation.DirtiesContext;
+
+/**
+ * A show case for how the Spring Modulith application event publication registry keeps track of incomplete publications
+ * for failing transactional event listeners
+ *
+ * @author Oliver Drotbohm
+ */
+@ApplicationModuleTest
+@Import(FailingAsyncTransactionalEventListener.class)
+@DirtiesContext
+@RequiredArgsConstructor
+class EventPublicationRegistryTests {
+
+	private final OrderManagement orders;
+	private final EventPublicationRegistry registry;
+	private final FailingAsyncTransactionalEventListener listener;
+
+	@Test
+	void leavesPublicationIncompleteForFailingListener(Scenario scenario) throws Exception {
+
+		var order = new Order();
+
+		scenario.stimulate(() -> orders.complete(order))
+				.andWaitForStateChange(() -> listener.getEx())
+				.andVerify(__ -> {
+					assertThat(registry.findIncompletePublications()).hasSize(1);
+				});
+	}
+
+	static class FailingAsyncTransactionalEventListener {
+
+		@Getter Exception ex;
+
+		@ApplicationModuleListener
+		void foo(OrderCompleted event) {
+
+			var exception = new IllegalStateException("¯\\_(ツ)_/¯");
+
+			try {
+
+				throw exception;
+
+			} finally {
+				this.ex = exception;
+			}
+		}
+	}
+}

spring-modulith-examples/spring-modulith-example-full/src/test/java/example/order/OrderIntegrationTests.java

@@ -0,0 +1,43 @@
+/*
+ * 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.RequiredArgsConstructor;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.modulith.test.ApplicationModuleTest;
+import org.springframework.modulith.test.Scenario;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@ApplicationModuleTest
+@RequiredArgsConstructor
+class OrderIntegrationTests {
+
+	private final OrderManagement orders;
+
+	@Test
+	void publishesOrderCompletion(Scenario scenario) {
+
+		var reference = new Order();
+
+		scenario.stimulate(() -> orders.complete(reference))
+				.andWaitForEventOfType(OrderCompleted.class)
+				.matchingMappedValue(OrderCompleted::orderId, reference.getId())
+				.toArrive();
+	}
+}