Merge branch 'feature/fix_tests'

open-schnick · open-schnick · commit 973c04499795 · 2020-10-11T20:18:24.000+02:00
# Conflicts:
#	.run/RestApplication.run.xml
#	src/test/java/de/filefighter/rest/RestApplicationTests.java
diff --git a/.run/TESTS.run.xml b/.run/TESTS.run.xml
@@ -0,0 +1,28 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="TESTS" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="clean" />
+              <option value="test" />
+            </list>
+          </option>
+          <option name="pomFileName" value="pom.xml" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/src/main/java/de/filefighter/rest/config/SwaggerConfiguration.java b/src/main/java/de/filefighter/rest/config/SwaggerConfiguration.java
@@ -30,7 +30,7 @@ private ApiInfo apiInfo() {
                 "REST-API of the FileFighter application.",
                 "0.1",
                 "terms of service url",
-                new Contact("FileFighter Dev-Team", "https://github.com/filefighter/", "comming soon"),
+                new Contact("FileFighter Dev-Team", "https://github.com/filefighter/", "filefighter@t-online.de"),
                 "MIT License",
                 "https://github.com/filefighter/restapi/blob/master/LICENSE",
                 Collections.emptyList()
diff --git a/src/main/java/de/filefighter/rest/health/business/SystemHealthBusinessService.java b/src/main/java/de/filefighter/rest/health/business/SystemHealthBusinessService.java
@@ -8,12 +8,20 @@
 @Service
 public class SystemHealthBusinessService {
 
-    private final long serverStartedAt = Instant.now().getEpochSecond();
+    private final long serverStartedAt;
+
+    public SystemHealthBusinessService() {
+        this.serverStartedAt = this.getCurrentEpochSeconds();
+    }
 
     public SystemHealth getCurrentSystemHealthInfo(){
-        long currentEpoch = Instant.now().getEpochSecond();
+        long currentEpoch = getCurrentEpochSeconds();
         return SystemHealth.builder()
                 .uptimeInSeconds(currentEpoch - serverStartedAt)
                 .create();
     }
+
+    public long getCurrentEpochSeconds(){
+        return Instant.now().getEpochSecond();
+    }
 }
diff --git a/src/main/java/de/filefighter/rest/health/business/SystemHealthModelAssembler.java b/src/main/java/de/filefighter/rest/health/business/SystemHealthModelAssembler.java
@@ -1,7 +1,7 @@
 package de.filefighter.rest.health.business;
 
 import de.filefighter.rest.health.data.SystemHealth;
-import de.filefighter.rest.health.rest.HealthRestController;
+import de.filefighter.rest.health.rest.SystemHealthRestController;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.hateoas.EntityModel;
 import org.springframework.hateoas.server.RepresentationModelAssembler;
@@ -16,6 +16,6 @@ public class SystemHealthModelAssembler implements RepresentationModelAssembler<
     @Override
     public @NotNull EntityModel<SystemHealth> toModel(@NotNull SystemHealth entity) {
         return EntityModel.of(entity,
-                linkTo(methodOn(HealthRestController.class).getSystemHealthInfo()).withSelfRel());
+                linkTo(methodOn(SystemHealthRestController.class).getSystemHealthInfo()).withSelfRel());
     }
 }
diff --git a/src/main/java/de/filefighter/rest/health/data/SystemHealth.java b/src/main/java/de/filefighter/rest/health/data/SystemHealth.java
@@ -1,10 +1,14 @@
 package de.filefighter.rest.health.data;
 
 import lombok.Builder;
-import lombok.Data;
+import lombok.Getter;
 
-@Data
+/**
+ * This class is a representation of the json model.
+ */
+
+@Getter
 @Builder(buildMethodName = "create")
 public class SystemHealth {
-    private long uptimeInSeconds;
+    private final long uptimeInSeconds;
 }
diff --git a/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestController.java b/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestController.java
@@ -4,16 +4,15 @@
 import io.swagger.annotations.Api;
 import org.springframework.hateoas.EntityModel;
 import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 @Api(value = "System Health", tags = { "SystemHealth" })
