2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Nordix Foundation.
4 * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.clamp.controlloop.runtime.supervision.comm;
24 import static org.assertj.core.api.Assertions.assertThatCode;
25 import static org.assertj.core.api.Assertions.assertThatThrownBy;
26 import static org.mockito.ArgumentMatchers.anyString;
27 import static org.mockito.Mockito.mock;
28 import static org.mockito.Mockito.times;
29 import static org.mockito.Mockito.verify;
31 import java.time.Instant;
32 import java.util.Collections;
33 import java.util.List;
34 import java.util.UUID;
35 import org.junit.jupiter.api.BeforeAll;
36 import org.junit.jupiter.api.Test;
37 import org.mockito.Mockito;
38 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
39 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
40 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ClElementStatisticsProvider;
41 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
42 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
43 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantStatisticsProvider;
44 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ServiceTemplateProvider;
45 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
46 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregisterAck;
47 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegisterAck;
48 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdateAck;
49 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
50 import org.onap.policy.clamp.controlloop.runtime.supervision.SupervisionHandler;
51 import org.onap.policy.clamp.controlloop.runtime.util.rest.CommonRestController;
52 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
53 import org.onap.policy.common.endpoints.event.comm.TopicSink;
54 import org.onap.policy.models.base.PfModelException;
55 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
57 class SupervisionMessagesTest extends CommonRestController {
59 private static final String NOT_ACTIVE = "Not Active!";
60 private static final Object lockit = new Object();
61 private static final CommInfrastructure INFRA = CommInfrastructure.NOOP;
62 private static final String TOPIC = "my-topic";
63 private static SupervisionHandler supervisionHandler;
66 * setup Db Provider Parameters.
68 * @throws PfModelException if an error occurs
71 public static void setupDbProviderParameters() throws PfModelException {
72 var clProvider = mock(ControlLoopProvider.class);
73 var participantStatisticsProvider = mock(ParticipantStatisticsProvider.class);
74 var clElementStatisticsProvider = mock(ClElementStatisticsProvider.class);
75 var monitoringProvider =
76 new MonitoringProvider(participantStatisticsProvider, clElementStatisticsProvider, clProvider);
77 var participantProvider = mock(ParticipantProvider.class);
78 var serviceTemplateProvider = Mockito.mock(ServiceTemplateProvider.class);
79 var controlLoopUpdatePublisher = Mockito.mock(ControlLoopUpdatePublisher.class);
80 var controlLoopStateChangePublisher = Mockito.mock(ControlLoopStateChangePublisher.class);
81 var participantRegisterAckPublisher = Mockito.mock(ParticipantRegisterAckPublisher.class);
82 var participantDeregisterAckPublisher = Mockito.mock(ParticipantDeregisterAckPublisher.class);
83 var participantUpdatePublisher = Mockito.mock(ParticipantUpdatePublisher.class);
84 supervisionHandler = new SupervisionHandler(clProvider, participantProvider, monitoringProvider,
85 serviceTemplateProvider, controlLoopUpdatePublisher, controlLoopStateChangePublisher,
86 participantRegisterAckPublisher, participantDeregisterAckPublisher, participantUpdatePublisher);
90 void testSendParticipantRegisterAck() throws Exception {
91 final ParticipantRegisterAck participantRegisterAckMsg = new ParticipantRegisterAck();
92 participantRegisterAckMsg.setMessage("ParticipantRegisterAck message");
93 participantRegisterAckMsg.setResponseTo(UUID.randomUUID());
94 participantRegisterAckMsg.setResult(true);
96 synchronized (lockit) {
97 ParticipantRegisterAckPublisher clRegisterAckPublisher = new ParticipantRegisterAckPublisher();
98 clRegisterAckPublisher.active(List.of(Mockito.mock(TopicSink.class)));
99 assertThatCode(() -> clRegisterAckPublisher.send(participantRegisterAckMsg)).doesNotThrowAnyException();
104 void testReceiveParticipantDeregister() throws Exception {
105 final ParticipantDeregister participantDeregisterMsg = new ParticipantDeregister();
106 participantDeregisterMsg.setParticipantId(getParticipantId());
107 participantDeregisterMsg.setTimestamp(Instant.now());
108 participantDeregisterMsg.setParticipantType(getParticipantType());
110 synchronized (lockit) {
111 ParticipantDeregisterListener participantDeregisterListener =
112 new ParticipantDeregisterListener(supervisionHandler);
114 () -> participantDeregisterListener.onTopicEvent(INFRA, TOPIC, null, participantDeregisterMsg))
115 .doesNotThrowAnyException();
120 void testSendParticipantDeregisterAck() throws Exception {
121 final ParticipantDeregisterAck participantDeregisterAckMsg = new ParticipantDeregisterAck();
122 participantDeregisterAckMsg.setMessage("ParticipantDeregisterAck message");
123 participantDeregisterAckMsg.setResponseTo(UUID.randomUUID());
124 participantDeregisterAckMsg.setResult(true);
126 synchronized (lockit) {
127 ParticipantDeregisterAckPublisher clDeregisterAckPublisher = new ParticipantDeregisterAckPublisher();
128 clDeregisterAckPublisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
129 assertThatCode(() -> clDeregisterAckPublisher.send(participantDeregisterAckMsg)).doesNotThrowAnyException();
134 void testReceiveParticipantUpdateAckMessage() throws Exception {
135 final ParticipantUpdateAck participantUpdateAckMsg = new ParticipantUpdateAck();
136 participantUpdateAckMsg.setMessage("ParticipantUpdateAck message");
137 participantUpdateAckMsg.setResponseTo(UUID.randomUUID());
138 participantUpdateAckMsg.setResult(true);
139 participantUpdateAckMsg.setParticipantId(getParticipantId());
140 participantUpdateAckMsg.setParticipantType(getParticipantType());
142 synchronized (lockit) {
143 ParticipantUpdateAckListener participantUpdateAckListener =
144 new ParticipantUpdateAckListener(supervisionHandler);
145 assertThatCode(() -> participantUpdateAckListener.onTopicEvent(INFRA, TOPIC, null, participantUpdateAckMsg))
146 .doesNotThrowAnyException();
151 void testSendControlLoopStateChangePublisherNotActive() {
152 var publisher = new ControlLoopStateChangePublisher();
153 assertThatThrownBy(() -> publisher.send(getControlLoop(), 0)).hasMessage(NOT_ACTIVE);
157 void testSendControlLoopStateChangePublisher() {
158 var publisher = new ControlLoopStateChangePublisher();
159 var topicSink = mock(TopicSink.class);
160 publisher.active(List.of(topicSink));
161 publisher.send(getControlLoop(), 0);
162 verify(topicSink).send(anyString());
166 void testParticipantUpdatePublisherDecomisioning() {
167 var publisher = new ParticipantUpdatePublisher(mock(ServiceTemplateProvider.class));
168 var topicSink = mock(TopicSink.class);
169 publisher.active(List.of(topicSink));
170 publisher.sendDecomisioning();
171 verify(topicSink).send(anyString());
175 void testParticipantUpdatePublisherComissioning() {
176 var publisher = new ParticipantUpdatePublisher(mock(ServiceTemplateProvider.class));
177 var topicSink = mock(TopicSink.class);
178 publisher.active(List.of(topicSink));
179 publisher.sendComissioningBroadcast("NAME", "1.0.0");
180 verify(topicSink, times(0)).send(anyString());
184 void testParticipantStatusReqPublisher() {
185 var publisher = new ParticipantStatusReqPublisher();
186 var topicSink = mock(TopicSink.class);
187 publisher.active(List.of(topicSink));
188 publisher.send(getParticipantId());
189 verify(topicSink).send(anyString());
193 void testParticipantRegisterAckPublisher() {
194 var publisher = new ParticipantRegisterAckPublisher();
195 var topicSink = mock(TopicSink.class);
196 publisher.active(List.of(topicSink));
197 publisher.send(UUID.randomUUID(), getParticipantId(), getParticipantType());
198 verify(topicSink).send(anyString());
202 void testParticipantDeregisterAckPublisher() {
203 var publisher = new ParticipantDeregisterAckPublisher();
204 var topicSink = mock(TopicSink.class);
205 publisher.active(List.of(topicSink));
206 publisher.send(UUID.randomUUID());
207 verify(topicSink).send(anyString());
210 private ControlLoop getControlLoop() {
211 var controlLoop = new ControlLoop();
212 controlLoop.setName("NAME");
213 controlLoop.setVersion("0.0.1");
214 controlLoop.setState(ControlLoopState.UNINITIALISED);
218 private ToscaConceptIdentifier getParticipantId() {
219 return new ToscaConceptIdentifier("org.onap.PM_Policy", "1.0.0");
222 private ToscaConceptIdentifier getParticipantType() {
223 return new ToscaConceptIdentifier("org.onap.policy.controlloop.PolicyControlLoopParticipant", "2.3.1");