Create Readiness Endpoint

Signed-off-by: Adam Wudzinski <adam.wudzinski@nokia.com>
Issue-ID: AAF-997
Change-Id: Icb978fd7d4ac59d2b2968e5c0b861fba5eb616bf

diff --git a/certService/helm/aaf-cert-service/templates/deployment.yaml b/certService/helm/aaf-cert-service/templates/deployment.yaml
index 2e16cbc..f8b2d43 100644 (file)
--- a/certService/helm/aaf-cert-service/templates/deployment.yaml
+++ b/certService/helm/aaf-cert-service/templates/deployment.yaml
@@ -25,13 +25,13 @@ spec:
         livenessProbe:
           httpGet:
             port: {{ .Values.containerPort }}
-            path: {{ .Values.healthcheck.path }}
+            path: {{ .Values.liveness.path }}
             initialDelaySeconds: {{ .Values.liveness.initialDelaySeconds }}
             periodSeconds: {{ .Values.liveness.periodSeconds }}
         readinessProbe:
           httpGet:
             port: {{ .Values.containerPort }}
-            path: {{ .Values.healthcheck.path }}
+            path: {{ .Values.readiness.path }}
             initialDelaySeconds: {{ .Values.readiness.initialDelaySeconds }}
             periodSeconds: {{ .Values.readiness.periodSeconds }}
         volumeMounts:

diff --git a/certService/helm/aaf-cert-service/values.yaml b/certService/helm/aaf-cert-service/values.yaml
index a971edd..0dab1e3 100644 (file)
--- a/certService/helm/aaf-cert-service/values.yaml
+++ b/certService/helm/aaf-cert-service/values.yaml
@@ -9,11 +9,11 @@ service:
 liveness:
   initialDelaySeconds: 60
   periodSeconds: 10
+  path: /actuator/health
 readiness:
   initialDelaySeconds: 30
   periodSeconds: 10
-healthcheck:
-  path: /actuator/health
+  path: /ready
 volume:
   name: aaf-cert-service-volume
   mountPath: /etc/onap/aaf/certservice

diff --git a/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java b/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java
new file mode 100644 (file)
index 0000000..e33bf51
--- /dev/null
+++ b/certService/src/main/java/org/onap/aaf/certservice/api/ReadinessController.java
@@ -0,0 +1,48 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PROJECT
+ * ================================================================================
+ * Copyright (C) 2020 Nokia. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.aaf.certservice.api;
+
+import org.onap.aaf.certservice.certification.configuration.CmpServersConfig;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class ReadinessController {
+
+    private final CmpServersConfig cmpServersConfig;
+
+    @Autowired
+    public ReadinessController(CmpServersConfig cmpServersConfig) {
+        this.cmpServersConfig = cmpServersConfig;
+    }
+
+    @GetMapping("/ready")
+    public ResponseEntity<String> checkReady() {
+        if (cmpServersConfig.isReady()) {
+            return new ResponseEntity<>(HttpStatus.OK);
+        } else {
+            return new ResponseEntity<>(HttpStatus.SERVICE_UNAVAILABLE);
+        }
+    }
+}

