feat: rest-adapter

{{cookiecutter.app_name}}/pom.xml

@@ -37,7 +37,8 @@
     <module>domain-api</module>
     <module>domain</module>
     <module>jpa-adapter</module>
-    <!--<module>rest-adapter</module>
+    <module>rest-adapter</module>
+    <!--
     <module>bootstrap</module>
     <module>acceptance-test</module>-->
   </modules>
@@ -55,10 +56,15 @@
         <version>${project.version}</version>
       </dependency>
       <dependency>
-        <groupId>packagename</groupId>
+        <groupId>{{cookiecutter.group_id}}</groupId>
         <artifactId>jpa-adapter</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>{{cookiecutter.group_id}}</groupId>
+        <artifactId>rest-adapter</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <!-- Frameworks & Libraries -->
       <dependency>
         <groupId>net.lbruun.springboot</groupId>

{{cookiecutter.app_name}}/rest-adapter/pom.xml

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <parent>
+    <groupId>{{cookiecutter.group_id}}</groupId>
+    <artifactId>{{cookiecutter.artifact_id}}-parent</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>rest-adapter</artifactId>
+  <dependencies>
+    <!-- Domain -->
+    <dependency>
+      <groupId>{{cookiecutter.group_id}}</groupId>
+      <artifactId>domain-api</artifactId>
+    </dependency>
+    <!-- Frameworks & Libraries -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.yaml</groupId>
+      <artifactId>snakeyaml</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.springdoc</groupId>
+      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+      <version>${springdoc-openapi-starter.version}</version>
+    </dependency>
+    <!-- Test -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.openapitools</groupId>
+        <artifactId>openapi-generator-maven-plugin</artifactId>
+        <version>7.9.0</version>
+        <executions>
+          <execution>
+            <id>generate-open-api-source</id>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+            <configuration>
+              <inputSpec>${project.basedir}/src/main/resources/open-api.yaml</inputSpec>
+              <generatorName>spring</generatorName>
+              <library>spring-boot</library>
+              <schemaMappings>
+                <schemaMapping>{{cookiecutter.domain_capitalized}}={{cookiecutter.package_name}}.domain.model.{{cookiecutter.domain_capitalized}}</schemaMapping>
+              </schemaMappings>
+              <typeMappings>
+                <typeMapping>OffsetDateTime=java.time.LocalDateTime</typeMapping>
+              </typeMappings>
+              <apiPackage>{{cookiecutter.package_name}}.rest.generated.api</apiPackage>
+              <modelPackage>{{cookiecutter.package_name}}.rest.generated.model</modelPackage>
+              <configOptions>
+                <useBeanValidation>false</useBeanValidation>
+                <performBeanValidation>false</performBeanValidation>
+                <useSpringBoot3>true</useSpringBoot3>
+                <interfaceOnly>true</interfaceOnly>
+                <dateLibrary>java8</dateLibrary>
+                <useTags>true</useTags>
+                <openApiNullable>false</openApiNullable>
+                <additionalModelTypeAnnotations>@lombok.AllArgsConstructor @lombok.Builder @lombok.Data @lombok.NoArgsConstructor
+                </additionalModelTypeAnnotations>
+              </configOptions>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>com.societegenerale.commons</groupId>
+        <artifactId>arch-unit-maven-plugin</artifactId>
+        <configuration>
+          <rules>
+            <preConfiguredRules>
+              <rule>com.societegenerale.commons.plugin.rules.NoJunitAssertRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoPowerMockRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoTestIgnoreRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoTestIgnoreWithoutCommentRuleTest
+              </rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoStandardStreamRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoJodaTimeRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoJavaUtilDateRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoPrefixForInterfacesRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoPublicFieldRuleTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoInjectedFieldTest</rule>
+              <rule>com.societegenerale.commons.plugin.rules.NoAutowiredFieldTest</rule>
+            </preConfiguredRules>
+          </rules>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

{{cookiecutter.app_name}}/rest-adapter/src/main/java/{{cookiecutter.package_name}}/rest/exception/{{cookiecutter.domain_capitalized}}ExceptionHandler.java

