Adding PdpGroup healthcheck REST API in PAP

Adding PdpGroup healthcheck REST API in PAP to return the health status
of all the Pdps registered with this PAP instance. The healthcheck
status will be based on the regular heartbeat coming from the pdps.

Change-Id: Ia0f1603b513bf62ce1df3058427dc6ccaf179cb3
Issue-ID: POLICY-1770
Signed-off-by: ramverma <ram.krishna.verma@est.tech>

3 files changed, 272 insertions, 0 deletions

diff --git a/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckControllerV1.java b/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckControllerV1.java
new file mode 100644
index 00000000..370582d0
--- /dev/null
+++ b/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckControllerV1.java
@@ -0,0 +1,64 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pap.main.rest;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import javax.ws.rs.client.Invocation;
+import javax.ws.rs.core.Response;
+
+import org.junit.Test;
+import org.onap.policy.models.pdp.concepts.Pdps;
+
+/**
+ * Class to perform unit test of {@link PdpGroupHealthCheckControllerV1}.
+ *
+ * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
+ */
+public class TestPdpGroupHealthCheckControllerV1 extends CommonPapRestServer {
+
+    private static final String ENDPOINT = "pdps/healthcheck";
+
+    @Test
+    public void testSwagger() throws Exception {
+        super.testSwagger(ENDPOINT);
+    }
+
+    @Test
+    public void testPdpGroupHealthCheck() throws Exception {
+        final String uri = ENDPOINT;
+
+        final Invocation.Builder invocationBuilder = sendRequest(uri);
+        Response rawresp = invocationBuilder.get();
+        Pdps resp = rawresp.readEntity(Pdps.class);
+        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+        assertNotNull(resp);
+
+        rawresp = invocationBuilder.get();
+        resp = rawresp.readEntity(Pdps.class);
+        assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+        assertNotNull(resp);
+
+        // verify it fails when no authorization info is included
+        checkUnauthRequest(uri, req -> req.get());
+    }
+}
diff --git a/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckProvider.java b/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckProvider.java
new file mode 100644
index 00000000..977c5262
--- /dev/null
+++ b/main/src/test/java/org/onap/policy/pap/main/rest/TestPdpGroupHealthCheckProvider.java
@@ -0,0 +1,110 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pap.main.rest;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.io.File;
+import java.util.List;
+
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+
+import org.apache.commons.lang3.tuple.Pair;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.onap.policy.common.utils.coder.Coder;
+import org.onap.policy.common.utils.coder.CoderException;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.onap.policy.common.utils.resources.ResourceUtils;
+import org.onap.policy.common.utils.services.Registry;
+import org.onap.policy.models.pdp.concepts.Pdp;
+import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpGroups;
+import org.onap.policy.models.pdp.concepts.PdpSubGroup;
+import org.onap.policy.models.pdp.concepts.Pdps;
+import org.onap.policy.models.provider.PolicyModelsProvider;
+import org.onap.policy.pap.main.PapConstants;
+import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
+
+/**
+ * Class to perform unit test of {@link PdpGroupHealthCheckProvider}.
+ *
+ * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
+ */
+public class TestPdpGroupHealthCheckProvider {
+
+    @Mock
+    private PolicyModelsProvider dao;
+    private PolicyModelsProviderFactoryWrapper daofact;
+    private List<PdpGroup> groups;
+    private Coder coder = new StandardCoder();
+
+    /**
+     * Configures DAO and mocks.
+     */
+    @Before
+    public void setUp() throws Exception {
+
+        Registry.newRegistry();
+        MockitoAnnotations.initMocks(this);
+        daofact = mock(PolicyModelsProviderFactoryWrapper.class);
+        when(daofact.create()).thenReturn(dao);
+
+        groups = loadFile("pdpGroup.json").getGroups();
+
+        when(dao.getPdpGroups(any())).thenReturn(groups);
+
+        Registry.register(PapConstants.REG_PAP_DAO_FACTORY, daofact);
+    }
+
+    @Test
+    public void testFetchPdpGroupHealthStatus() throws Exception {
+        final PdpGroupHealthCheckProvider provider = new PdpGroupHealthCheckProvider();
+        final Pair<Status, Pdps> pair = provider.fetchPdpGroupHealthStatus();
+        assertEquals(Response.Status.OK, pair.getLeft());
+        verifyPdps(pair.getRight().getPdpList(), groups);
+    }
+
+    private void verifyPdps(final List<Pdp> pdpList, final List<PdpGroup> groups) {
+        assertEquals(5, pdpList.size());
+        for (final PdpGroup group : groups) {
+            for (final PdpSubGroup subGroup : group.getPdpSubgroups()) {
+                pdpList.containsAll(subGroup.getPdpInstances());
+            }
+        }
+    }
+
+    private PdpGroups loadFile(final String fileName) {
+        final File propFile = new File(ResourceUtils.getFilePath4Resource("rest/" + fileName));
+        try {
+            return coder.decode(propFile, PdpGroups.class);
+
+        } catch (final CoderException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}
diff --git a/main/src/test/resources/rest/pdpGroup.json b/main/src/test/resources/rest/pdpGroup.json
new file mode 100644
index 00000000..2a7b4edc
--- /dev/null
+++ b/main/src/test/resources/rest/pdpGroup.json
@@ -0,0 +1,98 @@
+{
+    "groups": [
+        {
+            "name": "queryGroup1",
+            "description": "my description",
+            "pdpGroupState": "PASSIVE",
+            "properties": {
+                    "abc": "def"
+                },
+            "pdpSubgroups": [
+                {
+                    "pdpType": "pdpTypeA",
+                    "currentInstanceCount": 3,
+                    "desiredInstanceCount": 2,
+                    "properties": {
+                            "ten": 10
+                        },
+                    "pdpInstances": [
+                        {
+                            "instanceId": "pdpAA_1",
+                            "pdpState": "PASSIVE",
+                            "healthy": "HEALTHY"
+                        },
+                        {
+                            "instanceId": "pdpAA_2",
+                            "pdpState": "PASSIVE",
+                            "healthy": "HEALTHY"
+                        }
+                    ],
+                    "supportedPolicyTypes": [
+                        {
+                            "name": "onap.policies.monitoring.cdap.tca.hi.lo.app",
+                            "version": "1.0.0"
+                        }
+                    ],
+                    "policies": [
+                        {
+                            "name": "onap.restart.tca",
+                            "version": "1.0.0"
+                        }
+                    ]
+                },
+                {
+                    "pdpType": "pdpTypeB",
+                    "desiredInstanceCount": 1,
+                    "pdpInstances": [
+                        {
+                            "instanceId": "pdpAB_1",
+                            "pdpState": "PASSIVE",
+                            "healthy": "HEALTHY"
+                        }
+                    ],
+                    "supportedPolicyTypes": [
+                        {
+                            "name": "onap.policies.monitoring.cdap.tca.hi.lo.app",
+                            "version": "1.0.0"
+                        }
+                    ],
+                    "policies": []
+                }
+            ]
+        },
+        {
+            "name": "queryGroup2",
+            "pdpGroupState": "ACTIVE",
+            "pdpSubgroups": [
+                {
+                    "pdpType": "pdpTypeA",
+                    "desiredInstanceCount": 2,
+                    "pdpInstances": [
+                        {
+                            "instanceId": "pdpBA_1",
+                            "pdpState": "PASSIVE",
+                            "healthy": "HEALTHY"
+                        },
+                        {
+                            "instanceId": "pdpBA_2",
+                            "pdpState": "PASSIVE",
+                            "healthy": "HEALTHY"
+                        }
+                    ],
+                    "supportedPolicyTypes": [
+                        {
+                            "name": "onap.policies.monitoring.cdap.tca.hi.lo.app",
+                            "version": "1.0.0"
+                        }
+                    ],
+                    "policies": [
+                        {
+                            "name": "onap.restart.tcaB",
+                            "version": "1.0.0"
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}