diff --git a/certService/src/main/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfig.java b/certService/src/main/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfig.java
index a304b5a..cea228c 100644 (file)
--- a/certService/src/main/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfig.java
+++ b/certService/src/main/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfig.java
@@ -35,15 +35,16 @@ import org.springframework.context.annotation.Configuration;
 public class CmpServersConfig {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(CmpServersConfig.class);
+    private static final String INIT_CONFIGURATION = "Loading initial configuration";
+    private static final String RELOADING_CONFIGURATION = "Reloading configuration";
     private static final String LOADING_SUCCESS_MESSAGE = "CMP Servers configuration successfully loaded from file {}";
     private static final String CMP_SERVERS_CONFIG_FILENAME = "cmpServers.json";
-    private static final String INIT_CONFIGURATION = "Loading initial configuration";
-    private static final String REFRESHING_CONFIGURATION = "Refreshing configuration";
 
     private final String configPath;
     private final CmpServersConfigLoader cmpServersConfigLoader;
 
     private List<Cmpv2Server> cmpServers;
+    private volatile boolean isReady;
 
     @Autowired
     public CmpServersConfig(@Value("${app.config.path}") String configPath,
@@ -54,8 +55,8 @@ public class CmpServersConfig {
 
     @PostConstruct
     void init() {
-        LOGGER.info(INIT_CONFIGURATION);
         try {
+            LOGGER.info(INIT_CONFIGURATION);
             loadConfiguration();
         } catch (CmpServersConfigLoadingException e) {
             LOGGER.error(e.getMessage(), e.getCause());
@@ -63,18 +64,24 @@ public class CmpServersConfig {
     }
 
     public void reloadConfiguration() throws CmpServersConfigLoadingException {
-        LOGGER.info(REFRESHING_CONFIGURATION);
+        LOGGER.info(RELOADING_CONFIGURATION);
         loadConfiguration();
     }
 
-    void loadConfiguration() throws CmpServersConfigLoadingException {
+
+    synchronized void loadConfiguration() throws CmpServersConfigLoadingException {
+        isReady = false;
         String configFilePath = configPath + File.separator + CMP_SERVERS_CONFIG_FILENAME;
         this.cmpServers = Collections.unmodifiableList(cmpServersConfigLoader.load(configFilePath));
         LOGGER.info(LOADING_SUCCESS_MESSAGE, configFilePath);
+        isReady = true;
     }
 
     public List<Cmpv2Server> getCmpServers() {
         return cmpServers;
     }
 
+    public boolean isReady() {
+        return isReady;
+    }
 }

diff --git a/certService/src/test/java/org/onap/aaf/certservice/api/ReadinessControllerTest.java b/certService/src/test/java/org/onap/aaf/certservice/api/ReadinessControllerTest.java
new file mode 100644 (file)
index 0000000..4000a38
--- /dev/null
+++ b/certService/src/test/java/org/onap/aaf/certservice/api/ReadinessControllerTest.java
@@ -0,0 +1,57 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PROJECT
+ * ================================================================================
+ * Copyright (C) 2020 Nokia. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.aaf.certservice.api;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.onap.aaf.certservice.certification.configuration.CmpServersConfig;
+import org.springframework.http.HttpStatus;
+
+@ExtendWith(MockitoExtension.class)
+public class ReadinessControllerTest {
+
+    @Mock
+    private CmpServersConfig cmpServersConfig;
+
+    @Test
+    public void shouldReturnStatusOkWhenConfigIsReady() {
+        // Given
+        Mockito.when(cmpServersConfig.isReady()).thenReturn(true);
+
+        // Then
+        assertThat(new ReadinessController(cmpServersConfig).checkReady().getStatusCode()).isEqualTo(HttpStatus.OK);;
+    }
+
+    @Test
+    public void shouldReturnStatusServiceUnavailableWhenConfigIsNotReady() {
+        // Given
+        Mockito.when(cmpServersConfig.isReady()).thenReturn(false);
+
+        // Then
+        assertThat(new ReadinessController(cmpServersConfig).checkReady().getStatusCode()).isEqualTo(HttpStatus.SERVICE_UNAVAILABLE);;
+    }
+
+}

diff --git a/certService/src/test/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfigTest.java b/certService/src/test/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfigTest.java
index 5d850fe..043dbc0 100644 (file)
--- a/certService/src/test/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfigTest.java
+++ b/certService/src/test/java/org/onap/aaf/certservice/certification/configuration/CmpServersConfigTest.java
@@ -159,6 +159,55 @@ class CmpServersConfigTest {
         assertThat(exception.getMessage()).isEqualTo(ERROR_MESSAGE);
     }
 
+    @Test
+    void shouldBeNotReadyWhenCreated() {
+        assertThat(cmpServersConfig.isReady()).isFalse();
+    }
+
+    @Test
+    void shouldBeReadyWhenSuccessfullyInitialized() {
+        // When
+        this.cmpServersConfig.init();      // Manual PostConstruct call
+
+        // Then
+        assertThat(cmpServersConfig.isReady()).isTrue();
+    }
+
+    @Test
+    void shouldNotBeReadyWhenFailedToInitialize() throws CmpServersConfigLoadingException {
+        // Given
+        Mockito.when(cmpServersConfigLoader.load(any())).thenThrow(new CmpServersConfigLoadingException(ERROR_MESSAGE));
+
+        // When
+        this.cmpServersConfig.init();      // Manual PostConstruct call
+
+        // Then
+        assertThat(cmpServersConfig.isReady()).isFalse();
+    }
+
+    @Test
+    void shouldBeReadyWhenSuccessfullyReloaded() throws CmpServersConfigLoadingException {
+        // When
+        this.cmpServersConfig.reloadConfiguration();
+
+        // Then
+        assertThat(cmpServersConfig.isReady()).isTrue();
+    }
+
+    @Test
+    void shouldNotBeReadyWhenFailedToReload() throws CmpServersConfigLoadingException {
+        // Given
+        Mockito.when(cmpServersConfigLoader.load(any())).thenThrow(new CmpServersConfigLoadingException(ERROR_MESSAGE));
+
+        // When
+        assertThrows(
+            CmpServersConfigLoadingException.class,
+            () -> cmpServersConfig.loadConfiguration());
+
+        // Then
+        assertThat(cmpServersConfig.isReady()).isFalse();
+    }
+
     private static List<Cmpv2Server> generateTestConfiguration() {
         Cmpv2Server testServer1 = new Cmpv2Server();
         testServer1.setCaName("TEST_CA1");