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.instantiation;
  23
  24 import static org.assertj.core.api.Assertions.assertThat;
  25 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  26 import static org.mockito.ArgumentMatchers.any;
  27 import static org.mockito.Mockito.doNothing;
  28 import static org.mockito.Mockito.mock;
  29 import static org.mockito.Mockito.verify;
  30 import static org.mockito.Mockito.when;
  31 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
  32
  33 import java.util.List;
  34 import java.util.Optional;
  35 import java.util.UUID;
  36 import org.junit.jupiter.api.BeforeAll;
  37 import org.junit.jupiter.api.Test;
  38 import org.onap.policy.clamp.acm.runtime.participants.AcmParticipantProvider;
  39 import org.onap.policy.clamp.acm.runtime.supervision.SupervisionAcHandler;
  40 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
  41 import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException;
  42 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  43 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  44 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  45 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  46 import org.onap.policy.clamp.models.acm.concepts.LockState;
  47 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.AcInstanceStateUpdate;
  48 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.DeployOrder;
  49 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.LockOrder;
  50 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  51 import org.onap.policy.clamp.models.acm.persistence.provider.AcInstanceStateResolver;
  52 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  53 import org.onap.policy.clamp.models.acm.persistence.provider.ProviderUtils;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  55 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  56
  57 /**
  58  * Class to perform unit test of {@link AutomationCompositionInstantiationProvider}}.
  59  *
  60  */
  61 class AutomationCompositionInstantiationProviderTest {
  62     private static final String AC_INSTANTIATION_CREATE_JSON = "src/test/resources/rest/acm/AutomationComposition.json";
  63     private static final String AC_INSTANTIATION_UPDATE_JSON =
  64             "src/test/resources/rest/acm/AutomationCompositionUpdate.json";
  65
  66     private static final String AC_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON =
  67             "src/test/resources/rest/acm/AutomationCompositionElementsNotFound.json";
  68     private static final String AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON =
  69             "src/test/resources/rest/acm/AutomationCompositionNotFound.json";
  70     private static final String DELETE_BAD_REQUEST = "Automation composition state is still %s";
  71
  72     private static final String AC_ELEMENT_NAME_NOT_FOUND =
  73             "\"AutomationComposition\" INVALID, item has status INVALID\n"
  74                     + "  \"entry PMSHInstance0AcElementNotFound\" INVALID, item has status INVALID\n"
  75                     + "    \"entry org.onap.domain.pmsh.DCAEMicroservice\" INVALID, Not found\n"
  76                     + "    \"entry org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement\""
  77                     + " INVALID, Not found\n";
  78     private static final String AC_DEFINITION_NOT_FOUND = "\"AutomationComposition\" INVALID, item has status INVALID\n"
  79             + "  item \"ServiceTemplate\" value \"\" INVALID,"
  80             + " Commissioned automation composition definition not found\n";
  81     private static final String DO_NOT_MATCH = " do not match with ";
  82
  83     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  84
  85     @BeforeAll
  86     public static void setUpBeforeClass() {
  87         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  88         var jpa =
  89                 ProviderUtils.getJpaAndValidate(serviceTemplate, JpaToscaServiceTemplate::new, "toscaServiceTemplate");
  90         serviceTemplate = jpa.toAuthorative();
  91     }
  92
  93     @Test
  94     void testInstantiationCrud() throws AutomationCompositionException {
  95         var acDefinitionProvider = mock(AcDefinitionProvider.class);
  96         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
  97         var compositionId = acDefinition.getCompositionId();
  98         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
  99         var acProvider = mock(AutomationCompositionProvider.class);
 100         var supervisionAcHandler = mock(SupervisionAcHandler.class);
 101         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 102         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, acDefinitionProvider,
 103                 null, supervisionAcHandler, acmParticipantProvider);
 104         var automationCompositionCreate =
 105                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Crud");
 106         automationCompositionCreate.setCompositionId(compositionId);
 107         when(acProvider.createAutomationComposition(automationCompositionCreate))
 108                 .thenReturn(automationCompositionCreate);
 109
 110         var instantiationResponse = instantiationProvider.createAutomationComposition(
 111                 automationCompositionCreate.getCompositionId(), automationCompositionCreate);
 112         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 113
 114         verify(acProvider).createAutomationComposition(automationCompositionCreate);
 115
 116         when(acProvider.getAutomationCompositions(compositionId, automationCompositionCreate.getName(),
 117                 automationCompositionCreate.getVersion())).thenReturn(List.of(automationCompositionCreate));
 118
 119         var automationCompositionsGet = instantiationProvider.getAutomationCompositions(compositionId,
 120                 automationCompositionCreate.getName(), automationCompositionCreate.getVersion());
 121         assertThat(automationCompositionCreate)
 122                 .isEqualTo(automationCompositionsGet.getAutomationCompositionList().get(0));
 123
 124         var automationCompositionUpdate =
 125                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_UPDATE_JSON, "Crud");
 126         automationCompositionUpdate.setCompositionId(compositionId);
 127         when(acProvider.getAutomationComposition(automationCompositionUpdate.getInstanceId()))
 128                 .thenReturn(automationCompositionUpdate);
 129         when(acProvider.updateAutomationComposition(automationCompositionUpdate))
 130                 .thenReturn(automationCompositionUpdate);
 131
 132         instantiationResponse = instantiationProvider.updateAutomationComposition(
 133                 automationCompositionUpdate.getCompositionId(), automationCompositionUpdate);
 134         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionUpdate);
 135
 136         verify(acProvider).updateAutomationComposition(automationCompositionUpdate);
 137
 138         when(acProvider.deleteAutomationComposition(automationCompositionUpdate.getInstanceId()))
 139                 .thenReturn(automationCompositionUpdate);
 140         doNothing().when(acmParticipantProvider).verifyParticipantState(any());
 141         instantiationProvider.deleteAutomationComposition(automationCompositionCreate.getCompositionId(),
 142                 automationCompositionCreate.getInstanceId());
 143
 144         verify(supervisionAcHandler).delete(any(), any());
 145     }
 146
 147     @Test
 148     void testInstantiationDelete() {
 149         var automationComposition =
 150                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Delete");
 151
 152         var acProvider = mock(AutomationCompositionProvider.class);
 153         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 154         var supervisionAcHandler = mock(SupervisionAcHandler.class);
 155         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 156
 157         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider,
 158                 acDefinitionProvider, null, supervisionAcHandler, acmParticipantProvider);
 159
 160         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 161                 .thenReturn(automationComposition);
 162
 163         var wrongCompositionId = UUID.randomUUID();
 164         var instanceId = automationComposition.getInstanceId();
 165         var compositionId = automationComposition.getCompositionId();
 166         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(wrongCompositionId, instanceId))
 167                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 168
 169         assertThatDeleteThrownBy(automationComposition, DeployState.DEPLOYED, LockState.LOCKED);
 170         assertThatDeleteThrownBy(automationComposition, DeployState.DEPLOYING, LockState.NONE);
 171         assertThatDeleteThrownBy(automationComposition, DeployState.UNDEPLOYING, LockState.LOCKED);
 172
 173         automationComposition.setDeployState(DeployState.UNDEPLOYED);
 174         automationComposition.setLockState(LockState.NONE);
 175         when(acProvider.deleteAutomationComposition(instanceId)).thenReturn(automationComposition);
 176
 177         instantiationProvider.deleteAutomationComposition(compositionId, instanceId);
 178         verify(supervisionAcHandler).delete(any(), any());
 179     }
 180
 181     private void assertThatDeleteThrownBy(AutomationComposition automationComposition,
 182             DeployState deployState, LockState lockState) {
 183         automationComposition.setDeployState(deployState);
 184         automationComposition.setLockState(lockState);
 185         var acProvider = mock(AutomationCompositionProvider.class);
 186         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 187
 188         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider,
 189                 acDefinitionProvider, null, null, null);
 190
 191         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 192                 .thenReturn(automationComposition);
 193
 194         var compositionId = automationComposition.getCompositionId();
 195         var instanceId = automationComposition.getInstanceId();
 196         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(compositionId, instanceId))
 197                 .hasMessageMatching(String.format(DELETE_BAD_REQUEST, deployState));
 198     }
 199
 200     @Test
 201     void testCreateAutomationCompositions_NoDuplicates() {
 202         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 203         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
 204         var compositionId = acDefinition.getCompositionId();
 205         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
 206
 207         var automationCompositionCreate =
 208                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "NoDuplicates");
 209         automationCompositionCreate.setCompositionId(compositionId);
 210         automationCompositionCreate.setInstanceId(UUID.randomUUID());
 211
 212         var acProvider = mock(AutomationCompositionProvider.class);
 213         when(acProvider.createAutomationComposition(automationCompositionCreate))
 214                 .thenReturn(automationCompositionCreate);
 215         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 216
 217         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider,
 218                 acDefinitionProvider, null, null, acmParticipantProvider);
 219
 220         var instantiationResponse = instantiationProvider.createAutomationComposition(
 221                 automationCompositionCreate.getCompositionId(), automationCompositionCreate);
 222         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 223
 224         when(acProvider.findAutomationComposition(automationCompositionCreate.getKey().asIdentifier()))
 225                 .thenReturn(Optional.of(automationCompositionCreate));
 226
 227         assertThatThrownBy(
 228                 () -> instantiationProvider.createAutomationComposition(compositionId, automationCompositionCreate))
 229                         .hasMessageMatching(automationCompositionCreate.getKey().asIdentifier() + " already defined");
 230     }
 231
 232     @Test
 233     void testCreateAutomationCompositions_CommissionedAcElementNotFound() {
 234         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 235         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 236         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
 237         var compositionId = acDefinition.getCompositionId();
 238         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
 239         var automationComposition = InstantiationUtils.getAutomationCompositionFromResource(
 240                 AC_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON, "AcElementNotFound");
 241         automationComposition.setCompositionId(compositionId);
 242
 243         var acProvider = mock(AutomationCompositionProvider.class);
 244         var provider = new AutomationCompositionInstantiationProvider(acProvider,
 245                 acDefinitionProvider, null, null, acmParticipantProvider);
 246
 247         assertThatThrownBy(() -> provider.createAutomationComposition(compositionId, automationComposition))
 248                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 249
 250         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 251                 .thenReturn(automationComposition);
 252
 253         assertThatThrownBy(() -> provider.updateAutomationComposition(compositionId, automationComposition))
 254                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 255     }
 256
 257     @Test
 258     void testAcDefinitionNotFound() {
 259         var automationComposition = InstantiationUtils
 260                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 261
 262         var acProvider = mock(AutomationCompositionProvider.class);
 263         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 264                 .thenReturn(automationComposition);
 265         var provider = new AutomationCompositionInstantiationProvider(acProvider,
 266                 mock(AcDefinitionProvider.class), null, null, null);
 267
 268         var compositionId = automationComposition.getCompositionId();
 269         assertThatThrownBy(() -> provider.createAutomationComposition(compositionId, automationComposition))
 270                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 271
 272         assertThatThrownBy(() -> provider.updateAutomationComposition(compositionId, automationComposition))
 273                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 274     }
 275
 276     @Test
 277     void testCompositionIdDoNotMatch() {
 278         var automationComposition = InstantiationUtils
 279                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 280
 281         var acProvider = mock(AutomationCompositionProvider.class);
 282         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 283                 .thenReturn(automationComposition);
 284         var provider = new AutomationCompositionInstantiationProvider(acProvider,
 285                 mock(AcDefinitionProvider.class), null, null, null);
 286
 287         var compositionId = automationComposition.getCompositionId();
 288         var wrongCompositionId = UUID.randomUUID();
 289         assertThatThrownBy(() -> provider.createAutomationComposition(wrongCompositionId, automationComposition))
 290                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 291
 292         assertThatThrownBy(() -> provider.updateAutomationComposition(wrongCompositionId, automationComposition))
 293                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 294
 295         assertThatThrownBy(
 296                 () -> provider.getAutomationComposition(wrongCompositionId, automationComposition.getInstanceId()))
 297                         .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 298         assertThatThrownBy(() -> provider.compositionInstanceState(wrongCompositionId,
 299                 automationComposition.getInstanceId(), new AcInstanceStateUpdate()))
 300                         .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 301     }
 302
 303     @Test
 304     void testCompositionNotPrimed() {
 305         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 306         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.COMMISSIONED);
 307         var compositionId = acDefinition.getCompositionId();
 308         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
 309         var acProvider = mock(AutomationCompositionProvider.class);
 310         var provider =
 311                 new AutomationCompositionInstantiationProvider(acProvider, acDefinitionProvider, null, null, null);
 312
 313         var automationComposition =
 314                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Crud");
 315         automationComposition.setCompositionId(compositionId);
 316         assertThatThrownBy(() -> provider.createAutomationComposition(compositionId, automationComposition))
 317                 .hasMessageMatching("\"AutomationComposition\" INVALID, item has status INVALID\n"
 318                         + "  item \"ServiceTemplate\" value \"COMMISSIONED\" INVALID,"
 319                         + " Commissioned automation composition definition not primed\n");
 320     }
 321
 322     @Test
 323     void testCompositionInstanceState() {
 324         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 325         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.COMMISSIONED);
 326         var compositionId = acDefinition.getCompositionId();
 327         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acDefinition);
 328
 329         var automationComposition = InstantiationUtils
 330                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 331         var instanceId = UUID.randomUUID();
 332         automationComposition.setCompositionId(compositionId);
 333         automationComposition.setInstanceId(instanceId);
 334         var acProvider = mock(AutomationCompositionProvider.class);
 335         when(acProvider.getAutomationComposition(instanceId))
 336                 .thenReturn(automationComposition);
 337
 338         var supervisionAcHandler = mock(SupervisionAcHandler.class);
 339         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 340         var provider = new AutomationCompositionInstantiationProvider(acProvider, acDefinitionProvider,
 341                 new AcInstanceStateResolver(), supervisionAcHandler, acmParticipantProvider);
 342
 343         var acInstanceStateUpdate = new AcInstanceStateUpdate();
 344         acInstanceStateUpdate.setDeployOrder(DeployOrder.DEPLOY);
 345         acInstanceStateUpdate.setLockOrder(LockOrder.NONE);
 346         provider.compositionInstanceState(compositionId, instanceId, acInstanceStateUpdate);
 347         verify(supervisionAcHandler).deploy(any(AutomationComposition.class),
 348                 any(AutomationCompositionDefinition.class));
 349
 350         automationComposition.setDeployState(DeployState.DEPLOYED);
 351         automationComposition.setLockState(LockState.LOCKED);
 352         acInstanceStateUpdate.setDeployOrder(DeployOrder.UNDEPLOY);
 353         provider.compositionInstanceState(compositionId, instanceId, acInstanceStateUpdate);
 354         verify(supervisionAcHandler).undeploy(any(AutomationComposition.class),
 355                 any(AutomationCompositionDefinition.class));
 356
 357         automationComposition.setDeployState(DeployState.DEPLOYED);
 358         automationComposition.setLockState(LockState.LOCKED);
 359         acInstanceStateUpdate.setDeployOrder(DeployOrder.NONE);
 360         acInstanceStateUpdate.setLockOrder(LockOrder.UNLOCK);
 361         provider.compositionInstanceState(compositionId, instanceId, acInstanceStateUpdate);
 362         verify(supervisionAcHandler).unlock(any(AutomationComposition.class),
 363                 any(AutomationCompositionDefinition.class));
 364
 365         automationComposition.setDeployState(DeployState.DEPLOYED);
 366         automationComposition.setLockState(LockState.UNLOCKED);
 367         acInstanceStateUpdate.setDeployOrder(DeployOrder.NONE);
 368         acInstanceStateUpdate.setLockOrder(LockOrder.LOCK);
 369         provider.compositionInstanceState(compositionId, instanceId, acInstanceStateUpdate);
 370         verify(supervisionAcHandler).lock(any(AutomationComposition.class),
 371                 any(AutomationCompositionDefinition.class));
 372     }
 373 }