-public class HealthRestController {
+public class SystemHealthRestController {
 
-    private final HealthRestInterface healthRestService;
+    private final SystemHealthRestInterface healthRestService;
 
-    public HealthRestController(HealthRestInterface healthRestService) {
+    public SystemHealthRestController(SystemHealthRestInterface healthRestService) {
         this.healthRestService = healthRestService;
     }
 
diff --git a/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestInterface.java b/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestInterface.java
@@ -3,6 +3,6 @@
 import de.filefighter.rest.health.data.SystemHealth;
 import org.springframework.hateoas.EntityModel;
 
-public interface HealthRestInterface {
+public interface SystemHealthRestInterface {
     EntityModel<SystemHealth> getSystemHealth();
 }
diff --git a/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestService.java b/src/main/java/de/filefighter/rest/health/rest/SystemHealthRestService.java
@@ -7,12 +7,12 @@
 import org.springframework.stereotype.Service;
 
 @Service
-public class HealthRestService implements HealthRestInterface{
+public class SystemHealthRestService implements SystemHealthRestInterface {
 
     private final SystemHealthBusinessService systemHealthBusinessService;
     private final SystemHealthModelAssembler systemHealthModelAssembler;
 
-    public HealthRestService(SystemHealthBusinessService systemHealthBusinessService, SystemHealthModelAssembler systemHealthModelAssembler) {
+    public SystemHealthRestService(SystemHealthBusinessService systemHealthBusinessService, SystemHealthModelAssembler systemHealthModelAssembler) {
         this.systemHealthBusinessService = systemHealthBusinessService;
         this.systemHealthModelAssembler = systemHealthModelAssembler;
     }
diff --git a/src/main/java/de/filefighter/rest/rest/RestErrorController.java b/src/main/java/de/filefighter/rest/rest/RestErrorController.java
@@ -10,15 +10,15 @@
 @RestController
 public class RestErrorController implements ErrorController {
 
-    private static final String DEFAULT_PATH = "/error";
+    public static final String DEFAULT_ERROR_PATH = "/error";
 
-    @RequestMapping(value = DEFAULT_PATH)
+    @RequestMapping(value = DEFAULT_ERROR_PATH)
     public EntityModel<ServerResponse> error() {
         return new ServerResponse("denied", "This endpoint does not exist.").toModel();
     }
 
     @Override
     public String getErrorPath() {
-        return DEFAULT_PATH;
+        return DEFAULT_ERROR_PATH;
     }
 }
diff --git a/src/main/java/de/filefighter/rest/rest/ServerResponse.java b/src/main/java/de/filefighter/rest/rest/ServerResponse.java
@@ -1,12 +1,13 @@
 package de.filefighter.rest.rest;
 
 import lombok.Data;
+import lombok.Getter;
 import org.springframework.hateoas.EntityModel;
 
-@Data
+@Getter
 public class ServerResponse {
-    private String message;
-    private String status;
+    private final String message;
+    private final String status;
 
     public ServerResponse(String status, String message) {
         this.status = status;
diff --git a/src/test/java/de/filefighter/rest/RestApplicationTests.java b/src/test/java/de/filefighter/rest/RestApplicationTests.java
@@ -0,0 +1,15 @@
+/*package de.filefighter.rest;
+
+import org.junit.Ignore;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class RestApplicationTests {
+
+	@Test
+	void contextLoads() {
+	}
+
+}
+ */
diff --git a/src/test/java/de/filefighter/rest/health/business/SystemHealthBusinessServiceUnitTest.java b/src/test/java/de/filefighter/rest/health/business/SystemHealthBusinessServiceUnitTest.java
@@ -0,0 +1,32 @@
+package de.filefighter.rest.health.business;
+
+import de.filefighter.rest.health.data.SystemHealth;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import java.time.Instant;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class SystemHealthBusinessServiceUnitTest {
+
+    private static SystemHealthBusinessService systemHealthBusinessService;
+
+    @BeforeAll
+    static void setUp() {
+        systemHealthBusinessService = new SystemHealthBusinessService();
+    }
+
+    @Test
+    void getCurrentSystemHealthInfo() {
+        SystemHealth systemHealth = systemHealthBusinessService.getCurrentSystemHealthInfo();
+        assertEquals(0, systemHealth.getUptimeInSeconds());
+    }
+
+    @Test
+    void getCurrentEpochSecondsReturnsEpochSeconds() {
+        long expectedSeconds = Instant.now().getEpochSecond();
+        long epochSeconds = systemHealthBusinessService.getCurrentEpochSeconds();
+        assertEquals(expectedSeconds, epochSeconds);
+    }
+}
diff --git a/src/test/java/de/filefighter/rest/health/business/SystemHealthModelAssemblerUnitTest.java b/src/test/java/de/filefighter/rest/health/business/SystemHealthModelAssemblerUnitTest.java
@@ -0,0 +1,28 @@
+package de.filefighter.rest.health.business;
+
+import de.filefighter.rest.health.data.SystemHealth;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.hateoas.EntityModel;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class SystemHealthModelAssemblerUnitTest {
+
+    private static SystemHealthModelAssembler systemHealthModelAssembler;
+
+    @BeforeAll
+    static void setUp(){
+        systemHealthModelAssembler = new SystemHealthModelAssembler();
+    }
+
+    @Test
+    void toModel() {
+        SystemHealth systemHealth = SystemHealth.builder().uptimeInSeconds(420).create();
+        EntityModel<SystemHealth> systemHealthEntityModel = systemHealthModelAssembler.toModel(systemHealth);
+
+        assertEquals(systemHealth, systemHealthEntityModel.getContent());
+        assertTrue(systemHealthEntityModel.getLink("self").isPresent());
+        assertTrue(systemHealthEntityModel.getLink("thislinkdoesnotexist").isEmpty());
+    }
+}
diff --git a/src/test/java/de/filefighter/rest/health/rest/HealthRestServiceUnitTest.java b/src/test/java/de/filefighter/rest/health/rest/HealthRestServiceUnitTest.java
@@ -0,0 +1,37 @@
+package de.filefighter.rest.health.rest;
+
+import de.filefighter.rest.health.business.SystemHealthBusinessService;
+import de.filefighter.rest.health.business.SystemHealthModelAssembler;
+import de.filefighter.rest.health.data.SystemHealth;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.hateoas.EntityModel;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class HealthRestServiceUnitTest {
+
+    private static final SystemHealthBusinessService systemHealthBusinessServiceMock = mock(SystemHealthBusinessService.class);
+    private static final SystemHealthModelAssembler systemHealthModelAssemblerMock = mock(SystemHealthModelAssembler.class);
+    private static SystemHealthRestService systemHealthRestService;
+
+    @BeforeAll
+    public static void setUp() {
+        systemHealthRestService = new SystemHealthRestService(systemHealthBusinessServiceMock, systemHealthModelAssemblerMock);
+    }
+
+    @Test
+    void getSystemHealth() {
+        SystemHealth dummyHealth = SystemHealth.builder().uptimeInSeconds(420).create();
+        EntityModel<SystemHealth> actualModell = EntityModel.of(dummyHealth);
+
+        when(systemHealthBusinessServiceMock.getCurrentSystemHealthInfo()).thenReturn(dummyHealth);
+        when(systemHealthModelAssemblerMock.toModel(dummyHealth)).thenReturn(actualModell);
+
+        EntityModel<SystemHealth> expectedModel = systemHealthRestService.getSystemHealth();
+
+        assertEquals(expectedModel, actualModell);
+    }
+}
diff --git a/src/test/java/de/filefighter/rest/health/rest/SystemHealthRestControllerUnitTest.java b/src/test/java/de/filefighter/rest/health/rest/SystemHealthRestControllerUnitTest.java
@@ -0,0 +1,36 @@
+package de.filefighter.rest.health.rest;
+
+import de.filefighter.rest.rest.RestErrorController;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.isA;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.mockito.Mockito.*;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+class SystemHealthRestControllerUnitTest {
+
+    private static MockMvc mockMvc;
+    private static SystemHealthRestService systemHealthRestServiceMock = mock(SystemHealthRestService.class);
+    private static SystemHealthRestController systemHealthRestController;
+
+    @BeforeAll
+    public static void setUp() {
+        systemHealthRestController = new SystemHealthRestController(systemHealthRestServiceMock);
+        mockMvc = MockMvcBuilders.standaloneSetup(systemHealthRestController).build();
+    }
+
+    @Test
+    void getSystemHealthInfo() throws Exception {
+        mockMvc.perform(get("/health"))
+                .andExpect(status().isOk())
+                .andReturn();
+
+        verify(systemHealthRestServiceMock, times(1)).getSystemHealth();
+    }
+}
diff --git a/src/test/java/de/filefighter/rest/rest/RestErrorControllerUnitTest.java b/src/test/java/de/filefighter/rest/rest/RestErrorControllerUnitTest.java
@@ -0,0 +1,41 @@
+package de.filefighter.rest.rest;
+
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+
+import static org.hamcrest.Matchers.is;
+import static org.springframework.test.web.client.match.MockRestRequestMatchers.jsonPath;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+class RestErrorControllerUnitTest {
+
+    private static MockMvc mockMvc;
+    private static RestErrorController restErrorController;
+
+    @BeforeAll
+    static void setUp() {
+        restErrorController = new RestErrorController();
+        mockMvc = MockMvcBuilders.standaloneSetup(restErrorController).build();
+    }
+
+    @Test
+    void errorHandleingDoesWork() throws Exception {
+        mockMvc.perform(get(RestErrorController.DEFAULT_ERROR_PATH))
+                .andExpect(status().isOk())
+                .andReturn();
+    }
+
+    @Test
+    void getErrorPath() {
+        String expectedPath = RestErrorController.DEFAULT_ERROR_PATH;
+        String actualPath = restErrorController.getErrorPath();
+
+        assertEquals(expectedPath, actualPath);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@`
`3`	`3`	`import de.filefighter.rest.health.data.SystemHealth;`
`4`	`4`	`import org.springframework.hateoas.EntityModel;`
`5`	`5`
`6`		`-public interface HealthRestInterface {`
	`6`	`+public interface SystemHealthRestInterface {`
`7`	`7`	`EntityModel<SystemHealth> getSystemHealth();`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,15 +10,15 @@`
`10`	`10`	`@RestController`
`11`	`11`	`public class RestErrorController implements ErrorController {`
`12`	`12`
`13`		`- private static final String DEFAULT_PATH = "/error";`
	`13`	`+ public static final String DEFAULT_ERROR_PATH = "/error";`
`14`	`14`
`15`		`- @RequestMapping(value = DEFAULT_PATH)`
	`15`	`+ @RequestMapping(value = DEFAULT_ERROR_PATH)`
`16`	`16`	`public EntityModel<ServerResponse> error() {`
`17`	`17`	`return new ServerResponse("denied", "This endpoint does not exist.").toModel();`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`@Override`
`21`	`21`	`public String getErrorPath() {`
`22`		`- return DEFAULT_PATH;`
	`22`	`+ return DEFAULT_ERROR_PATH;`
`23`	`23`	`}`
`24`	`24`	`}`