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.common.acm.exception.AutomationCompositionRuntimeException;
  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 AUTOMATION_COMPOSITION_NOT_FOUND = "Automation composition not found";
  65     private static final String DELETE_BAD_REQUEST = "Automation composition state is still %s";
  66     private static final String ORDERED_STATE_INVALID = "ordered state invalid or not specified on command";
  67     private static final String AC_ELEMENT_NAME_NOT_FOUND =
  68             "\"AutomationComposition\" INVALID, item has status INVALID\n"
  69             + "  \"entry PMSHInstance0AcElementNotFound\" INVALID, item has status INVALID\n"
  70             + "    \"entry org.onap.domain.pmsh.DCAEMicroservice\" INVALID, Not found\n"
  71             + "    \"entry org.onap.domain.pmsh.PMSH_MonitoringPolicyAutomationCompositionElement\""
  72             + " INVALID, Not found\n";
  73     private static final String AC_DEFINITION_NOT_FOUND =
  74             "\"AutomationComposition\" INVALID, item has status INVALID\n"
  75                     + "  item \"ServiceTemplate\" value \"\" INVALID,"
  76                     + " Commissioned automation composition definition not found\n";
  77
  78     private static ToscaServiceTemplate serviceTemplate = new ToscaServiceTemplate();
  79
  80     @BeforeAll
  81     public static void setUpBeforeClass() {
  82         serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  83         var jpa =
  84                 ProviderUtils.getJpaAndValidate(serviceTemplate, JpaToscaServiceTemplate::new, "toscaServiceTemplate");
  85         serviceTemplate = jpa.toAuthorative();
  86     }
  87
  88     @Test
  89     void testInstantiationCrud() throws AutomationCompositionException {
  90         var participantProvider = Mockito.mock(ParticipantProvider.class);
  91         var participants = CommonTestData.createParticipants();
  92         when(participantProvider.getParticipants()).thenReturn(participants);
  93
  94         var acDefinitionProvider = mock(AcDefinitionProvider.class);
  95         var compositionId = UUID.randomUUID();
  96         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(serviceTemplate));
  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.saveAutomationComposition(automationCompositionCreate)).thenReturn(automationCompositionCreate);
 105
 106         var instantiationResponse = instantiationProvider.createAutomationComposition(automationCompositionCreate);
 107         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 108
 109         verify(acProvider).saveAutomationComposition(automationCompositionCreate);
 110
 111         when(acProvider.getAutomationCompositions(automationCompositionCreate.getName(),
 112                 automationCompositionCreate.getVersion())).thenReturn(List.of(automationCompositionCreate));
 113
 114         var automationCompositionsGet = instantiationProvider.getAutomationCompositions(
 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
 123         instantiationResponse = instantiationProvider.updateAutomationComposition(automationCompositionUpdate);
 124         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionUpdate);
 125
 126         verify(acProvider).saveAutomationComposition(automationCompositionUpdate);
 127
 128         when(acProvider.findAutomationComposition(automationCompositionUpdate.getKey().asIdentifier()))
 129                 .thenReturn(Optional.of(automationCompositionUpdate));
 130         when(acProvider.findAutomationComposition(automationCompositionUpdate.getName(),
 131                 automationCompositionUpdate.getVersion())).thenReturn(Optional.of(automationCompositionUpdate));
 132         when(acProvider.deleteAutomationComposition(automationCompositionUpdate.getName(),
 133                 automationCompositionUpdate.getVersion())).thenReturn(automationCompositionUpdate);
 134
 135         var instantiationCommand =
 136                 InstantiationUtils.getInstantiationCommandFromResource(AC_INSTANTIATION_CHANGE_STATE_JSON, "Crud");
 137         instantiationResponse = instantiationProvider.issueAutomationCompositionCommand(instantiationCommand);
 138         InstantiationUtils.assertInstantiationResponse(instantiationResponse, instantiationCommand);
 139
 140         verify(supervisionHandler).triggerAutomationCompositionSupervision(automationCompositionUpdate);
 141
 142         // in order to delete a automationComposition the state must be UNINITIALISED
 143         automationCompositionCreate.setState(AutomationCompositionState.UNINITIALISED);
 144         instantiationProvider.updateAutomationComposition(automationCompositionCreate);
 145
 146         instantiationProvider.deleteAutomationComposition(automationCompositionCreate.getName(),
 147                 automationCompositionCreate.getVersion());
 148
 149         verify(acProvider).deleteAutomationComposition(automationCompositionCreate.getName(),
 150                 automationCompositionCreate.getVersion());
 151     }
 152
 153     @Test
 154     void testInstantiationDelete() {
 155         var automationComposition =
 156                 InstantiationUtils.getAutomationCompositionFromResource(AC_INSTANTIATION_CREATE_JSON, "Delete");
 157
 158         var participantProvider = Mockito.mock(ParticipantProvider.class);
 159         var acProvider = mock(AutomationCompositionProvider.class);
 160         var supervisionHandler = mock(SupervisionHandler.class);
 161         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 162
 163         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 164                 participantProvider, acDefinitionProvider);
 165
 166         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(automationComposition.getName(),
 167                 automationComposition.getVersion())).hasMessageMatching(AUTOMATION_COMPOSITION_NOT_FOUND);
 168
 169         for (var state : AutomationCompositionState.values()) {
 170             if (!AutomationCompositionState.UNINITIALISED.equals(state)) {
 171                 assertThatDeleteThrownBy(automationComposition, state);
 172             }
 173         }
 174         automationComposition.setState(AutomationCompositionState.UNINITIALISED);
 175
 176         when(acProvider.findAutomationComposition(automationComposition.getName(), automationComposition.getVersion()))
 177                 .thenReturn(Optional.of(automationComposition));
 178         when(acProvider.deleteAutomationComposition(automationComposition.getName(),
 179                 automationComposition.getVersion())).thenReturn(automationComposition);
 180
 181         instantiationProvider.deleteAutomationComposition(automationComposition.getName(),
 182                 automationComposition.getVersion());
 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.findAutomationComposition(automationComposition.getName(), automationComposition.getVersion()))
 197                 .thenReturn(Optional.of(automationComposition));
 198
 199         assertThatThrownBy(() -> instantiationProvider.deleteAutomationComposition(automationComposition.getName(),
 200                 automationComposition.getVersion())).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
 213         var acProvider = mock(AutomationCompositionProvider.class);
 214         when(acProvider.saveAutomationComposition(automationCompositionCreate)).thenReturn(automationCompositionCreate);
 215
 216         var participantProvider = Mockito.mock(ParticipantProvider.class);
 217         var supervisionHandler = mock(SupervisionHandler.class);
 218
 219         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 220                 participantProvider, acDefinitionProvider);
 221
 222         var instantiationResponse = instantiationProvider.createAutomationComposition(automationCompositionCreate);
 223         InstantiationUtils.assertInstantiationResponse(instantiationResponse, automationCompositionCreate);
 224
 225         when(acProvider.findAutomationComposition(automationCompositionCreate.getKey().asIdentifier()))
 226                 .thenReturn(Optional.of(automationCompositionCreate));
 227
 228         assertThatThrownBy(() -> instantiationProvider.createAutomationComposition(automationCompositionCreate))
 229                 .hasMessageMatching(automationCompositionCreate.getKey().asIdentifier() + " already defined");
 230     }
 231
 232     @Test
 233     void testCreateAutomationCompositions_CommissionedAcElementNotFound() {
 234         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 235         var compositionId = UUID.randomUUID();
 236         when(acDefinitionProvider.findAcDefinition(compositionId)).thenReturn(Optional.of(serviceTemplate));
 237         var automationComposition = InstantiationUtils.getAutomationCompositionFromResource(
 238                 AC_INSTANTIATION_DEFINITION_NAME_NOT_FOUND_JSON, "AcElementNotFound");
 239         automationComposition.setCompositionId(compositionId);
 240
 241         var acProvider = mock(AutomationCompositionProvider.class);
 242         var participantProvider = mock(ParticipantProvider.class);
 243         var supervisionHandler = mock(SupervisionHandler.class);
 244         var provider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 245                 participantProvider, acDefinitionProvider);
 246
 247         assertThatThrownBy(() -> provider.createAutomationComposition(automationComposition))
 248                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 249
 250         assertThatThrownBy(() -> provider.updateAutomationComposition(automationComposition))
 251                 .hasMessageMatching(AC_ELEMENT_NAME_NOT_FOUND);
 252     }
 253
 254     @Test
 255     void testCreateAutomationCompositions_CommissionedAcNotFound() throws Exception {
 256         var automationComposition = InstantiationUtils
 257                 .getAutomationCompositionFromResource(AC_INSTANTIATION_AC_DEFINITION_NOT_FOUND_JSON, "AcNotFound");
 258
 259         var participantProvider = Mockito.mock(ParticipantProvider.class);
 260         var acProvider = mock(AutomationCompositionProvider.class);
 261         var supervisionHandler = mock(SupervisionHandler.class);
 262         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 263         var provider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 264                 participantProvider, acDefinitionProvider);
 265
 266         assertThatThrownBy(() -> provider.createAutomationComposition(automationComposition))
 267                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 268
 269         assertThatThrownBy(() -> provider.updateAutomationComposition(automationComposition))
 270                 .hasMessageMatching(AC_DEFINITION_NOT_FOUND);
 271     }
 272
 273     @Test
 274     void testIssueAutomationCompositionCommand_OrderedStateInvalid() throws AutomationCompositionRuntimeException {
 275         var participantProvider = Mockito.mock(ParticipantProvider.class);
 276         var acProvider = mock(AutomationCompositionProvider.class);
 277         var supervisionHandler = mock(SupervisionHandler.class);
 278         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 279         var instantiationProvider = new AutomationCompositionInstantiationProvider(acProvider, supervisionHandler,
 280                 participantProvider, acDefinitionProvider);
 281         assertThatThrownBy(() -> instantiationProvider.issueAutomationCompositionCommand(new InstantiationCommand()))
 282                 .hasMessageMatching(ORDERED_STATE_INVALID);
 283     }
 284 }