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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2023 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.instantiation;
  23
  24 import java.util.UUID;
  25 import javax.validation.Valid;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.Response.Status;
  28 import lombok.AllArgsConstructor;
  29 import org.onap.policy.clamp.acm.runtime.supervision.SupervisionAcHandler;
  30 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  31 import org.onap.policy.clamp.models.acm.concepts.AutomationComposition;
  32 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionState;
  33 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositions;
  34 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.AcInstanceStateUpdate;
  35 import org.onap.policy.clamp.models.acm.messages.rest.instantiation.InstantiationResponse;
  36 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  37 import org.onap.policy.clamp.models.acm.persistence.provider.AcInstanceStateResolver;
  38 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  39 import org.onap.policy.clamp.models.acm.utils.AcmUtils;
  40 import org.onap.policy.common.parameters.BeanValidationResult;
  41 import org.onap.policy.common.parameters.ObjectValidationResult;
  42 import org.onap.policy.common.parameters.ValidationStatus;
  43 import org.onap.policy.models.base.PfModelRuntimeException;
  44 import org.springframework.stereotype.Service;
  45 import org.springframework.transaction.annotation.Transactional;
  46
  47 /**
  48  * This class is dedicated to the Instantiation of Commissioned automation composition.
  49  */
  50 @Service
  51 @Transactional
  52 @AllArgsConstructor
  53 public class AutomationCompositionInstantiationProvider {
  54     private static final String DO_NOT_MATCH = " do not match with ";
  55
  56     private final AutomationCompositionProvider automationCompositionProvider;
  57     private final AcDefinitionProvider acDefinitionProvider;
  58     private final AcInstanceStateResolver acInstanceStateResolver;
  59     private final SupervisionAcHandler supervisionAcHandler;
  60
  61     /**
  62      * Create automation composition.
  63      *
  64      * @param compositionId The UUID of the automation composition definition
  65      * @param automationComposition the automation composition
  66      * @return the result of the instantiation operation
  67      */
  68     public InstantiationResponse createAutomationComposition(UUID compositionId,
  69             AutomationComposition automationComposition) {
  70         if (!compositionId.equals(automationComposition.getCompositionId())) {
  71             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
  72                     automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
  73         }
  74         var checkAutomationCompositionOpt =
  75                 automationCompositionProvider.findAutomationComposition(automationComposition.getKey().asIdentifier());
  76         if (checkAutomationCompositionOpt.isPresent()) {
  77             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
  78                     automationComposition.getKey().asIdentifier() + " already defined");
  79         }
  80
  81         var validationResult = validateAutomationComposition(automationComposition);
  82         if (!validationResult.isValid()) {
  83             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult());
  84         }
  85         automationComposition = automationCompositionProvider.createAutomationComposition(automationComposition);
  86
  87         var response = new InstantiationResponse();
  88         response.setInstanceId(automationComposition.getInstanceId());
  89         response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier());
  90
  91         return response;
  92     }
  93
  94     /**
  95      * Update automation composition.
  96      *
  97      * @param compositionId The UUID of the automation composition definition
  98      * @param automationComposition the automation composition
  99      * @return the result of the update
 100      */
 101     public InstantiationResponse updateAutomationComposition(UUID compositionId,
 102             AutomationComposition automationComposition) {
 103         var instanceId = automationComposition.getInstanceId();
 104         var acToUpdate = automationCompositionProvider.getAutomationComposition(instanceId);
 105         if (!compositionId.equals(acToUpdate.getCompositionId())) {
 106             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
 107                     automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
 108         }
 109         acToUpdate.setElements(automationComposition.getElements());
 110         acToUpdate.setName(automationComposition.getName());
 111         acToUpdate.setVersion(automationComposition.getVersion());
 112         acToUpdate.setDescription(automationComposition.getDescription());
 113         acToUpdate.setDerivedFrom(automationComposition.getDerivedFrom());
 114         var validationResult = validateAutomationComposition(acToUpdate);
 115         if (!validationResult.isValid()) {
 116             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, validationResult.getResult());
 117         }
 118         automationComposition = automationCompositionProvider.updateAutomationComposition(acToUpdate);
 119
 120         var response = new InstantiationResponse();
 121         response.setInstanceId(instanceId);
 122         response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier());
 123         return response;
 124     }
 125
 126     /**
 127      * Validate AutomationComposition.
 128      *
 129      * @param automationComposition AutomationComposition to validate
 130      * @return the result of validation
 131      */
 132     private BeanValidationResult validateAutomationComposition(AutomationComposition automationComposition) {
 133
 134         var result = new BeanValidationResult("AutomationComposition", automationComposition);
 135         var acDefinitionOpt = acDefinitionProvider.findAcDefinition(automationComposition.getCompositionId());
 136         if (acDefinitionOpt.isEmpty()) {
 137             result.addResult(new ObjectValidationResult("ServiceTemplate", "", ValidationStatus.INVALID,
 138                     "Commissioned automation composition definition not found"));
 139             return result;
 140         }
 141         if (!AcTypeState.PRIMED.equals(acDefinitionOpt.get().getState())) {
 142             result.addResult(new ObjectValidationResult("ServiceTemplate", "", ValidationStatus.INVALID,
 143                     "Commissioned automation composition definition not primed"));
 144             return result;
 145         }
 146         result.addResult(AcmUtils.validateAutomationComposition(automationComposition,
 147                 acDefinitionOpt.get().getServiceTemplate()));
 148
 149         if (result.isValid()) {
 150             for (var element : automationComposition.getElements().values()) {
 151                 var name = element.getDefinition().getName();
 152                 var participantId = acDefinitionOpt.get().getElementStateMap().get(name).getParticipantId();
 153                 element.setParticipantId(participantId);
 154             }
 155         }
 156
 157         return result;
 158     }
 159
 160     /**
 161      * Get Automation Composition.
 162      *
 163      * @param compositionId The UUID of the automation composition definition
 164      * @param instanceId The UUID of the automation composition instance
 165      * @return the Automation Composition
 166      */
 167     @Transactional(readOnly = true)
 168     public AutomationComposition getAutomationComposition(UUID compositionId, UUID instanceId) {
 169         var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
 170         if (!automationComposition.getCompositionId().equals(compositionId)) {
 171             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
 172                     "Composition Id " + compositionId + DO_NOT_MATCH + automationComposition.getCompositionId());
 173         }
 174         return automationComposition;
 175     }
 176
 177     /**
 178      * Delete the automation composition with the given name and version.
 179      *
 180      * @param compositionId The UUID of the automation composition definition
 181      * @param instanceId The UUID of the automation composition instance
 182      * @return the result of the deletion
 183      */
 184     public InstantiationResponse deleteAutomationComposition(UUID compositionId, UUID instanceId) {
 185         var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
 186         if (!compositionId.equals(automationComposition.getCompositionId())) {
 187             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
 188                     automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
 189         }
 190         if (!AutomationCompositionState.UNINITIALISED.equals(automationComposition.getState())) {
 191             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
 192                     "Automation composition state is still " + automationComposition.getState());
 193         }
 194         var response = new InstantiationResponse();
 195         automationComposition =
 196                 automationCompositionProvider.deleteAutomationComposition(automationComposition.getInstanceId());
 197         response.setInstanceId(automationComposition.getInstanceId());
 198         response.setAffectedAutomationComposition(automationComposition.getKey().asIdentifier());
 199         return response;
 200     }
 201
 202     /**
 203      * Get the requested automation compositions.
 204      *
 205      * @param name the name of the automation composition to get, null for all automation compositions
 206      * @param version the version of the automation composition to get, null for all automation compositions
 207      * @return the automation compositions
 208      */
 209     @Transactional(readOnly = true)
 210     public AutomationCompositions getAutomationCompositions(UUID compositionId, String name, String version) {
 211         var automationCompositions = new AutomationCompositions();
 212         automationCompositions.setAutomationCompositionList(
 213                 automationCompositionProvider.getAutomationCompositions(compositionId, name, version));
 214
 215         return automationCompositions;
 216     }
 217
 218     /**
 219      * Handle Composition Instance State.
 220      *
 221      * @param compositionId the compositionId
 222      * @param instanceId the instanceId
 223      * @param acInstanceStateUpdate the AcInstanceStateUpdate
 224      */
 225     public void compositionInstanceState(UUID compositionId, UUID instanceId,
 226             @Valid AcInstanceStateUpdate acInstanceStateUpdate) {
 227         var automationComposition = automationCompositionProvider.getAutomationComposition(instanceId);
 228         if (!compositionId.equals(automationComposition.getCompositionId())) {
 229             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
 230                     automationComposition.getCompositionId() + DO_NOT_MATCH + compositionId);
 231         }
 232         var acDefinition = acDefinitionProvider.getAcDefinition(automationComposition.getCompositionId());
 233         var result = acInstanceStateResolver.resolve(acInstanceStateUpdate.getDeployOrder(),
 234                 acInstanceStateUpdate.getLockOrder(), automationComposition.getDeployState(),
 235                 automationComposition.getLockState());
 236         switch (result) {
 237             case "DEPLOY":
 238                 supervisionAcHandler.deploy(automationComposition, acDefinition);
 239                 break;
 240
 241             case "UNDEPLOY":
 242                 supervisionAcHandler.undeploy(automationComposition, acDefinition);
 243                 break;
 244
 245             case "LOCK":
 246                 supervisionAcHandler.lock(automationComposition, acDefinition);
 247                 break;
 248
 249             case "UNLOCK":
 250                 supervisionAcHandler.unlock(automationComposition, acDefinition);
 251                 break;
 252
 253             default:
 254                 throw new PfModelRuntimeException(Status.BAD_REQUEST, "Not valid " + acInstanceStateUpdate);
 255         }
 256     }
 257 }