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

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