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.Test;
38 import org.junit.jupiter.api.extension.ExtendWith;
39 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
40 import org.onap.policy.clamp.acm.runtime.util.rest.CommonRestController;
41 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
42 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
43 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
44 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
46 import org.springframework.beans.factory.annotation.Autowired;
47 import org.springframework.boot.test.context.SpringBootTest;
48 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
49 import org.springframework.boot.web.server.LocalServerPort;
50 import org.springframework.test.context.ActiveProfiles;
51 import org.springframework.test.context.junit.jupiter.SpringExtension;
53 @ExtendWith(SpringExtension.class)
54 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
55 @ActiveProfiles({ "test", "default" })
56 class CommissioningControllerTest extends CommonRestController {
58 private static final String COMMISSIONING_ENDPOINT = "compositions";
59 private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
62 private AcDefinitionProvider acDefinitionProvider;
65 private int randomServerPort;
68 * starts Main and inserts a commissioning template.
71 public static void setUpBeforeClass() {
72 serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
76 public void setUpPort() {
77 super.setHttpPrefix(randomServerPort);
82 super.testSwagger(COMMISSIONING_ENDPOINT);
86 void testUnauthorizedCreate() {
87 assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
91 void testUnauthorizedQuery() {
92 assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
96 void testUnauthorizedDelete() {
97 assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
101 void testCreateBadRequest() {
102 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
103 var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
105 assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
106 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
107 assertThat(commissioningResponse.getErrorDetails()).isNotNull();
108 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
113 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
114 serviceTemplateCreate.setName("Create");
116 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
117 var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
118 assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
119 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
120 assertNotNull(commissioningResponse);
121 assertNull(commissioningResponse.getErrorDetails());
122 // Response should return the number of node templates present in the service template
123 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
124 for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
125 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
126 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
132 var toscaDataType = new ToscaDataType();
133 toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
134 toscaDataType.setDerivedFrom("tosca.datatypes.Root");
135 toscaDataType.setProperties(new HashMap<>());
136 var toscaProperty = new ToscaProperty();
137 toscaProperty.setName("configurationEntityId");
138 toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
139 toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
141 var compositionId = createEntryInDB("forUpdate");
142 var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
143 serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
144 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
145 var resp = invocationBuilder.put(Entity.json(serviceTemplateUpdate));
146 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
147 var commissioningResponse = resp.readEntity(CommissioningResponse.class);
148 assertNotNull(commissioningResponse);
149 assertNull(commissioningResponse.getErrorDetails());
150 // Response should return the number of node templates present in the service template
151 assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
152 for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
153 assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
154 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
157 invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
158 resp = invocationBuilder.buildGet().invoke();
159 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
160 var entity = resp.readEntity(ToscaServiceTemplate.class);
161 assertThat(entity.getDataTypes()).containsKey(toscaDataType.getName());
165 void testQuery_NoResultWithThisName() {
166 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
167 var rawresp = invocationBuilder.buildGet().invoke();
168 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
169 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
170 assertThat(entityList.getNodeTypes()).isNull();
175 createEntryInDB("forQuery");
177 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
178 var rawresp = invocationBuilder.buildGet().invoke();
179 assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
180 var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
181 assertNotNull(entityList);
185 void testDeleteBadRequest() {
186 createEntryInDB("DeleteBadRequest");
188 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
189 // Call delete with no info
190 var resp = invocationBuilder.delete();
191 assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
196 var compositionId = createEntryInDB("forDelete");
198 var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
199 // Call delete with no info
200 var resp = invocationBuilder.delete();
201 assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
203 var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
204 assertThat(templatesInDB).isEmpty();
207 private UUID createEntryInDB(String name) {
208 var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
209 serviceTemplateCreate.setName(name);
210 var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplateCreate);
211 return acmDefinition.getCompositionId();