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 java.util.ArrayList;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.UUID;
  29 import java.util.concurrent.ConcurrentHashMap;
  30 import javax.ws.rs.core.Response.Status;
  31 import lombok.RequiredArgsConstructor;
  32 import lombok.Setter;
  33 import org.apache.http.HttpStatus;
  34 import org.onap.policy.clamp.acm.participant.intermediary.api.AutomationCompositionElementListener;
  35 import org.onap.policy.clamp.acm.participant.intermediary.api.ParticipantIntermediaryApi;
  36 import org.onap.policy.clamp.acm.participant.policy.client.PolicyApiHttpClient;
  37 import org.onap.policy.clamp.acm.participant.policy.client.PolicyPapHttpClient;
  38 import org.onap.policy.clamp.models.acm.concepts.AcElementDeploy;
  39 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  40 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElementDefinition;
  41 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  42 import org.onap.policy.clamp.models.acm.concepts.LockState;
  43 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  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
  66     @Setter
  67     private ParticipantIntermediaryApi intermediaryApi;
  68
  69     /**
  70      * Callback method to handle a automation composition element state change.
  71      *
  72      * @param automationCompositionId the ID of the automation composition
  73      * @param automationCompositionElementId the ID of the automation composition element
  74      */
  75     @Override
  76     public void undeploy(UUID automationCompositionId, UUID automationCompositionElementId) throws PfModelException {
  77         var automationCompositionDefinition = serviceTemplateMap.get(automationCompositionElementId);
  78         if (automationCompositionDefinition == null) {
  79             LOGGER.debug("No policies to undeploy to {}", automationCompositionElementId);
  80             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
  81                     automationCompositionElementId, DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR,
  82                     "Undeployed");
  83             return;
  84         }
  85         var policyList = getPolicyList(automationCompositionDefinition);
  86         undeployPolicies(policyList, automationCompositionElementId);
  87         var policyTypeList = getPolicyTypeList(automationCompositionDefinition);
  88         deletePolicyData(policyTypeList, policyList);
  89         serviceTemplateMap.remove(automationCompositionElementId);
  90         intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, automationCompositionElementId,
  91                 DeployState.UNDEPLOYED, null, StateChangeResult.NO_ERROR, "Undeployed");
  92     }
  93
  94     private void deletePolicyData(List<ToscaConceptIdentifier> policyTypeList,
  95             List<ToscaConceptIdentifier> policyList) {
  96         // Delete all policies of this automationComposition from policy framework
  97         for (var policy : policyList) {
  98             apiHttpClient.deletePolicy(policy.getName(), policy.getVersion());
  99         }
 100         // Delete all policy types of this automation composition from policy framework
 101         for (var policyType : policyTypeList) {
 102             apiHttpClient.deletePolicyType(policyType.getName(), policyType.getVersion());
 103         }
 104     }
 105
 106     private void deployPolicies(List<ToscaConceptIdentifier> policyList, UUID automationCompositionId,
 107             UUID automationCompositionElementId) throws PfModelException {
 108         var deployFailure = false;
 109         // Deploy all policies of this automationComposition from Policy Framework
 110         if (!policyList.isEmpty()) {
 111             for (var policy : policyList) {
 112                 var deployPolicyResp = papHttpClient.handlePolicyDeployOrUndeploy(policy.getName(), policy.getVersion(),
 113                         DeploymentSubGroup.Action.POST).getStatus();
 114                 if (deployPolicyResp != HttpStatus.SC_ACCEPTED) {
 115                     deployFailure = true;
 116                 }
 117             }
 118             LOGGER.info("Policies deployed to {} successfully", automationCompositionElementId);
 119         } else {
 120             LOGGER.debug("No policies to deploy to {}", automationCompositionElementId);
 121         }
 122         if (!deployFailure) {
 123             // Update the AC element state
 124             intermediaryApi.sendAcElementInfo(automationCompositionId, automationCompositionElementId, "IDLE",
 125                     "ENABLED", Map.of());
 126             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId,
 127                     automationCompositionElementId, DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR, "Deployed");
 128         } else {
 129             throw new PfModelException(Status.BAD_REQUEST, "Deploy of Policy failed.");
 130         }
 131     }
 132
 133     private void undeployPolicies(List<ToscaConceptIdentifier> policyList, UUID automationCompositionElementId) {
 134         // Undeploy all policies of this automation composition from Policy Framework
 135         if (!policyList.isEmpty()) {
 136             for (var policy : policyList) {
 137                 papHttpClient.handlePolicyDeployOrUndeploy(policy.getName(), policy.getVersion(),
 138                         DeploymentSubGroup.Action.DELETE);
 139             }
 140             LOGGER.debug("Undeployed policies from {} successfully", automationCompositionElementId);
 141         } else {
 142             LOGGER.debug("No policies are deployed to {}", automationCompositionElementId);
 143         }
 144     }
 145
 146     /**
 147      * Callback method to handle an update on automation composition element.
 148      *
 149      * @param automationCompositionId the automationComposition Id
 150      * @param element the information on the automation composition element
 151      * @param properties properties Map
 152      * @throws PfModelException in case of an exception
 153      */
 154     @Override
 155     public void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
 156             throws PfModelException {
 157         var createPolicyTypeResp = HttpStatus.SC_OK;
 158         var createPolicyResp = HttpStatus.SC_OK;
 159
 160         var automationCompositionDefinition = element.getToscaServiceTemplateFragment();
 161         if (automationCompositionDefinition.getToscaTopologyTemplate() == null) {
 162             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 163                     DeployState.UNDEPLOYED, null, StateChangeResult.FAILED, "ToscaTopologyTemplate not defined");
 164             return;
 165         }
 166         serviceTemplateMap.put(element.getId(), automationCompositionDefinition);
 167         if (automationCompositionDefinition.getPolicyTypes() != null) {
 168             LOGGER.info("Found Policy Types in automation composition definition: {} , Creating Policy Types",
 169                     automationCompositionDefinition.getName());
 170             createPolicyTypeResp = apiHttpClient.createPolicyType(automationCompositionDefinition).getStatus();
 171         }
 172         if (automationCompositionDefinition.getToscaTopologyTemplate().getPolicies() != null) {
 173             LOGGER.info("Found Policies in automation composition definition: {} , Creating Policies",
 174                     automationCompositionDefinition.getName());
 175             createPolicyResp = apiHttpClient.createPolicy(automationCompositionDefinition).getStatus();
 176         }
 177         if (createPolicyTypeResp == HttpStatus.SC_OK && createPolicyResp == HttpStatus.SC_OK) {
 178             LOGGER.info(
 179                     "PolicyTypes/Policies for the automation composition element : {} are created " + "successfully",
 180                     element.getId());
 181             var policyList = getPolicyList(automationCompositionDefinition);
 182             deployPolicies(policyList, automationCompositionId, element.getId());
 183         } else {
 184             intermediaryApi.updateAutomationCompositionElementState(automationCompositionId, element.getId(),
 185                     DeployState.UNDEPLOYED, null, StateChangeResult.FAILED,
 186                     "Creation of PolicyTypes/Policies failed. Policies will not be deployed.");
 187         }
 188     }
 189
 190     private List<ToscaConceptIdentifier> getPolicyTypeList(ToscaServiceTemplate serviceTemplate) {
 191         List<ToscaConceptIdentifier> policyTypeList = new ArrayList<>();
 192         if (serviceTemplate.getPolicyTypes() != null) {
 193             for (var policyType : serviceTemplate.getPolicyTypes().values()) {
 194                 policyTypeList.add(policyType.getKey().asIdentifier());
 195             }
 196         }
 197
 198         return policyTypeList;
 199     }
 200
 201     private List<ToscaConceptIdentifier> getPolicyList(ToscaServiceTemplate serviceTemplate) {
 202         List<ToscaConceptIdentifier> policyList = new ArrayList<>();
 203         if (serviceTemplate.getToscaTopologyTemplate().getPolicies() != null) {
 204             for (var gotPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
 205                 for (var policy : gotPolicyMap.values()) {
 206                     policyList.add(policy.getKey().asIdentifier());
 207                 }
 208             }
 209         }
 210
 211         return policyList;
 212     }
 213
 214     @Override
 215     public void lock(UUID instanceId, UUID elementId) throws PfModelException {
 216         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.LOCKED,
 217                 StateChangeResult.NO_ERROR, "Locked");
 218     }
 219
 220     @Override
 221     public void unlock(UUID instanceId, UUID elementId) throws PfModelException {
 222         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, null, LockState.UNLOCKED,
 223                 StateChangeResult.NO_ERROR, "Unlocked");
 224     }
 225
 226     @Override
 227     public void delete(UUID instanceId, UUID elementId) throws PfModelException {
 228         intermediaryApi.updateAutomationCompositionElementState(instanceId, elementId, DeployState.DELETED, null,
 229                 StateChangeResult.NO_ERROR, "Deleted");
 230     }
 231
 232     @Override
 233     public void update(UUID instanceId, AcElementDeploy element, Map<String, Object> properties)
 234             throws PfModelException {
 235         intermediaryApi.updateAutomationCompositionElementState(instanceId, element.getId(), DeployState.DEPLOYED, null,
 236                 StateChangeResult.NO_ERROR, "Update not supported");
 237     }
 238
 239     @Override
 240     public void prime(UUID compositionId, List<AutomationCompositionElementDefinition> elementDefinitionList)
 241             throws PfModelException {
 242         intermediaryApi.updateCompositionState(compositionId, AcTypeState.PRIMED, StateChangeResult.NO_ERROR, "Primed");
 243     }
 244
 245     @Override
 246     public void deprime(UUID compositionId) throws PfModelException {
 247         intermediaryApi.updateCompositionState(compositionId, AcTypeState.COMMISSIONED, StateChangeResult.NO_ERROR,
 248                 "Deprimed");
 249     }
 250 }