Support for Retry and Timeout handling on ParticipantStatus

POLICY-3464: Support for Retry and Timeout handling on ParticipantStatus
Change-Id: Iecf8bc9921cb92987bc75b6938efc543350a1543
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

3 files changed, 310 insertions, 0 deletions

diff --git a/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/HandleCounterTest.java b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/HandleCounterTest.java
new file mode 100644
index 000000000..51f3b4a32
--- /dev/null
+++ b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/HandleCounterTest.java
@@ -0,0 +1,84 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 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.clamp.controlloop.runtime.supervision;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+
+class HandleCounterTest {
+
+    private static final int ID = 1;
+
+    @Test
+    void testCount() {
+        var handleCounter = new HandleCounter<Integer>();
+        handleCounter.setMaxRetryCount(2);
+        assertThat(handleCounter.count(ID)).isTrue();
+        assertThat(handleCounter.getCounter(ID)).isEqualTo(1);
+        assertThat(handleCounter.count(ID)).isTrue();
+        assertThat(handleCounter.getCounter(ID)).isEqualTo(2);
+        assertThat(handleCounter.count(ID)).isFalse();
+        assertThat(handleCounter.getCounter(ID)).isEqualTo(2);
+
+        handleCounter.clear(ID);
+        assertThat(handleCounter.count(ID)).isTrue();
+        assertThat(handleCounter.getCounter(ID)).isEqualTo(1);
+    }
+
+    @Test
+    void testFault() {
+        var handleCounter = new HandleCounter<Integer>();
+        handleCounter.setFault(ID);
+        assertThat(handleCounter.isFault(ID)).isTrue();
+        handleCounter.clear(ID);
+        assertThat(handleCounter.isFault(ID)).isFalse();
+    }
+
+    @Test
+    void testDuration() throws InterruptedException {
+
+        var handleCounter = new HandleCounter<Integer>() {
+            long epochMilli = 0;
+
+            @Override
+            protected long getEpochMilli() {
+                return epochMilli;
+            }
+        };
+        handleCounter.epochMilli = 100;
+        var result = handleCounter.getDuration(ID);
+        assertThat(result).isZero();
+
+        handleCounter.epochMilli += 100;
+        result = handleCounter.getDuration(ID);
+        assertThat(result).isEqualTo(100);
+
+        handleCounter.epochMilli += 100;
+        result = handleCounter.getDuration(ID);
+        assertThat(result).isEqualTo(200);
+
+        handleCounter.epochMilli += 100;
+        handleCounter.clear(ID);
+        result = handleCounter.getDuration(ID);
+        assertThat(result).isZero();
+    }
+}
diff --git a/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionAspectTest.java b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionAspectTest.java
new file mode 100644
index 000000000..30ee9b1b9
--- /dev/null
+++ b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionAspectTest.java
@@ -0,0 +1,66 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 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.clamp.controlloop.runtime.supervision;
+
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.timeout;
+import static org.mockito.Mockito.verify;
+
+import org.junit.jupiter.api.Test;
+import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
+
+class SupervisionAspectTest {
+
+    @Test
+    void testSchedule() throws Exception {
+        var supervisionScanner = spy(mock(SupervisionScanner.class));
+        try (var supervisionAspect = new SupervisionAspect(supervisionScanner)) {
+            supervisionAspect.schedule();
+            verify(supervisionScanner, timeout(500)).run(eq(true));
+        }
+    }
+
+    @Test
+    void testDoCheck() throws Exception {
+        var supervisionScanner = spy(mock(SupervisionScanner.class));
+        try (var supervisionAspect = new SupervisionAspect(supervisionScanner)) {
+            supervisionAspect.doCheck();
+            supervisionAspect.doCheck();
+            verify(supervisionScanner, timeout(500).times(2)).run(eq(false));
+        }
+    }
+
+    @Test
+    void testHandleParticipantStatus() throws Exception {
+        var supervisionScanner = spy(mock(SupervisionScanner.class));
+        var participantStatusMessage = new ParticipantStatus();
+        var identifier = new ToscaConceptIdentifier("abc", "1.0.0");
+        participantStatusMessage.setParticipantId(identifier);
+
+        try (var supervisionAspect = new SupervisionAspect(supervisionScanner)) {
+            supervisionAspect.handleParticipantStatus(participantStatusMessage);
+            verify(supervisionScanner, timeout(500)).handleParticipantStatus(eq(identifier));
+        }
+    }
+}
diff --git a/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionScannerTest.java b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionScannerTest.java
new file mode 100644
index 000000000..485f58dba
--- /dev/null
+++ b/runtime-controlloop/src/test/java/org/onap/policy/clamp/controlloop/runtime/supervision/SupervisionScannerTest.java
@@ -0,0 +1,160 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2021 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.clamp.controlloop.runtime.supervision;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+import org.junit.jupiter.api.Test;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopOrderedState;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantHealthStatus;
+import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
+import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
+import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
+import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopStateChangePublisher;
+import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopUpdatePublisher;
+import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantStatusReqPublisher;
+import org.onap.policy.clamp.controlloop.runtime.util.CommonTestData;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
+
+class SupervisionScannerTest {
+
+    @Test
+    void testScannerOrderedStateEqualsToState() throws PfModelException {
+        var controlLoopProvider = mock(ControlLoopProvider.class);
+        var controlLoopStateChangePublisher = mock(ControlLoopStateChangePublisher.class);
+        var controlLoopUpdatePublisher = mock(ControlLoopUpdatePublisher.class);
+        var participantProvider = mock(ParticipantProvider.class);
+        var participantStatusReqPublisher = mock(ParticipantStatusReqPublisher.class);
+        var clRuntimeParameterGroup = CommonTestData.geParameterGroup("dbScanner");
+
+        var controlLoop = new ControlLoop();
+        when(controlLoopProvider.getControlLoops(null, null)).thenReturn(List.of(controlLoop));
+
+        var supervisionScanner =
+                new SupervisionScanner(controlLoopProvider, controlLoopStateChangePublisher, controlLoopUpdatePublisher,
+                        participantProvider, participantStatusReqPublisher, clRuntimeParameterGroup);
+        supervisionScanner.run(false);
+
+        verify(controlLoopProvider, times(0)).updateControlLoop(any(ControlLoop.class));
+    }
+
+    @Test
+    void testScannerOrderedStateDifferentToState() throws PfModelException {
+        var controlLoop = new ControlLoop();
+        controlLoop.setState(ControlLoopState.UNINITIALISED2PASSIVE);
+        controlLoop.setOrderedState(ControlLoopOrderedState.UNINITIALISED);
+        controlLoop.setElements(Map.of(UUID.randomUUID(), new ControlLoopElement()));
+        var controlLoopProvider = mock(ControlLoopProvider.class);
+        when(controlLoopProvider.getControlLoops(null, null)).thenReturn(List.of(controlLoop));
+
+        var controlLoopUpdatePublisher = mock(ControlLoopUpdatePublisher.class);
+        var controlLoopStateChangePublisher = mock(ControlLoopStateChangePublisher.class);
+        var participantProvider = mock(ParticipantProvider.class);
+        var participantStatusReqPublisher = mock(ParticipantStatusReqPublisher.class);
+        var clRuntimeParameterGroup = CommonTestData.geParameterGroup("dbScanner");
+
+        var supervisionScanner =
+                new SupervisionScanner(controlLoopProvider, controlLoopStateChangePublisher, controlLoopUpdatePublisher,
+                        participantProvider, participantStatusReqPublisher, clRuntimeParameterGroup);
+        supervisionScanner.run(false);
+
+        verify(controlLoopProvider, times(1)).updateControlLoop(any(ControlLoop.class));
+    }
+
+    @Test
+    void testScanner() throws PfModelException {
+        var controlLoopProvider = mock(ControlLoopProvider.class);
+        var controlLoop = new ControlLoop();
+        when(controlLoopProvider.getControlLoops(null, null)).thenReturn(List.of(controlLoop));
+
+        var participantProvider = mock(ParticipantProvider.class);
+        var participant = new Participant();
+        participant.setName("Participant0");
+        participant.setVersion("1.0.0");
+        when(participantProvider.getParticipants(null, null)).thenReturn(List.of(participant));
+
+        var controlLoopUpdatePublisher = mock(ControlLoopUpdatePublisher.class);
+        var participantStatusReqPublisher = mock(ParticipantStatusReqPublisher.class);
+        var controlLoopStateChangePublisher = mock(ControlLoopStateChangePublisher.class);
+        var clRuntimeParameterGroup = CommonTestData.geParameterGroup("dbScanner");
+
+        var supervisionScanner =
+                new SupervisionScanner(controlLoopProvider, controlLoopStateChangePublisher, controlLoopUpdatePublisher,
+                        participantProvider, participantStatusReqPublisher, clRuntimeParameterGroup);
+
+        supervisionScanner.handleParticipantStatus(participant.getKey().asIdentifier());
+        supervisionScanner.run(true);
+        verify(controlLoopProvider, times(0)).updateControlLoop(any(ControlLoop.class));
+        verify(participantStatusReqPublisher, times(0)).send(any(ToscaConceptIdentifier.class));
+    }
+
+    @Test
+    void testScanParticipant() throws PfModelException {
+        var controlLoopProvider = mock(ControlLoopProvider.class);
+        var controlLoop = new ControlLoop();
+        when(controlLoopProvider.getControlLoops(null, null)).thenReturn(List.of(controlLoop));
+
+        var clRuntimeParameterGroup = CommonTestData.geParameterGroup("dbScanParticipant");
+        clRuntimeParameterGroup.getParticipantParameters().setMaxMessageAgeMs(0);
+
+        var participant = new Participant();
+        participant.setName("Participant0");
+        participant.setVersion("1.0.0");
+        participant.setHealthStatus(ParticipantHealthStatus.HEALTHY);
+        participant.setParticipantState(ParticipantState.ACTIVE);
+        participant.setDefinition(new ToscaConceptIdentifier("unknown", "0.0.0"));
+        var participantProvider = new ParticipantProvider(clRuntimeParameterGroup.getDatabaseProviderParameters());
+        participantProvider.updateParticipants(List.of(participant));
+
+        var controlLoopUpdatePublisher = mock(ControlLoopUpdatePublisher.class);
+        var participantStatusReqPublisher = mock(ParticipantStatusReqPublisher.class);
+        var controlLoopStateChangePublisher = mock(ControlLoopStateChangePublisher.class);
+
+        var supervisionScanner =
+                new SupervisionScanner(controlLoopProvider, controlLoopStateChangePublisher, controlLoopUpdatePublisher,
+                        participantProvider, participantStatusReqPublisher, clRuntimeParameterGroup);
+
+        supervisionScanner.handleParticipantStatus(participant.getKey().asIdentifier());
+        supervisionScanner.run(true);
+        verify(participantStatusReqPublisher, times(1)).send(any(ToscaConceptIdentifier.class));
+
+        List<Participant> participants = participantProvider.getParticipants(null, null);
+        assertThat(participants.get(0).getHealthStatus()).isEqualTo(ParticipantHealthStatus.NOT_HEALTHY);
+
+        supervisionScanner.run(true);
+        supervisionScanner.run(true);
+        participants = participantProvider.getParticipants(null, null);
+        assertThat(participants.get(0).getHealthStatus()).isEqualTo(ParticipantHealthStatus.OFF_LINE);
+    }
+}