2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Nordix Foundation.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.clamp.controlloop.runtime.supervision.comm;
23 import java.time.Instant;
24 import java.util.Collections;
25 import java.util.List;
27 import java.util.UUID;
28 import org.junit.jupiter.api.AfterAll;
29 import org.junit.jupiter.api.BeforeAll;
30 import org.junit.jupiter.api.Test;
31 import org.mockito.Mockito;
32 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElementDefinition;
33 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ClElementStatisticsProvider;
34 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
35 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
36 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantStatisticsProvider;
37 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
38 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregisterAck;
39 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegister;
40 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegisterAck;
41 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdate;
42 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdateAck;
43 import org.onap.policy.clamp.controlloop.runtime.commissioning.CommissioningProvider;
44 import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
45 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
46 import org.onap.policy.clamp.controlloop.runtime.supervision.SupervisionHandler;
47 import org.onap.policy.clamp.controlloop.runtime.util.CommonTestData;
48 import org.onap.policy.clamp.controlloop.runtime.util.rest.CommonRestController;
49 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
50 import org.onap.policy.common.endpoints.event.comm.TopicSink;
51 import org.onap.policy.common.utils.coder.YamlJsonTranslator;
52 import org.onap.policy.common.utils.resources.ResourceUtils;
53 import org.onap.policy.models.base.PfModelException;
54 import org.onap.policy.models.provider.PolicyModelsProvider;
55 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
56 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
57 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
59 class SupervisionMessagesTest extends CommonRestController {
61 private static final String TOSCA_SERVICE_TEMPLATE_YAML =
62 "src/test/resources/rest/servicetemplates/pmsh_multiple_cl_tosca.yaml";
63 private static final Object lockit = new Object();
64 private static final CommInfrastructure INFRA = CommInfrastructure.NOOP;
65 private static final String TOPIC = "my-topic";
66 private static final long interval = 1000;
67 private static SupervisionHandler supervisionHandler;
68 private static CommissioningProvider commissioningProvider;
69 private static ControlLoopProvider clProvider;
70 private static PolicyModelsProvider modelsProvider;
71 private static final YamlJsonTranslator yamlTranslator = new YamlJsonTranslator();
74 * setup Db Provider Parameters.
76 * @throws PfModelException if an error occurs
79 public static void setupDbProviderParameters() throws PfModelException {
80 ClRuntimeParameterGroup controlLoopParameters = CommonTestData.geParameterGroup("instantproviderdb");
82 modelsProvider = CommonTestData.getPolicyModelsProvider(controlLoopParameters.getDatabaseProviderParameters());
83 clProvider = new ControlLoopProvider(controlLoopParameters.getDatabaseProviderParameters());
84 var participantStatisticsProvider =
85 new ParticipantStatisticsProvider(controlLoopParameters.getDatabaseProviderParameters());
86 var clElementStatisticsProvider =
87 new ClElementStatisticsProvider(controlLoopParameters.getDatabaseProviderParameters());
88 commissioningProvider = new CommissioningProvider(modelsProvider, clProvider);
89 var monitoringProvider =
90 new MonitoringProvider(participantStatisticsProvider, clElementStatisticsProvider, clProvider);
91 var participantProvider = new ParticipantProvider(controlLoopParameters.getDatabaseProviderParameters());
92 var controlLoopUpdatePublisher = Mockito.mock(ControlLoopUpdatePublisher.class);
93 var controlLoopStateChangePublisher = Mockito.mock(ControlLoopStateChangePublisher.class);
94 var participantRegisterAckPublisher = Mockito.mock(ParticipantRegisterAckPublisher.class);
95 var participantDeregisterAckPublisher = Mockito.mock(ParticipantDeregisterAckPublisher.class);
96 var participantUpdatePublisher = Mockito.mock(ParticipantUpdatePublisher.class);
97 supervisionHandler = new SupervisionHandler(clProvider, participantProvider, monitoringProvider,
98 controlLoopUpdatePublisher, controlLoopStateChangePublisher, participantRegisterAckPublisher,
99 participantDeregisterAckPublisher, participantUpdatePublisher);
103 public static void closeDbProvider() throws PfModelException {
105 modelsProvider.close();
109 void testReceiveParticipantRegister() throws Exception {
110 final ParticipantRegister participantRegisterMsg = new ParticipantRegister();
111 participantRegisterMsg.setParticipantId(getParticipantId());
112 participantRegisterMsg.setTimestamp(Instant.now());
113 participantRegisterMsg.setParticipantType(getParticipantType());
115 synchronized (lockit) {
116 ParticipantRegisterListener participantRegisterListener =
117 new ParticipantRegisterListener(supervisionHandler);
118 ToscaServiceTemplate serviceTemplate = yamlTranslator.fromYaml(
119 ResourceUtils.getResourceAsString(TOSCA_SERVICE_TEMPLATE_YAML), ToscaServiceTemplate.class);
121 List<ToscaNodeTemplate> listOfTemplates = commissioningProvider.getControlLoopDefinitions(null, null);
122 commissioningProvider.createControlLoopDefinitions(serviceTemplate);
123 participantRegisterListener.onTopicEvent(INFRA, TOPIC, null, participantRegisterMsg);
128 void testSendParticipantRegisterAck() throws Exception {
129 final ParticipantRegisterAck participantRegisterAckMsg = new ParticipantRegisterAck();
130 participantRegisterAckMsg.setMessage("ParticipantRegisterAck message");
131 participantRegisterAckMsg.setResponseTo(UUID.randomUUID());
132 participantRegisterAckMsg.setResult(true);
134 synchronized (lockit) {
135 ParticipantRegisterAckPublisher clRegisterAckPublisher = new ParticipantRegisterAckPublisher();
136 clRegisterAckPublisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
137 clRegisterAckPublisher.send(participantRegisterAckMsg);
142 void testReceiveParticipantDeregister() throws Exception {
143 final ParticipantDeregister participantDeregisterMsg = new ParticipantDeregister();
144 participantDeregisterMsg.setParticipantId(getParticipantId());
145 participantDeregisterMsg.setTimestamp(Instant.now());
146 participantDeregisterMsg.setParticipantType(getParticipantType());
148 synchronized (lockit) {
149 ParticipantDeregisterListener participantDeregisterListener =
150 new ParticipantDeregisterListener(supervisionHandler);
151 participantDeregisterListener.onTopicEvent(INFRA, TOPIC, null, participantDeregisterMsg);
156 void testSendParticipantDeregisterAck() throws Exception {
157 final ParticipantDeregisterAck participantDeregisterAckMsg = new ParticipantDeregisterAck();
158 participantDeregisterAckMsg.setMessage("ParticipantDeregisterAck message");
159 participantDeregisterAckMsg.setResponseTo(UUID.randomUUID());
160 participantDeregisterAckMsg.setResult(true);
162 synchronized (lockit) {
163 ParticipantDeregisterAckPublisher clDeregisterAckPublisher = new ParticipantDeregisterAckPublisher();
164 clDeregisterAckPublisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
165 clDeregisterAckPublisher.send(participantDeregisterAckMsg);
170 void testSendParticipantUpdate() throws Exception {
171 final ParticipantUpdate participantUpdateMsg = new ParticipantUpdate();
172 participantUpdateMsg.setParticipantId(getParticipantId());
173 participantUpdateMsg.setTimestamp(Instant.now());
174 participantUpdateMsg.setParticipantType(getParticipantType());
175 participantUpdateMsg.setTimestamp(Instant.ofEpochMilli(3000));
176 participantUpdateMsg.setMessageId(UUID.randomUUID());
178 ToscaServiceTemplate toscaServiceTemplate = new ToscaServiceTemplate();
179 toscaServiceTemplate.setName("serviceTemplate");
180 toscaServiceTemplate.setDerivedFrom("parentServiceTemplate");
181 toscaServiceTemplate.setDescription("Description of serviceTemplate");
182 toscaServiceTemplate.setVersion("1.2.3");
184 ControlLoopElementDefinition clDefinition = new ControlLoopElementDefinition();
185 clDefinition.setId(UUID.randomUUID());
186 clDefinition.setControlLoopElementToscaServiceTemplate(toscaServiceTemplate);
187 Map<String, String> commonPropertiesMap = Map.of("Prop1", "PropValue");
188 clDefinition.setCommonPropertiesMap(commonPropertiesMap);
190 Map<UUID, ControlLoopElementDefinition> controlLoopElementDefinitionMap =
191 Map.of(UUID.randomUUID(), clDefinition);
193 Map<String, Map<UUID, ControlLoopElementDefinition>> participantDefinitionUpdateMap =
194 Map.of(getParticipantId().toString(), controlLoopElementDefinitionMap);
195 participantUpdateMsg.setParticipantDefinitionUpdateMap(participantDefinitionUpdateMap);
197 synchronized (lockit) {
198 ParticipantUpdatePublisher clUpdatePublisher = new ParticipantUpdatePublisher(commissioningProvider);
199 clUpdatePublisher.active(Collections.singletonList(Mockito.mock(TopicSink.class)));
200 clUpdatePublisher.send(participantUpdateMsg);
205 void testReceiveParticipantUpdateAckMessage() throws Exception {
206 final ParticipantUpdateAck participantUpdateAckMsg = new ParticipantUpdateAck();
207 participantUpdateAckMsg.setMessage("ParticipantUpdateAck message");
208 participantUpdateAckMsg.setResponseTo(UUID.randomUUID());
209 participantUpdateAckMsg.setResult(true);
211 synchronized (lockit) {
212 ParticipantUpdateAckListener participantUpdateAckListener =
213 new ParticipantUpdateAckListener(supervisionHandler);
214 participantUpdateAckListener.onTopicEvent(INFRA, TOPIC, null, participantUpdateAckMsg);
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");