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

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