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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2025 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.models.acm.persistence.provider;
  22
  23 import static org.assertj.core.api.Assertions.assertThat;
  24 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  25 import static org.mockito.ArgumentMatchers.any;
  26 import static org.mockito.Mockito.clearInvocations;
  27 import static org.mockito.Mockito.mock;
  28 import static org.mockito.Mockito.verify;
  29 import static org.mockito.Mockito.when;
  30
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Optional;
  35 import java.util.UUID;
  36 import org.junit.jupiter.api.BeforeAll;
  37 import org.junit.jupiter.api.Test;
  38 import org.mockito.Mockito;
  39 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  40 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  41 import org.onap.policy.clamp.models.acm.concepts.NodeTemplateState;
  42 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  43 import org.onap.policy.clamp.models.acm.document.concepts.DocToscaServiceTemplate;
  44 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaAutomationCompositionDefinition;
  45 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaNodeTemplateState;
  46 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionDefinitionRepository;
  47 import org.onap.policy.clamp.models.acm.persistence.repository.NodeTemplateStateRepository;
  48 import org.onap.policy.clamp.models.acm.utils.CommonTestData;
  49 import org.onap.policy.clamp.models.acm.utils.TimestampHelper;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;
  53 import org.springframework.data.domain.Example;
  54
  55 class AcDefinitionProviderTest {
  56
  57     private static final String TOSCA_SERVICE_TEMPLATE_YAML = "clamp/acm/pmsh/funtional-pmsh-usecase.yaml";
  58     private static final String TOSCA_SERVICE_TEMPLATE_YAML_PROP =
  59             "clamp/acm/test/tosca-template-additional-properties.yaml";
  60
  61     private static final String ELEMENT_NAME = "org.onap.policy.clamp.acm.AutomationCompositionElement";
  62     private static final String INVALID_ELEMENT_NAME = "dummyElement";
  63     private static final String NODE_TYPE = "org.onap.policy.clamp.acm.AutomationComposition";
  64     private static final String INVALID_NODE_TYPE = "dummyNodeTypeName";
  65
  66     private static ToscaServiceTemplate inputServiceTemplate;
  67
  68     @Test
  69     void testBadRequest() {
  70         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
  71         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
  72
  73         var compositionId = UUID.randomUUID();
  74         var serviceTemplate = new ToscaServiceTemplate();
  75         serviceTemplate.setToscaTopologyTemplate(new ToscaTopologyTemplate());
  76         serviceTemplate.getToscaTopologyTemplate().setNodeTemplates(new HashMap<>());
  77         assertThatThrownBy(() -> acDefinitionProvider.updateServiceTemplate(compositionId, serviceTemplate,
  78                 "ElementName", "CompositionName"))
  79                 .hasMessageMatching("NodeTemplate with element type ElementName must exist!");
  80
  81         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
  82         var acmDefinition = getAcDefinition(docServiceTemplate);
  83         assertThatThrownBy(() -> acDefinitionProvider.updateAcDefinition(acmDefinition, "CompositionName"))
  84                 .hasMessageStartingWith("\"AutomationCompositionDefinition\" INVALID, item has status INVALID");
  85
  86         assertThatThrownBy(() -> acDefinitionProvider.updateAcDefinitionState(compositionId, AcTypeState.PRIMED,
  87                 StateChangeResult.NO_ERROR))
  88                 .hasMessageStartingWith("update of Automation Composition Definition");
  89     }
  90
  91     @BeforeAll
  92     static void loadServiceTemplate() {
  93         inputServiceTemplate = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
  94     }
  95
  96     @Test
  97     void testDocCopyCompare() {
  98
  99         var inputServiceTemplateProperties = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML_PROP);
 100         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplateProperties);
 101         var docServiceTemplateCopy = new DocToscaServiceTemplate(docServiceTemplate);
 102
 103         assertThat(docServiceTemplate.compareTo(docServiceTemplateCopy)).isEqualByComparingTo(0);
 104         assertThat(docServiceTemplate.compareToWithoutEntities(docServiceTemplateCopy)).isZero();
 105
 106         var acmDefinition = getAcDefinition(docServiceTemplate);
 107         var acmDefinitionCopy = getAcDefinition(docServiceTemplateCopy);
 108
 109         assertThat(acmDefinition.getServiceTemplate().getName())
 110                 .isEqualTo(acmDefinitionCopy.getServiceTemplate().getName());
 111
 112     }
 113
 114     @Test
 115     void testCreateServiceTemplate() {
 116         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
 117         var acmDefinition = getAcDefinition(docServiceTemplate);
 118
 119         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 120         when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
 121                 .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
 122
 123         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 124         var result = acDefinitionProvider
 125                 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
 126
 127         assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
 128         assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
 129     }
 130
 131     @Test
 132     void testToscaWithInvalidElement() {
 133         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 134
 135         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 136
 137         assertThatThrownBy(() -> acDefinitionProvider
 138                 .createAutomationCompositionDefinition(inputServiceTemplate, INVALID_ELEMENT_NAME, NODE_TYPE))
 139                 .hasMessage("NodeTemplate with element type " + INVALID_ELEMENT_NAME + " must exist!");
 140     }
 141
 142     @Test
 143     void testToscaWithInvalidNodeType() {
 144         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 145
 146         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 147
 148         assertThatThrownBy(() -> acDefinitionProvider
 149                 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, INVALID_NODE_TYPE))
 150                 .hasMessageContaining("NodeTemplate with type " + INVALID_NODE_TYPE + " must exist!");
 151     }
 152
 153     @Test
 154     void testCreateServiceTemplateWithMetadata() {
 155         inputServiceTemplate.setMetadata(new HashMap<>());
 156         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
 157         var acmDefinition = getAcDefinition(docServiceTemplate);
 158
 159         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 160         when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
 161             .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
 162
 163         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 164         inputServiceTemplate.setMetadata(new HashMap<>());
 165         var result = acDefinitionProvider
 166                 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
 167
 168         assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
 169         assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
 170     }
 171
 172     @Test
 173     void testUpdateServiceTemplate() {
 174         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 175         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 176         acDefinitionProvider.updateServiceTemplate(UUID.randomUUID(), inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
 177         verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
 178     }
 179
 180     @Test
 181     void testUpdateAcDefinition() {
 182         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 183         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 184         var acmDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
 185         acDefinitionProvider.updateAcDefinition(acmDefinition, NODE_TYPE);
 186         verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
 187     }
 188
 189     @Test
 190     void testUpdateAcDefinitionState() {
 191         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 192         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 193         var acmDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
 194         acmDefinition.setState(AcTypeState.PRIMING);
 195         var jpa = new JpaAutomationCompositionDefinition(acmDefinition);
 196         when(acmDefinitionRepository.findById(acmDefinition.getCompositionId().toString()))
 197             .thenReturn(Optional.of(jpa));
 198         acDefinitionProvider.updateAcDefinitionState(acmDefinition.getCompositionId(), AcTypeState.PRIMED,
 199             StateChangeResult.NO_ERROR);
 200         verify(acmDefinitionRepository).save(jpa);
 201
 202         clearInvocations(acmDefinitionRepository);
 203         acDefinitionProvider.updateAcDefinitionState(acmDefinition);
 204         verify(acmDefinitionRepository).save(any());
 205     }
 206
 207     @Test
 208     void testUpdateAcDefinitionElement() {
 209         var nodeTemplateState = new NodeTemplateState();
 210         nodeTemplateState.setNodeTemplateId(new ToscaConceptIdentifier("name", "1.0.0"));
 211         nodeTemplateState.setNodeTemplateStateId(UUID.randomUUID());
 212         nodeTemplateState.setState(AcTypeState.PRIMED);
 213         var nodeTemplateStateRepository = mock(NodeTemplateStateRepository.class);
 214         var acDefinitionProvider = new AcDefinitionProvider(null, nodeTemplateStateRepository);
 215         acDefinitionProvider.updateAcDefinitionElement(nodeTemplateState, UUID.randomUUID());
 216         verify(nodeTemplateStateRepository).save(any(JpaNodeTemplateState.class));
 217     }
 218
 219     @Test
 220     void testGetAcDefinition() {
 221         var jpa = new JpaAutomationCompositionDefinition();
 222         jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
 223         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 224         when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
 225         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 226         var result = acDefinitionProvider.getAcDefinition(UUID.fromString(jpa.getCompositionId()));
 227         assertThat(result).isNotNull();
 228     }
 229
 230     @Test
 231     void testGetAcDefinitionNotFound() {
 232         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 233         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 234         var compositionId = UUID.randomUUID();
 235         assertThatThrownBy(() -> acDefinitionProvider.getAcDefinition(compositionId))
 236                 .hasMessage("Get serviceTemplate \"" + compositionId + "\" failed, serviceTemplate does not exist");
 237     }
 238
 239     @Test
 240     void testFindAcDefinition() {
 241         var jpa = new JpaAutomationCompositionDefinition();
 242         jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
 243         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 244         when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
 245         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 246         var compositionId = UUID.fromString(jpa.getCompositionId());
 247         var result = acDefinitionProvider.findAcDefinition(compositionId);
 248         assertThat(result).isNotEmpty();
 249     }
 250
 251     @Test
 252     void getAllAcDefinitionsInTransition() {
 253         var acDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
 254         acDefinition.setState(AcTypeState.PRIMING);
 255         var jpa = new JpaAutomationCompositionDefinition();
 256         jpa.fromAuthorative(acDefinition);
 257         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 258         when(acmDefinitionRepository.findByStateIn(List.of(AcTypeState.PRIMING, AcTypeState.DEPRIMING)))
 259             .thenReturn(List.of(jpa));
 260         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 261         var result = acDefinitionProvider.getAllAcDefinitionsInTransition();
 262         assertThat(result).isNotEmpty();
 263     }
 264
 265     @Test
 266     void testDeleteAcDefintion() {
 267         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
 268         var acmDefinition = getAcDefinition(docServiceTemplate);
 269
 270         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 271         when(acmDefinitionRepository.findById(acmDefinition.getCompositionId().toString()))
 272                 .thenReturn(Optional.of(new JpaAutomationCompositionDefinition(acmDefinition)));
 273
 274         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 275         var result = acDefinitionProvider.deleteAcDefintion(acmDefinition.getCompositionId());
 276
 277         assertThat(result).isEqualTo(docServiceTemplate.toAuthorative());
 278     }
 279
 280     @Test
 281     void testDeleteServiceTemplateEmpty() {
 282         var compositionId = UUID.randomUUID();
 283         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 284         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 285         assertThatThrownBy(() -> acDefinitionProvider.deleteAcDefintion(compositionId))
 286                 .hasMessage("delete of Automation Composition Definition \"" + compositionId
 287                         + "\" failed, Automation Composition Definition does not exist");
 288     }
 289
 290     @Test
 291     void testGetServiceTemplate() {
 292         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
 293         var acmDefinition = getAcDefinition(docServiceTemplate);
 294         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 295         when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
 296                 .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
 297
 298         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 299         var result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
 300                 inputServiceTemplate.getVersion());
 301
 302         assertThat(result).hasSize(1);
 303         assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
 304     }
 305
 306     @Test
 307     void testGetServiceTemplateNulls() {
 308         var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
 309         var acmDefinition = getAcDefinition(docServiceTemplate);
 310         var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
 311         when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
 312             .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
 313
 314         var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
 315         var result = acDefinitionProvider.getServiceTemplateList(null,
 316             inputServiceTemplate.getVersion());
 317
 318         assertThat(result).hasSize(1);
 319         assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
 320
 321         result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
 322             null);
 323
 324         assertThat(result).hasSize(1);
 325         assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
 326
 327         result = acDefinitionProvider.getServiceTemplateList(null,
 328             null);
 329
 330         assertThat(result).isEmpty();
 331     }
 332
 333     private AutomationCompositionDefinition getAcDefinition(DocToscaServiceTemplate docServiceTemplate) {
 334         var acmDefinition = new AutomationCompositionDefinition();
 335         acmDefinition.setCompositionId(UUID.randomUUID());
 336         acmDefinition.setState(AcTypeState.COMMISSIONED);
 337         acmDefinition.setLastMsg(TimestampHelper.now());
 338         acmDefinition.setServiceTemplate(docServiceTemplate.toAuthorative());
 339         var nodeTemplateState = new NodeTemplateState();
 340         nodeTemplateState.setNodeTemplateStateId(UUID.randomUUID());
 341         nodeTemplateState.setNodeTemplateId(new ToscaConceptIdentifier("name", "1.0.0"));
 342         nodeTemplateState.setState(AcTypeState.COMMISSIONED);
 343         nodeTemplateState.setParticipantId(UUID.randomUUID());
 344         acmDefinition.setElementStateMap(Map.of(nodeTemplateState.getNodeTemplateId().getName(), nodeTemplateState));
 345         return acmDefinition;
 346     }
 347 }