Merge pull request #37 from bnc-projects/sonar-qube-code-analysis

Sonar qube code analysis

Author: alphafoobar

src/main/java/com/bnc/sbjb/model/api/CustomError.java

@@ -10,7 +10,7 @@ public class CustomError {
     private Instant timestamp;
     private String message;
 
-    private List<SubError> subErrors;
+    private List<ValidationError> subErrors;
 
     private CustomError() {
         timestamp = Instant.now();
@@ -46,11 +46,11 @@ public void setMessage(String message) {
         this.message = message;
     }
 
-    public List<SubError> getSubErrors() {
+    public List<ValidationError> getSubErrors() {
         return subErrors;
     }
 
-    public void setSubErrors(List<SubError> subErrors) {
+    public void setSubErrors(List<ValidationError> subErrors) {
         this.subErrors = subErrors;
     }
 }

src/main/java/com/bnc/sbjb/model/api/SubError.java

@@ -1,6 +1,6 @@
 package com.bnc.sbjb.model.api;
 
-public class ValidationError extends SubError {
+public class ValidationError {
 
     private String object;
     private String field;

src/main/java/com/bnc/sbjb/model/api/ValidationError.java

@@ -9,6 +9,12 @@
 @RequestMapping("${resource.path}")
 public class Controller {
 
+    @RequestMapping("/hello-error")
+    @ResponseStatus(HttpStatus.OK)
+    public String notYetWorld() {
+        throw new IllegalStateException("Hello World");
+    }
+
     @RequestMapping("/hello")
     @ResponseStatus(HttpStatus.OK)
     public String helloWorld() {

src/main/java/com/bnc/sbjb/rest/Controller.java

@@ -2,18 +2,20 @@
 
 import org.springframework.boot.web.servlet.error.ErrorController;
 import org.springframework.http.HttpStatus;
-import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 public class DefaultErrorController implements ErrorController {
 
     private static final String PATH = "/error";
 
+    @ResponseStatus(HttpStatus.NOT_FOUND)
     @RequestMapping(value = PATH)
-    public ResponseEntity<String> error() {
-        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+    public void error() {
+        // Blank method since we don't need to do anything to handle unknown paths.
+        // Any forked service may choose to handle some requests differently.
     }
 
     @Override

src/main/java/com/bnc/sbjb/rest/DefaultErrorController.java

@@ -0,0 +1,20 @@
+package com.bnc.sbjb.rest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ControllerAdvice
+public class DefaultExceptionHandler {
+
+    private static final Logger logger = LoggerFactory.getLogger(DefaultExceptionHandler.class);
+
+    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    @ExceptionHandler({Exception.class})
+    public void handleException(Exception exception) {
+        logger.warn("errorMessage=\"{}\"", exception.getMessage());
+    }
+}

src/main/java/com/bnc/sbjb/rest/DefaultExceptionHandler.java

@@ -1,6 +1,6 @@
 spring:
   application:
-    name: Spring Boot Java Base
+    name: spring-base
   main:
     banner-mode: "off"
   profiles:

src/main/java/com/bnc/sbjb/rest/ExceptionHandler.java

@@ -3,13 +3,13 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import java.time.Instant;
-import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.http.HttpStatus;
 
-public class CustomErrorTest {
+class CustomErrorTest {
 
     private CustomError customError;
 
@@ -39,8 +39,7 @@ void testMessageIdempotent() {
 
     @Test
     void testSubErrorIdempotent() {
-        List<SubError> errors = new ArrayList<SubError>();
-        errors.add(new TestSubError());
+        List<ValidationError> errors = Collections.singletonList(new ValidationError("test", "test"));
         customError.setSubErrors(errors);
         assertThat(customError.getSubErrors().size()).isEqualTo(1);
     }