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