Add Health checks

Author: alfonsserra

pom.xml

@@ -6,7 +6,7 @@
 	<groupId>com.systelab</groupId>
 	<artifactId>seed</artifactId>
 	<packaging>war</packaging>
-	<version>2.0</version>
+	<version>2.1</version>
 	<name>seed</name>
 
 	<properties>

src/main/java/com/systelab/seed/SeedApplication.java

@@ -1,6 +1,7 @@
 package com.systelab.seed;
 
 import com.systelab.seed.infrastructure.auth.TokenAuthenticationFilter;
+import com.systelab.seed.resource.HealthResource;
 import com.systelab.seed.resource.PatientResource;
 import com.systelab.seed.resource.UserResource;
 import com.systelab.seed.util.security.CORSFilter;
@@ -38,6 +39,7 @@ public Set<Class<?>> getClasses() {
 
         resources.add(PatientResource.class);
         resources.add(UserResource.class);
+        resources.add(HealthResource.class);
 
         resources.add(CORSFilter.class);
         resources.add(TokenAuthenticationFilter.class);

src/main/java/com/systelab/seed/resource/HealthResource.java

@@ -0,0 +1,34 @@
+package com.systelab.seed.resource;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+
+import javax.annotation.security.PermitAll;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+@Api(value = "Health")
+
+@Path("health")
+@Produces({MediaType.TEXT_PLAIN})
+public class HealthResource {
+
+    @ApiOperation(value = "Check Health", notes = "")
+    @ApiResponses(value = {@ApiResponse(code = 200, message = "Healthy"), @ApiResponse(code = 500, message = "Internal Server Error")})
+
+    @GET
+    @PermitAll
+    public Response checkHealth() {
+        try {
+            return Response.ok().build();
+        } catch (Exception ex) {
+            return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build();
+        }
+    }
+
+}

src/test/java/com/systelab/seed/bdd/PatientSearchSteps.java

@@ -8,6 +8,8 @@
 import cucumber.api.java.en.Given;
 import cucumber.api.java.en.Then;
 import cucumber.api.java.en.When;
+import io.qameta.allure.Feature;
+import org.junit.jupiter.api.DisplayName;
 
 import java.util.ArrayList;
 import java.util.Date;
@@ -16,6 +18,9 @@
 /**
  * Class that defines the expected behavior for BDD Test following Gherkin language
  */
+
+@Feature("Cucumber Test Suite")
+@DisplayName("Cucumber Test Suite")
 public class PatientSearchSteps {
 
 	private Hospital hospital = new Hospital();

src/test/java/com/systelab/seed/client/HealthClient.java

@@ -0,0 +1,26 @@
+package com.systelab.seed.client;
+
+import com.systelab.seed.model.user.User;
+import io.qameta.allure.Step;
+
+import java.util.List;
+
+import javax.ws.rs.client.Entity;
+import javax.ws.rs.client.WebTarget;
+import javax.ws.rs.core.GenericType;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+public class HealthClient extends BaseClient {
+
+    public void getHealth() throws RequestException {
+        WebTarget target = getWebTarget().path("health");
+
+        Response response = target.request(MediaType.TEXT_PLAIN).get(Response.class);
+
+        if (response.getStatus() != 200) {
+            throw new RequestException(response.getStatus());
+        }
+    }
+}

src/test/java/com/systelab/seed/rest/SeedRestTest.java

@@ -1,5 +1,6 @@
 package com.systelab.seed.rest;
 
+import io.qameta.allure.Feature;
 import io.restassured.module.jsv.JsonSchemaValidator;
 import io.restassured.response.Response;
 import org.junit.jupiter.api.*;
@@ -15,6 +16,9 @@
  * Note: See FunctionalTest parent class to understand how to obtain the rest entry endpoint
  * Note: Consider to change the method naming to pass Codacy checks
  */
+
+@Feature("Rest Assured Test Suite")
+@DisplayName("Rest Assureddocker-compose  Test Suite")
 public class SeedRestTest extends FunctionalTest {
 
     @Test

src/test/java/com/systelab/seed/unit/HealthClientTest.java

@@ -0,0 +1,41 @@
+package com.systelab.seed.unit;
+
+import com.systelab.seed.TestUtil;
+import com.systelab.seed.client.HealthClient;
+import com.systelab.seed.client.RequestException;
+import io.qameta.allure.*;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+
+@TmsLink("TC0003_HealthManagement_IntegrationTest")
+@Feature("Check that the service is healthy by calling a REST endpoint.")
+@DisplayName("Health Check Test Suite")
+public class HealthClientTest extends BaseClientTest {
+
+    public static HealthClient clientForHealth;
+
+    @BeforeAll
+    public static void init() throws RequestException {
+        clientForHealth = new HealthClient();
+    }
+
+    @DisplayName("Get the Health status")
+    @Description("Action: Get the Health status and check that is OK.")
+    @Tag("health")
+    @Severity(SeverityLevel.BLOCKER)
+    @Test
+    public void testHealth() throws RequestException {
+
+        Exception caughtException = null;
+        try {
+            clientForHealth.getHealth();
+        } catch (Exception ex) {
+            caughtException = ex;
+        }
+        TestUtil.checkObjectIsNull("Exception", caughtException);
+    }
+
+}