2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2024 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.concepts.StateChangeResult;
42 import org.onap.policy.clamp.models.acm.document.concepts.DocToscaServiceTemplate;
43 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaAutomationCompositionDefinition;
44 import org.onap.policy.clamp.models.acm.persistence.concepts.JpaNodeTemplateState;
45 import org.onap.policy.clamp.models.acm.persistence.repository.AutomationCompositionDefinitionRepository;
46 import org.onap.policy.clamp.models.acm.persistence.repository.NodeTemplateStateRepository;
47 import org.onap.policy.clamp.models.acm.utils.CommonTestData;
48 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
50 import org.springframework.data.domain.Example;
52 class AcDefinitionProviderTest {
54 private static final String TOSCA_SERVICE_TEMPLATE_YAML = "clamp/acm/pmsh/funtional-pmsh-usecase.yaml";
55 private static final String TOSCA_SERVICE_TEMPLATE_YAML_PROP =
56 "clamp/acm/test/tosca-template-additional-properties.yaml";
58 private static final String ELEMENT_NAME = "org.onap.policy.clamp.acm.AutomationCompositionElement";
59 private static final String INVALID_ELEMENT_NAME = "dummyElement";
60 private static final String NODE_TYPE = "org.onap.policy.clamp.acm.AutomationComposition";
61 private static final String INVALID_NODE_TYPE = "dummyNodeTypeName";
63 private static ToscaServiceTemplate inputServiceTemplate;
66 static void loadServiceTemplate() {
67 inputServiceTemplate = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML);
71 void testDocCopyCompare() {
73 var inputServiceTemplateProperties = CommonTestData.getToscaServiceTemplate(TOSCA_SERVICE_TEMPLATE_YAML_PROP);
74 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplateProperties);
75 var docServiceTemplateCopy = new DocToscaServiceTemplate(docServiceTemplate);
77 assertThat(docServiceTemplate.compareTo(docServiceTemplateCopy)).isEqualByComparingTo(0);
78 assertThat(docServiceTemplate.compareToWithoutEntities(docServiceTemplateCopy)).isZero();
80 var acmDefinition = getAcDefinition(docServiceTemplate);
81 var acmDefinitionCopy = getAcDefinition(docServiceTemplateCopy);
83 assertThat(acmDefinition.getServiceTemplate().getName())
84 .isEqualTo(acmDefinitionCopy.getServiceTemplate().getName());
89 void testCreateServiceTemplate() {
90 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
91 var acmDefinition = getAcDefinition(docServiceTemplate);
93 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
94 when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
95 .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
97 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
98 var result = acDefinitionProvider
99 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
101 assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
102 assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
106 void testToscaWithInvalidElement() {
107 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
109 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
111 assertThatThrownBy(() -> acDefinitionProvider
112 .createAutomationCompositionDefinition(inputServiceTemplate, INVALID_ELEMENT_NAME, NODE_TYPE))
113 .hasMessage("NodeTemplate with element type " + INVALID_ELEMENT_NAME + " must exist!");
117 void testToscaWithInvalidNodeType() {
118 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
120 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
122 assertThatThrownBy(() -> acDefinitionProvider
123 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, INVALID_NODE_TYPE))
124 .hasMessageContaining("NodeTemplate with type " + INVALID_NODE_TYPE + " must exist!");
128 void testCreateServiceTemplateWithMetadata() {
129 inputServiceTemplate.setMetadata(new HashMap<>());
130 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
131 var acmDefinition = getAcDefinition(docServiceTemplate);
133 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
134 when(acmDefinitionRepository.save(any(JpaAutomationCompositionDefinition.class)))
135 .thenReturn(new JpaAutomationCompositionDefinition(acmDefinition));
137 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
138 inputServiceTemplate.setMetadata(new HashMap<>());
139 var result = acDefinitionProvider
140 .createAutomationCompositionDefinition(inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
142 assertThat(result.getServiceTemplate()).isEqualTo(docServiceTemplate.toAuthorative());
143 assertThat(result.getServiceTemplate().getMetadata()).isNotNull();
147 void testUpdateServiceTemplate() {
148 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
149 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
150 acDefinitionProvider.updateServiceTemplate(UUID.randomUUID(), inputServiceTemplate, ELEMENT_NAME, NODE_TYPE);
151 verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
155 void testUpdateAcDefinition() {
156 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
157 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
158 var acmDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
159 acDefinitionProvider.updateAcDefinition(acmDefinition, NODE_TYPE);
160 verify(acmDefinitionRepository).save(any(JpaAutomationCompositionDefinition.class));
164 void testUpdateAcDefinitionState() {
165 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
166 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
167 var acmDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
168 acmDefinition.setState(AcTypeState.PRIMING);
169 var jpa = new JpaAutomationCompositionDefinition(acmDefinition);
170 when(acmDefinitionRepository.findById(acmDefinition.getCompositionId().toString()))
171 .thenReturn(Optional.of(jpa));
172 acDefinitionProvider.updateAcDefinitionState(acmDefinition.getCompositionId(), AcTypeState.PRIMED,
173 StateChangeResult.NO_ERROR, false);
174 verify(acmDefinitionRepository).save(jpa);
178 void testUpdateAcDefinitionElement() {
179 var nodeTemplateState = new NodeTemplateState();
180 nodeTemplateState.setNodeTemplateId(new ToscaConceptIdentifier("name", "1.0.0"));
181 nodeTemplateState.setNodeTemplateStateId(UUID.randomUUID());
182 nodeTemplateState.setState(AcTypeState.PRIMED);
183 var nodeTemplateStateRepository = mock(NodeTemplateStateRepository.class);
184 var acDefinitionProvider = new AcDefinitionProvider(null, nodeTemplateStateRepository);
185 acDefinitionProvider.updateAcDefinitionElement(nodeTemplateState, UUID.randomUUID());
186 verify(nodeTemplateStateRepository).save(any(JpaNodeTemplateState.class));
190 void testGetAcDefinition() {
191 var jpa = new JpaAutomationCompositionDefinition();
192 jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
193 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
194 when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
195 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
196 var result = acDefinitionProvider.getAcDefinition(UUID.fromString(jpa.getCompositionId()));
197 assertThat(result).isNotNull();
201 void testGetAcDefinitionNotFound() {
202 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
203 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
204 var compositionId = UUID.randomUUID();
205 assertThatThrownBy(() -> acDefinitionProvider.getAcDefinition(compositionId))
206 .hasMessage("Get serviceTemplate \"" + compositionId + "\" failed, serviceTemplate does not exist");
210 void testFindAcDefinition() {
211 var jpa = new JpaAutomationCompositionDefinition();
212 jpa.fromAuthorative(getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate)));
213 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
214 when(acmDefinitionRepository.findById(jpa.getCompositionId())).thenReturn(Optional.of(jpa));
215 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
216 var compositionId = UUID.fromString(jpa.getCompositionId());
217 var result = acDefinitionProvider.findAcDefinition(compositionId);
218 assertThat(result).isNotEmpty();
222 void getAllAcDefinitionsInTransition() {
223 var acDefinition = getAcDefinition(new DocToscaServiceTemplate(inputServiceTemplate));
224 acDefinition.setState(AcTypeState.PRIMING);
225 var jpa = new JpaAutomationCompositionDefinition();
226 jpa.fromAuthorative(acDefinition);
227 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
228 when(acmDefinitionRepository.findByStateIn(List.of(AcTypeState.PRIMING, AcTypeState.DEPRIMING)))
229 .thenReturn(List.of(jpa));
230 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
231 var result = acDefinitionProvider.getAllAcDefinitionsInTransition();
232 assertThat(result).isNotEmpty();
236 void testDeleteAcDefintion() {
237 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
238 var acmDefinition = getAcDefinition(docServiceTemplate);
240 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
241 when(acmDefinitionRepository.findById(acmDefinition.getCompositionId().toString()))
242 .thenReturn(Optional.of(new JpaAutomationCompositionDefinition(acmDefinition)));
244 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
245 var result = acDefinitionProvider.deleteAcDefintion(acmDefinition.getCompositionId());
247 assertThat(result).isEqualTo(docServiceTemplate.toAuthorative());
251 void testDeleteServiceTemplateEmpty() {
252 var compositionId = UUID.randomUUID();
253 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
254 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
255 assertThatThrownBy(() -> acDefinitionProvider.deleteAcDefintion(compositionId))
256 .hasMessage("delete of Automation Composition Definition \"" + compositionId
257 + "\" failed, Automation Composition Definition does not exist");
261 void testGetServiceTemplate() {
262 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
263 var acmDefinition = getAcDefinition(docServiceTemplate);
264 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
265 when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
266 .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
268 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
269 var result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
270 inputServiceTemplate.getVersion());
272 assertThat(result).hasSize(1);
273 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
277 void testGetServiceTemplateNulls() {
278 var docServiceTemplate = new DocToscaServiceTemplate(inputServiceTemplate);
279 var acmDefinition = getAcDefinition(docServiceTemplate);
280 var acmDefinitionRepository = mock(AutomationCompositionDefinitionRepository.class);
281 when(acmDefinitionRepository.findAll(Mockito.<Example<JpaAutomationCompositionDefinition>>any()))
282 .thenReturn(List.of(new JpaAutomationCompositionDefinition(acmDefinition)));
284 var acDefinitionProvider = new AcDefinitionProvider(acmDefinitionRepository, null);
285 var result = acDefinitionProvider.getServiceTemplateList(null,
286 inputServiceTemplate.getVersion());
288 assertThat(result).hasSize(1);
289 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
291 result = acDefinitionProvider.getServiceTemplateList(inputServiceTemplate.getName(),
294 assertThat(result).hasSize(1);
295 assertThat(result.get(0)).isEqualTo(acmDefinition.getServiceTemplate());
297 result = acDefinitionProvider.getServiceTemplateList(null,
300 assertThat(result).isEmpty();
303 private AutomationCompositionDefinition getAcDefinition(DocToscaServiceTemplate docServiceTemplate) {
304 var acmDefinition = new AutomationCompositionDefinition();
305 acmDefinition.setCompositionId(UUID.randomUUID());
306 acmDefinition.setState(AcTypeState.COMMISSIONED);
307 acmDefinition.setServiceTemplate(docServiceTemplate.toAuthorative());
308 var nodeTemplateState = new NodeTemplateState();
309 nodeTemplateState.setNodeTemplateStateId(UUID.randomUUID());
310 nodeTemplateState.setNodeTemplateId(new ToscaConceptIdentifier("name", "1.0.0"));
311 nodeTemplateState.setState(AcTypeState.COMMISSIONED);
312 nodeTemplateState.setParticipantId(UUID.randomUUID());
313 acmDefinition.setElementStateMap(Map.of(nodeTemplateState.getNodeTemplateId().getName(), nodeTemplateState));
314 return acmDefinition;