Merge pull request #10 from companieshouse/feature/DSND-1631-expose-put-endpoint

Expose PUT endpoint and save to mongo

Author: EmrysRoberts

.gitignore

@@ -22,3 +22,7 @@
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 /target/
+
+# IntelliJ files
+.idea/
+*.iml

Makefile

@@ -30,6 +30,10 @@ test: test-unit
 test-unit:
 	mvn test
 
+.PHONY: coverage
+coverage:
+	mvn verify
+
 .PHONY: package
 package:
 ifndef version
@@ -45,7 +49,7 @@ endif
 	rm -rf $(tmpdir)
 
 .PHONY: dist
-dist: clean package
+dist: clean build package coverage
 
 .PHONY: publish
 publish:

pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>uk.gov.companieshouse</groupId>
         <artifactId>companies-house-parent</artifactId>
-        <version>1.3.0</version>
+        <version>1.3.1</version>
         <relativePath />
     </parent>
     <artifactId>psc-data-api</artifactId>
@@ -22,6 +22,24 @@
         <maven.compiler.target>${java.version}</maven.compiler.target>
         <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
         <jib-maven-plugin.version>3.1.1</jib-maven-plugin.version>
+        <jacoco-maven-plugin.version>0.8.5</jacoco-maven-plugin.version>
+
+        <!-- Internal -->
+        <structured-logging.version>1.9.12</structured-logging.version>
+        <private-api-sdk-java.version>2.0.237</private-api-sdk-java.version>
+        <api-sdk-manager-java-library.version>1.0.4</api-sdk-manager-java-library.version>
+        <api-helper-java-library.version>1.4.5</api-helper-java-library.version>
+
+        <!-- tests -->
+        <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
+        <jib-maven-plugin.version>3.1.1</jib-maven-plugin.version>
+        <io-cucumber.version>7.2.3</io-cucumber.version>
+        <test-containers.version>1.16.3</test-containers.version>
+        <maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
+        <assertj-core.version>3.22.0</assertj-core.version>
+        <skip.integration.tests>false</skip.integration.tests>
+        <skip.unit.tests>false</skip.unit.tests>
+        <maven-resources-plugin.version>2.5</maven-resources-plugin.version>
 
         <!--sonar configuration-->
         <sonar.coverage.jacoco.xmlReportPaths>${project.basedir}/target/site/jacoco/jacoco.xml,
