2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2024 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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.clamp.acm.runtime.instantiation;
24 import jakarta.validation.Valid;
25 import jakarta.ws.rs.core.Response.Status;
26 import java.util.List;
27 import java.util.UUID;
28 import java.util.stream.Collectors;
29 import lombok.NonNull;
30 import lombok.RequiredArgsConstructor;
31 import org.onap.policy.clamp.acm.runtime.main.parameters.AcRuntimeParameterGroup;
32 import org.onap.policy.clamp.acm.runtime.supervision.SupervisionAcHandler;
33 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
34 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
35 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions;
36 import org.onap.policy.clamp.models.acm.concepts.DeployState;
37 import org.onap.policy.clamp.models.acm.concepts.LockState;
38 import org.onap.policy.clamp.models.acm.concepts.NodeTemplateState;
39 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
40 import org.onap.policy.clamp.models.acm.concepts.SubState;
41 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.AcInstanceStateUpdate;
42 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.DeployOrder;
43 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse;
44 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.LockOrder;
45 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.SubOrder;
46 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
47 import org.onap.policy.clamp.models.acm.persistence.provider.AcInstanceStateResolver;
48 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
49 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
50 import org.onap.policy.clamp.models.acm.utils.AcmUtils;
51 import org.onap.policy.common.parameters.BeanValidationResult;
52 import org.onap.policy.common.parameters.ObjectValidationResult;
53 import org.onap.policy.common.parameters.ValidationStatus;
54 import org.onap.policy.models.base.PfConceptKey;
55 import org.onap.policy.models.base.PfKey;
56 import org.onap.policy.models.base.PfModelRuntimeException;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
59 import org.springframework.stereotype.Service;
60 import org.springframework.transaction.annotation.Transactional;
63 * This class is dedicated to the Instantiation of Commissioned automation composition.
67 @RequiredArgsConstructor
68 public class AutomationCompositionInstantiationProvider {
69 private static final String DO_NOT_MATCH = " do not match with ";
70 private static final String ELEMENT_ID_NOT_PRESENT = "Element id not present ";
72 private static final Logger LOGGER = LoggerFactory.getLogger(AutomationCompositionInstantiationProvider.class);
74 private final AutomationCompositionProvider automationCompositionProvider;
75 private final AcDefinitionProvider acDefinitionProvider;
76 private final AcInstanceStateResolver acInstanceStateResolver;
77 private final SupervisionAcHandler supervisionAcHandler;
78 private final ParticipantProvider participantProvider;
79 private final AcRuntimeParameterGroup acRuntimeParameterGroup;
82 * Create automation composition.
84 * @param compositionId The UUID of the automation composition definition
85 * @param automationComposition the automation composition
86 * @return the result of the instantiation operation
88 public InstantiationResponse createAutomationComposition(UUID compositionId,
89 AutomationComposition automationComposition) {
90 if (!compositionId.equals(automationComposition.getCompositionId())) {
91 throw new PfModelRuntimeException(Status.BAD_REQUEST,
92 automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
94 var checkAutomationCompositionOpt =
95 automationCompositionProvider.findAutomationComposition(automationComposition.getKey().asIdentifier());
96 if (checkAutomationCompositionOpt.isPresent()) {
97 throw new PfModelRuntimeException(Status.BAD_REQUEST,
98 automationComposition.getKey().asIdentifier() + " already defined");
101 var validationResult = validateAutomationComposition(automationComposition);
102 if (!validationResult.isValid()) {
103 throw new PfModelRuntimeException(Status.BAD_REQUEST, validationResult.getResult());
105 automationComposition = automationCompositionProvider.createAutomationComposition(automationComposition);
107 return createInstantiationResponse(automationComposition);
110 private InstantiationResponse createInstantiationResponse(AutomationComposition automationComposition) {
111 var response = new InstantiationResponse();
112 response.setInstanceId(automationComposition.getInstanceId());
113 response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier());
118 * Update automation composition.
120 * @param compositionId The UUID of the automation composition definition
121 * @param automationComposition the automation composition
122 * @return the result of the update
124 public InstantiationResponse updateAutomationComposition(UUID compositionId,
125 AutomationComposition automationComposition) {
126 var instanceId = automationComposition.getInstanceId();
127 var acToUpdate = automationCompositionProvider.getAutomationComposition(instanceId);
128 if (!compositionId.equals(acToUpdate.getCompositionId())) {
129 throw new PfModelRuntimeException(Status.BAD_REQUEST,
130 automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
132 if (DeployState.UNDEPLOYED.equals(acToUpdate.getDeployState())) {
133 acToUpdate.setElements(automationComposition.getElements());
134 acToUpdate.setName(automationComposition.getName());
135 acToUpdate.setVersion(automationComposition.getVersion());
136 acToUpdate.setDescription(automationComposition.getDescription());
137 acToUpdate.setDerivedFrom(automationComposition.getDerivedFrom());
138 var validationResult = validateAutomationComposition(acToUpdate);
139 if (!validationResult.isValid()) {
140 throw new PfModelRuntimeException(Status.BAD_REQUEST, validationResult.getResult());
142 automationComposition = automationCompositionProvider.updateAutomationComposition(acToUpdate);
143 return createInstantiationResponse(automationComposition);
147 if (automationComposition.getRestarting() != null) {
148 throw new PfModelRuntimeException(Status.BAD_REQUEST, "There is a restarting process, Update not allowed");
151 var deployOrder = DeployOrder.UPDATE;
152 var subOrder = SubOrder.NONE;
154 if (automationComposition.getCompositionTargetId() != null) {
156 if (Boolean.TRUE.equals(automationComposition.getPrecheck())) {
157 subOrder = SubOrder.MIGRATE_PRECHECK;
158 deployOrder = DeployOrder.NONE;
160 deployOrder = DeployOrder.MIGRATE;
163 var result = acInstanceStateResolver.resolve(deployOrder, LockOrder.NONE, subOrder,
164 acToUpdate.getDeployState(), acToUpdate.getLockState(), acToUpdate.getSubState(),
165 acToUpdate.getStateChangeResult());
166 return switch (result) {
167 case "UPDATE" -> updateDeployedAutomationComposition(automationComposition, acToUpdate);
169 case "MIGRATE" -> migrateAutomationComposition(automationComposition, acToUpdate);
171 case "MIGRATE_PRECHECK" -> migratePrecheckAc(automationComposition, acToUpdate);
173 default -> throw new PfModelRuntimeException(Status.BAD_REQUEST,
174 "Not allowed to " + deployOrder + " in the state " + acToUpdate.getDeployState());
179 * Update deployed AC Element properties.
181 * @param automationComposition the automation composition
182 * @param acToBeUpdated the composition to be updated
183 * @return the result of the update
185 private InstantiationResponse updateDeployedAutomationComposition(
186 AutomationComposition automationComposition, AutomationComposition acToBeUpdated) {
188 // Iterate and update the element property values
189 for (var element : automationComposition.getElements().entrySet()) {
190 var elementId = element.getKey();
191 var dbAcElement = acToBeUpdated.getElements().get(elementId);
192 if (dbAcElement == null) {
193 throw new PfModelRuntimeException(Status.BAD_REQUEST, ELEMENT_ID_NOT_PRESENT + elementId);
195 AcmUtils.recursiveMerge(dbAcElement.getProperties(), element.getValue().getProperties());
198 var validationResult = validateAutomationComposition(acToBeUpdated);
199 if (!validationResult.isValid()) {
200 throw new PfModelRuntimeException(Status.BAD_REQUEST, validationResult.getResult());
202 // Publish property update event to the participants
203 supervisionAcHandler.update(acToBeUpdated);
205 automationComposition = automationCompositionProvider.updateAutomationComposition(acToBeUpdated);
206 return createInstantiationResponse(automationComposition);
209 private InstantiationResponse migrateAutomationComposition(
210 AutomationComposition automationComposition, AutomationComposition acToBeUpdated) {
212 if (!DeployState.DEPLOYED.equals(acToBeUpdated.getDeployState())) {
213 throw new PfModelRuntimeException(Status.BAD_REQUEST,
214 "Not allowed to migrate in the state " + acToBeUpdated.getDeployState());
217 // Iterate and update the element property values
218 for (var element : automationComposition.getElements().entrySet()) {
219 var elementId = element.getKey();
220 var dbAcElement = acToBeUpdated.getElements().get(elementId);
221 // Add additional elements if present for migration
222 if (dbAcElement == null) {
223 LOGGER.info("New Ac element {} added in Migration", elementId);
224 acToBeUpdated.getElements().put(elementId, element.getValue());
226 AcmUtils.recursiveMerge(dbAcElement.getProperties(), element.getValue().getProperties());
227 var newDefinition = element.getValue().getDefinition().asConceptKey();
228 var dbElementDefinition = dbAcElement.getDefinition().asConceptKey();
229 checkCompatibility(newDefinition, dbElementDefinition, automationComposition.getInstanceId());
230 dbAcElement.setDefinition(element.getValue().getDefinition());
233 // Remove element which is not present in the new Ac instance
234 var elementsRemoved = getElementRemoved(acToBeUpdated, automationComposition);
235 elementsRemoved.forEach(uuid -> acToBeUpdated.getElements().remove(uuid));
237 var validationResult =
238 validateAutomationComposition(acToBeUpdated, automationComposition.getCompositionTargetId());
239 if (!validationResult.isValid()) {
240 throw new PfModelRuntimeException(Status.BAD_REQUEST, validationResult.getResult());
242 acToBeUpdated.setCompositionTargetId(automationComposition.getCompositionTargetId());
243 var acDefinition = acDefinitionProvider.getAcDefinition(automationComposition.getCompositionTargetId());
244 // Publish migrate event to the participants
245 supervisionAcHandler.migrate(acToBeUpdated, acDefinition.getServiceTemplate());
247 var ac = automationCompositionProvider.updateAutomationComposition(acToBeUpdated);
248 elementsRemoved.forEach(automationCompositionProvider::deleteAutomationCompositionElement);
249 return createInstantiationResponse(ac);
252 private List<UUID> getElementRemoved(AutomationComposition acFromDb, AutomationComposition acFromMigration) {
253 return acFromDb.getElements().keySet().stream()
254 .filter(id -> acFromMigration.getElements().get(id) == null).toList();
257 void checkCompatibility(PfConceptKey newDefinition, PfConceptKey dbElementDefinition,
259 var compatibility = newDefinition.getCompatibility(dbElementDefinition);
260 if (PfKey.Compatibility.DIFFERENT.equals(compatibility)) {
261 throw new PfModelRuntimeException(Status.BAD_REQUEST,
262 dbElementDefinition + " is not compatible with " + newDefinition);
264 if (PfKey.Compatibility.MAJOR.equals(compatibility) || PfKey.Compatibility.MINOR
265 .equals(compatibility)) {
266 LOGGER.warn("Migrate {}: Version {} has {} compatibility with {} ", instanceId, newDefinition,
267 compatibility, dbElementDefinition);
271 private InstantiationResponse migratePrecheckAc(
272 AutomationComposition automationComposition, AutomationComposition acToBeUpdated) {
274 acToBeUpdated.setPrecheck(true);
275 var copyAc = new AutomationComposition(acToBeUpdated);
276 // Iterate and update the element property values
277 for (var element : automationComposition.getElements().entrySet()) {
278 var elementId = element.getKey();
279 var copyElement = copyAc.getElements().get(elementId);
280 // Add additional elements if present for migration
281 if (copyElement == null) {
282 LOGGER.info("New Ac element {} added in Migration", elementId);
283 copyAc.getElements().put(elementId, element.getValue());
285 AcmUtils.recursiveMerge(copyElement.getProperties(), element.getValue().getProperties());
286 var newDefinition = element.getValue().getDefinition().asConceptKey();
287 var copyElementDefinition = copyElement.getDefinition().asConceptKey();
288 checkCompatibility(newDefinition, copyElementDefinition, automationComposition.getInstanceId());
289 copyElement.setDefinition(element.getValue().getDefinition());
292 // Remove element which is not present in the new Ac instance
293 var elementsRemoved = getElementRemoved(copyAc, automationComposition);
294 elementsRemoved.forEach(uuid -> copyAc.getElements().remove(uuid));
296 var validationResult =
297 validateAutomationComposition(copyAc, automationComposition.getCompositionTargetId());
298 if (!validationResult.isValid()) {
299 throw new PfModelRuntimeException(Status.BAD_REQUEST, validationResult.getResult());
301 copyAc.setCompositionTargetId(automationComposition.getCompositionTargetId());
303 // Publish migrate event to the participants
304 supervisionAcHandler.migratePrecheck(copyAc);
306 AcmUtils.setCascadedState(acToBeUpdated, DeployState.DEPLOYED, LockState.LOCKED,
307 SubState.MIGRATION_PRECHECKING);
308 acToBeUpdated.setStateChangeResult(StateChangeResult.NO_ERROR);
309 // excluding removed element in MIGRATION_PRECHECKING
310 elementsRemoved.forEach(uuid -> acToBeUpdated.getElements().get(uuid).setSubState(SubState.NONE));
312 return createInstantiationResponse(automationCompositionProvider.updateAutomationComposition(acToBeUpdated));
315 private BeanValidationResult validateAutomationComposition(AutomationComposition automationComposition) {
316 return validateAutomationComposition(automationComposition, automationComposition.getCompositionId());
320 * Validate AutomationComposition.
322 * @param automationComposition AutomationComposition to validate
323 * @param compositionId the composition id
324 * @return the result of validation
326 private BeanValidationResult validateAutomationComposition(AutomationComposition automationComposition,
327 UUID compositionId) {
329 var result = new BeanValidationResult("AutomationComposition", automationComposition);
330 var acDefinitionOpt = acDefinitionProvider.findAcDefinition(compositionId);
331 if (acDefinitionOpt.isEmpty()) {
332 result.addResult(new ObjectValidationResult("ServiceTemplate", compositionId, ValidationStatus.INVALID,
333 "Commissioned automation composition definition not found"));
336 if (!AcTypeState.PRIMED.equals(acDefinitionOpt.get().getState())) {
337 result.addResult(new ObjectValidationResult("ServiceTemplate.state", acDefinitionOpt.get().getState(),
338 ValidationStatus.INVALID, "Commissioned automation composition definition not primed"));
341 if (acDefinitionOpt.get().getRestarting() != null) {
343 new ObjectValidationResult("ServiceTemplate.restarting", acDefinitionOpt.get().getRestarting(),
344 ValidationStatus.INVALID, "There is a restarting process in composition"));
347 var participantIds = acDefinitionOpt.get().getElementStateMap().values().stream()
348 .map(NodeTemplateState::getParticipantId).collect(Collectors.toSet());
350 participantProvider.verifyParticipantState(participantIds);
352 result.addResult(AcmUtils.validateAutomationComposition(automationComposition,
353 acDefinitionOpt.get().getServiceTemplate(),
354 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName()));
356 result.addResult(automationCompositionProvider.validateElementIds(automationComposition));
358 if (result.isValid()) {
359 for (var element : automationComposition.getElements().values()) {
360 var name = element.getDefinition().getName();
361 var participantId = acDefinitionOpt.get().getElementStateMap().get(name).getParticipantId();
362 element.setParticipantId(participantId);
370 * Get Automation Composition.
372 * @param compositionId The UUID of the automation composition definition
373 * @param instanceId The UUID of the automation composition instance
374 * @return the Automation Composition
376 @Transactional(readOnly = true)
377 public AutomationComposition getAutomationComposition(@NonNull UUID compositionId, UUID instanceId) {
378 var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
379 if (!compositionId.equals(automationComposition.getCompositionId())
380 && !compositionId.equals(automationComposition.getCompositionTargetId())) {
381 throw new PfModelRuntimeException(Status.BAD_REQUEST,
382 automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
384 return automationComposition;
388 * Delete the automation composition with the given name and version.
390 * @param compositionId The UUID of the automation composition definition
391 * @param instanceId The UUID of the automation composition instance
392 * @return the result of the deletion
394 public InstantiationResponse deleteAutomationComposition(UUID compositionId, UUID instanceId) {
395 var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
396 if (!compositionId.equals(automationComposition.getCompositionId())) {
397 throw new PfModelRuntimeException(Status.BAD_REQUEST,
398 automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
400 if (!DeployState.UNDEPLOYED.equals(automationComposition.getDeployState())
401 && !DeployState.DELETING.equals(automationComposition.getDeployState())) {
402 throw new PfModelRuntimeException(Status.BAD_REQUEST,
403 "Automation composition state is still " + automationComposition.getDeployState());
405 if (DeployState.DELETING.equals(automationComposition.getDeployState())
406 && StateChangeResult.NO_ERROR.equals(automationComposition.getStateChangeResult())) {
407 throw new PfModelRuntimeException(Status.BAD_REQUEST,
408 "Automation composition state is still " + automationComposition.getDeployState());
410 if (automationComposition.getRestarting() != null) {
411 throw new PfModelRuntimeException(Status.BAD_REQUEST, "There is a restarting process, Delete not allowed");
413 var acDefinition = acDefinitionProvider.getAcDefinition(automationComposition.getCompositionId());
414 var participantIds = acDefinition.getElementStateMap().values().stream()
415 .map(NodeTemplateState::getParticipantId).collect(Collectors.toSet());
416 participantProvider.verifyParticipantState(participantIds);
417 supervisionAcHandler.delete(automationComposition, acDefinition);
418 var response = new InstantiationResponse();
419 response.setInstanceId(automationComposition.getInstanceId());
420 response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier());
425 * Get the requested automation compositions.
427 * @param name the name of the automation composition to get, null for all automation compositions
428 * @param version the version of the automation composition to get, null for all automation compositions
429 * @return the automation compositions
431 @Transactional(readOnly = true)
432 public AutomationCompositions getAutomationCompositions(UUID compositionId, String name, String version) {
433 var automationCompositions = new AutomationCompositions();
434 automationCompositions.setAutomationCompositionList(
435 automationCompositionProvider.getAutomationCompositions(compositionId, name, version));
437 return automationCompositions;
441 * Handle Composition Instance State.
443 * @param compositionId the compositionId
444 * @param instanceId the instanceId
445 * @param acInstanceStateUpdate the AcInstanceStateUpdate
447 public void compositionInstanceState(UUID compositionId, UUID instanceId,
448 @Valid AcInstanceStateUpdate acInstanceStateUpdate) {
449 var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
450 if (!compositionId.equals(automationComposition.getCompositionId())) {
451 throw new PfModelRuntimeException(Status.BAD_REQUEST,
452 automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
454 var acDefinition = acDefinitionProvider.getAcDefinition(automationComposition.getCompositionId());
456 var participantIds = acDefinition.getElementStateMap().values().stream()
457 .map(NodeTemplateState::getParticipantId).collect(Collectors.toSet());
459 participantProvider.verifyParticipantState(participantIds);
460 var result = acInstanceStateResolver.resolve(acInstanceStateUpdate.getDeployOrder(),
461 acInstanceStateUpdate.getLockOrder(), acInstanceStateUpdate.getSubOrder(),
462 automationComposition.getDeployState(), automationComposition.getLockState(),
463 automationComposition.getSubState(), automationComposition.getStateChangeResult());
466 supervisionAcHandler.deploy(automationComposition, acDefinition);
470 supervisionAcHandler.undeploy(automationComposition, acDefinition);
474 supervisionAcHandler.lock(automationComposition, acDefinition);
478 supervisionAcHandler.unlock(automationComposition, acDefinition);
482 supervisionAcHandler.prepare(automationComposition);
486 supervisionAcHandler.review(automationComposition);
490 throw new PfModelRuntimeException(Status.BAD_REQUEST, "Not valid " + acInstanceStateUpdate);