Refactor, adjust documentation

README.md

@@ -17,9 +17,11 @@ An example of a Spring-Boot application, which based on the port and adapters/he
 
 ## Implementing new adapter
 
-The key concept is that the component scan for the adapter package is excluded in the application, so the unnecessary adapter beans won't be loaded into the application context, just the configured ones.
+The whole component scan for the adapter package is excluded in the application, so the unnecessary adapter beans won't be loaded into the application context, just the configured ones.
 Each adapter defines her own spring configuration class, which is imported via the **@Import** annotation (on top of the application's main class) but getting only component scanned if the condition fulfills for it via **@ConditionalOnProperty** annotation.
 
+Based on the below example if you define "spring-data-jpa" value as a persistence adapter in the application-[profile].yml, 
+then it will activate the corresponding Configuration class, which is going to component scan the underlying packages for spring beans.
 
 ### Example
 
@@ -45,9 +47,30 @@ adapter:
   web: rest
 ```
 
+## Build and test with Maven
+```
+mvn clean verify
+```
+
+**Building and verifying the application requires a running docker, since some tests are using
+Testcontainers library!
+
+
+### Test catalog and Maven lifecycle bindings
+
+| Test catalog type | Maven lifecycle |
+|:-----------------:|:---------------:|
+|     Unit test     |      test       |
+|  Component test   |      test       |
+|   ArchUnit test   |      test       |
+| Integration test  |     verify      |
+|  Functional test  |     verify      |
+
 ## API Documentation
+You can access the API documentation locally at the following URL:
+
+[http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html)
 
-You can access the live API documentation at http://localhost:8080/swagger-ui/index.html
 
 ![Preview](img/openapi-swagger-ui.PNG)
 

app/pom.xml

@@ -26,6 +26,9 @@
         <testcontainers.version>1.17.6</testcontainers.version>
         <postgresql.version>42.5.4</postgresql.version>
         <springdoc-openapi-starter-webmvc-ui.version>2.1.0</springdoc-openapi-starter-webmvc-ui.version>
+        <junit-jupiter.version>1.18.3</junit-jupiter.version>
+        <spring-boot-maven-plugin.mainClass>hu.hirannor.hexagonal.HexagonalApplication
+        </spring-boot-maven-plugin.mainClass>
     </properties>
 
     <dependencies>
@@ -98,6 +101,14 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>${junit-jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+
         <dependency>
             <groupId>com.tngtech.archunit</groupId>
             <artifactId>archunit-junit5</artifactId>
@@ -121,7 +132,7 @@
                 <artifactId>spring-boot-maven-plugin</artifactId>
                 <version>${spring-boot.version}</version>
                 <configuration>
-                    <mainClass>hu.hirannor.hexagonal.HexagonalApplication</mainClass>
+                    <mainClass>${spring-boot-maven-plugin.mainClass}</mainClass>
                 </configuration>
                 <executions>
                     <execution>

app/src/main/java/hu/hirannor/hexagonal/adapter/authentication/basic/BasicAuthenticationConfiguration.java

@@ -4,7 +4,6 @@
 import org.springframework.context.annotation.*;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
-import org.springframework.security.config.annotation.web.configurers.HeadersConfigurer;
 import org.springframework.security.core.userdetails.*;
 import org.springframework.security.provisioning.InMemoryUserDetailsManager;
 import org.springframework.security.web.SecurityFilterChain;

app/src/main/java/hu/hirannor/hexagonal/adapter/persistence/jpa/customer/CustomerJpaRepository.java

@@ -69,11 +69,11 @@ class CustomerJpaRepository implements CustomerRepository {
     public Customer updateDetails(final Customer domain) {
         if (domain == null) throw new IllegalArgumentException(ERR_CUSTOMER_IS_NULL);
 
-        LOGGER.debug("Changing customer details for customer value: {}", domain.customerId());
+        LOGGER.debug("Changing customer details for customer id: {}", domain.customerId());
 
         final CustomerModel model = customers.findByCustomerId(domain.customerId().asText())
                 .orElseThrow(
-                        () -> new CustomerNotFound("Customer not found with value: " + domain)
+                        () -> new CustomerNotFound("Customer not found with id: " + domain)
                 );
 
         final CustomerModel modifiedCustomer = CustomerModeller.applyChangesFrom(domain).to(model);
@@ -86,7 +86,7 @@ public Customer updateDetails(final Customer domain) {
     public void deleteBy(final CustomerId id) {
         if (id == null) throw new IllegalArgumentException(ERR_CUSTOMER_ID_IS_NULL);
 
-        LOGGER.debug("Attempting to delete customer by value: {}", id);
+        LOGGER.debug("Attempting to delete customer by id: {}", id);
 
         customers.deleteByCustomerId(id.asText());
     }
@@ -111,7 +111,7 @@ public List<Customer> findAllBy(final FilterCriteria criteria) {
     public Optional<Customer> findBy(final CustomerId id) {
         if (id == null) throw new IllegalArgumentException(ERR_CUSTOMER_ID_IS_NULL);
 
-        LOGGER.debug("Fetching customer by value: {}", id);
+        LOGGER.debug("Fetching customer by id: {}", id);
 
         return customers.findByCustomerId(id.value())
                 .map(mapModelToDomain);

app/src/main/java/hu/hirannor/hexagonal/adapter/web/rest/customer/CustomerManagementController.java

@@ -10,10 +10,10 @@
 import hu.hirannor.hexagonal.domain.customer.query.FilterCriteria;
 import hu.hirannor.hexagonal.infrastructure.adapter.DriverAdapter;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.net.URI;
 import java.time.LocalDate;
 import java.util.List;
 import java.util.Optional;
@@ -28,11 +28,8 @@
 @DriverAdapter
 class CustomerManagementController implements CustomersApi {
 
-    private static final String BASE_PATH = "/customers/";
-
     private final Function<Customer, CustomerModel> mapCustomerToModel;
     private final Function<RegisterCustomerModel, RegisterCustomer> mapRegisterCustomerToModel;
-    private final Function<AddressModel, Address> mapAddressModelToDomain;
     private final Function<GenderModel, Gender> mapGenderModelToDomain;
 
     private final CustomerDisplay customers;
@@ -52,7 +49,6 @@ class CustomerManagementController implements CustomersApi {
                 deletion,
                 CustomerMappingFactory.createCustomerToModelMapper(),
                 CustomerMappingFactory.createRegisterCustomerModelToDomainMapper(),
-                CustomerMappingFactory.createAddressModelToAddressMapper(),
                 CustomerMappingFactory.createGenderModelToDomainMapper()
         );
     }
@@ -63,24 +59,24 @@ class CustomerManagementController implements CustomersApi {
                                  final CustomerDeletion deletion,
                                  final Function<Customer, CustomerModel> mapCustomerToModel,
                                  final Function<RegisterCustomerModel, RegisterCustomer> mapRegisterCustomerToModel,
-                                 final Function<AddressModel, Address> mapAddressModelToDomain,
                                  final Function<GenderModel, Gender> mapGenderModelToDomain) {
         this.customers = customers;
         this.details = details;
         this.deletion = deletion;
         this.enrolling = enrolling;
         this.mapCustomerToModel = mapCustomerToModel;
         this.mapRegisterCustomerToModel = mapRegisterCustomerToModel;
-        this.mapAddressModelToDomain = mapAddressModelToDomain;
         this.mapGenderModelToDomain = mapGenderModelToDomain;
     }
 
     @Override
     public ResponseEntity<CustomerModel> changeDetails(final String customerId,
                                                        final ChangeCustomerDetailsModel model) {
-        final ChangeCustomerDetails cmd = assembleCommand(customerId, model);
+        final ChangeCustomerDetails cmd = CustomerMappingFactory
+                .createChangeCustomerDetailsModelToDomainMapper(customerId)
+                .apply(model);
 
-        final Customer changedCustomer = details.changeDetailsBy(cmd);
+        final Customer changedCustomer = details.changeBy(cmd);
         final CustomerModel response = mapCustomerToModel.apply(changedCustomer);
 
         return ResponseEntity.ok(response);
@@ -127,20 +123,7 @@ public ResponseEntity<CustomerModel> register(final RegisterCustomerModel model)
         final RegisterCustomer cmd = mapRegisterCustomerToModel.apply(model);
         final Customer registeredCustomer = enrolling.register(cmd);
 
-        return ResponseEntity.created(
-                URI.create(BASE_PATH + registeredCustomer.customerId().asText())
-        ).body(mapCustomerToModel.apply(registeredCustomer));
+        return new ResponseEntity<>(mapCustomerToModel.apply(registeredCustomer), HttpStatus.CREATED);
     }
 
-    private ChangeCustomerDetails assembleCommand(final String customerId,
-                                                  final ChangeCustomerDetailsModel model) {
-        return new ChangeCustomerDetails.Builder()
-                .customerId(CustomerId.from(customerId))
-                .fullName(FullName.from(model.getFirstName(), model.getLastName()))
-                .gender(mapGenderModelToDomain.apply(model.getGender()))
-                .birthDate(model.getBirthDate())
-                .address(mapAddressModelToDomain.apply(model.getAddress()))
-                .email(EmailAddress.from(model.getEmailAddress()))
-                .assemble();
-    }
 }

app/src/main/java/hu/hirannor/hexagonal/adapter/web/rest/customer/mapping/ChangeCustomerDetailsModelToDomainMapper.java

@@ -0,0 +1,49 @@
+package hu.hirannor.hexagonal.adapter.web.rest.customer.mapping;
+
+import hu.hirannor.hexagonal.adapter.web.rest.customer.model.*;
+import hu.hirannor.hexagonal.domain.customer.*;
+import hu.hirannor.hexagonal.domain.customer.command.ChangeCustomerDetails;
+
+import java.util.function.Function;
+
+/**
+ * Maps a {@link ChangeCustomerDetailsModel} model type to {@link ChangeCustomerDetails} domain type.
+ *
+ * @author Mate Karolyi
+ */
+class ChangeCustomerDetailsModelToDomainMapper implements Function<ChangeCustomerDetailsModel, ChangeCustomerDetails> {
+
+    private final String customerId;
+
+    private final Function<GenderModel, Gender> mapGenderModelToDomain;
+    private final Function<AddressModel, Address> mapAddressModelToDomain;
+
+    ChangeCustomerDetailsModelToDomainMapper(final String customerId) {
+        this(
+                customerId,
+                CustomerMappingFactory.createGenderModelToDomainMapper(),
+                CustomerMappingFactory.createAddressModelToAddressMapper()
+        );
+    }
+
+    ChangeCustomerDetailsModelToDomainMapper(final String customerId,
+                                             final Function<GenderModel, Gender> mapGenderModelToDomain,
+                                             final Function<AddressModel, Address> mapAddressModelToDomain) {
+        this.customerId = customerId;
+        this.mapGenderModelToDomain = mapGenderModelToDomain;
+        this.mapAddressModelToDomain = mapAddressModelToDomain;
+    }
+
+
+    @Override
+    public ChangeCustomerDetails apply(final ChangeCustomerDetailsModel model) {
+        return new ChangeCustomerDetails.Builder()
+                .customerId(CustomerId.from(customerId))
+                .fullName(FullName.from(model.getFirstName(), model.getLastName()))
+                .gender(mapGenderModelToDomain.apply(model.getGender()))
+                .birthDate(model.getBirthDate())
+                .address(mapAddressModelToDomain.apply(model.getAddress()))
+                .email(EmailAddress.from(model.getEmailAddress()))
+                .assemble();
+    }
+}

app/src/main/java/hu/hirannor/hexagonal/adapter/web/rest/customer/mapping/CustomerMappingFactory.java

@@ -2,6 +2,7 @@
 
 import hu.hirannor.hexagonal.adapter.web.rest.customer.model.*;
 import hu.hirannor.hexagonal.domain.customer.*;
+import hu.hirannor.hexagonal.domain.customer.command.ChangeCustomerDetails;
 import hu.hirannor.hexagonal.domain.customer.command.RegisterCustomer;
 
 import java.util.function.Function;
@@ -53,4 +54,16 @@ static Function<AddressModel, Address> createAddressModelToAddressMapper() {
         return new AddressModelToDomainMapper();
     }
 
+    /**
+     * Create an instance of {@link ChangeCustomerDetailsModelToDomainMapper},
+     * which maps a {@link ChangeCustomerDetailsModel} model type
+     * to a {@link ChangeCustomerDetails} domain type.
+     *
+     * @return an instance of {@link ChangeCustomerDetailsModelToDomainMapper}
+     */
+    static Function<ChangeCustomerDetailsModel, ChangeCustomerDetails> createChangeCustomerDetailsModelToDomainMapper(
+            final String customerId) {
+        return new ChangeCustomerDetailsModelToDomainMapper(customerId);
+    }
+
 }

app/src/main/java/hu/hirannor/hexagonal/application/service/CustomerManagementService.java

@@ -50,7 +50,7 @@ class CustomerManagementService implements
     }
 
     @Override
-    public Customer changeDetailsBy(final ChangeCustomerDetails cmd) {
+    public Customer changeBy(final ChangeCustomerDetails cmd) {
         if (cmd == null) throw new IllegalArgumentException("ChangeCustomerDetails command cannot be null!");
 
         final Customer foundCustomer = customers.findBy(cmd.customerId())
@@ -64,7 +64,7 @@ public Customer changeDetailsBy(final ChangeCustomerDetails cmd) {
         messages.publish(updatedCustomer.listEvents());
         updatedCustomer.clearEvents();
 
-        LOGGER.info("Customer details for customer value: {} are updated successfully!", updatedCustomer.customerId());
+        LOGGER.info("Customer details for customer id: {} are updated successfully!", updatedCustomer.customerId());
 
         return updatedCustomer;
     }
@@ -78,7 +78,7 @@ public void deleteBy(final CustomerId customerId) {
                         () -> new CustomerNotFound(String.format(ERR_CUSTOMER_NOT_FOUND, customerId.asText()))
                 );
 
-        LOGGER.info("Attempting to delete customer by value: {}", customerId.asText());
+        LOGGER.info("Attempting to delete customer by id: {}", customerId.asText());
 
         customers.deleteBy(customerId);
     }
@@ -96,7 +96,7 @@ public List<Customer> displayAllBy(final FilterCriteria criteria) {
     public Optional<Customer> displayBy(final CustomerId customerId) {
         if (customerId == null) throw new IllegalArgumentException(ERR_CUSTOMER_ID_IS_NULL);
 
-        LOGGER.info("Retrieving customer by value: {}", customerId);
+        LOGGER.info("Retrieving customer by id: {}", customerId);
 
         return customers.findBy(customerId);
     }

app/src/main/java/hu/hirannor/hexagonal/application/usecase/CustomerModification.java

@@ -16,5 +16,5 @@ public interface CustomerModification {
      * @param cmd {@link ChangeCustomerDetails} including the modifications
      * @return {@link Customer} customer with modified details
      */
-    Customer changeDetailsBy(ChangeCustomerDetails cmd);
+    Customer changeBy(ChangeCustomerDetails cmd);
 }

app/src/main/resources/adapter/persistence/bundle-init.xml

@@ -7,7 +7,4 @@
     <!-- DDL -->
     <include file="adapter/persistence/ddl/customers-ddl-1.0.0.xml"/>
 
-    <!-- DML -->
-    <include file="adapter/persistence/dml/customers-demo-dml-1.0.0.xml"/>
-
 </databaseChangeLog>

app/src/main/resources/application.yml

@@ -1,6 +1,8 @@
 logging:
   level:
     root: INFO
+  file:
+    path: logs
 
 spring:
   h2: