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.instantiation;
24 import static org.assertj.core.api.Assertions.assertThat;
25 import static org.assertj.core.api.Assertions.assertThatThrownBy;
27 import java.io.IOException;
28 import java.util.ArrayList;
29 import java.util.List;
30 import org.junit.jupiter.api.AfterAll;
31 import org.junit.jupiter.api.AfterEach;
32 import org.junit.jupiter.api.BeforeAll;
33 import org.junit.jupiter.api.BeforeEach;
34 import org.junit.jupiter.api.Test;
35 import org.mockito.Mockito;
36 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopRuntimeException;
37 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
38 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
39 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
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.messages.rest.instantiation.InstantiationCommand;
45 import org.onap.policy.clamp.controlloop.models.messages.rest.instantiation.InstantiationResponse;
46 import org.onap.policy.clamp.controlloop.runtime.commissioning.CommissioningProvider;
47 import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
48 import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
49 import org.onap.policy.clamp.controlloop.runtime.supervision.SupervisionHandler;
50 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopStateChangePublisher;
51 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ControlLoopUpdatePublisher;
52 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantDeregisterAckPublisher;
53 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantRegisterAckPublisher;
54 import org.onap.policy.clamp.controlloop.runtime.supervision.comm.ParticipantUpdatePublisher;
55 import org.onap.policy.clamp.controlloop.runtime.util.CommonTestData;
56 import org.onap.policy.common.utils.coder.YamlJsonTranslator;
57 import org.onap.policy.common.utils.resources.ResourceUtils;
58 import org.onap.policy.models.base.PfModelException;
59 import org.onap.policy.models.provider.PolicyModelsProvider;
60 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
61 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
64 * Class to perform unit test of {@link ControlLoopInstantiationProvider}}.
67 class ControlLoopInstantiationProviderTest {
69 private static final String CL_INSTANTIATION_CREATE_JSON = "src/test/resources/rest/controlloops/ControlLoops.json";
70 private static final String CL_INSTANTIATION_UPDATE_JSON =
71 "src/test/resources/rest/controlloops/ControlLoopsUpdate.json";
72 private static final String CL_INSTANTIATION_CHANGE_STATE_JSON =
73 "src/test/resources/rest/controlloops/PassiveCommand.json";
74 private static final String CL_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON =
75 "src/test/resources/rest/controlloops/ControlLoopElementsNotFound.json";
76 private static final String CL_INSTANTIATION_CONTROLLOOP_DEFINITION_NOT_FOUND_JSON =
77 "src/test/resources/rest/controlloops/ControlLoopsNotFound.json";
78 private static final String TOSCA_TEMPLATE_YAML =
79 "src/test/resources/rest/servicetemplates/pmsh_multiple_cl_tosca.yaml";
80 private static final String CONTROL_LOOP_NOT_FOUND = "Control Loop not found";
81 private static final String DELETE_BAD_REQUEST = "Control Loop State is still %s";
82 private static final String ORDERED_STATE_INVALID = "ordered state invalid or not specified on command";
83 private static final String CONTROLLOOP_ELEMENT_NAME_NOT_FOUND =
84 "\"ControlLoops\" INVALID, item has status INVALID\n"
85 + " \"entry org.onap.domain.pmsh.PMSHControlLoopDefinition\" INVALID, item has status INVALID\n"
86 + " \"entry org.onap.domain.pmsh.DCAEMicroservice\" INVALID, Not FOUND\n"
87 + " \"entry org.onap.domain.pmsh.PMSHControlLoopDefinition\" INVALID, item has status INVALID\n"
88 + " \"entry org.onap.domain.pmsh.DCAEMicroservice\" INVALID, Not FOUND\n";
90 private static final String CONTROLLOOP_DEFINITION_NOT_FOUND = "\"ControlLoops\" INVALID, item has status INVALID\n"
91 + " \"entry org.onap.domain.PMSHControlLoopDefinition\" INVALID, item has status INVALID\n"
92 + " item \"ControlLoop\" value \"org.onap.domain.PMSHControlLoopDefinition\" INVALID,"
93 + " Commissioned control loop definition not FOUND\n"
94 + " \"entry org.onap.domain.PMSHControlLoopDefinition\" INVALID, item has status INVALID\n"
95 + " item \"ControlLoop\" value \"org.onap.domain.PMSHControlLoopDefinition\" INVALID,"
96 + " Commissioned control loop definition not FOUND\n";
98 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
100 private static final YamlJsonTranslator yamlTranslator = new YamlJsonTranslator();
102 private static SupervisionHandler supervisionHandler;
103 private static CommissioningProvider commissioningProvider;
104 private static ControlLoopProvider clProvider;
105 private static PolicyModelsProvider modelsProvider;
106 private static ParticipantProvider participantProvider;
109 public static void setUpBeforeClass() throws Exception {
110 serviceTemplate = yamlTranslator.fromYaml(ResourceUtils.getResourceAsString(TOSCA_TEMPLATE_YAML),
111 ToscaServiceTemplate.class);
115 * setup Db Provider Parameters.
117 * @throws PfModelException if an error occurs
120 public static void setupDbProviderParameters() throws PfModelException {
121 ClRuntimeParameterGroup controlLoopParameters = CommonTestData.geParameterGroup("instantproviderdb");
123 modelsProvider = CommonTestData.getPolicyModelsProvider(controlLoopParameters.getDatabaseProviderParameters());
124 clProvider = new ControlLoopProvider(controlLoopParameters.getDatabaseProviderParameters());
125 participantProvider = new ParticipantProvider(controlLoopParameters.getDatabaseProviderParameters());
127 var participantStatisticsProvider =
128 new ParticipantStatisticsProvider(controlLoopParameters.getDatabaseProviderParameters());
129 var clElementStatisticsProvider =
130 new ClElementStatisticsProvider(controlLoopParameters.getDatabaseProviderParameters());
131 commissioningProvider = new CommissioningProvider(modelsProvider, clProvider, null, participantProvider);
132 var monitoringProvider =
133 new MonitoringProvider(participantStatisticsProvider, clElementStatisticsProvider, clProvider);
134 var participantProvider = new ParticipantProvider(controlLoopParameters.getDatabaseProviderParameters());
135 var controlLoopUpdatePublisher = Mockito.mock(ControlLoopUpdatePublisher.class);
136 var controlLoopStateChangePublisher = Mockito.mock(ControlLoopStateChangePublisher.class);
137 var participantRegisterAckPublisher = Mockito.mock(ParticipantRegisterAckPublisher.class);
138 var participantDeregisterAckPublisher = Mockito.mock(ParticipantDeregisterAckPublisher.class);
139 var participantUpdatePublisher = Mockito.mock(ParticipantUpdatePublisher.class);
140 supervisionHandler = new SupervisionHandler(clProvider, participantProvider, monitoringProvider,
141 controlLoopUpdatePublisher, controlLoopStateChangePublisher, participantRegisterAckPublisher,
142 participantDeregisterAckPublisher, participantUpdatePublisher);
146 public void populateDb() throws Exception {
151 public static void closeDbProvider() throws PfModelException {
153 modelsProvider.close();
157 public void cleanDatabase() throws Exception {
158 deleteEntryInDB(serviceTemplate.getName(), serviceTemplate.getVersion());
162 void testInstantiationCrud() throws Exception {
163 participantProvider.createParticipants(CommonTestData.createParticipants());
165 ControlLoops controlLoopsCreate =
166 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Crud");
167 ControlLoops controlLoopsDb = getControlLoopsFromDb(controlLoopsCreate);
168 assertThat(controlLoopsDb.getControlLoopList()).isEmpty();
169 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
170 supervisionHandler, participantProvider);
171 InstantiationResponse instantiationResponse = instantiationProvider.createControlLoops(controlLoopsCreate);
172 InstantiationUtils.assertInstantiationResponse(instantiationResponse, controlLoopsCreate);
174 controlLoopsDb = getControlLoopsFromDb(controlLoopsCreate);
175 assertThat(controlLoopsDb.getControlLoopList()).isNotEmpty();
176 assertThat(controlLoopsCreate).isEqualTo(controlLoopsDb);
178 for (ControlLoop controlLoop : controlLoopsCreate.getControlLoopList()) {
179 ControlLoops controlLoopsGet =
180 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
181 assertThat(controlLoopsGet.getControlLoopList()).hasSize(1);
182 assertThat(controlLoop).isEqualTo(controlLoopsGet.getControlLoopList().get(0));
185 ControlLoops controlLoopsUpdate =
186 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_UPDATE_JSON, "Crud");
187 assertThat(controlLoopsUpdate).isNotEqualTo(controlLoopsDb);
189 instantiationResponse = instantiationProvider.updateControlLoops(controlLoopsUpdate);
190 InstantiationUtils.assertInstantiationResponse(instantiationResponse, controlLoopsUpdate);
192 controlLoopsDb = getControlLoopsFromDb(controlLoopsCreate);
193 assertThat(controlLoopsDb.getControlLoopList()).isNotEmpty();
194 assertThat(controlLoopsUpdate).isEqualTo(controlLoopsDb);
196 InstantiationCommand instantiationCommand =
197 InstantiationUtils.getInstantiationCommandFromResource(CL_INSTANTIATION_CHANGE_STATE_JSON, "Crud");
198 instantiationResponse = instantiationProvider.issueControlLoopCommand(instantiationCommand);
199 InstantiationUtils.assertInstantiationResponse(instantiationResponse, instantiationCommand);
201 for (ToscaConceptIdentifier toscaConceptIdentifier : instantiationCommand.getControlLoopIdentifierList()) {
202 ControlLoops controlLoopsGet = instantiationProvider.getControlLoops(toscaConceptIdentifier.getName(),
203 toscaConceptIdentifier.getVersion());
204 assertThat(controlLoopsGet.getControlLoopList()).hasSize(1);
205 assertThat(instantiationCommand.getOrderedState())
206 .isEqualTo(controlLoopsGet.getControlLoopList().get(0).getOrderedState());
209 // in order to delete a controlLoop the state must be UNINITIALISED
210 controlLoopsCreate.getControlLoopList().forEach(cl -> cl.setState(ControlLoopState.UNINITIALISED));
211 instantiationProvider.updateControlLoops(controlLoopsCreate);
213 for (ControlLoop controlLoop : controlLoopsCreate.getControlLoopList()) {
214 instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion());
217 controlLoopsDb = getControlLoopsFromDb(controlLoopsCreate);
218 assertThat(controlLoopsDb.getControlLoopList()).isEmpty();
221 private ControlLoops getControlLoopsFromDb(ControlLoops controlLoopsSource) throws Exception {
223 ControlLoops controlLoopsDb = new ControlLoops();
224 controlLoopsDb.setControlLoopList(new ArrayList<>());
226 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
227 supervisionHandler, participantProvider);
229 for (ControlLoop controlLoop : controlLoopsSource.getControlLoopList()) {
230 ControlLoops controlLoopsFromDb =
231 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
232 controlLoopsDb.getControlLoopList().addAll(controlLoopsFromDb.getControlLoopList());
234 return controlLoopsDb;
238 void testInstantiationDelete() throws Exception {
240 ControlLoops controlLoops =
241 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Delete");
242 assertThat(getControlLoopsFromDb(controlLoops).getControlLoopList()).isEmpty();
244 ControlLoop controlLoop0 = controlLoops.getControlLoopList().get(0);
246 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
247 supervisionHandler, participantProvider);
250 () -> instantiationProvider.deleteControlLoop(controlLoop0.getName(), controlLoop0.getVersion()))
251 .hasMessageMatching(CONTROL_LOOP_NOT_FOUND);
253 InstantiationUtils.assertInstantiationResponse(instantiationProvider.createControlLoops(controlLoops),
256 for (ControlLoopState state : ControlLoopState.values()) {
257 if (!ControlLoopState.UNINITIALISED.equals(state)) {
258 assertThatDeleteThrownBy(controlLoops, state);
262 controlLoop0.setState(ControlLoopState.UNINITIALISED);
263 instantiationProvider.updateControlLoops(controlLoops);
265 for (ControlLoop controlLoop : controlLoops.getControlLoopList()) {
266 instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion());
269 for (ControlLoop controlLoop : controlLoops.getControlLoopList()) {
270 ControlLoops controlLoopsGet =
271 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
272 assertThat(controlLoopsGet.getControlLoopList()).isEmpty();
276 private void assertThatDeleteThrownBy(ControlLoops controlLoops, ControlLoopState state) throws Exception {
277 ControlLoop controlLoop = controlLoops.getControlLoopList().get(0);
279 controlLoop.setState(state);
281 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
282 supervisionHandler, participantProvider);
284 instantiationProvider.updateControlLoops(controlLoops);
286 () -> instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion()))
287 .hasMessageMatching(String.format(DELETE_BAD_REQUEST, state));
291 void testCreateControlLoops_NoDuplicates() throws Exception {
293 ControlLoops controlLoopsCreate =
294 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "NoDuplicates");
296 ControlLoops controlLoopsDb = getControlLoopsFromDb(controlLoopsCreate);
297 assertThat(controlLoopsDb.getControlLoopList()).isEmpty();
299 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
300 supervisionHandler, participantProvider);
302 InstantiationResponse instantiationResponse = instantiationProvider.createControlLoops(controlLoopsCreate);
303 InstantiationUtils.assertInstantiationResponse(instantiationResponse, controlLoopsCreate);
305 assertThatThrownBy(() -> instantiationProvider.createControlLoops(controlLoopsCreate)).hasMessageMatching(
306 controlLoopsCreate.getControlLoopList().get(0).getKey().asIdentifier() + " already defined");
308 for (ControlLoop controlLoop : controlLoopsCreate.getControlLoopList()) {
309 instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion());
314 void testCreateControlLoops_CommissionedClElementNotFound() throws Exception {
316 ControlLoops controlLoops = InstantiationUtils
317 .getControlLoopsFromResource(CL_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON, "ClElementNotFound");
319 var provider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider, supervisionHandler,
320 participantProvider);
322 // to validate control Loop, it needs to define ToscaServiceTemplate
323 // InstantiationUtils.storeToscaServiceTemplate(TOSCA_TEMPLATE_YAML, commissioningProvider);
325 assertThat(getControlLoopsFromDb(controlLoops).getControlLoopList()).isEmpty();
327 assertThatThrownBy(() -> provider.createControlLoops(controlLoops))
328 .hasMessageMatching(CONTROLLOOP_ELEMENT_NAME_NOT_FOUND);
332 void testCreateControlLoops_CommissionedClNotFound() throws Exception {
333 ControlLoops controlLoops = InstantiationUtils
334 .getControlLoopsFromResource(CL_INSTANTIATION_CONTROLLOOP_DEFINITION_NOT_FOUND_JSON, "ClNotFound");
336 assertThat(getControlLoopsFromDb(controlLoops).getControlLoopList()).isEmpty();
338 var provider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider, supervisionHandler,
339 participantProvider);
340 assertThatThrownBy(() -> provider.createControlLoops(controlLoops))
341 .hasMessageMatching(CONTROLLOOP_DEFINITION_NOT_FOUND);
345 void testIssueControlLoopCommand_OrderedStateInvalid() throws ControlLoopRuntimeException, IOException {
346 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
347 supervisionHandler, participantProvider);
348 assertThatThrownBy(() -> instantiationProvider.issueControlLoopCommand(new InstantiationCommand()))
349 .hasMessageMatching(ORDERED_STATE_INVALID);
353 void testInstantiationVersions() throws Exception {
354 // create controlLoops V1
355 ControlLoops controlLoopsV1 =
356 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "V1");
357 assertThat(getControlLoopsFromDb(controlLoopsV1).getControlLoopList()).isEmpty();
359 var instantiationProvider = new ControlLoopInstantiationProvider(clProvider, commissioningProvider,
360 supervisionHandler, participantProvider);
362 InstantiationUtils.assertInstantiationResponse(instantiationProvider.createControlLoops(controlLoopsV1),
365 // create controlLoops V2
366 ControlLoops controlLoopsV2 =
367 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "V2");
368 assertThat(getControlLoopsFromDb(controlLoopsV2).getControlLoopList()).isEmpty();
369 InstantiationUtils.assertInstantiationResponse(instantiationProvider.createControlLoops(controlLoopsV2),
372 // GET controlLoops V2
373 for (ControlLoop controlLoop : controlLoopsV2.getControlLoopList()) {
374 ControlLoops controlLoopsGet =
375 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
376 assertThat(controlLoopsGet.getControlLoopList()).hasSize(1);
377 assertThat(controlLoop).isEqualTo(controlLoopsGet.getControlLoopList().get(0));
380 // DELETE controlLoops V1
381 for (ControlLoop controlLoop : controlLoopsV1.getControlLoopList()) {
382 instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion());
385 // GET controlLoops V1 is not available
386 for (ControlLoop controlLoop : controlLoopsV1.getControlLoopList()) {
387 ControlLoops controlLoopsGet =
388 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
389 assertThat(controlLoopsGet.getControlLoopList()).isEmpty();
392 // GET controlLoops V2 is still available
393 for (ControlLoop controlLoop : controlLoopsV2.getControlLoopList()) {
394 ControlLoops controlLoopsGet =
395 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
396 assertThat(controlLoopsGet.getControlLoopList()).hasSize(1);
397 assertThat(controlLoop).isEqualTo(controlLoopsGet.getControlLoopList().get(0));
400 // DELETE controlLoops V2
401 for (ControlLoop controlLoop : controlLoopsV2.getControlLoopList()) {
402 instantiationProvider.deleteControlLoop(controlLoop.getName(), controlLoop.getVersion());
405 // GET controlLoops V2 is not available
406 for (ControlLoop controlLoop : controlLoopsV2.getControlLoopList()) {
407 ControlLoops controlLoopsGet =
408 instantiationProvider.getControlLoops(controlLoop.getName(), controlLoop.getVersion());
409 assertThat(controlLoopsGet.getControlLoopList()).isEmpty();
413 private synchronized void deleteEntryInDB(String name, String version) throws Exception {
414 if (!modelsProvider.getServiceTemplateList(null, null).isEmpty()) {
415 modelsProvider.deleteServiceTemplate(name, version);
419 private synchronized void createEntryInDB() throws Exception {
421 deleteEntryInDB(serviceTemplate.getName(), serviceTemplate.getVersion());
422 modelsProvider.createServiceTemplate(serviceTemplate);
423 } catch (Exception e) {