@@ -0,0 +1,30 @@
+package {{cookiecutter.package_name}}.rest.exception;
+
+import java.time.LocalDateTime;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.ServletWebRequest;
+import org.springframework.web.context.request.WebRequest;
+import {{cookiecutter.package_name}}.domain.exception.{{cookiecutter.domain_capitalized}}NotFoundException;
+import {{cookiecutter.package_name}}.rest.generated.model.ProblemDetail;
+
+@RestControllerAdvice(basePackages = {"{{cookiecutter.package_name}}"})
+public class {{cookiecutter.domain_capitalized}}ExceptionHandler {
+
+  @ExceptionHandler(value = {{cookiecutter.domain_capitalized}}NotFoundException.class)
+  public final ResponseEntity<ProblemDetail> handle{{cookiecutter.domain_capitalized}}NotFoundException(
+      final Exception exception, final WebRequest request) {
+    var problem =
+        ProblemDetail.builder()
+            .type("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404")
+            .status(HttpStatus.NOT_FOUND.value())
+            .title("{{cookiecutter.domain_capitalized}} not found")
+            .detail(exception.getMessage())
+            .instance(((ServletWebRequest) request).getRequest().getRequestURI())
+            .timestamp(LocalDateTime.now())
+            .build();
+    return ResponseEntity.status(HttpStatus.NOT_FOUND).body(problem);
+  }
+}

{{cookiecutter.app_name}}/rest-adapter/src/main/java/{{cookiecutter.package_name}}/rest/{{cookiecutter.domain_capitalized}}Resource.java

@@ -0,0 +1,27 @@
+package {{cookiecutter.package_name}}.rest;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+import {{cookiecutter.package_name}}.domain.model.{{cookiecutter.domain_capitalized}};
+import {{cookiecutter.package_name}}.domain.port.Request{{cookiecutter.domain_capitalized}};
+import {{cookiecutter.package_name}}.rest.generated.api.{{cookiecutter.domain_capitalized}}Api;
+import {{cookiecutter.package_name}}.rest.generated.model.{{cookiecutter.domain_capitalized}}Info;
+
+@RestController
+public class {{cookiecutter.domain_capitalized}}Resource implements {{cookiecutter.domain_capitalized}}Api {
+
+  private final Request{{cookiecutter.domain_capitalized}} request{{cookiecutter.domain_capitalized}};
+
+  public {{cookiecutter.domain_capitalized}}Resource(Request{{cookiecutter.domain_capitalized}} request{{cookiecutter.domain_capitalized}}) {
+    this.request{{cookiecutter.domain_capitalized}} = request{{cookiecutter.domain_capitalized}};
+  }
+
+  public ResponseEntity<{{cookiecutter.domain_capitalized}}Info> get{{cookiecutter.domain_plural_capitalized}}() {
+    return ResponseEntity.ok({{cookiecutter.domain_capitalized}}Info.builder().{{cookiecutter.domain_plural}}(request{{cookiecutter.domain_capitalized}}.get{{cookiecutter.domain_plural_capitalized}}()).build());
+  }
+
+  public ResponseEntity<{{cookiecutter.domain_capitalized}}> get{{cookiecutter.domain_capitalized}}ByCode(@PathVariable("code") Long code) {
+    return ResponseEntity.ok(request{{cookiecutter.domain_capitalized}}.get{{cookiecutter.domain_capitalized}}ByCode(code));
+  }
+}

{{cookiecutter.app_name}}/rest-adapter/src/main/resources/open-api.yaml

