DSND-3203: Make healthcheck private (#158)

* DSND-3203: Make healthcheck not public * DSND-3203: Address vulnerable deps * DSND-3203: Remove fixing vulnerable transitive dep * Upgrading this transitive dep breaks the service and is out of scope for this ticket. * Service needs a major refactor.
companieshouse · Dec 18, 2024 · 2a695ef · 2a695ef
1 parent 8b250dd
commit 2a695ef
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 33 deletions.
diff --git a/pom.xml b/pom.xml
@@ -61,6 +61,7 @@
             </dependency>
         </dependencies>
     </dependencyManagement>
+
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -126,6 +127,10 @@
                     <groupId>org.codehaus.plexus</groupId>
                     <artifactId>plexus-utils</artifactId>
                 </exclusion>
+                <exclusion>
+                    <groupId>org.sonarsource.scanner.maven</groupId>
+                    <artifactId>sonar-maven-plugin</artifactId>
+                </exclusion>
             </exclusions>
         </dependency>
         <dependency>

diff --git a/src/main/java/uk/gov/companieshouse/pscdataapi/controller/HealthCheckController.java b/src/main/java/uk/gov/companieshouse/pscdataapi/controller/HealthCheckController.java
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -1,5 +1,9 @@
-management.endpoints.web.base-path=/psc-data-api
-management.endpoints.web.path-mapping.health=/healthcheck
+management.endpoints.enabled-by-default=false
+management.endpoints.web.base-path=/
+management.endpoints.web.path-mapping.health=healthcheck
+management.endpoint.health.show-details=never
+management.endpoint.health.enabled=true
+management.health.mongo.enabled=false
 
 chs.api.kafka.url=${CHS_KAFKA_API_URL:localhost}
 chs.api.kafka.resource-changed.uri=${PSC_API_RESOURCE_CHANGED_URI:/private/resource-changed}

diff --git a/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationIT.java b/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationIT.java
@@ -0,0 +1,37 @@
+package uk.gov.companieshouse.pscdataapi;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.function.Executable;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.test.web.servlet.MockMvc;
+
+@AutoConfigureMockMvc
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+class PscDataApiApplicationIT {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @Test
+    void shouldStartApplication() {
+        Executable executable = () -> PscDataApiApplication.main(new String[0]);
+        assertDoesNotThrow(executable);
+    }
+
+    @Test
+    void shouldReturn200FromGetHealthEndpoint() throws Exception {
+        this.mockMvc.perform(get("/healthcheck"))
+                .andDo(print())
+                .andExpect(status().isOk())
+                .andExpect(content().string("{\"status\":\"UP\"}"));
+    }
+}
diff --git a/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationTests.java b/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationTests.java
diff --git a/src/test/resources/application.properties b/src/test/resources/application.properties
@@ -15,8 +15,12 @@ feature.psc_individual_full_record_get=true
 
 items-per-page-max-internal=500
 
-management.endpoints.web.base-path=/psc-data-api
-management.endpoints.web.path-mapping.health=/healthcheck
+management.endpoints.enabled-by-default=false
+management.endpoints.web.base-path=/
+management.endpoints.web.path-mapping.health=healthcheck
+management.endpoint.health.show-details=never
+management.endpoint.health.enabled=true
+management.health.mongo.enabled=false
 
 spring.data.mongodb.uri=${MONGODB_URL:mongodb://mongo:27017}
 spring.data.mongodb.name=company_pscs

diff --git a/terraform/groups/ecs-service/locals.tf b/terraform/groups/ecs-service/locals.tf
@@ -10,11 +10,10 @@ locals {
   kms_alias                   = "alias/${var.aws_profile}/environment-services-kms"
   lb_listener_rule_priority   = 88
   lb_listener_paths           = [
-    "/psc-data-api/healthcheck",
     "/company/*/persons-with-significant-control",
     "/company/*/persons-with-significant-control/*"
   ]
-  healthcheck_path            = "/psc-data-api/healthcheck" #healthcheck path for psc-data-api
+  healthcheck_path            = "/healthcheck" #healthcheck path for psc-data-api
   healthcheck_matcher         = "200"
   vpc_name                    = local.stack_secrets["vpc_name"]
   s3_config_bucket            = data.vault_generic_secret.shared_s3.data["config_bucket_name"]