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 java.util.HashMap;
33 import java.util.UUID;
34 import javax.ws.rs.client.Entity;
35 import javax.ws.rs.core.Response;
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.rest.CommonRestController;
42 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
43 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
44 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
46 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
47 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
48 import org.springframework.beans.factory.annotation.Autowired;
49 import org.springframework.boot.test.context.SpringBootTest;
50 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
51 import org.springframework.boot.web.server.LocalServerPort;
52 import org.springframework.test.context.ActiveProfiles;
53 import org.springframework.test.context.junit.jupiter.SpringExtension;
55 @ExtendWith(SpringExtension.class)
56 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
57 @ActiveProfiles({ "test", "default" })
58 class CommissioningControllerTest extends CommonRestController {
60 private static final String COMMISSIONING_ENDPOINT = "compositions";
61 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
64 private AcDefinitionProvider acDefinitionProvider;
67 private int randomServerPort;
70 * starts Main and inserts a commissioning template.
73 public static void setUpBeforeClass() {
74 serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
78 public void setUpPort() {
79 super.setHttpPrefix(randomServerPort);
84 super.testSwagger(COMMISSIONING_ENDPOINT);
88 void testUnauthorizedCreate() {
89 assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
93 void testUnauthorizedQuery() {
94 assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
98 void testUnauthorizedDelete() {
99 assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
103 void testCreateBadRequest() {
104 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
105 var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
107 assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
108 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
109 assertThat(commissioningResponse.getErrorDetails()).isNotNull();
110 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
115 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
116 serviceTemplateCreate.setName("Create");
118 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
119 var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
120 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
121 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
122 assertNotNull(commissioningResponse);
123 assertNull(commissioningResponse.getErrorDetails());
124 // Response should return the number of node templates present in the service template
125 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
126 for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
127 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
128 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
134 var toscaDataType = new ToscaDataType();
135 toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
136 toscaDataType.setDerivedFrom("tosca.datatypes.Root");
137 toscaDataType.setProperties(new HashMap<>());
138 var toscaProperty = new ToscaProperty();
139 toscaProperty.setName("configurationEntityId");
140 toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
141 toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
143 var compositionId = createEntryInDB("forUpdate");
144 var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
145 serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
146 serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
147 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
148 var resp = invocationBuilder.post(Entity.json(serviceTemplateUpdate));
149 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
150 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
151 assertNotNull(commissioningResponse);
152 assertNull(commissioningResponse.getErrorDetails());
153 // Response should return the number of node templates present in the service template
154 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
155 for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
156 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
157 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
160 invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
161 resp = invocationBuilder.buildGet().invoke();
162 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
163 var entity = resp.readEntity(AutomationCompositionDefinition.class);
164 assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
168 void testQuery_NoResultWithThisName() {
169 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
170 var rawresp = invocationBuilder.buildGet().invoke();
171 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
172 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
173 assertThat(entityList.getNodeTypes()).isNull();
178 createEntryInDB("forQuery");
180 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
181 var rawresp = invocationBuilder.buildGet().invoke();
182 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
183 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
184 assertNotNull(entityList);
188 void testDeleteBadRequest() {
189 createEntryInDB("DeleteBadRequest");
191 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
192 // Call delete with no info
193 var resp = invocationBuilder.delete();
194 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
199 var compositionId = createEntryInDB("forDelete");
201 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
202 // Call delete with no info
203 var resp = invocationBuilder.delete();
204 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
206 var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
207 assertThat(templatesInDB).isEmpty();
210 private UUID createEntryInDB(String name) {
211 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
212 serviceTemplateCreate.setName(name);
213 var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplateCreate);
214 return acmDefinition.getCompositionId();