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.Mockito.mock;
  27 import static org.mockito.Mockito.verify;
  28 import static org.mockito.Mockito.when;
  29 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
  30
  31 import java.util.List;
  32 import java.util.Optional;
  33 import java.util.UUID;
  34 import org.junit.jupiter.api.BeforeAll;
  35 import org.junit.jupiter.api.Test;
  36 import org.mockito.Mockito;
  37 import org.onap.policy.clamp.acm.runtime.supervision.SupervisionHandler;
  38 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
  39 import org.onap.policy.clamp.common.acm.exception.AutomationCompositionException;
  40 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  41 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  42 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionState;
  43 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationCommand;
  44 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  45 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  46 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  47 import org.onap.policy.clamp.models.acm.persistence.provider.ProviderUtils;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  49 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  50
  51 /**
  52  * Class to perform unit test of {@link AutomationCompositionInstantiationProvider}}.
  53  *
  54  */
  55 class AutomationCompositionInstantiationProviderTest {
  56     private static final String AC_INSTANTIATION_CREATE_JSON = "src/test/resources/rest/acm/AutomationComposition.json";
  57     private static final String AC_INSTANTIATION_UPDATE_JSON =
  58             "src/test/resources/rest/acm/AutomationCompositionUpdate.json";
  59     private static final String AC_INSTANTIATION_CHANGE_STATE_JSON = "src/test/resources/rest/acm/PassiveCommand.json";
  60     private static final String AC_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON =
  61             "src/test/resources/rest/acm/AutomationCompositionElementsNotFound.json";
  62     private static final String AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON =
  63             "src/test/resources/rest/acm/AutomationCompositionNotFound.json";
  64     private static final String DELETE_BAD_REQUEST = "Automation composition state is still %s";
  65     private static final String ORDERED_STATE_INVALID = "ordered state invalid or not specified on command";
  66     private static final String AC_ELEMENT_NAME_NOT_FOUND =
  67             "\"AutomationComposition\" INVALID, item has status INVALID\n"
  68                     + "  \"entry PMSHInstance0AcElementNotFound\" INVALID, item has status INVALID\n"
  69                     + "    \"entry org.onap.domain.pmsh.DCAEMicroservice\" INVALID, Not found\n"
  70                     + "    \"entry org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement\""
  71                     + " INVALID, Not found\n";
  72     private static final String AC_DEFINITION_NOT_FOUND = "\"AutomationComposition\" INVALID, item has status INVALID\n"
  73             + "  item \"ServiceTemplate\" value \"\" INVALID,"
  74             + " Commissioned automation composition definition not found\n";
  75     private static final String DO_NOT_MATCH = " do not match with ";
  76
  77     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  78
  79     @BeforeAll
  80     public static void setUpBeforeClass() {
  81         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  82         var jpa =
  83                 ProviderUtils.getJpaAndValidate(serviceTemplate, JpaToscaServiceTemplate::new, "toscaServiceTemplate");
  84         serviceTemplate = jpa.toAuthorative();
  85     }
  86
  87     @Test
  88     void testInstantiationCrud() throws AutomationCompositionException {
  89         var participantProvider = Mockito.mock(ParticipantProvider.class);
  90         var participants = CommonTestData.createParticipants();
  91         when(participantProvider.getParticipants()).thenReturn(participants);
  92
  93         var acDefinitionProvider = mock(AcDefinitionProvider.class);
  94         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
  95         var compositionId = acDefinition.getCompositionId();
  96         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
  97         var supervisionHandler = mock(SupervisionHandler.class);
  98         var acProvider = mock(AutomationCompositionProvider.class);
  99         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 100                 participantProvider, acDefinitionProvider);
 101         var automationCompositionCreate =
 102                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Crud");
 103         automationCompositionCreate.setCompositionId(compositionId);
 104         when(acProvider.createAutomationComposition(automationCompositionCreate))
 105                 .thenReturn(automationCompositionCreate);
 106
 107         var instantiationResponse = instantiationProvider.createAutomationComposition(
 108                 automationCompositionCreate.getCompositionId(), automationCompositionCreate);
 109         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 110
 111         verify(acProvider).createAutomationComposition(automationCompositionCreate);
 112
 113         when(acProvider.getAutomationCompositions(compositionId, automationCompositionCreate.getName(),
 114                 automationCompositionCreate.getVersion())).thenReturn(List.of(automationCompositionCreate));
 115
 116         var automationCompositionsGet = instantiationProvider.getAutomationCompositions(compositionId,
 117                 automationCompositionCreate.getName(), automationCompositionCreate.getVersion());
 118         assertThat(automationCompositionCreate)
 119                 .isEqualTo(automationCompositionsGet.getAutomationCompositionList().get(0));
 120
 121         var automationCompositionUpdate =
 122                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_UPDATE_JSON, "Crud");
 123         automationCompositionUpdate.setCompositionId(compositionId);
 124         when(acProvider.getAutomationComposition(automationCompositionUpdate.getInstanceId()))
 125                 .thenReturn(automationCompositionUpdate);
 126         when(acProvider.updateAutomationComposition(automationCompositionUpdate))
 127                 .thenReturn(automationCompositionUpdate);
 128
 129         instantiationResponse = instantiationProvider.updateAutomationComposition(
 130                 automationCompositionUpdate.getCompositionId(), automationCompositionUpdate);
 131         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionUpdate);
 132
 133         verify(acProvider).updateAutomationComposition(automationCompositionUpdate);
 134
 135         var instantiationCommand =
 136                 InstantiationUtils.getInstantiationCommandFromResource(AC_INSTANTIATION_CHANGE_STATE_JSON);
 137         instantiationProvider.issueAutomationCompositionCommand(automationCompositionUpdate,
 138                 instantiationCommand);
 139         verify(supervisionHandler).triggerAutomationCompositionSupervision(automationCompositionUpdate);
 140
 141         // in order to delete a automationComposition the state must be UNINITIALISED
 142         automationCompositionCreate.setState(AutomationCompositionState.UNINITIALISED);
 143
 144         when(acProvider.deleteAutomationComposition(automationCompositionUpdate.getInstanceId()))
 145                 .thenReturn(automationCompositionUpdate);
 146         instantiationProvider.deleteAutomationComposition(automationCompositionCreate.getCompositionId(),
 147                 automationCompositionCreate.getInstanceId());
 148
 149         verify(acProvider).deleteAutomationComposition(automationCompositionCreate.getInstanceId());
 150     }
 151
 152     @Test
 153     void testInstantiationDelete() {
 154         var automationComposition =
 155                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Delete");
 156
 157         var participantProvider = Mockito.mock(ParticipantProvider.class);
 158         var acProvider = mock(AutomationCompositionProvider.class);
 159         var supervisionHandler = mock(SupervisionHandler.class);
 160         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 161
 162         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 163                 participantProvider, acDefinitionProvider);
 164
 165         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 166                 .thenReturn(automationComposition);
 167
 168         var wrongCompositionId = UUID.randomUUID();
 169         var instanceId = automationComposition.getInstanceId();
 170         var compositionId = automationComposition.getCompositionId();
 171         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(wrongCompositionId, instanceId))
 172                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 173
 174         for (var state : AutomationCompositionState.values()) {
 175             if (!AutomationCompositionState.UNINITIALISED.equals(state)) {
 176                 assertThatDeleteThrownBy(automationComposition, state);
 177             }
 178         }
 179         automationComposition.setState(AutomationCompositionState.UNINITIALISED);
 180         when(acProvider.deleteAutomationComposition(instanceId)).thenReturn(automationComposition);
 181
 182         instantiationProvider.deleteAutomationComposition(compositionId, instanceId);
 183     }
 184
 185     private void assertThatDeleteThrownBy(AutomationComposition automationComposition,
 186             AutomationCompositionState state) {
 187         automationComposition.setState(state);
 188         var participantProvider = Mockito.mock(ParticipantProvider.class);
 189         var acProvider = mock(AutomationCompositionProvider.class);
 190         var supervisionHandler = mock(SupervisionHandler.class);
 191         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 192
 193         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 194                 participantProvider, acDefinitionProvider);
 195
 196         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 197                 .thenReturn(automationComposition);
 198
 199         var compositionId = automationComposition.getCompositionId();
 200         var instanceId = automationComposition.getInstanceId();
 201         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(compositionId, instanceId))
 202                 .hasMessageMatching(String.format(DELETE_BAD_REQUEST, state));
 203     }
 204
 205     @Test
 206     void testCreateAutomationCompositions_NoDuplicates() {
 207         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 208         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
 209         var compositionId = acDefinition.getCompositionId();
 210         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
 211
 212         var automationCompositionCreate =
 213                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "NoDuplicates");
 214         automationCompositionCreate.setCompositionId(compositionId);
 215         automationCompositionCreate.setInstanceId(UUID.randomUUID());
 216
 217         var acProvider = mock(AutomationCompositionProvider.class);
 218         when(acProvider.createAutomationComposition(automationCompositionCreate))
 219                 .thenReturn(automationCompositionCreate);
 220
 221         var participantProvider = Mockito.mock(ParticipantProvider.class);
 222         var supervisionHandler = mock(SupervisionHandler.class);
 223
 224         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 225                 participantProvider, acDefinitionProvider);
 226
 227         var instantiationResponse = instantiationProvider.createAutomationComposition(
 228                 automationCompositionCreate.getCompositionId(), automationCompositionCreate);
 229         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 230
 231         when(acProvider.findAutomationComposition(automationCompositionCreate.getKey().asIdentifier()))
 232                 .thenReturn(Optional.of(automationCompositionCreate));
 233
 234         assertThatThrownBy(
 235                 () -> instantiationProvider.createAutomationComposition(compositionId, automationCompositionCreate))
 236                         .hasMessageMatching(automationCompositionCreate.getKey().asIdentifier() + " already defined");
 237     }
 238
 239     @Test
 240     void testCreateAutomationCompositions_CommissionedAcElementNotFound() {
 241         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 242         var acDefinition = CommonTestData.createAcDefinition(serviceTemplate, AcTypeState.PRIMED);
 243         var compositionId = acDefinition.getCompositionId();
 244         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(acDefinition));
 245         var automationComposition = InstantiationUtils.getAutomationCompositionFromResource(
 246                 AC_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON, "AcElementNotFound");
 247         automationComposition.setCompositionId(compositionId);
 248
 249         var acProvider = mock(AutomationCompositionProvider.class);
 250         var participantProvider = mock(ParticipantProvider.class);
 251         var supervisionHandler = mock(SupervisionHandler.class);
 252         var provider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 253                 participantProvider, acDefinitionProvider);
 254
 255         assertThatThrownBy(() -> provider.createAutomationComposition(compositionId, automationComposition))
 256                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 257
 258         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 259                 .thenReturn(automationComposition);
 260
 261         assertThatThrownBy(() -> provider.updateAutomationComposition(compositionId, automationComposition))
 262                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 263     }
 264
 265     @Test
 266     void testCreateAutomationCompositions_CommissionedAcNotFound() {
 267         var automationComposition = InstantiationUtils
 268                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 269
 270         var participantProvider = Mockito.mock(ParticipantProvider.class);
 271         var acProvider = mock(AutomationCompositionProvider.class);
 272         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 273                 .thenReturn(automationComposition);
 274         var supervisionHandler = mock(SupervisionHandler.class);
 275         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 276         var provider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 277                 participantProvider, acDefinitionProvider);
 278
 279         var compositionId = automationComposition.getCompositionId();
 280         assertThatThrownBy(() -> provider.createAutomationComposition(compositionId, automationComposition))
 281                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 282
 283         assertThatThrownBy(() -> provider.updateAutomationComposition(compositionId, automationComposition))
 284                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 285
 286         var wrongCompositionId = UUID.randomUUID();
 287         assertThatThrownBy(() -> provider.createAutomationComposition(wrongCompositionId, automationComposition))
 288                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 289
 290         assertThatThrownBy(() -> provider.updateAutomationComposition(wrongCompositionId, automationComposition))
 291                 .hasMessageMatching(compositionId + DO_NOT_MATCH + wrongCompositionId);
 292     }
 293
 294     @Test
 295     void testIssueAutomationCompositionCommand_OrderedStateInvalid() {
 296         var participantProvider = Mockito.mock(ParticipantProvider.class);
 297         var acProvider = mock(AutomationCompositionProvider.class);
 298         var supervisionHandler = mock(SupervisionHandler.class);
 299         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 300         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 301                 participantProvider, acDefinitionProvider);
 302         var automationComposition = InstantiationUtils
 303                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 304         when(acProvider.getAutomationComposition(automationComposition.getInstanceId()))
 305                 .thenReturn(automationComposition);
 306
 307         assertThatThrownBy(() -> instantiationProvider.issueAutomationCompositionCommand(automationComposition,
 308                 new InstantiationCommand())).hasMessageMatching(ORDERED_STATE_INVALID);
 309     }
 310 }