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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 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.controlloop.runtime.instantiation.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
  29 import javax.ws.rs.client.Entity;
  30 import javax.ws.rs.client.Invocation;
  31 import javax.ws.rs.core.Response;
  32 import org.junit.jupiter.api.AfterEach;
  33 import org.junit.jupiter.api.BeforeAll;
  34 import org.junit.jupiter.api.BeforeEach;
  35 import org.junit.jupiter.api.Test;
  36 import org.junit.jupiter.api.extension.ExtendWith;
  37 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  38 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  39 import org.onap.policy.clamp.controlloop.models.messages.rest.instantiation.InstantiationCommand;
  40 import org.onap.policy.clamp.controlloop.models.messages.rest.instantiation.InstantiationResponse;
  41 import org.onap.policy.clamp.controlloop.runtime.instantiation.ControlLoopInstantiationProvider;
  42 import org.onap.policy.clamp.controlloop.runtime.instantiation.InstantiationUtils;
  43 import org.onap.policy.clamp.controlloop.runtime.main.parameters.ClRuntimeParameterGroup;
  44 import org.onap.policy.clamp.controlloop.runtime.main.rest.InstantiationController;
  45 import org.onap.policy.clamp.controlloop.runtime.util.rest.CommonRestController;
  46 import org.onap.policy.common.utils.coder.YamlJsonTranslator;
  47 import org.onap.policy.common.utils.resources.ResourceUtils;
  48 import org.onap.policy.models.provider.PolicyModelsProvider;
  49 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  52 import org.springframework.beans.factory.annotation.Autowired;
  53 import org.springframework.boot.test.context.SpringBootTest;
  54 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
  55 import org.springframework.boot.web.server.LocalServerPort;
  56 import org.springframework.test.context.TestPropertySource;
  57 import org.springframework.test.context.junit.jupiter.SpringExtension;
  58
  59 /**
  60  * Class to perform unit test of {@link InstantiationController}}.
  61  *
  62  */
  63 @ExtendWith(SpringExtension.class)
  64 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
  65 @TestPropertySource(locations = {"classpath:application_test.properties"})
  66 class InstantiationControllerTest extends CommonRestController {
  67
  68     private static final String CL_INSTANTIATION_CREATE_JSON = "src/test/resources/rest/controlloops/ControlLoops.json";
  69
  70     private static final String CL_INSTANTIATION_UPDATE_JSON =
  71             "src/test/resources/rest/controlloops/ControlLoopsUpdate.json";
  72
  73     private static final String CL_INSTANTIATION_CHANGE_STATE_JSON =
  74             "src/test/resources/rest/controlloops/PassiveCommand.json";
  75
  76     private static final String TOSCA_TEMPLATE_YAML =
  77             "src/test/resources/rest/servicetemplates/pmsh_multiple_cl_tosca.yaml";
  78
  79     private static final String INSTANTIATION_ENDPOINT = "instantiation";
  80
  81     private static final String INSTANTIATION_COMMAND_ENDPOINT = "instantiation/command";
  82
  83     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  84
  85     private static final YamlJsonTranslator yamlTranslator = new YamlJsonTranslator();
  86
  87
  88     @Autowired
  89     private ClRuntimeParameterGroup clRuntimeParameterGroup;
  90
  91     @Autowired
  92     private ControlLoopInstantiationProvider instantiationProvider;
  93
  94     @LocalServerPort
  95     private int randomServerPort;
  96
  97     @BeforeAll
  98     public static void setUpBeforeClass() throws Exception {
  99         serviceTemplate = yamlTranslator.fromYaml(ResourceUtils.getResourceAsString(TOSCA_TEMPLATE_YAML),
 100             ToscaServiceTemplate.class);
 101     }
 102
 103     @BeforeEach
 104     public void populateDb() throws Exception {
 105         createEntryInDB();
 106     }
 107
 108     @BeforeEach
 109     public void setUpPort() {
 110         super.setHttpPrefix(randomServerPort);
 111     }
 112
 113     @AfterEach
 114     public void cleanDatabase() throws Exception {
 115         deleteEntryInDB(serviceTemplate.getName(), serviceTemplate.getVersion());
 116     }
 117
 118     @Test
 119     void testSwagger() throws Exception {
 120         super.testSwagger(INSTANTIATION_ENDPOINT);
 121     }
 122
 123     @Test
 124     void testCreate_Unauthorized() throws Exception {
 125         ControlLoops controlLoops =
 126                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Unauthorized");
 127
 128         assertUnauthorizedPost(INSTANTIATION_ENDPOINT, Entity.json(controlLoops));
 129     }
 130
 131     @Test
 132     void testQuery_Unauthorized() throws Exception {
 133         assertUnauthorizedGet(INSTANTIATION_ENDPOINT);
 134     }
 135
 136     @Test
 137     void testUpdate_Unauthorized() throws Exception {
 138         ControlLoops controlLoops =
 139                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_UPDATE_JSON, "Unauthorized");
 140
 141         assertUnauthorizedPut(INSTANTIATION_ENDPOINT, Entity.json(controlLoops));
 142     }
 143
 144     @Test
 145     void testDelete_Unauthorized() throws Exception {
 146         assertUnauthorizedDelete(INSTANTIATION_ENDPOINT);
 147     }
 148
 149     @Test
 150     void testCommand_Unauthorized() throws Exception {
 151         InstantiationCommand instantiationCommand = InstantiationUtils
 152                 .getInstantiationCommandFromResource(CL_INSTANTIATION_CHANGE_STATE_JSON, "Unauthorized");
 153
 154         assertUnauthorizedPut(INSTANTIATION_COMMAND_ENDPOINT, Entity.json(instantiationCommand));
 155     }
 156
 157     @Test
 158     void testCreate() throws Exception {
 159
 160         ControlLoops controlLoopsFromRsc =
 161                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Create");
 162
 163         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT);
 164         Response resp = invocationBuilder.post(Entity.json(controlLoopsFromRsc));
 165         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 166         InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 167         InstantiationUtils.assertInstantiationResponse(instResponse, controlLoopsFromRsc);
 168
 169         for (ControlLoop controlLoopFromRsc : controlLoopsFromRsc.getControlLoopList()) {
 170             ControlLoops controlLoopsFromDb = instantiationProvider
 171                     .getControlLoops(controlLoopFromRsc.getKey().getName(), controlLoopFromRsc.getKey().getVersion());
 172
 173             assertNotNull(controlLoopsFromDb);
 174             assertThat(controlLoopsFromDb.getControlLoopList()).hasSize(1);
 175             assertEquals(controlLoopFromRsc, controlLoopsFromDb.getControlLoopList().get(0));
 176         }
 177     }
 178
 179     @Test
 180     void testCreateBadRequest() throws Exception {
 181
 182         ControlLoops controlLoopsFromRsc =
 183                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "CreateBadRequest");
 184
 185         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT);
 186         Response resp = invocationBuilder.post(Entity.json(controlLoopsFromRsc));
 187         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 188
 189         // testing Bad Request: CL already defined
 190         resp = invocationBuilder.post(Entity.json(controlLoopsFromRsc));
 191         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 192         InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 193         assertNotNull(instResponse.getErrorDetails());
 194         assertNull(instResponse.getAffectedControlLoops());
 195     }
 196
 197     @Test
 198     void testQuery_NoResultWithThisName() throws Exception {
 199         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT + "?name=noResultWithThisName");
 200         Response rawresp = invocationBuilder.buildGet().invoke();
 201         assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 202         ControlLoops resp = rawresp.readEntity(ControlLoops.class);
 203         assertThat(resp.getControlLoopList()).isEmpty();
 204     }
 205
 206     @Test
 207     void testQuery() throws Exception {
 208
 209         var controlLoops = InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Query");
 210         instantiationProvider.createControlLoops(controlLoops);
 211
 212         for (ControlLoop controlLoopFromRsc : controlLoops.getControlLoopList()) {
 213             Invocation.Builder invocationBuilder =
 214                     super.sendRequest(INSTANTIATION_ENDPOINT + "?name=" + controlLoopFromRsc.getKey().getName());
 215             Response rawresp = invocationBuilder.buildGet().invoke();
 216             assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
 217             ControlLoops controlLoopsQuery = rawresp.readEntity(ControlLoops.class);
 218             assertNotNull(controlLoopsQuery);
 219             assertThat(controlLoopsQuery.getControlLoopList()).hasSize(1);
 220             assertEquals(controlLoopFromRsc, controlLoopsQuery.getControlLoopList().get(0));
 221         }
 222     }
 223
 224     @Test
 225     void testUpdate() throws Exception {
 226
 227         ControlLoops controlLoopsCreate =
 228                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Update");
 229
 230         var controlLoops = InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_UPDATE_JSON, "Update");
 231         instantiationProvider.createControlLoops(controlLoopsCreate);
 232
 233         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT);
 234         Response resp = invocationBuilder.put(Entity.json(controlLoops));
 235         assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 236
 237         InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 238         InstantiationUtils.assertInstantiationResponse(instResponse, controlLoops);
 239
 240         for (ControlLoop controlLoopUpdate : controlLoops.getControlLoopList()) {
 241             ControlLoops controlLoopsFromDb = instantiationProvider
 242                     .getControlLoops(controlLoopUpdate.getKey().getName(), controlLoopUpdate.getKey().getVersion());
 243
 244             assertNotNull(controlLoopsFromDb);
 245             assertThat(controlLoopsFromDb.getControlLoopList()).hasSize(1);
 246             assertEquals(controlLoopUpdate, controlLoopsFromDb.getControlLoopList().get(0));
 247         }
 248     }
 249
 250     @Test
 251     void testDelete_NoResultWithThisName() throws Exception {
 252         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT + "?name=noResultWithThisName");
 253         Response resp = invocationBuilder.delete();
 254         assertEquals(Response.Status.NOT_FOUND.getStatusCode(), resp.getStatus());
 255         InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 256         assertNotNull(instResponse.getErrorDetails());
 257         assertNull(instResponse.getAffectedControlLoops());
 258     }
 259
 260     @Test
 261     void testDelete() throws Exception {
 262
 263         ControlLoops controlLoopsFromRsc =
 264                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Delete");
 265
 266         instantiationProvider.createControlLoops(controlLoopsFromRsc);
 267
 268         for (ControlLoop controlLoopFromRsc : controlLoopsFromRsc.getControlLoopList()) {
 269             Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_ENDPOINT + "?name="
 270                     + controlLoopFromRsc.getKey().getName() + "&version=" + controlLoopFromRsc.getKey().getVersion());
 271             Response resp = invocationBuilder.delete();
 272             assertEquals(Response.Status.OK.getStatusCode(), resp.getStatus());
 273             InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 274             InstantiationUtils.assertInstantiationResponse(instResponse, controlLoopFromRsc);
 275
 276             ControlLoops controlLoopsFromDb = instantiationProvider
 277                     .getControlLoops(controlLoopFromRsc.getKey().getName(), controlLoopFromRsc.getKey().getVersion());
 278             assertThat(controlLoopsFromDb.getControlLoopList()).isEmpty();
 279         }
 280     }
 281
 282     @Test
 283     void testDeleteBadRequest() throws Exception {
 284
 285         ControlLoops controlLoopsFromRsc =
 286                 InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "DelBadRequest");
 287
 288         instantiationProvider.createControlLoops(controlLoopsFromRsc);
 289
 290         for (ControlLoop controlLoopFromRsc : controlLoopsFromRsc.getControlLoopList()) {
 291             Invocation.Builder invocationBuilder =
 292                     super.sendRequest(INSTANTIATION_ENDPOINT + "?name=" + controlLoopFromRsc.getKey().getName());
 293             Response resp = invocationBuilder.delete();
 294             // should be BAD_REQUEST
 295             assertEquals(Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), resp.getStatus());
 296         }
 297     }
 298
 299     @Test
 300     void testCommand_NotFound1() throws Exception {
 301         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_COMMAND_ENDPOINT);
 302         Response resp = invocationBuilder.put(Entity.json(new InstantiationCommand()));
 303         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 304     }
 305
 306     @Test
 307     void testCommand_NotFound2() throws Exception {
 308         InstantiationCommand command =
 309                 InstantiationUtils.getInstantiationCommandFromResource(CL_INSTANTIATION_CHANGE_STATE_JSON, "Command");
 310         command.setOrderedState(null);
 311
 312         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_COMMAND_ENDPOINT);
 313         Response resp = invocationBuilder.put(Entity.json(command));
 314         assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), resp.getStatus());
 315     }
 316
 317     @Test
 318     void testCommand() throws Exception {
 319
 320         var controlLoops = InstantiationUtils.getControlLoopsFromResource(CL_INSTANTIATION_CREATE_JSON, "Command");
 321         instantiationProvider.createControlLoops(controlLoops);
 322
 323         InstantiationCommand command =
 324                 InstantiationUtils.getInstantiationCommandFromResource(CL_INSTANTIATION_CHANGE_STATE_JSON, "Command");
 325
 326         Invocation.Builder invocationBuilder = super.sendRequest(INSTANTIATION_COMMAND_ENDPOINT);
 327         Response resp = invocationBuilder.put(Entity.json(command));
 328         assertEquals(Response.Status.ACCEPTED.getStatusCode(), resp.getStatus());
 329         InstantiationResponse instResponse = resp.readEntity(InstantiationResponse.class);
 330         InstantiationUtils.assertInstantiationResponse(instResponse, command);
 331
 332         // check passive state on DB
 333         for (ToscaConceptIdentifier toscaConceptIdentifier : command.getControlLoopIdentifierList()) {
 334             ControlLoops controlLoopsGet = instantiationProvider.getControlLoops(toscaConceptIdentifier.getName(),
 335                     toscaConceptIdentifier.getVersion());
 336             assertThat(controlLoopsGet.getControlLoopList()).hasSize(1);
 337             assertEquals(command.getOrderedState(), controlLoopsGet.getControlLoopList().get(0).getOrderedState());
 338         }
 339     }
 340
 341     private synchronized void deleteEntryInDB(String name, String version) throws Exception {
 342         try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
 343                 .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
 344             if (!modelsProvider.getServiceTemplateList(null, null).isEmpty()) {
 345                 modelsProvider.deleteServiceTemplate(name, version);
 346             }
 347         }
 348     }
 349
 350     private synchronized void createEntryInDB() throws Exception {
 351         try (PolicyModelsProvider modelsProvider = new PolicyModelsProviderFactory()
 352                 .createPolicyModelsProvider(clRuntimeParameterGroup.getDatabaseProviderParameters())) {
 353             deleteEntryInDB(serviceTemplate.getName(), serviceTemplate.getVersion());
 354             modelsProvider.createServiceTemplate(serviceTemplate);
 355         }
 356     }
 357 }