@@ -0,0 +1,76 @@
+---
+openapi: 3.0.1
+info:
+  title: {{cookiecutter.domain_capitalized}} API Documentation
+  version: v1
+tags:
+  - name: {{cookiecutter.domain_capitalized}}
+    description: Resource to manage {{cookiecutter.domain}}
+paths:
+  "/api/v1/{{cookiecutter.domain_plural}}":
+    get:
+      tags:
+        - {{cookiecutter.domain_capitalized}}
+      summary: Get all {{cookiecutter.domain_plural}}
+      operationId: get{{cookiecutter.domain_plural_capitalized}}
+      responses:
+        '200':
+          description: OK
+          content:
+            "*/*":
+              schema:
+                "$ref": "#/components/schemas/{{cookiecutter.domain_capitalized}}Info"
+  "/api/v1/{{cookiecutter.domain_plural}}/{code}":
+    get:
+      tags:
+        - {{cookiecutter.domain_capitalized}}
+      summary: Get {{cookiecutter.domain}} by code
+      operationId: get{{cookiecutter.domain_capitalized}}ByCode
+      parameters:
+        - name: code
+          in: path
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: OK
+          content:
+            "*/*":
+              schema:
+                "$ref": "#/components/schemas/{{cookiecutter.domain_capitalized}}"
+components:
+  schemas:
+    {{cookiecutter.domain_capitalized}}:
+      type: object
+      properties:
+        code:
+          type: integer
+          format: int64
+        description:
+          type: string
+    {{cookiecutter.domain_capitalized}}Info:
+      type: object
+      properties:
+        {{cookiecutter.domain_plural}}:
+          type: array
+          items:
+            "$ref": "#/components/schemas/{{cookiecutter.domain_capitalized}}"
+    ProblemDetail:
+      type: object
+      properties:
+        type:
+          type: string
+        title:
+          type: string
+        status:
+          type: integer
+          format: int32
+        detail:
+          type: string
+        instance:
+          type: string
+        timestamp:
+          type: string
+          format: date-time

{{cookiecutter.app_name}}/rest-adapter/src/test/java/{{cookiecutter.package_name}}/rest/{{cookiecutter.domain_capitalized}}ResourceTest.java

