2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2022 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.acm.runtime.instantiation.rest;
24 import static org.assertj.core.api.Assertions.assertThat;
25 import static org.junit.jupiter.api.Assertions.assertEquals;
26 import static org.junit.jupiter.api.Assertions.assertNotNull;
27 import static org.junit.jupiter.api.Assertions.assertNull;
28 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
30 import java.util.UUID;
31 import javax.ws.rs.client.Entity;
32 import javax.ws.rs.core.Response;
33 import org.junit.jupiter.api.AfterEach;
34 import org.junit.jupiter.api.BeforeAll;
35 import org.junit.jupiter.api.BeforeEach;
36 import org.junit.jupiter.api.Disabled;
37 import org.junit.jupiter.api.Test;
38 import org.junit.jupiter.api.extension.ExtendWith;
39 import org.onap.policy.clamp.acm.runtime.instantiation.AutomationCompositionInstantiationProvider;
40 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
41 import org.onap.policy.clamp.acm.runtime.main.rest.InstantiationController;
42 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
43 import org.onap.policy.clamp.acm.runtime.util.rest.CommonRestController;
44 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
45 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions;
46 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.AcInstanceStateUpdate;
47 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse;
48 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
49 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
50 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionRepository;
51 import org.onap.policy.models.base.PfModelException;
52 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
53 import org.springframework.beans.factory.annotation.Autowired;
54 import org.springframework.boot.test.context.SpringBootTest;
55 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
56 import org.springframework.boot.web.server.LocalServerPort;
57 import org.springframework.test.context.ActiveProfiles;
58 import org.springframework.test.context.junit.jupiter.SpringExtension;
61 * Class to perform unit test of {@link InstantiationController}}.
64 @ExtendWith(SpringExtension.class)
65 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
66 @ActiveProfiles({ "test", "default" })
67 class InstantiationControllerTest extends CommonRestController {
69 private static final String AC_INSTANTIATION_CREATE_JSON = "src/test/resources/rest/acm/AutomationComposition.json";
71 private static final String AC_INSTANTIATION_UPDATE_JSON =
72 "src/test/resources/rest/acm/AutomationCompositionUpdate.json";
74 private static final String AC_INSTANTIATION_CHANGE_STATE_JSON = "src/test/resources/rest/acm/PassiveCommand.json";
76 private static final String INSTANTIATION_ENDPOINT = "compositions/%s/instances";
78 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
79 private UUID compositionId = UUID.randomUUID();
82 private AutomationCompositionRepository automationCompositionRepository;
85 private AcDefinitionProvider acDefinitionProvider;
88 private AutomationCompositionInstantiationProvider instantiationProvider;
91 private ParticipantProvider participantProvider;
94 private int randomServerPort;
97 public static void setUpBeforeClass() {
98 serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
102 public void populateDb() {
107 public void setUpPort() {
108 super.setHttpPrefix(randomServerPort);
112 public void cleanDatabase() {
116 private String getInstanceEndPoint() {
117 return String.format(INSTANTIATION_ENDPOINT, compositionId.toString());
120 private String getInstanceEndPoint(UUID instanceId) {
121 return String.format(INSTANTIATION_ENDPOINT, compositionId.toString()) + "/" + instanceId;
126 super.testSwagger(String.format(INSTANTIATION_ENDPOINT, "{compositionId}"));
130 void testCreate_Unauthorized() {
131 var automationComposition =
132 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Unauthorized");
134 assertUnauthorizedPost(getInstanceEndPoint(), Entity.json(automationComposition));
138 void testQuery_Unauthorized() {
139 assertUnauthorizedGet(getInstanceEndPoint());
143 void testUpdate_Unauthorized() {
144 var automationComposition =
145 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_UPDATE_JSON, "Unauthorized");
147 assertUnauthorizedPut(getInstanceEndPoint(), Entity.json(automationComposition));
151 void testDelete_Unauthorized() {
152 assertUnauthorizedDelete(getInstanceEndPoint());
157 var automationCompositionFromRsc =
158 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Create");
159 automationCompositionFromRsc.setCompositionId(compositionId);
161 var invocationBuilder = super.sendRequest(getInstanceEndPoint());
162 var resp = invocationBuilder.post(Entity.json(automationCompositionFromRsc));
163 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
164 var instResponse = resp.readEntity(InstantiationResponse.class);
165 InstantiationUtils.assertInstantiationResponse(instResponse, automationCompositionFromRsc);
166 automationCompositionFromRsc.setInstanceId(instResponse.getInstanceId());
168 var automationCompositionFromDb =
169 instantiationProvider.getAutomationComposition(compositionId, instResponse.getInstanceId());
171 assertNotNull(automationCompositionFromDb);
172 assertEquals(automationCompositionFromRsc, automationCompositionFromDb);
177 void testCreateBadRequest() {
178 var automationCompositionFromRsc = InstantiationUtils
179 .getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "CreateBadRequest");
180 automationCompositionFromRsc.setCompositionId(compositionId);
182 var invocationBuilder = super.sendRequest(getInstanceEndPoint());
183 var resp = invocationBuilder.post(Entity.json(automationCompositionFromRsc));
184 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
186 // testing Bad Request: AC already defined
187 resp = invocationBuilder.post(Entity.json(automationCompositionFromRsc));
188 assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
189 var instResponse = resp.readEntity(InstantiationResponse.class);
190 assertNotNull(instResponse.getErrorDetails());
191 assertNull(instResponse.getAffectedAutomationComposition());
195 void testQuery_NoResultWithThisName() {
196 var invocationBuilder = super.sendRequest(getInstanceEndPoint() + "?name=noResultWithThisName");
197 var rawresp = invocationBuilder.buildGet().invoke();
198 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
199 var resp = rawresp.readEntity(AutomationCompositions.class);
200 assertThat(resp.getAutomationCompositionList()).isEmpty();
205 var automationComposition =
206 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Query");
207 automationComposition.setCompositionId(compositionId);
209 instantiationProvider.createAutomationComposition(compositionId, automationComposition);
211 var invocationBuilder =
212 super.sendRequest(getInstanceEndPoint() + "?name=" + automationComposition.getKey().getName());
213 var rawresp = invocationBuilder.buildGet().invoke();
214 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
215 var automationCompositionsQuery = rawresp.readEntity(AutomationCompositions.class);
216 assertNotNull(automationCompositionsQuery);
217 assertThat(automationCompositionsQuery.getAutomationCompositionList()).hasSize(1);
218 assertEquals(automationComposition, automationCompositionsQuery.getAutomationCompositionList().get(0));
223 var automationCompositionCreate =
224 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Update");
225 automationCompositionCreate.setCompositionId(compositionId);
227 var response = instantiationProvider.createAutomationComposition(compositionId, automationCompositionCreate);
229 var automationComposition =
230 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_UPDATE_JSON, "Update");
231 automationComposition.setCompositionId(compositionId);
232 automationComposition.setInstanceId(response.getInstanceId());
233 var invocationBuilder = super.sendRequest(getInstanceEndPoint());
234 var resp = invocationBuilder.post(Entity.json(automationComposition));
235 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
237 var instResponse = resp.readEntity(InstantiationResponse.class);
238 InstantiationUtils.assertInstantiationResponse(instResponse, automationComposition);
240 var automationCompositionsFromDb = instantiationProvider.getAutomationCompositions(compositionId,
241 automationComposition.getKey().getName(), automationComposition.getKey().getVersion());
243 assertNotNull(automationCompositionsFromDb);
244 assertThat(automationCompositionsFromDb.getAutomationCompositionList()).hasSize(1);
245 assertEquals(automationComposition, automationCompositionsFromDb.getAutomationCompositionList().get(0));
250 var automationCompositionFromRsc =
251 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Delete");
252 automationCompositionFromRsc.setCompositionId(compositionId);
255 instantiationProvider.createAutomationComposition(compositionId, automationCompositionFromRsc);
257 var invocationBuilder = super.sendRequest(getInstanceEndPoint(instResponse.getInstanceId()));
258 var resp = invocationBuilder.delete();
259 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
260 instResponse = resp.readEntity(InstantiationResponse.class);
261 InstantiationUtils.assertInstantiationResponse(instResponse, automationCompositionFromRsc);
263 var automationCompositionsFromDb = instantiationProvider.getAutomationCompositions(compositionId,
264 automationCompositionFromRsc.getKey().getName(), automationCompositionFromRsc.getKey().getVersion());
265 assertThat(automationCompositionsFromDb.getAutomationCompositionList()).isEmpty();
269 void testDeleteNotFound() {
270 var automationCompositionFromRsc =
271 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "DelNotFound");
272 automationCompositionFromRsc.setCompositionId(compositionId);
274 instantiationProvider.createAutomationComposition(compositionId, automationCompositionFromRsc);
276 var invocationBuilder = super.sendRequest(getInstanceEndPoint(UUID.randomUUID()));
277 var resp = invocationBuilder.delete();
278 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
283 void testCommand_NotFound1() {
284 var invocationBuilder = super.sendRequest(getInstanceEndPoint(UUID.randomUUID()));
285 var resp = invocationBuilder.post(Entity.json(new AutomationComposition()));
286 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
291 void testCommand_NotFound2() {
293 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "DelNotFound");
294 acFromRsc.setCompositionId(compositionId);
296 var instResponse = instantiationProvider.createAutomationComposition(compositionId, acFromRsc);
298 var command = new AcInstanceStateUpdate();
299 command.setDeployOrder(null);
300 command.setLockOrder(null);
302 var invocationBuilder = super.sendRequest(getInstanceEndPoint(instResponse.getInstanceId()));
303 var resp = invocationBuilder.put(Entity.json(command));
304 assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
309 void testCommand() throws PfModelException {
310 var automationComposition =
311 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Command");
312 automationComposition.setCompositionId(compositionId);
313 var instResponse = instantiationProvider.createAutomationComposition(compositionId, automationComposition);
315 var participants = CommonTestData.createParticipants();
316 for (var participant : participants) {
317 participantProvider.saveParticipant(participant);
320 var instantiationUpdate = new AcInstanceStateUpdate();
322 var invocationBuilder = super.sendRequest(getInstanceEndPoint(instResponse.getInstanceId()));
323 var resp = invocationBuilder.put(Entity.json(instantiationUpdate));
324 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
325 instResponse = resp.readEntity(InstantiationResponse.class);
326 InstantiationUtils.assertInstantiationResponse(instResponse, automationComposition);
328 // check passive state on DB
329 var toscaConceptIdentifier = instResponse.getAffectedAutomationComposition();
330 var automationCompositionsGet = instantiationProvider.getAutomationCompositions(compositionId,
331 toscaConceptIdentifier.getName(), toscaConceptIdentifier.getVersion());
332 assertThat(automationCompositionsGet.getAutomationCompositionList()).hasSize(1);
335 private synchronized void deleteEntryInDB() {
336 automationCompositionRepository.deleteAll();
337 var list = acDefinitionProvider.findAcDefinition(compositionId);
338 if (!list.isEmpty()) {
339 acDefinitionProvider.deleteAcDefintion(compositionId);
343 private synchronized void createEntryInDB() {
345 var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplate);
346 compositionId = acmDefinition.getCompositionId();