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
  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.concepts.Participant;
  44 import org.onap.policy.clamp.models.acm.concepts.ParticipantState;
  45 import org.onap.policy.clamp.models.acm.concepts.ParticipantSupportedElementType;
  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.clamp.models.acm.utils.AcmUtils;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
  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     @LocalServerPort
  77     private int randomServerPort;
  78
  79     /**
  80      * starts Main and inserts a commissioning template.
  81      */
  82     @BeforeAll
  83     public static void setUpBeforeClass() {
  84         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  85     }
  86
  87     @BeforeEach
  88     public void setUpPort() {
  89         super.setHttpPrefix(randomServerPort);
  90     }
  91
  92     @Test
  93     void testSwagger() {
  94         super.testSwagger(COMMISSIONING_ENDPOINT);
  95     }
  96
  97     @Test
  98     void testUnauthorizedCreate() {
  99         assertUnauthorizedPost(COMMISSIONING_ENDPOINT, Entity.json(serviceTemplate));
 100     }
 101
 102     @Test
 103     void testUnauthorizedQuery() {
 104         assertUnauthorizedGet(COMMISSIONING_ENDPOINT);
 105     }
 106
 107     @Test
 108     void testUnauthorizedDelete() {
 109         assertUnauthorizedDelete(COMMISSIONING_ENDPOINT);
 110     }
 111
 112     @Test
 113     void testCreateBadRequest() {
 114         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 115         var resp = invocationBuilder.post(Entity.json("NotToscaServiceTempalte"));
 116
 117         assertThat(Response.Status.BAD_REQUEST.getStatusCode()).isEqualTo(resp.getStatus());
 118         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
 119         assertThat(commissioningResponse.getErrorDetails()).isNotNull();
 120         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).isNull();
 121     }
 122
 123     @Test
 124     void testCreate() {
 125         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 126         serviceTemplateCreate.setName("Create");
 127
 128         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 129         var resp = invocationBuilder.post(Entity.json(serviceTemplateCreate));
 130         assertEquals(Response.Status.CREATED.getStatusCode(), resp.getStatus());
 131         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
 132         assertNotNull(commissioningResponse);
 133         assertNull(commissioningResponse.getErrorDetails());
 134         // Response should return the number of node templates present in the service template
 135         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 136         for (var nodeTemplateName : serviceTemplateCreate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 137             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 138                     .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 139         }
 140     }
 141
 142     @Test
 143     void testUpdate() {
 144         var toscaDataType = new ToscaDataType();
 145         toscaDataType.setName("org.onap.datatypes.policy.clamp.Configuration");
 146         toscaDataType.setDerivedFrom("tosca.datatypes.Root");
 147         toscaDataType.setProperties(new HashMap<>());
 148         var toscaProperty = new ToscaProperty();
 149         toscaProperty.setName("configurationEntityId");
 150         toscaProperty.setType("onap.datatypes.ToscaConceptIdentifier");
 151         toscaDataType.getProperties().put(toscaProperty.getName(), toscaProperty);
 152
 153         var compositionId = createEntryInDB("forUpdate");
 154         var serviceTemplateUpdate = new ToscaServiceTemplate(serviceTemplate);
 155         serviceTemplateUpdate.getDataTypes().put(toscaDataType.getName(), toscaDataType);
 156         serviceTemplateUpdate.setMetadata(Map.of("compositionId", compositionId));
 157         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 158         var resp = invocationBuilder.post(Entity.json(serviceTemplateUpdate));
 159         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 160         var commissioningResponse = resp.readEntity(CommissioningResponse.class);
 161         assertNotNull(commissioningResponse);
 162         assertNull(commissioningResponse.getErrorDetails());
 163         // Response should return the number of node templates present in the service template
 164         assertThat(commissioningResponse.getAffectedAutomationCompositionDefinitions()).hasSize(7);
 165         for (var nodeTemplateName : serviceTemplateUpdate.getToscaTopologyTemplate().getNodeTemplates().keySet()) {
 166             assertTrue(commissioningResponse.getAffectedAutomationCompositionDefinitions().stream()
 167                     .anyMatch(ac -> ac.getName().equals(nodeTemplateName)));
 168         }
 169
 170         invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
 171         resp = invocationBuilder.buildGet().invoke();
 172         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 173         var entity = resp.readEntity(AutomationCompositionDefinition.class);
 174         assertThat(entity.getServiceTemplate().getDataTypes()).containsKey(toscaDataType.getName());
 175     }
 176
 177     @Test
 178     void testQuery_NoResultWithThisName() {
 179         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "?name=noResultWithThisName");
 180         var rawresp = invocationBuilder.buildGet().invoke();
 181         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 182         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 183         assertThat(entityList.getNodeTypes()).isNull();
 184     }
 185
 186     @Test
 187     void testQuery() {
 188         createEntryInDB("forQuery");
 189
 190         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT);
 191         var rawresp = invocationBuilder.buildGet().invoke();
 192         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 193         var entityList = rawresp.readEntity(ToscaServiceTemplate.class);
 194         assertNotNull(entityList);
 195     }
 196
 197     @Test
 198     void testDeleteBadRequest() {
 199         createEntryInDB("DeleteBadRequest");
 200
 201         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + UUID.randomUUID());
 202         // Call delete with no info
 203         var resp = invocationBuilder.delete();
 204         assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
 205     }
 206
 207     @Test
 208     void testDelete() {
 209         var compositionId = createEntryInDB("forDelete");
 210
 211         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
 212         // Call delete with no info
 213         var resp = invocationBuilder.delete();
 214         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 215
 216         var templatesInDB = acDefinitionProvider.findAcDefinition(compositionId);
 217         assertThat(templatesInDB).isEmpty();
 218     }
 219
 220     @Test
 221     void testPrimeBadRequest() {
 222         var compositionId = createEntryInDB("Prime");
 223         var invocationBuilder = super.sendRequest(COMMISSIONING_ENDPOINT + "/" + compositionId);
 224         var body = new AcTypeStateUpdate();
 225         body.setPrimeOrder(PrimeOrder.PRIME);
 226         var resp = invocationBuilder.put(Entity.json(body));
 227         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 228     }
 229
 230     private UUID createEntryInDB(String name) {
 231         var serviceTemplateCreate = new ToscaServiceTemplate(serviceTemplate);
 232         serviceTemplateCreate.setName(name);
 233         var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplateCreate);
 234
 235         return acmDefinition.getCompositionId();
 236     }
 237
 238 }