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

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