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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2025 OpenInfra Foundation Europe. All rights reserved.
   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     static void setUpBeforeClass() {
  85         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  86     }
  87
  88     @BeforeEach
  89     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             .contains("org.springframework.http.converter.HttpMessageNotReadableException");
 127         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
 128         resp.close();
 129     }
 130
 131     @Test
 132     void testCreateBadVersion() {
 133         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 134         var x = new ToscaNodeTemplate(serviceTemplateCreate
 135             .getToscaTopologyTemplate().getNodeTemplates().values().iterator().next());
 136         x.setVersion("1.0.wrong");
 137         serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().put(x.getName(), x);
 138
 139         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.INTERNAL_SERVER_ERROR);
 140         assertThat(commissioningResponse.getErrorDetails())
 141             .isEqualTo("java.lang.IllegalArgumentException parameter "
 142                 + "\"version\": value \"1.0.wrong\", does not match regular expression \""
 143                 + PfKey.VERSION_REGEXP + "\"");
 144         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
 145     }
 146
 147     @Test
 148     void testCreate() {
 149         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 150         serviceTemplateCreate.setName("Create");
 151         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.CREATED);
 152         assertNotNull(commissioningResponse);
 153         assertNull(commissioningResponse.getErrorDetails());
 154         // Response should return the number of node templates present in the service template
 155         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 156         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 157             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 158                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 159         }
 160     }
 161
 162     @Test
 163     void testVersioning() {
 164         var serviceTemplateCreate = InstantiationUtils.getToscaServiceTemplate(TOSCA_VERSIONING);
 165         var commissioningResponse = createServiceTemplate(serviceTemplateCreate, Response.Status.CREATED);
 166         assertNotNull(commissioningResponse);
 167         assertNull(commissioningResponse.getErrorDetails());
 168         // Response should return the number of node templates present in the service template
 169         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(11);
 170         assertNotNull(serviceTemplateCreate);
 171         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 172             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 173                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 174         }
 175     }
 176
 177     private CommissioningResponse createServiceTemplate(ToscaServiceTemplate serviceTemplateCreate,
 178                                                         Response.Status statusExpected) {
 179         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 180         try (var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate))) {
 181             assertEquals(statusExpected.getStatusCode(), resp.getStatus());
 182             return resp.readEntity(CommissioningResponse.class);
 183         }
 184     }
 185
 186     @Test
 187     void testUpdate() {
 188         var toscaDataType = new ToscaDataType();
 189         toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
 190         toscaDataType.setDerivedFrom("tosca.datatypes.Root");
 191         toscaDataType.setProperties(new HashMap<>());
 192         var toscaProperty = new ToscaProperty();
 193         toscaProperty.setName("configurationEntityId");
 194         toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
 195         toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
 196
 197         var compositionId = createEntryInDB("forUpdate");
 198         var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
 199         serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
 200         serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
 201
 202         var commissioningResponse = createServiceTemplate(serviceTemplateUpdate, Response.Status.OK);
 203         assertNotNull(commissioningResponse);
 204         assertNull(commissioningResponse.getErrorDetails());
 205         // Response should return the number of node templates present in the service template
 206         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 207         for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 208             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 209                 .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 210         }
 211
 212         var entity = getServiceTemplate(COMMISSIONING_ENDPOINT + "/" + compositionId);
 213         assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
 214     }
 215
 216     private AutomationCompositionDefinition getServiceTemplate(String url) {
 217         var invocationBuilder = super.sendRequest(url);
 218         try (var resp = invocationBuilder.buildGet().invoke()) {
 219             assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 220             return resp.readEntity(AutomationCompositionDefinition.class);
 221         }
 222     }
 223
 224     @Test
 225     void testQuery_NoResultWithThisName() {
 226         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
 227         var rawresp = invocationBuilder.buildGet().invoke();
 228         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 229         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 230         assertThat(entityList.getNodeTypes()).isNull();
 231         rawresp.close();
 232     }
 233
 234     @Test
 235     void testQuery() {
 236         createEntryInDB("forQuery");
 237
 238         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 239         var rawresp = invocationBuilder.buildGet().invoke();
 240         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 241         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 242         assertNotNull(entityList);
 243         rawresp.close();
 244     }
 245
 246     @Test
 247     void testDeleteBadRequest() {
 248         createEntryInDB("DeleteBadRequest");
 249         deleteServiceTemplate(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID(), Response.Status.NOT_FOUND);
 250     }
 251
 252     private void deleteServiceTemplate(String url, Response.Status statusExpected) {
 253         var invocationBuilder = super.sendRequest(url);
 254         try (var resp = invocationBuilder.delete()) {
 255             assertEquals(statusExpected.getStatusCode(), resp.getStatus());
 256         }
 257     }
 258
 259     @Test
 260     void testDelete() {
 261         var compositionId = createEntryInDB("forDelete");
 262         deleteServiceTemplate(COMMISSIONING_ENDPOINT + "/" + compositionId, Response.Status.OK);
 263
 264         var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
 265         assertThat(templatesInDB).isEmpty();
 266     }
 267
 268     @Test
 269     void testPrimeBadRequest() {
 270         var compositionId = createEntryInDB("Prime");
 271         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
 272         var body = new AcTypeStateUpdate();
 273         body.setPrimeOrder(PrimeOrder.PRIME);
 274         var resp = invocationBuilder.put(Entity.json(body));
 275         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 276         resp.close();
 277     }
 278
 279     private UUID createEntryInDB(String name) {
 280         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 281         serviceTemplateCreate.setName(name);
 282         var acmDefinition = acDefinitionProvider
 283             .createAutomationCompositionDefinition(serviceTemplateCreate, CommonTestData.TOSCA_ELEMENT_NAME,
 284                 CommonTestData.TOSCA_COMP_NAME);
 285
 286         return acmDefinition.getCompositionId();
 287     }
 288
 289 }