gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2024 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 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_VERSIONING;
  31
  32 import jakarta.ws.rs.client.Entity;
  33 import jakarta.ws.rs.core.Response;
  34 import java.util.HashMap;
  35 import java.util.Map;
  36 import java.util.UUID;
  37 import org.junit.jupiter.api.AfterEach;
  38 import org.junit.jupiter.api.BeforeAll;
  39 import org.junit.jupiter.api.BeforeEach;
  40 import org.junit.jupiter.api.Test;
  41 import org.junit.jupiter.api.extension.ExtendWith;
  42 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
  43 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
  44 import org.onap.policy.clamp.acm.runtime.util.rest.CommonRestController;
  45 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  46 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.AcTypeStateUpdate;
  47 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
  48 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.PrimeOrder;
  49 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  50 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  51 import org.onap.policy.models.base.PfKey;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  56 import org.springframework.beans.factory.annotation.Autowired;
  57 import org.springframework.boot.test.context.SpringBootTest;
  58 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
  59 import org.springframework.boot.test.web.server.LocalServerPort;
  60 import org.springframework.test.context.ActiveProfiles;
  61 import org.springframework.test.context.junit.jupiter.SpringExtension;
  62
  63 @ExtendWith(SpringExtension.class)
  64 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
  65 @ActiveProfiles({"test", "default"})
  66 class CommissioningControllerTest extends CommonRestController {
  67
  68     private static final String COMMISSIONING_ENDPOINT = "compositions";
  69     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  70
  71     @Autowired
  72     private AcDefinitionProvider acDefinitionProvider;
  73
  74     @Autowired
  75     private ParticipantProvider participantProvider;
  76
  77     @LocalServerPort
  78     private int randomServerPort;
  79
  80     /**
  81      * starts Main and inserts a commissioning template.
  82      */
  83     @BeforeAll
  84     public static void setUpBeforeClass() {
  85         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  86     }
  87
  88     @BeforeEach
  89     public void setUpPort() {
  90         super.setHttpPrefix(randomServerPort);
  91     }
  92
  93     @AfterEach
  94     void after() {
  95         super.client.close();
  96     }
  97
  98     @Test
  99     void testSwagger() {
 100         super.testSwagger(COMMISSIONING_ENDPOINT);
 101     }
 102
 103     @Test
 104     void testUnauthorizedCreate() {
 105         assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
 106     }
 107
 108     @Test
 109     void testUnauthorizedQuery() {
 110         assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
 111     }
 112
 113     @Test
 114     void testUnauthorizedDelete() {
 115         assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
 116     }
 117
 118     @Test
 119     void testCreateBadRequest() {
 120         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 121         var resp = invocationBuilder.post(Entity.json("NotToscaServiceTemplate"));
 122
 123         assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
 124         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
 125         assertThat(commissioningResponse.getErrorDetails())
 126             .isEqualTo("org.springframework.http.converter.HttpMessageNotReadableException "
 127                 + "Could not read JSON: java.lang.IllegalStateException: "
 128                 + "Expected BEGIN_OBJECT but was STRING at line 1 column 1 path $");
 129         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
 130         resp.close();
 131     }
 132
 133     @Test
 134     void testCreateBadVersion() {
 135         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 136         var x = new ToscaNodeTemplate(serviceTemplateCreate
 137             .getToscaTopologyTemplate().getNodeTemplates().values().iterator().next());
 138         x.setVersion("1.0.wrong");
 139         serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().put(x.getName(), x);
 140
 141         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.INTERNAL_SERVER_ERROR);
 142         assertThat(commissioningResponse.getErrorDetails())
 143             .isEqualTo("java.lang.IllegalArgumentException parameter "
 144                 + "\"version\": value \"1.0.wrong\", does not match regular expression \""
 145                 + PfKey.VERSION_REGEXP + "\"");
 146         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
 147     }
 148
 149     @Test
 150     void testCreate() {
 151         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 152         serviceTemplateCreate.setName("Create");
 153         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.CREATED);
 154         assertNotNull(commissioningResponse);
 155         assertNull(commissioningResponse.getErrorDetails());
 156         // Response should return the number of node templates present in the service template
 157         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 158         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 159             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 160                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 161         }
 162     }
 163
 164     @Test
 165     void testVersioning() {
 166         var serviceTemplateCreate = InstantiationUtils.getToscaServiceTemplate(TOSCA_VERSIONING);
 167         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.CREATED);
 168         assertNotNull(commissioningResponse);
 169         assertNull(commissioningResponse.getErrorDetails());
 170         // Response should return the number of node templates present in the service template
 171         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(11);
 172         assertNotNull(serviceTemplateCreate);
 173         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 174             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 175                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 176         }
 177     }
 178
 179     private CommissioningResponse createServiceTemplate(ToscaServiceTemplate serviceTemplateCreate,
 180                                                         Response.Status statusExpected) {
 181         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 182         try (var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate))) {
 183             assertEquals(statusExpected.getStatusCode(), resp.getStatus());
 184             return resp.readEntity(CommissioningResponse.class);
 185         }
 186     }
 187
 188     @Test
 189     void testUpdate() {
 190         var toscaDataType = new ToscaDataType();
 191         toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
 192         toscaDataType.setDerivedFrom("tosca.datatypes.Root");
 193         toscaDataType.setProperties(new HashMap<>());
 194         var toscaProperty = new ToscaProperty();
 195         toscaProperty.setName("configurationEntityId");
 196         toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
 197         toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
 198
 199         var compositionId = createEntryInDB("forUpdate");
 200         var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
 201         serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
 202         serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
 203
 204         var commissioningResponse = createServiceTemplate(serviceTemplateUpdate, Response.Status.OK);
 205         assertNotNull(commissioningResponse);
 206         assertNull(commissioningResponse.getErrorDetails());
 207         // Response should return the number of node templates present in the service template
 208         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 209         for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 210             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 211                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 212         }
 213
 214         var entity = getServiceTemplate(COMMISSIONING_ENDPOINT + "/" + compositionId);
 215         assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
 216     }
 217
 218     private AutomationCompositionDefinition getServiceTemplate(String url) {
 219         var invocationBuilder = super.sendRequest(url);
 220         try (var resp = invocationBuilder.buildGet().invoke()) {
 221             assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 222             return resp.readEntity(AutomationCompositionDefinition.class);
 223         }
 224     }
 225
 226     @Test
 227     void testQuery_NoResultWithThisName() {
 228         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
 229         var rawresp = invocationBuilder.buildGet().invoke();
 230         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 231         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 232         assertThat(entityList.getNodeTypes()).isNull();
 233         rawresp.close();
 234     }
 235
 236     @Test
 237     void testQuery() {
 238         createEntryInDB("forQuery");
 239
 240         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 241         var rawresp = invocationBuilder.buildGet().invoke();
 242         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 243         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 244         assertNotNull(entityList);
 245         rawresp.close();
 246     }
 247
 248     @Test
 249     void testDeleteBadRequest() {
 250         createEntryInDB("DeleteBadRequest");
 251         deleteServiceTemplate(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID(), Response.Status.NOT_FOUND);
 252     }
 253
 254     private void deleteServiceTemplate(String url, Response.Status statusExpected) {
 255         var invocationBuilder = super.sendRequest(url);
 256         try (var resp = invocationBuilder.delete()) {
 257             assertEquals(statusExpected.getStatusCode(), resp.getStatus());
 258         }
 259     }
 260
 261     @Test
 262     void testDelete() {
 263         var compositionId = createEntryInDB("forDelete");
 264         deleteServiceTemplate(COMMISSIONING_ENDPOINT + "/" + compositionId, Response.Status.OK);
 265
 266         var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
 267         assertThat(templatesInDB).isEmpty();
 268     }
 269
 270     @Test
 271     void testPrimeBadRequest() {
 272         var compositionId = createEntryInDB("Prime");
 273         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
 274         var body = new AcTypeStateUpdate();
 275         body.setPrimeOrder(PrimeOrder.PRIME);
 276         var resp = invocationBuilder.put(Entity.json(body));
 277         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 278         resp.close();
 279     }
 280
 281     private UUID createEntryInDB(String name) {
 282         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 283         serviceTemplateCreate.setName(name);
 284         var acmDefinition = acDefinitionProvider
 285             .createAutomationCompositionDefinition(serviceTemplateCreate, CommonTestData.TOSCA_ELEMENT_NAME,
 286                 CommonTestData.TOSCA_COMP_NAME);
 287
 288         return acmDefinition.getCompositionId();
 289     }
 290
 291 }