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.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;
32 import java.util.UUID;
33 import javax.ws.rs.client.Entity;
34 import javax.ws.rs.core.Response;
35 import org.junit.jupiter.api.BeforeAll;
36 import org.junit.jupiter.api.BeforeEach;
37 import org.junit.jupiter.api.Disabled;
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.messages.rest.commissioning.CommissioningResponse;
43 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
44 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
46 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
47 import org.springframework.beans.factory.annotation.Autowired;
48 import org.springframework.boot.test.context.SpringBootTest;
49 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
50 import org.springframework.boot.web.server.LocalServerPort;
51 import org.springframework.test.context.ActiveProfiles;
52 import org.springframework.test.context.junit.jupiter.SpringExtension;
54 @ExtendWith(SpringExtension.class)
55 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
56 @ActiveProfiles({ "test", "default" })
57 class CommissioningControllerTest extends CommonRestController {
59 private static final String COMMISSIONING_ENDPOINT = "compositions";
60 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
63 private AcDefinitionProvider acDefinitionProvider;
66 private int randomServerPort;
69 * starts Main and inserts a commissioning template.
72 public static void setUpBeforeClass() {
73 serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
77 public void setUpPort() {
78 super.setHttpPrefix(randomServerPort);
83 super.testSwagger(COMMISSIONING_ENDPOINT);
87 void testUnauthorizedCreate() {
88 assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
92 void testUnauthorizedQuery() {
93 assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
97 void testUnauthorizedDelete() {
98 assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
102 void testCreateBadRequest() {
103 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
104 var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
106 assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
107 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
108 assertThat(commissioningResponse.getErrorDetails()).isNotNull();
109 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
114 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
115 serviceTemplateCreate.setName("Create");
117 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
118 var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
119 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
120 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
121 assertNotNull(commissioningResponse);
122 assertNull(commissioningResponse.getErrorDetails());
123 // Response should return the number of node templates present in the service template
124 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
125 for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
126 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
127 .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 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
147 var resp = invocationBuilder.put(Entity.json(serviceTemplateUpdate));
148 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
149 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
150 assertNotNull(commissioningResponse);
151 assertNull(commissioningResponse.getErrorDetails());
152 // Response should return the number of node templates present in the service template
153 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
154 for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
155 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
156 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
159 invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
160 resp = invocationBuilder.buildGet().invoke();
161 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
162 var entity = resp.readEntity(ToscaServiceTemplate.class);
163 assertThat(entity.getDataTypes()).containsKey(toscaDataType.getName());
167 void testQuery_NoResultWithThisName() {
168 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
169 var rawresp = invocationBuilder.buildGet().invoke();
170 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
171 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
172 assertThat(entityList.getNodeTypes()).isNull();
177 createEntryInDB("forQuery");
179 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
180 var rawresp = invocationBuilder.buildGet().invoke();
181 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
182 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
183 assertNotNull(entityList);
187 void testDeleteBadRequest() {
188 createEntryInDB("DeleteBadRequest");
190 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
191 // Call delete with no info
192 var resp = invocationBuilder.delete();
193 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
198 var compositionId = createEntryInDB("forDelete");
200 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
201 // Call delete with no info
202 var resp = invocationBuilder.delete();
203 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
205 var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
206 assertThat(templatesInDB).isEmpty();
209 private UUID createEntryInDB(String name) {
210 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
211 serviceTemplateCreate.setName(name);
212 var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplateCreate);
213 return acmDefinition.getCompositionId();