73f3a687ec56c8ad34179e7a5d6365dd4046f76a
[policy/clamp.git] /
1 /*-
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
9  *
10  *      http://www.apache.org/licenses/LICENSE-2.0
11  *
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.
17  *
18  * SPDX-License-Identifier: Apache-2.0
19  * ============LICENSE_END=========================================================
20  */
21
22 package org.onap.policy.clamp.acm.runtime.commissioning.rest;
23
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;
30
31 import java.util.HashMap;
32 import java.util.Map;
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.AcTypeStateUpdate;
44 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
45 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.PrimeOrder;
46 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
47 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
48 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
50 import org.springframework.beans.factory.annotation.Autowired;
51 import org.springframework.boot.test.context.SpringBootTest;
52 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
53 import org.springframework.boot.web.server.LocalServerPort;
54 import org.springframework.test.context.ActiveProfiles;
55 import org.springframework.test.context.junit.jupiter.SpringExtension;
56
57 @ExtendWith(SpringExtension.class)
58 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
59 @ActiveProfiles({ "test", "default" })
60 class CommissioningControllerTest extends CommonRestController {
61
62     private static final String COMMISSIONING_ENDPOINT = "compositions";
63     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
64
65     @Autowired
66     private AcDefinitionProvider acDefinitionProvider;
67
68     @LocalServerPort
69     private int randomServerPort;
70
71     /**
72      * starts Main and inserts a commissioning template.
73      */
74     @BeforeAll
75     public static void setUpBeforeClass() {
76         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
77     }
78
79     @BeforeEach
80     public void setUpPort() {
81         super.setHttpPrefix(randomServerPort);
82     }
83
84     @Test
85     void testSwagger() {
86         super.testSwagger(COMMISSIONING_ENDPOINT);
87     }
88
89     @Test
90     void testUnauthorizedCreate() {
91         assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
92     }
93
94     @Test
95     void testUnauthorizedQuery() {
96         assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
97     }
98
99     @Test
100     void testUnauthorizedDelete() {
101         assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
102     }
103
104     @Test
105     void testCreateBadRequest() {
106         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
107         var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
108
109         assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
110         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
111         assertThat(commissioningResponse.getErrorDetails()).isNotNull();
112         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
113     }
114
115     @Test
116     void testCreate() {
117         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
118         serviceTemplateCreate.setName("Create");
119
120         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
121         var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
122         assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
123         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
124         assertNotNull(commissioningResponse);
125         assertNull(commissioningResponse.getErrorDetails());
126         // Response should return the number of node templates present in the service template
127         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
128         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
129             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
130                     .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
131         }
132     }
133
134     @Test
135     void testUpdate() {
136         var toscaDataType = new ToscaDataType();
137         toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
138         toscaDataType.setDerivedFrom("tosca.datatypes.Root");
139         toscaDataType.setProperties(new HashMap<>());
140         var toscaProperty = new ToscaProperty();
141         toscaProperty.setName("configurationEntityId");
142         toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
143         toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
144
145         var compositionId = createEntryInDB("forUpdate");
146         var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
147         serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
148         serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
149         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
150         var resp = invocationBuilder.post(Entity.json(serviceTemplateUpdate));
151         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
152         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
153         assertNotNull(commissioningResponse);
154         assertNull(commissioningResponse.getErrorDetails());
155         // Response should return the number of node templates present in the service template
156         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
157         for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
158             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
159                     .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
160         }
161
162         invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
163         resp = invocationBuilder.buildGet().invoke();
164         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
165         var entity = resp.readEntity(AutomationCompositionDefinition.class);
166         assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
167     }
168
169     @Test
170     void testQuery_NoResultWithThisName() {
171         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
172         var rawresp = invocationBuilder.buildGet().invoke();
173         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
174         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
175         assertThat(entityList.getNodeTypes()).isNull();
176     }
177
178     @Test
179     void testQuery() {
180         createEntryInDB("forQuery");
181
182         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
183         var rawresp = invocationBuilder.buildGet().invoke();
184         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
185         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
186         assertNotNull(entityList);
187     }
188
189     @Test
190     void testDeleteBadRequest() {
191         createEntryInDB("DeleteBadRequest");
192
193         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
194         // Call delete with no info
195         var resp = invocationBuilder.delete();
196         assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
197     }
198
199     @Test
200     void testDelete() {
201         var compositionId = createEntryInDB("forDelete");
202
203         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
204         // Call delete with no info
205         var resp = invocationBuilder.delete();
206         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
207
208         var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
209         assertThat(templatesInDB).isEmpty();
210     }
211
212     @Test
213     void testPrimeBadRequest() {
214         var compositionId = createEntryInDB("Prime");
215         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
216         var body = new AcTypeStateUpdate();
217         body.setPrimeOrder(PrimeOrder.PRIME);
218         var resp = invocationBuilder.put(Entity.json(body));
219         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
220     }
221
222     private UUID createEntryInDB(String name) {
223         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
224         serviceTemplateCreate.setName(name);
225         var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplateCreate);
226         return acmDefinition.getCompositionId();
227     }
228 }