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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 Nordix Foundation.
   4  * ================================================================================
   5  * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.clamp.acm.participant.policy.main.handler;
  24
  25 import jakarta.ws.rs.core.Response.Status;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.UUID;
  30 import java.util.concurrent.ConcurrentHashMap;
  31 import lombok.RequiredArgsConstructor;
  32 import org.apache.http.HttpStatus;
  33 import org.onap.policy.clamp.acm.participant.intermediary.api.AutomationCompositionElementListener;
  34 import org.onap.policy.clamp.acm.participant.intermediary.api.ParticipantIntermediaryApi;
  35 import org.onap.policy.clamp.acm.participant.policy.client.PolicyApiHttpClient;
  36 import org.onap.policy.clamp.acm.participant.policy.client.PolicyPapHttpClient;
  37 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  38 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  39 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  40 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  41 import org.onap.policy.clamp.models.acm.concepts.LockState;
  42 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  43 import org.onap.policy.clamp.models.acm.utils.AcmUtils;
  44 import org.onap.policy.models.base.PfModelException;
  45 import org.onap.policy.models.pdp.concepts.DeploymentSubGroup;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import org.springframework.stereotype.Component;
  51
  52 /**
  53  * This class handles implementation of automationCompositionElement updates.
  54  */
  55 @Component
  56 @RequiredArgsConstructor
  57 public class AutomationCompositionElementHandler implements AutomationCompositionElementListener {
  58
  59     private static final Logger LOGGER = LoggerFactory.getLogger(AutomationCompositionElementHandler.class);
  60
  61     private final Map<UUID, ToscaServiceTemplate> serviceTemplateMap = new ConcurrentHashMap<>();
  62
  63     private final PolicyApiHttpClient apiHttpClient;
  64     private final PolicyPapHttpClient papHttpClient;
  65     private final ParticipantIntermediaryApi intermediaryApi;
  66
  67     /**
  68      * Callback method to handle a automation composition element state change.
  69      *
  70      * @param automationCompositionId the ID of the automation composition
  71      * @param automationCompositionElementId the ID of the automation composition element
  72      */
  73     @Override
  74     public void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException {
  75         var automationCompositionDefinition = serviceTemplateMap.get(automationCompositionElementId);
  76         if (automationCompositionDefinition == null) {
  77             LOGGER.debug("No policies to undeploy to {}", automationCompositionElementId);
  78             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
  79                     automationCompositionElementId, DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR,
  80                     "Undeployed");
  81             return;
  82         }
  83         var policyList = getPolicyList(automationCompositionDefinition);
  84         undeployPolicies(policyList, automationCompositionElementId);
  85         var policyTypeList = getPolicyTypeList(automationCompositionDefinition);
  86         deletePolicyData(policyTypeList, policyList);
  87         serviceTemplateMap.remove(automationCompositionElementId);
  88         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, automationCompositionElementId,
  89                 DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR, "Undeployed");
  90     }
  91
  92     private void deletePolicyData(List<ToscaConceptIdentifier> policyTypeList,
  93             List<ToscaConceptIdentifier> policyList) {
  94         // Delete all policies of this automationComposition from policy framework
  95         for (var policy : policyList) {
  96             apiHttpClient.deletePolicy(policy.getName(), policy.getVersion());
  97         }
  98         // Delete all policy types of this automation composition from policy framework
  99         for (var policyType : policyTypeList) {
 100             apiHttpClient.deletePolicyType(policyType.getName(), policyType.getVersion());
 101         }
 102     }
 103
 104     private void deployPolicies(List<ToscaConceptIdentifier> policyList, UUID automationCompositionId,
 105             UUID automationCompositionElementId) throws PfModelException {
 106         var deployFailure = false;
 107         // Deploy all policies of this automationComposition from Policy Framework
 108         if (!policyList.isEmpty()) {
 109             for (var policy : policyList) {
 110                 var deployPolicyResp = papHttpClient.handlePolicyDeployOrUndeploy(policy.getName(), policy.getVersion(),
 111                         DeploymentSubGroup.Action.POST).getStatus();
 112                 if (deployPolicyResp != HttpStatus.SC_ACCEPTED) {
 113                     deployFailure = true;
 114                 }
 115             }
 116             LOGGER.info("Policies deployed to {} successfully", automationCompositionElementId);
 117         } else {
 118             LOGGER.debug("No policies to deploy to {}", automationCompositionElementId);
 119         }
 120         if (!deployFailure) {
 121             // Update the AC element state
 122             intermediaryApi.sendAcElementInfo(automationCompositionId, automationCompositionElementId, "IDLE",
 123                     "ENABLED", Map.of());
 124             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
 125                     automationCompositionElementId, DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Deployed");
 126         } else {
 127             throw new PfModelException(Status.BAD_REQUEST, "Deploy of Policy failed.");
 128         }
 129     }
 130
 131     private void undeployPolicies(List<ToscaConceptIdentifier> policyList, UUID automationCompositionElementId) {
 132         // Undeploy all policies of this automation composition from Policy Framework
 133         if (!policyList.isEmpty()) {
 134             for (var policy : policyList) {
 135                 papHttpClient.handlePolicyDeployOrUndeploy(policy.getName(), policy.getVersion(),
 136                         DeploymentSubGroup.Action.DELETE);
 137             }
 138             LOGGER.debug("Undeployed policies from {} successfully", automationCompositionElementId);
 139         } else {
 140             LOGGER.debug("No policies are deployed to {}", automationCompositionElementId);
 141         }
 142     }
 143
 144     /**
 145      * Callback method to handle an update on automation composition element.
 146      *
 147      * @param automationCompositionId the automationComposition Id
 148      * @param element the information on the automation composition element
 149      * @param properties properties Map
 150      * @throws PfModelException in case of an exception
 151      */
 152     @Override
 153     public void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
 154             throws PfModelException {
 155         var createPolicyTypeResp = HttpStatus.SC_OK;
 156         var createPolicyResp = HttpStatus.SC_OK;
 157
 158         var automationCompositionDefinition = element.getToscaServiceTemplateFragment();
 159         if (automationCompositionDefinition.getToscaTopologyTemplate() == null) {
 160             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 161                     DeployState.UNDEPLOYED, null, StateChangeResult.FAILED, "ToscaTopologyTemplate not defined");
 162             return;
 163         }
 164         serviceTemplateMap.put(element.getId(), automationCompositionDefinition);
 165         if (automationCompositionDefinition.getPolicyTypes() != null) {
 166             LOGGER.info("Found Policy Types in automation composition definition: {} , Creating Policy Types",
 167                     automationCompositionDefinition.getName());
 168             try (var response = apiHttpClient.createPolicyType(automationCompositionDefinition)) {
 169                 createPolicyTypeResp = response.getStatus();
 170             }
 171         }
 172         if (automationCompositionDefinition.getToscaTopologyTemplate().getPolicies() != null) {
 173             LOGGER.info("Found Policies in automation composition definition: {} , Creating Policies",
 174                     automationCompositionDefinition.getName());
 175             try (var response = apiHttpClient.createPolicy(automationCompositionDefinition)) {
 176                 createPolicyResp = response.getStatus();
 177             }
 178         }
 179         if (createPolicyTypeResp == HttpStatus.SC_OK && createPolicyResp == HttpStatus.SC_OK) {
 180             LOGGER.info(
 181                     "PolicyTypes/Policies for the automation composition element : {} are created " + "successfully",
 182                     element.getId());
 183             var policyList = getPolicyList(automationCompositionDefinition);
 184             deployPolicies(policyList, automationCompositionId, element.getId());
 185         } else {
 186             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 187                     DeployState.UNDEPLOYED, null, StateChangeResult.FAILED,
 188                     "Creation of PolicyTypes/Policies failed. Policies will not be deployed.");
 189         }
 190     }
 191
 192     private List<ToscaConceptIdentifier> getPolicyTypeList(ToscaServiceTemplate serviceTemplate) {
 193         List<ToscaConceptIdentifier> policyTypeList = new ArrayList<>();
 194         if (serviceTemplate.getPolicyTypes() != null) {
 195             for (var policyType : serviceTemplate.getPolicyTypes().values()) {
 196                 policyTypeList.add(policyType.getKey().asIdentifier());
 197             }
 198         }
 199
 200         return policyTypeList;
 201     }
 202
 203     private List<ToscaConceptIdentifier> getPolicyList(ToscaServiceTemplate serviceTemplate) {
 204         List<ToscaConceptIdentifier> policyList = new ArrayList<>();
 205         if (serviceTemplate.getToscaTopologyTemplate().getPolicies() != null) {
 206             for (var gotPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
 207                 for (var policy : gotPolicyMap.values()) {
 208                     policyList.add(policy.getKey().asIdentifier());
 209                 }
 210             }
 211         }
 212
 213         return policyList;
 214     }
 215
 216     @Override
 217     public void lock(UUID instanceId, UUID elementId) throws PfModelException {
 218         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.LOCKED,
 219                 StateChangeResult.NO_ERROR, "Locked");
 220     }
 221
 222     @Override
 223     public void unlock(UUID instanceId, UUID elementId) throws PfModelException {
 224         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.UNLOCKED,
 225                 StateChangeResult.NO_ERROR, "Unlocked");
 226     }
 227
 228     @Override
 229     public void delete(UUID instanceId, UUID elementId) throws PfModelException {
 230         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, DeployState.DELETED, null,
 231                 StateChangeResult.NO_ERROR, "Deleted");
 232     }
 233
 234     @Override
 235     public void update(UUID instanceId, AcElementDeploy element, Map<String, Object> properties)
 236             throws PfModelException {
 237         intermediaryApi.updateAutomationCompositionElementState(instanceId, element.getId(), DeployState.DEPLOYED, null,
 238                 StateChangeResult.NO_ERROR, "Update not supported");
 239     }
 240
 241     @Override
 242     public void prime(UUID compositionId, List<AutomationCompositionElementDefinition> elementDefinitionList)
 243             throws PfModelException {
 244         intermediaryApi.updateCompositionState(compositionId, AcTypeState.PRIMED, StateChangeResult.NO_ERROR, "Primed");
 245     }
 246
 247     @Override
 248     public void deprime(UUID compositionId) throws PfModelException {
 249         intermediaryApi.updateCompositionState(compositionId, AcTypeState.COMMISSIONED, StateChangeResult.NO_ERROR,
 250                 "Deprimed");
 251     }
 252
 253     @Override
 254     public void handleRestartComposition(UUID compositionId,
 255             List<AutomationCompositionElementDefinition> elementDefinitionList, AcTypeState state)
 256             throws PfModelException {
 257         var finalState = AcTypeState.PRIMED.equals(state) || AcTypeState.PRIMING.equals(state) ? AcTypeState.PRIMED
 258                 : AcTypeState.COMMISSIONED;
 259         intermediaryApi.updateCompositionState(compositionId, finalState, StateChangeResult.NO_ERROR, "Restarted");
 260     }
 261
 262     @Override
 263     public void handleRestartInstance(UUID automationCompositionId, AcElementDeploy element,
 264             Map<String, Object> properties, DeployState deployState, LockState lockState) throws PfModelException {
 265         if (DeployState.DEPLOYING.equals(deployState)) {
 266             deploy(automationCompositionId, element, properties);
 267             return;
 268         }
 269         if (DeployState.UNDEPLOYING.equals(deployState) || DeployState.DEPLOYED.equals(deployState)
 270                 || DeployState.UPDATING.equals(deployState)) {
 271             var automationCompositionDefinition = element.getToscaServiceTemplateFragment();
 272             serviceTemplateMap.put(element.getId(), automationCompositionDefinition);
 273         }
 274         if (DeployState.UNDEPLOYING.equals(deployState)) {
 275             undeploy(automationCompositionId, element.getId());
 276             return;
 277         }
 278         deployState = AcmUtils.deployCompleted(deployState);
 279         lockState = AcmUtils.lockCompleted(deployState, lockState);
 280         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(), deployState,
 281                 lockState, StateChangeResult.NO_ERROR, "Restarted");
 282     }
 283
 284     @Override
 285     public void migrate(UUID automationCompositionId, AcElementDeploy element, UUID compositionTargetId,
 286             Map<String, Object> properties) throws PfModelException {
 287         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 288                 DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Migrated");
 289     }
 290 }