2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2023 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.commissioning.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.junit.jupiter.api.Assertions.assertTrue;
29 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
31 import jakarta.ws.rs.client.Entity;
32 import jakarta.ws.rs.core.Response;
33 import java.util.HashMap;
35 import java.util.UUID;
36 import org.junit.jupiter.api.BeforeAll;
37 import org.junit.jupiter.api.BeforeEach;
38 import org.junit.jupiter.api.Test;
39 import org.junit.jupiter.api.extension.ExtendWith;
40 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
41 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
42 import org.onap.policy.clamp.acm.runtime.util.rest.CommonRestController;
43 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
44 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.AcTypeStateUpdate;
45 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
46 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.PrimeOrder;
47 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
48 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
49 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
50 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
51 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
52 import org.springframework.beans.factory.annotation.Autowired;
53 import org.springframework.boot.test.context.SpringBootTest;
54 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
55 import org.springframework.boot.test.web.server.LocalServerPort;
56 import org.springframework.test.context.ActiveProfiles;
57 import org.springframework.test.context.junit.jupiter.SpringExtension;
59 @ExtendWith(SpringExtension.class)
60 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
61 @ActiveProfiles({ "test", "default" })
62 class CommissioningControllerTest extends CommonRestController {
64 private static final String COMMISSIONING_ENDPOINT = "compositions";
65 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
68 private AcDefinitionProvider acDefinitionProvider;
71 private ParticipantProvider participantProvider;
73 private int randomServerPort;
76 * starts Main and inserts a commissioning template.
79 public static void setUpBeforeClass() {
80 serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
84 public void setUpPort() {
85 super.setHttpPrefix(randomServerPort);
90 super.testSwagger(COMMISSIONING_ENDPOINT);
94 void testUnauthorizedCreate() {
95 assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
99 void testUnauthorizedQuery() {
100 assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
104 void testUnauthorizedDelete() {
105 assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
109 void testCreateBadRequest() {
110 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
111 var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
113 assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
114 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
115 assertThat(commissioningResponse.getErrorDetails()).isNotNull();
116 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
121 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
122 serviceTemplateCreate.setName("Create");
124 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
125 var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
126 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
127 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
128 assertNotNull(commissioningResponse);
129 assertNull(commissioningResponse.getErrorDetails());
130 // Response should return the number of node templates present in the service template
131 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
132 for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
133 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
134 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
140 var toscaDataType = new ToscaDataType();
141 toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
142 toscaDataType.setDerivedFrom("tosca.datatypes.Root");
143 toscaDataType.setProperties(new HashMap<>());
144 var toscaProperty = new ToscaProperty();
145 toscaProperty.setName("configurationEntityId");
146 toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
147 toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
149 var compositionId = createEntryInDB("forUpdate");
150 var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
151 serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
152 serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
153 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
154 var resp = invocationBuilder.post(Entity.json(serviceTemplateUpdate));
155 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
156 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
157 assertNotNull(commissioningResponse);
158 assertNull(commissioningResponse.getErrorDetails());
159 // Response should return the number of node templates present in the service template
160 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
161 for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
162 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
163 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
166 invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
167 resp = invocationBuilder.buildGet().invoke();
168 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
169 var entity = resp.readEntity(AutomationCompositionDefinition.class);
170 assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
174 void testQuery_NoResultWithThisName() {
175 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
176 var rawresp = invocationBuilder.buildGet().invoke();
177 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
178 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
179 assertThat(entityList.getNodeTypes()).isNull();
184 createEntryInDB("forQuery");
186 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
187 var rawresp = invocationBuilder.buildGet().invoke();
188 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
189 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
190 assertNotNull(entityList);
194 void testDeleteBadRequest() {
195 createEntryInDB("DeleteBadRequest");
197 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
198 // Call delete with no info
199 var resp = invocationBuilder.delete();
200 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
205 var compositionId = createEntryInDB("forDelete");
207 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
208 // Call delete with no info
209 var resp = invocationBuilder.delete();
210 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
212 var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
213 assertThat(templatesInDB).isEmpty();
217 void testPrimeBadRequest() {
218 var compositionId = createEntryInDB("Prime");
219 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
220 var body = new AcTypeStateUpdate();
221 body.setPrimeOrder(PrimeOrder.PRIME);
222 var resp = invocationBuilder.put(Entity.json(body));
223 assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
226 private UUID createEntryInDB(String name) {
227 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
228 serviceTemplateCreate.setName(name);
229 var acmDefinition = acDefinitionProvider
230 .createAutomationCompositionDefinition(serviceTemplateCreate, CommonTestData.TOSCA_ELEMENT_NAME,
231 CommonTestData.TOSCA_COMP_NAME);
233 return acmDefinition.getCompositionId();