@@ -38,6 +56,13 @@
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
+            <dependency>
+                <groupId>org.testcontainers</groupId>
+                <artifactId>testcontainers-bom</artifactId>
+                <version>${test-containers.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>
@@ -53,12 +78,48 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-mongodb</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.apache.logging.log4j</groupId>
+                    <artifactId>log4j-to-slf4j</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+        <dependency>
+            <groupId>uk.gov.companieshouse</groupId>
+            <artifactId>structured-logging</artifactId>
+            <version>${structured-logging.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>uk.gov.companieshouse</groupId>
+            <artifactId>private-api-sdk-java</artifactId>
+            <version>${private-api-sdk-java.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>uk.gov.companieshouse</groupId>
+            <artifactId>api-sdk-manager-java-library</artifactId>
+            <version>${api-sdk-manager-java-library.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>uk.gov.companieshouse</groupId>
+            <artifactId>api-helper-java</artifactId>
+            <version>${api-helper-java-library.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -129,6 +190,59 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
+                <version>${jacoco-maven-plugin.version}</version>
+                <configuration>
+                    <excludes>
+                        <exclude>**/models/*.class</exclude>
+                    </excludes>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>pre-unit-test</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                        <configuration>
+                            <!-- Sets the path to the file which contains the execution model. -->
+                            <destFile>${sonar.jacoco.reports}/jacoco.exec</destFile>
+                            <propertyName>surefireArgLine</propertyName>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>post-unit-test</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                        <configuration>
+                            <dataFile>${sonar.jacoco.reports}/jacoco.exec</dataFile>
+                            <outputDirectory>${sonar.jacoco.reports}/jacoco</outputDirectory>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>pre-integration-test</id>
+                        <phase>pre-integration-test</phase>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                        <configuration>
+                            <!-- Sets the path to the file which contains the execution model. -->
+                            <destFile>${sonar.jacoco.reports}/jacoco-it.exec</destFile>
+                            <propertyName>failsafeArgLine</propertyName>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>post-integration-test</id>
+                        <phase>post-integration-test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                        <configuration>
+                            <dataFile>${sonar.jacoco.reports}/jacoco-it.exec</dataFile>
+                            <outputDirectory>${sonar.jacoco.reports}/jacoco-it</outputDirectory>
+                        </configuration>
+                    </execution>
+                </executions>
             </plugin>
             <plugin>
                 <groupId>org.sonarsource.scanner.maven</groupId>

routes.yaml

@@ -0,0 +1,6 @@
+app_name: psc-data-api
+group: api
+weight: 905
+routes:
+  1: ^/persons-with-significant-control/healthcheck
+  2: ^/company/(.*)/persons-with-significant-control/(.*)/full_record

src/main/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplication.java

@@ -5,6 +5,7 @@
 
 @SpringBootApplication
 public class PscDataApiApplication {
+    public static final String APPLICATION_NAME_SPACE = "psc-data-api";
 
     public static void main(String[] args) {
         SpringApplication.run(PscDataApiApplication.class, args);

src/main/java/uk/gov/companieshouse/pscdataapi/config/ApplicationConfig.java

@@ -0,0 +1,57 @@
+package uk.gov.companieshouse.pscdataapi.config;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+
+import java.time.LocalDate;
+import java.time.OffsetDateTime;
+import java.util.List;
+import java.util.function.Supplier;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
+import uk.gov.companieshouse.pscdataapi.converter.CompanyPscReadConverter;
+import uk.gov.companieshouse.pscdataapi.converter.CompanyPscWriteConverter;
+import uk.gov.companieshouse.pscdataapi.serialization.LocalDateDeSerializer;
+import uk.gov.companieshouse.pscdataapi.serialization.LocalDateSerializer;
+
+@Configuration
+public class ApplicationConfig {
+
+    /**
+     * mongoCustomConversions.
+     *
+     * @return MongoCustomConversions.
+     */
+    @Bean
+    public MongoCustomConversions mongoCustomConversions() {
+        ObjectMapper objectMapper = mongoDbObjectMapper();
+        return new MongoCustomConversions(List.of(new CompanyPscWriteConverter(objectMapper),
+                new CompanyPscReadConverter(objectMapper)));
+    }
+
+    @Bean
+    public Supplier<String> offsetDateTimeGenerator() {
+        return () -> String.valueOf(OffsetDateTime.now());
+    }
+
+    /**
+     * Mongo DB Object Mapper.
+     *
+     * @return ObjectMapper.
+     */
+    private ObjectMapper mongoDbObjectMapper() {
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+        objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
+        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        SimpleModule module = new SimpleModule();
+        module.addSerializer(LocalDate.class, new LocalDateSerializer());
+        module.addDeserializer(LocalDate.class, new LocalDateDeSerializer());
+        objectMapper.registerModule(module);
+        return objectMapper;
+    }
+}

src/main/java/uk/gov/companieshouse/pscdataapi/config/ExceptionHandlerConfig.java

@@ -0,0 +1,133 @@
+package uk.gov.companieshouse.pscdataapi.config;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeParseException;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.dao.DataAccessException;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.web.HttpRequestMethodNotSupportedException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.context.request.WebRequest;
+import uk.gov.companieshouse.logging.Logger;
+import uk.gov.companieshouse.pscdataapi.exceptions.BadRequestException;
+import uk.gov.companieshouse.pscdataapi.exceptions.MethodNotAllowedException;
+import uk.gov.companieshouse.pscdataapi.exceptions.ServiceUnavailableException;
+
+@ControllerAdvice
+public class ExceptionHandlerConfig {
+    private final Logger logger;
+
+    @Autowired
+    public ExceptionHandlerConfig(Logger logger) {
+        this.logger = logger;
+    }
+
+    private static final String TIMESTAMP = "timestamp";
+    private static final String MESSAGE = "message";
+    private static final String EXCEPTION_ATTRIBUTE = "javax.servlet.error.exception";
+
+    /**
+     * Runtime exception handler. Acts as the catch-all scenario.
+    *
+    * @param ex      exception to handle.
+    * @param request request.
+    * @return error response to return.
+    */
+    @ExceptionHandler(value = {Exception.class})
+    public ResponseEntity<Object> handleException(Exception ex, WebRequest request) {
+        logger.error(String.format("Unexpected exception, response code: %s",
+                HttpStatus.INTERNAL_SERVER_ERROR), ex);
+
+        Map<String, Object> responseBody = new LinkedHashMap<>();
+        responseBody.put(TIMESTAMP, LocalDateTime.now());
+        responseBody.put(MESSAGE, "Unable to process the request.");
+        request.setAttribute(EXCEPTION_ATTRIBUTE, ex, 0);
+        return new ResponseEntity<>(responseBody, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    /**
+     * IllegalArgumentException exception handler.
+    *
+    * @param ex      exception to handle.
+    * @param request request.
+    * @return error response to return.
+    */
+    @ExceptionHandler(value = {IllegalArgumentException.class})
+    public ResponseEntity<Object> handleNotFoundException(Exception ex, WebRequest request) {
+        logger.error(String.format("Resource not found, response code: %s",
+                HttpStatus.NOT_FOUND), ex);
+
+        Map<String, Object> responseBody = new LinkedHashMap<>();
+        responseBody.put(TIMESTAMP, LocalDateTime.now());
+        responseBody.put(MESSAGE, "Resource not found.");
+        request.setAttribute(EXCEPTION_ATTRIBUTE, ex, 0);
+        return new ResponseEntity<>(responseBody, HttpStatus.NOT_FOUND);
+    }
+
+    /**
+     * MethodNotAllowedException exception handler.
+    *
+    * @param ex      exception to handle.
+    * @param request request.
+    * @return error response to return.
+    */
+    @ExceptionHandler(value = {MethodNotAllowedException.class,
+            HttpRequestMethodNotSupportedException.class})
+    public ResponseEntity<Object> handleMethodNotAllowedException(
+            Exception ex, WebRequest request) {
+        logger.error(String.format("Unable to process the request, response code: %s",
+                HttpStatus.METHOD_NOT_ALLOWED), ex);
+
+        Map<String, Object> responseBody = new LinkedHashMap<>();
+        responseBody.put(TIMESTAMP, LocalDateTime.now());
+        responseBody.put(MESSAGE, "Unable to process the request.");
+        request.setAttribute(EXCEPTION_ATTRIBUTE, ex, 0);
+        return new ResponseEntity<>(responseBody, HttpStatus.METHOD_NOT_ALLOWED);
+    }
+
+    /**
+     * ServiceUnavailableException exception handler.
+    * To be thrown when there are connection issues.
+    *
+    * @param ex      exception to handle.
+    * @param request request.
+    * @return error response to return.
+    */
+    @ExceptionHandler(value = {ServiceUnavailableException.class, DataAccessException.class})
+    public ResponseEntity<Object> handleServiceUnavailableException(Exception ex,
+                                                                    WebRequest request) {
+        logger.error(String.format("Service unavailable, response code: %s",
+                HttpStatus.SERVICE_UNAVAILABLE), ex);
+
+        Map<String, Object> responseBody = new LinkedHashMap<>();
+        responseBody.put(TIMESTAMP, LocalDateTime.now());
+        responseBody.put(MESSAGE, "Service unavailable.");
+        request.setAttribute(EXCEPTION_ATTRIBUTE, ex, 0);
+        return new ResponseEntity<>(responseBody, HttpStatus.SERVICE_UNAVAILABLE);
+    }
+
+    /**
+     * BadRequestException exception handler.
+    * Thrown when data is given in the wrong format.
+    *
+    * @param ex      exception to handle.
+    * @param request request.
+    * @return error response to return.
+    */
+    @ExceptionHandler(value = {BadRequestException.class, DateTimeParseException.class,
+            HttpMessageNotReadableException.class})
+    public ResponseEntity<Object> handleBadRequestException(Exception ex, WebRequest request) {
+        logger.error(String.format("Bad request, response code: %s", HttpStatus.BAD_REQUEST), ex);
+
+        Map<String, Object> responseBody = new LinkedHashMap<>();
+        responseBody.put(TIMESTAMP, LocalDateTime.now());
+        responseBody.put(MESSAGE, "Bad request.");
+        request.setAttribute(EXCEPTION_ATTRIBUTE, ex, 0);
+        return new ResponseEntity<>(responseBody, HttpStatus.BAD_REQUEST);
+    }
+}