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.commissioning;
  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.timeout;
  30 import static org.mockito.Mockito.verify;
  31 import static org.mockito.Mockito.when;
  32 import static org.onap.policy.clamp.acm.runtime.util.CommonTestData.TOSCA_SERVICE_TEMPLATE_YAML;
  33
  34 import java.util.List;
  35 import java.util.UUID;
  36 import org.junit.jupiter.api.Test;
  37 import org.onap.policy.clamp.acm.runtime.instantiation.InstantiationUtils;
  38 import org.onap.policy.clamp.acm.runtime.participants.AcmParticipantProvider;
  39 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantPrimePublisher;
  40 import org.onap.policy.clamp.acm.runtime.util.CommonTestData;
  41 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  42 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  43 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  44 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.AcTypeStateUpdate;
  45 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.PrimeOrder;
  46 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  47 import org.onap.policy.clamp.models.acm.persistence.provider.AcTypeStateResolver;
  48 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  50
  51 class CommissioningProviderTest {
  52
  53     /**
  54      * Test the fetching of automation composition definitions (ToscaServiceTemplates).
  55      *
  56      * @throws Exception .
  57      */
  58     @Test
  59     void testGetAutomationCompositionDefinitions() {
  60         var acProvider = mock(AutomationCompositionProvider.class);
  61         var acDefinitionProvider = mock(AcDefinitionProvider.class);
  62
  63         var provider = new CommissioningProvider(acDefinitionProvider, acProvider, null, null, null);
  64
  65         var serviceTemplates = provider.getAutomationCompositionDefinitions(null, null);
  66         assertThat(serviceTemplates.getServiceTemplates()).isEmpty();
  67
  68         when(acDefinitionProvider.getServiceTemplateList(null, null)).thenReturn(List.of(new ToscaServiceTemplate()));
  69         serviceTemplates = provider.getAutomationCompositionDefinitions(null, null);
  70         assertThat(serviceTemplates.getServiceTemplates()).hasSize(1);
  71     }
  72
  73     /**
  74      * Test the creation of automation composition definitions (ToscaServiceTemplates).
  75      *
  76      * @throws Exception .
  77      */
  78     @Test
  79     void testCreateAutomationCompositionDefinitions() {
  80         var serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  81         serviceTemplate.setName("Name");
  82         serviceTemplate.setVersion("1.0.0");
  83         var acmDefinition = new AutomationCompositionDefinition();
  84         acmDefinition.setCompositionId(UUID.randomUUID());
  85         acmDefinition.setServiceTemplate(serviceTemplate);
  86         var acDefinitionProvider = mock(AcDefinitionProvider.class);
  87         when(acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplate)).thenReturn(acmDefinition);
  88
  89         var acProvider = mock(AutomationCompositionProvider.class);
  90         var provider = new CommissioningProvider(acDefinitionProvider, acProvider, null, null, null);
  91         var affectedDefinitions = provider.createAutomationCompositionDefinition(serviceTemplate)
  92                 .getAffectedAutomationCompositionDefinitions();
  93         verify(acDefinitionProvider).createAutomationCompositionDefinition(serviceTemplate);
  94         // Response should return the number of node templates present in the service template
  95         assertThat(affectedDefinitions).hasSize(7);
  96     }
  97
  98     /**
  99      * Test the fetching of a full ToscaServiceTemplate object - as opposed to the reduced template that is being
 100      * tested in the testGetToscaServiceTemplateReduced() test.
 101      *
 102      */
 103     @Test
 104     void testGetToscaServiceTemplateList() {
 105         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 106         var acProvider = mock(AutomationCompositionProvider.class);
 107
 108         var provider = new CommissioningProvider(acDefinitionProvider, acProvider, null, null, null);
 109         var serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
 110         when(acDefinitionProvider.getServiceTemplateList(null, null)).thenReturn(List.of(serviceTemplate));
 111
 112         var returnedServiceTemplate = provider.getAutomationCompositionDefinitions(null, null);
 113         assertThat(returnedServiceTemplate).isNotNull();
 114         assertThat(returnedServiceTemplate.getServiceTemplates()).isNotEmpty();
 115     }
 116
 117     @Test
 118     void testDeletecDefinitionDabRequest() {
 119         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 120         var acProvider = mock(AutomationCompositionProvider.class);
 121
 122         var compositionId = UUID.randomUUID();
 123         when(acProvider.getAcInstancesByCompositionId(compositionId)).thenReturn(List.of(new AutomationComposition()));
 124
 125         var provider = new CommissioningProvider(acDefinitionProvider, acProvider, null, null, null);
 126
 127         assertThatThrownBy(() -> provider.deleteAutomationCompositionDefinition(compositionId))
 128                 .hasMessageMatching("Delete instances, to commission automation composition definitions");
 129     }
 130
 131     @Test
 132     void testDeleteAutomationCompositionDefinition() {
 133         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 134         var compositionId = UUID.randomUUID();
 135         var serviceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
 136         when(acDefinitionProvider.deleteAcDefintion(compositionId)).thenReturn(serviceTemplate);
 137
 138         var acmDefinition = new AutomationCompositionDefinition();
 139         acmDefinition.setCompositionId(compositionId);
 140         acmDefinition.setServiceTemplate(serviceTemplate);
 141         acmDefinition.setState(AcTypeState.COMMISSIONED);
 142         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acmDefinition);
 143
 144         var acProvider = mock(AutomationCompositionProvider.class);
 145         var provider = new CommissioningProvider(acDefinitionProvider, acProvider, null, null, null);
 146
 147         provider.deleteAutomationCompositionDefinition(compositionId);
 148
 149         verify(acDefinitionProvider).deleteAcDefintion(compositionId);
 150     }
 151
 152     @Test
 153     void testPriming() {
 154         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 155         var acmDefinition = CommonTestData.createAcDefinition(
 156                 InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML), AcTypeState.COMMISSIONED);
 157         var compositionId = acmDefinition.getCompositionId();
 158         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acmDefinition);
 159
 160         var participantPrimePublisher = mock(ParticipantPrimePublisher.class);
 161         var provider = new CommissioningProvider(acDefinitionProvider, mock(AutomationCompositionProvider.class),
 162                 mock(AcmParticipantProvider.class), new AcTypeStateResolver(), participantPrimePublisher);
 163
 164         var acTypeStateUpdate = new AcTypeStateUpdate();
 165         acTypeStateUpdate.setPrimeOrder(PrimeOrder.PRIME);
 166         provider.compositionDefinitionPriming(compositionId, acTypeStateUpdate);
 167         verify(acDefinitionProvider).updateAcDefinition(acmDefinition);
 168         verify(participantPrimePublisher, timeout(1000).times(1)).sendPriming(any(), any(), any());
 169     }
 170
 171     @Test
 172     void testDepriming() {
 173         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 174         var acmDefinition = CommonTestData.createAcDefinition(
 175                 InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML), AcTypeState.PRIMED);
 176         var compositionId = acmDefinition.getCompositionId();
 177         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acmDefinition);
 178
 179         var participantPrimePublisher = mock(ParticipantPrimePublisher.class);
 180         var acmParticipantProvider = mock(AcmParticipantProvider.class);
 181         var provider = new CommissioningProvider(acDefinitionProvider, mock(AutomationCompositionProvider.class),
 182                 acmParticipantProvider, new AcTypeStateResolver(), participantPrimePublisher);
 183
 184         var acTypeStateUpdate = new AcTypeStateUpdate();
 185         acTypeStateUpdate.setPrimeOrder(PrimeOrder.DEPRIME);
 186
 187         doNothing().when(acmParticipantProvider).verifyParticipantState(any());
 188         provider.compositionDefinitionPriming(compositionId, acTypeStateUpdate);
 189         verify(participantPrimePublisher, timeout(1000).times(1)).sendDepriming(compositionId);
 190     }
 191
 192     @Test
 193     void testBadRequest() {
 194         var acProvider = mock(AutomationCompositionProvider.class);
 195         var provider = new CommissioningProvider(mock(AcDefinitionProvider.class), acProvider,
 196                 mock(AcmParticipantProvider.class), new AcTypeStateResolver(), mock(ParticipantPrimePublisher.class));
 197
 198         var compositionId = UUID.randomUUID();
 199         when(acProvider.getAcInstancesByCompositionId(compositionId)).thenReturn(List.of(new AutomationComposition()));
 200
 201         var toscaServiceTemplate = new ToscaServiceTemplate();
 202         assertThatThrownBy(() -> provider.updateCompositionDefinition(compositionId, toscaServiceTemplate))
 203                 .hasMessageMatching("There are ACM instances, Update of ACM Definition not allowed");
 204
 205         var acTypeStateUpdate = new AcTypeStateUpdate();
 206         assertThatThrownBy(() -> provider.compositionDefinitionPriming(compositionId, acTypeStateUpdate))
 207                 .hasMessageMatching("There are instances, Priming/Depriming not allowed");
 208     }
 209
 210     @Test
 211     void testPrimedBadRequest() {
 212         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 213         var toscaServiceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
 214         var acmDefinition = CommonTestData.createAcDefinition(toscaServiceTemplate, AcTypeState.PRIMED);
 215         var compositionId = acmDefinition.getCompositionId();
 216         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acmDefinition);
 217
 218         var provider = new CommissioningProvider(acDefinitionProvider, mock(AutomationCompositionProvider.class),
 219                 mock(AcmParticipantProvider.class), new AcTypeStateResolver(), mock(ParticipantPrimePublisher.class));
 220
 221         assertThatThrownBy(() -> provider.updateCompositionDefinition(compositionId, toscaServiceTemplate))
 222                 .hasMessageMatching("ACM not in COMMISSIONED state, Update of ACM Definition not allowed");
 223
 224         assertThatThrownBy(() -> provider.deleteAutomationCompositionDefinition(compositionId))
 225                 .hasMessageMatching("ACM not in COMMISSIONED state, Delete of ACM Definition not allowed");
 226     }
 227
 228     @Test
 229     void testPrimingBadRequest() {
 230         var acDefinitionProvider = mock(AcDefinitionProvider.class);
 231         var toscaServiceTemplate = InstantiationUtils.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
 232         var acmDefinition = CommonTestData.createAcDefinition(toscaServiceTemplate, AcTypeState.PRIMED);
 233         acmDefinition.setRestarting(true);
 234         var compositionId = acmDefinition.getCompositionId();
 235         when(acDefinitionProvider.getAcDefinition(compositionId)).thenReturn(acmDefinition);
 236
 237         var provider = new CommissioningProvider(acDefinitionProvider, mock(AutomationCompositionProvider.class),
 238                 mock(AcmParticipantProvider.class), new AcTypeStateResolver(), mock(ParticipantPrimePublisher.class));
 239
 240         var acTypeStateUpdate = new AcTypeStateUpdate();
 241         assertThatThrownBy(() -> provider.compositionDefinitionPriming(compositionId, acTypeStateUpdate))
 242                 .hasMessageMatching("There is a restarting process, Priming/Depriming not allowed");
 243     }
 244 }