2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2023 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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.clamp.models.acm.persistence.provider;
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.mock;
27 import static org.mockito.Mockito.verify;
28 import static org.mockito.Mockito.when;
30 import java.util.HashMap;
31 import java.util.List;
33 import java.util.Optional;
34 import java.util.UUID;
35 import org.junit.jupiter.api.BeforeAll;
36 import org.junit.jupiter.api.Test;
37 import org.mockito.Mockito;
38 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
39 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
40 import org.onap.policy.clamp.models.acm.concepts.NodeTemplateState;
41 import org.onap.policy.clamp.models.acm.document.concepts.DocToscaServiceTemplate;
42 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaAutomationCompositionDefinition;
43 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionDefinitionRepository;
44 import org.onap.policy.clamp.models.acm.utils.CommonTestData;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
46 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
47 import org.springframework.data.domain.Example;
49 class AcDefinitionProviderTest {
51 private static final String TOSCA_SERVICE_TEMPLATE_YAML = "clamp/acm/pmsh/funtional-pmsh-usecase.yaml";
52 private static final String TOSCA_SERVICE_TEMPLATE_YAML_PROP =
53 "clamp/acm/test/tosca-template-additional-properties.yaml";
55 private static final String ELEMENT_NAME = "org.onap.policy.clamp.acm.AutomationCompositionElement";
56 private static final String INVALID_ELEMENT_NAME = "dummyElement";
57 private static final String NODE_TYPE = "org.onap.policy.clamp.acm.AutomationComposition";
58 private static final String INVALID_NODE_TYPE = "dummyNodeTypeName";
60 private static ToscaServiceTemplate inputServiceTemplate;
63 static void loadServiceTemplate() {
64 inputServiceTemplate = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
68 void testDocCopyCompare() {
70 var inputServiceTemplateProperties = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML_PROP);
71 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplateProperties);
72 var docServiceTemplateCopy = new DocToscaServiceTemplate(docServiceTemplate);
74 assertThat(docServiceTemplate.compareTo(docServiceTemplateCopy)).isEqualByComparingTo(0);
75 assertThat(docServiceTemplate.compareToWithoutEntities(docServiceTemplateCopy)).isZero();
77 var acmDefinition = getAcDefinition(docServiceTemplate);
78 var acmDefinitionCopy = getAcDefinition(docServiceTemplateCopy);
80 assertThat(acmDefinition.getServiceTemplate().getName())
81 .isEqualTo(acmDefinitionCopy.getServiceTemplate().getName());
86 void testCreateServiceTemplate() {
87 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
88 var acmDefinition = getAcDefinition(docServiceTemplate);
90 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
91 when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
92 .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
94 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
95 var result = acDefinitionProvider
96 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
98 assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
99 assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
103 void testToscaWithInvalidElement() {
104 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
105 var acmDefinition = getAcDefinition(docServiceTemplate);
106 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
108 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
110 assertThatThrownBy(() -> acDefinitionProvider
111 .createAutomationCompositionDefinition(inputServiceTemplate, INVALID_ELEMENT_NAME, NODE_TYPE))
112 .hasMessage("NodeTemplate with element type " + INVALID_ELEMENT_NAME + " must exist!");
116 void testToscaWithInvalidNodeType() {
117 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
118 var acmDefinition = getAcDefinition(docServiceTemplate);
119 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
121 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
123 assertThatThrownBy(() -> acDefinitionProvider
124 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, INVALID_NODE_TYPE))
125 .hasMessageContaining("NodeTemplate with type " + INVALID_NODE_TYPE + " must exist!");
129 void testCreateServiceTemplateWithMetadata() {
130 inputServiceTemplate.setMetadata(new HashMap<>());
131 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
132 var acmDefinition = getAcDefinition(docServiceTemplate);
134 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
135 when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
136 .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
138 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
139 inputServiceTemplate.setMetadata(new HashMap<>());
140 var result = acDefinitionProvider
141 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
143 assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
144 assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
148 void testUpdateServiceTemplate() {
149 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
150 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
151 acDefinitionProvider.updateServiceTemplate(UUID.randomUUID(), inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
152 verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
156 void testUpdateAcDefinition() {
157 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
158 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
159 var acmDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
160 acDefinitionProvider.updateAcDefinition(acmDefinition, NODE_TYPE);
161 verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
165 void testGetAcDefinition() {
166 var jpa = new JpaAutomationCompositionDefinition();
167 jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
168 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
169 when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
170 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
171 var result = acDefinitionProvider.getAcDefinition(UUID.fromString(jpa.getCompositionId()));
172 assertThat(result).isNotNull();
176 void testGetAcDefinitionNotFound() {
177 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
178 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
179 var compositionId = UUID.randomUUID();
180 assertThatThrownBy(() -> acDefinitionProvider.getAcDefinition(compositionId))
181 .hasMessage("Get serviceTemplate \"" + compositionId + "\" failed, serviceTemplate does not exist");
185 void testFindAcDefinition() {
186 var jpa = new JpaAutomationCompositionDefinition();
187 jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
188 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
189 when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
190 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
191 var result = acDefinitionProvider.findAcDefinition(UUID.fromString(jpa.getCompositionId()));
192 assertThat(result).isNotNull();
196 void testGetAllAcDefinitions() {
197 var jpa = new JpaAutomationCompositionDefinition();
198 jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
199 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
200 when(acmDefinitionRepository.findAll()).thenReturn(List.of(jpa));
201 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
202 var result = acDefinitionProvider.getAllAcDefinitions();
203 assertThat(result).hasSize(1);
207 void testDeleteAcDefintion() {
208 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
209 var acmDefinition = getAcDefinition(docServiceTemplate);
211 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
212 when(acmDefinitionRepository.findById(acmDefinition.getCompositionId().toString()))
213 .thenReturn(Optional.of(new JpaAutomationCompositionDefinition(acmDefinition)));
215 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
216 var result = acDefinitionProvider.deleteAcDefintion(acmDefinition.getCompositionId());
218 assertThat(result).isEqualTo(docServiceTemplate.toAuthorative());
222 void testDeleteServiceTemplateEmpty() {
223 var compositionId = UUID.randomUUID();
224 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
225 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
226 assertThatThrownBy(() -> acDefinitionProvider.deleteAcDefintion(compositionId))
227 .hasMessage("delete of Automation Composition Definition \"" + compositionId
228 + "\" failed, Automation Composition Definition does not exist");
232 void testGetServiceTemplate() {
233 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
234 var acmDefinition = getAcDefinition(docServiceTemplate);
235 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
236 when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
237 .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
239 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
240 var result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
241 inputServiceTemplate.getVersion());
243 assertThat(result).hasSize(1);
244 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
248 void testGetServiceTemplateNulls() {
249 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
250 var acmDefinition = getAcDefinition(docServiceTemplate);
251 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
252 when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
253 .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
255 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository);
256 var result = acDefinitionProvider.getServiceTemplateList(null,
257 inputServiceTemplate.getVersion());
259 assertThat(result).hasSize(1);
260 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
262 result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
265 assertThat(result).hasSize(1);
266 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
268 result = acDefinitionProvider.getServiceTemplateList(null,
271 assertThat(result).isEmpty();
274 private AutomationCompositionDefinition getAcDefinition(DocToscaServiceTemplate docServiceTemplate) {
275 var acmDefinition = new AutomationCompositionDefinition();
276 acmDefinition.setCompositionId(UUID.randomUUID());
277 acmDefinition.setState(AcTypeState.COMMISSIONED);
278 acmDefinition.setServiceTemplate(docServiceTemplate.toAuthorative());
279 var nodeTemplateState = new NodeTemplateState();
280 nodeTemplateState.setNodeTemplateStateId(UUID.randomUUID());
281 nodeTemplateState.setNodeTemplateId(new ToscaConceptIdentifier("name", "1.0.0"));
282 nodeTemplateState.setState(AcTypeState.COMMISSIONED);
283 nodeTemplateState.setParticipantId(UUID.randomUUID());
284 acmDefinition.setElementStateMap(Map.of(nodeTemplateState.getNodeTemplateId().getName(), nodeTemplateState));
285 return acmDefinition;