@@ -0,0 +1,111 @@
+package {{cookiecutter.package_name}}.rest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.within;
+import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
+
+import java.time.LocalDateTime;
+import java.time.temporal.ChronoUnit;
+import java.util.List;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.http.HttpStatus;
+import {{cookiecutter.package_name}}.domain.exception.{{cookiecutter.domain_capitalized}}NotFoundException;
+import {{cookiecutter.package_name}}.domain.model.{{cookiecutter.domain_capitalized}};
+import {{cookiecutter.package_name}}.domain.port.Request{{cookiecutter.domain_capitalized}};
+import {{cookiecutter.package_name}}.rest.generated.model.{{cookiecutter.domain_capitalized}}Info;
+import {{cookiecutter.package_name}}.rest.generated.model.ProblemDetail;
+
+@ExtendWith(MockitoExtension.class)
+@SpringBootTest(classes = {{cookiecutter.domain_capitalized}}RestAdapterApplication.class, webEnvironment = RANDOM_PORT)
+@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class})
+public class {{cookiecutter.domain_capitalized}}ResourceTest {
+
+  private static final String LOCALHOST = "http://localhost:";
+  private static final String API_URI = "/api/v1/{{cookiecutter.domain_plural}}";
+  @LocalServerPort private int port;
+  @Autowired private TestRestTemplate restTemplate;
+  @Autowired private Request{{cookiecutter.domain_capitalized}} request{{cookiecutter.domain_capitalized}};
+
+  @Test
+  @DisplayName("should start the rest adapter application")
+  public void startup() {
+    assertThat(Boolean.TRUE).isTrue();
+  }
+
+  @Test
+  @DisplayName("should give {{cookiecutter.domain_plural}} when asked for {{cookiecutter.domain_plural}} with the support of domain stub")
+  public void obtain{{cookiecutter.domain_plural_capitalized}}FromDomainStub() {
+    // Given
+    var {{cookiecutter.domain}} = {{cookiecutter.domain_capitalized}}.builder().code(1L).description("Johnny Johnny Yes Papa !!").build();
+    Mockito.lenient().when(request{{cookiecutter.domain_capitalized}}.get{{cookiecutter.domain_plural_capitalized}}()).thenReturn(List.of({{cookiecutter.domain}}));
+    // When
+    var url = LOCALHOST + port + API_URI;
+    var responseEntity = restTemplate.getForEntity(url, {{cookiecutter.domain_capitalized}}Info.class);
+    // Then
+    assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
+    assertThat(responseEntity.getBody()).isNotNull();
+    assertThat(responseEntity.getBody().get{{cookiecutter.domain_plural_capitalized}}())
+        .isNotEmpty()
+        .extracting("description")
+        .contains("Johnny Johnny Yes Papa !!");
+  }
+
+  @Test
+  @DisplayName(
+      "should give the {{cookiecutter.domain}} when asked for an {{cookiecutter.domain}} by code with the support of domain stub")
+  public void obtain{{cookiecutter.domain_capitalized}}ByCodeFromDomainStub() {
+    // Given
+    var code = 1L;
+    var description = "Johnny Johnny Yes Papa !!";
+    var {{cookiecutter.domain}} = {{cookiecutter.domain_capitalized}}.builder().code(code).description(description).build();
+    Mockito.lenient().when(request{{cookiecutter.domain_capitalized}}.get{{cookiecutter.domain_capitalized}}ByCode(code)).thenReturn({{cookiecutter.domain}});
+    // When
+    var url = LOCALHOST + port + API_URI + "/" + code;
+    var responseEntity = restTemplate.getForEntity(url, {{cookiecutter.domain_capitalized}}.class);
+    // Then
+    assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
+    assertThat(responseEntity.getBody()).isNotNull();
+    assertThat(responseEntity.getBody()).isEqualTo({{cookiecutter.domain}});
+  }
+
+  @Test
+  @DisplayName(
+      "should give exception when asked for an {{cookiecutter.domain}} by code that does not exists with the support of domain stub")
+  public void shouldGiveExceptionWhenAskedForAn{{cookiecutter.domain_capitalized}}ByCodeFromDomainStub() {
+    // Given
+    var code = -1000L;
+    Mockito.lenient()
+        .when(request{{cookiecutter.domain_capitalized}}.get{{cookiecutter.domain_capitalized}}ByCode(code))
+        .thenThrow(new {{cookiecutter.domain_capitalized}}NotFoundException(code));
+    // When
+    var url = LOCALHOST + port + API_URI + "/" + code;
+    var responseEntity = restTemplate.getForEntity(url, ProblemDetail.class);
+    // Then
+    var expectedProblemDetail =
+        ProblemDetail.builder()
+            .type("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404")
+            .status(HttpStatus.NOT_FOUND.value())
+            .detail("{{cookiecutter.domain_capitalized}} with code -1000 does not exist")
+            .instance("/api/v1/{{cookiecutter.domain_plural}}/-1000")
+            .title("{{cookiecutter.domain_capitalized}} not found")
+            .build();
+    assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND);
+    assertThat(responseEntity.getBody()).isNotNull();
+    assertThat(responseEntity.getBody())
+        .usingRecursiveComparison()
+        .ignoringFields("timestamp")
+        .isEqualTo(expectedProblemDetail);
+    assertThat(responseEntity.getBody().getTimestamp())
+        .isCloseTo(LocalDateTime.now(), within(100L, ChronoUnit.SECONDS));
+  }
+}

{{cookiecutter.app_name}}/rest-adapter/src/test/java/{{cookiecutter.package_name}}/rest/{{cookiecutter.domain_capitalized}}RestAdapterApplication.java

@@ -0,0 +1,18 @@
+package {{cookiecutter.package_name}}.rest;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.context.annotation.ComponentScan;
+import {{cookiecutter.package_name}}.domain.port.Request{{cookiecutter.domain_capitalized}};
+
+@SpringBootApplication
+@ComponentScan(basePackages = "{{cookiecutter.package_name}}")
+public class {{cookiecutter.domain_capitalized}}RestAdapterApplication {
+
+  @MockBean private Request{{cookiecutter.domain_capitalized}} request{{cookiecutter.domain_capitalized}};
+
+  public static void main(String[] args) {
+    SpringApplication.run({{cookiecutter.domain_capitalized}}RestAdapterApplication.class, args);
+  }
+}