GH-34 - Initial draft of an example project.

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

@@ -0,0 +1,42 @@
+/*
+ * 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 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-example/src/main/java/example/inventory/InventoryInternal.java

@@ -0,0 +1,24 @@
+/*
+ * 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 example.inventory;
+
+import org.springframework.stereotype.Component;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Component
+class InventoryInternal {}

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

@@ -0,0 +1,49 @@
+/*
+ * 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 example.inventory;
+
+import example.order.OrderCompleted;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class InventoryManagement {
+
+	private final InventoryInternal dependency;
+
+	@Async
+	@TransactionalEventListener
+	void on(OrderCompleted event) throws InterruptedException {
+
+		var orderId = event.getOrderId();
+
+		LOG.info("Received order completion for {}.", orderId);
+
+		// Simulate busy work
+		Thread.sleep(1000);
+
+		LOG.info("Finished order completion for {}.", orderId);
+	}
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 example.inventory;
+
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
+import lombok.Value;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.ConstructorBinding;
+
+/**
+ * Some Spring Boot configuration properties exposed by the inventory.
+ *
+ * @author Oliver Drotbohm
+ */
+@Value
+@RequiredArgsConstructor(access = AccessLevel.PACKAGE, onConstructor = @__(@ConstructorBinding))
+@ConfigurationProperties("example.inventory")
+class InventorySettings {
+
+	/**
+	 * Some Javadoc.
+	 */
+	int stockThreshold;
+}

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

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

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

@@ -0,0 +1,29 @@
+/*
+ * 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 example.order;
+
+import example.order.Order.OrderIdentifier;
+import lombok.Value;
+
+import org.jmolecules.event.types.DomainEvent;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Value
+public class OrderCompleted implements DomainEvent {
+	OrderIdentifier orderId;
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 example.order;
+
+import example.order.internal.OrderInternal;
+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 ApplicationEventPublisher events;
+	private final OrderInternal dependency;
+
+	@Transactional
+	public void complete(Order order) {
+		events.publishEvent(new OrderCompleted(order.getId()));
+	}
+}

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

@@ -0,0 +1,24 @@
+/*
+ * 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 example.order.internal;
+
+import org.springframework.stereotype.Component;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Component
+public class OrderInternal {}

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

@@ -0,0 +1,5 @@
+spring.jackson.constructor-detector=use-properties-based
+
+spring.jpa.show-sql=true
+
+logging.level.org.springframework.modulith=info

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

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+		<encoder>
+			<pattern>%d %5p %40.40c:%4L - %m%n</pattern>
+		</encoder>
+	</appender>
+
+	<logger name="org.moduliths" level="info" />
+	<logger name="example" level="info" />
+
+	<root level="error">
+		<appender-ref ref="console" />
+	</root>
+
+</configuration>

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

@@ -0,0 +1,42 @@
+/*
+ * 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 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-example/src/test/java/example/ModularityTests.java

@@ -0,0 +1,46 @@
+/*
+ * 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 example;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.modulith.docs.Documenter;
+import org.springframework.modulith.docs.Documenter.CanvasOptions;
+import org.springframework.modulith.docs.Documenter.Options;
+import org.springframework.modulith.model.ApplicationModules;
+
+/**
+ * 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() {
+
+		var canvasOptions = CanvasOptions.defaults();
+
+		new Documenter(modules) //
+				.writeDocumentation(Options.defaults(), canvasOptions);
+	}
+}

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

@@ -0,0 +1,66 @@
+/*
+ * 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 example.order;
+
+import static org.assertj.core.api.Assertions.*;
+
+import example.order.EventPublicationRegistryTests.FailingAsyncTransactionalEventListener;
+import lombok.RequiredArgsConstructor;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.context.annotation.Import;
+import org.springframework.modulith.events.EventPublicationRegistry;
+import org.springframework.modulith.test.ApplicationModuleTest;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+/**
+ * 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
+@RequiredArgsConstructor
+@Import(FailingAsyncTransactionalEventListener.class)
+@DirtiesContext
+class EventPublicationRegistryTests {
+
+	private final OrderManagement orders;
+	private final EventPublicationRegistry registry;
+
+	@Test
+	void leavesPublicationIncompleteForFailingListener() throws Exception {
+
+		var order = new Order();
+
+		orders.complete(order);
+
+		Thread.sleep(40);
+
+		assertThat(registry.findIncompletePublications()).hasSize(1);
+	}
+
+	static class FailingAsyncTransactionalEventListener {
+
+		@Async
+		@TransactionalEventListener
+		void foo(OrderCompleted event) {
+			throw new IllegalStateException();
+		}
+	}
+}

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

@@ -0,0 +1,47 @@
+/*
+ * 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 example.order;
+
+import static org.assertj.core.api.Assertions.*;
+
+import lombok.RequiredArgsConstructor;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.modulith.test.ApplicationModuleTest;
+import org.springframework.modulith.test.PublishedEvents;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@ApplicationModuleTest
+@RequiredArgsConstructor
+class OrderIntegrationTests {
+
+	private final OrderManagement orders;
+
+	@Test
+	void publishesOrderCompletion(PublishedEvents events) {
+
+		var reference = new Order();
+
+		orders.complete(reference);
+
+		assertThat(events.ofType(OrderCompleted.class))
+				.hasSize(1)
+				.element(0)
+				.extracting(OrderCompleted::getOrderId).isEqualTo(reference.getId());
+	}
+}