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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2025 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.commissioning;
  23
  24 import io.opentelemetry.context.Context;
  25 import jakarta.ws.rs.core.Response.Status;
  26 import java.util.HashSet;
  27 import java.util.UUID;
  28 import java.util.concurrent.ExecutorService;
  29 import java.util.concurrent.Executors;
  30 import lombok.RequiredArgsConstructor;
  31 import org.onap.policy.clamp.acm.runtime.main.parameters.AcRuntimeParameterGroup;
  32 import org.onap.policy.clamp.acm.runtime.supervision.comm.ParticipantPrimePublisher;
  33 import org.onap.policy.clamp.models.acm.concepts.AcTypeState;
  34 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionDefinition;
  35 import org.onap.policy.clamp.models.acm.concepts.StateChangeResult;
  36 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.AcTypeStateUpdate;
  37 import org.onap.policy.clamp.models.acm.messages.rest.commissioning.CommissioningResponse;
  38 import org.onap.policy.clamp.models.acm.persistence.provider.AcDefinitionProvider;
  39 import org.onap.policy.clamp.models.acm.persistence.provider.AcTypeStateResolver;
  40 import org.onap.policy.clamp.models.acm.persistence.provider.AutomationCompositionProvider;
  41 import org.onap.policy.clamp.models.acm.persistence.provider.ParticipantProvider;
  42 import org.onap.policy.clamp.models.acm.utils.TimestampHelper;
  43 import org.onap.policy.models.base.PfModelRuntimeException;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplates;
  46 import org.springframework.stereotype.Service;
  47 import org.springframework.transaction.annotation.Transactional;
  48
  49 /**
  50  * This class provides the create, read and delete actions on Commissioning of automation composition concepts in the
  51  * database to the callers.
  52  */
  53 @Service
  54 @RequiredArgsConstructor
  55 public class CommissioningProvider {
  56
  57     private final AcDefinitionProvider acDefinitionProvider;
  58     private final AutomationCompositionProvider acProvider;
  59     private final ParticipantProvider participantProvider;
  60     private final AcTypeStateResolver acTypeStateResolver;
  61     private final ParticipantPrimePublisher participantPrimePublisher;
  62     private final AcRuntimeParameterGroup acRuntimeParameterGroup;
  63
  64     private final ExecutorService executor = Context.taskWrapping(Executors.newFixedThreadPool(1));
  65
  66     private CommissioningResponse createCommissioningResponse(UUID compositionId,
  67             ToscaServiceTemplate serviceTemplate) {
  68         var response = new CommissioningResponse();
  69         response.setCompositionId(compositionId);
  70         // @formatter:off
  71         response.setAffectedAutomationCompositionDefinitions(
  72             serviceTemplate.getToscaTopologyTemplate().getNodeTemplates()
  73                 .values()
  74                 .stream()
  75                 .map(template -> template.getKey().asIdentifier())
  76                 .toList());
  77         // @formatter:on
  78
  79         return response;
  80     }
  81
  82     /**
  83      * Create automation composition from a service template.
  84      *
  85      * @param serviceTemplate the service template
  86      * @return the result of the commissioning operation
  87      */
  88     @Transactional
  89     public CommissioningResponse createAutomationCompositionDefinition(ToscaServiceTemplate serviceTemplate) {
  90
  91         var acmDefinition = acDefinitionProvider.createAutomationCompositionDefinition(serviceTemplate,
  92                 acRuntimeParameterGroup.getAcmParameters().getToscaElementName(),
  93                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
  94         serviceTemplate = acmDefinition.getServiceTemplate();
  95         return createCommissioningResponse(acmDefinition.getCompositionId(), serviceTemplate);
  96     }
  97
  98     /**
  99      * Update Composition Definition.
 100      *
 101      * @param compositionId The UUID of the automation composition definition to update
 102      * @param serviceTemplate the service template
 103      * @return the result of the commissioning operation
 104      */
 105     @Transactional
 106     public CommissioningResponse updateCompositionDefinition(UUID compositionId, ToscaServiceTemplate serviceTemplate) {
 107         if (verifyIfInstanceExists(compositionId)) {
 108             throw new PfModelRuntimeException(Status.BAD_REQUEST,
 109                     "There are ACM instances, Update of ACM Definition not allowed");
 110         }
 111         var acDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 112         if (!AcTypeState.COMMISSIONED.equals(acDefinition.getState())) {
 113             throw new PfModelRuntimeException(Status.BAD_REQUEST,
 114                     "ACM not in COMMISSIONED state, Update of ACM Definition not allowed");
 115         }
 116         acDefinitionProvider.updateServiceTemplate(compositionId, serviceTemplate,
 117                 acRuntimeParameterGroup.getAcmParameters().getToscaElementName(),
 118                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 119
 120         return createCommissioningResponse(compositionId, serviceTemplate);
 121     }
 122
 123     /**
 124      * Delete the automation composition definition with the given name and version.
 125      *
 126      * @param compositionId The UUID of the automation composition definition to delete
 127      * @return the result of the deletion
 128      */
 129     @Transactional
 130     public CommissioningResponse deleteAutomationCompositionDefinition(UUID compositionId) {
 131         if (verifyIfInstanceExists(compositionId)) {
 132             throw new PfModelRuntimeException(Status.BAD_REQUEST,
 133                     "Delete instances, to commission automation composition definitions");
 134         }
 135         var acDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 136         if (!AcTypeState.COMMISSIONED.equals(acDefinition.getState())) {
 137             throw new PfModelRuntimeException(Status.BAD_REQUEST,
 138                     "ACM not in COMMISSIONED state, Delete of ACM Definition not allowed");
 139         }
 140         var serviceTemplate = acDefinitionProvider.deleteAcDefinition(compositionId);
 141         return createCommissioningResponse(compositionId, serviceTemplate);
 142     }
 143
 144     /**
 145      * Get automation composition definition.
 146      *
 147      * @param acName the name of the automation composition, null for all
 148      * @param acVersion the version of the automation composition, null for all
 149      * @return automation composition definition
 150      */
 151     @Transactional(readOnly = true)
 152     public ToscaServiceTemplates getAutomationCompositionDefinitions(String acName, String acVersion) {
 153
 154         var result = new ToscaServiceTemplates();
 155         result.setServiceTemplates(acDefinitionProvider.getServiceTemplateList(acName, acVersion));
 156         return result;
 157     }
 158
 159     /**
 160      * Get automation composition definition.
 161      *
 162      * @param compositionId the compositionId
 163      * @return automation composition definition
 164      */
 165     @Transactional(readOnly = true)
 166     public AutomationCompositionDefinition getAutomationCompositionDefinition(UUID compositionId) {
 167
 168         return acDefinitionProvider.getAcDefinition(compositionId);
 169     }
 170
 171     /**
 172      * Validates to see if there is any instance saved.
 173      *
 174      * @return true if exists instance
 175      */
 176     private boolean verifyIfInstanceExists(UUID compositionId) {
 177         return !acProvider.getAcInstancesByCompositionId(compositionId).isEmpty();
 178     }
 179
 180     /**
 181      * Composition Definition Priming.
 182      *
 183      * @param compositionId the compositionId
 184      * @param acTypeStateUpdate the ACMTypeStateUpdate
 185      */
 186     public void compositionDefinitionPriming(UUID compositionId, AcTypeStateUpdate acTypeStateUpdate) {
 187         if (verifyIfInstanceExists(compositionId)) {
 188             throw new PfModelRuntimeException(Status.BAD_REQUEST, "There are instances, Priming/Depriming not allowed");
 189         }
 190         var acmDefinition = acDefinitionProvider.getAcDefinition(compositionId);
 191         var stateOrdered = acTypeStateResolver.resolve(acTypeStateUpdate.getPrimeOrder(), acmDefinition.getState(),
 192                 acmDefinition.getStateChangeResult());
 193         switch (stateOrdered) {
 194             case PRIME:
 195                 prime(acmDefinition);
 196                 break;
 197
 198             case DEPRIME:
 199                 deprime(acmDefinition);
 200
 201                 break;
 202
 203             default:
 204                 throw new PfModelRuntimeException(Status.BAD_REQUEST, "Not valid " + acTypeStateUpdate.getPrimeOrder());
 205         }
 206     }
 207
 208     private void prime(AutomationCompositionDefinition acmDefinition) {
 209         var preparation = participantPrimePublisher.prepareParticipantPriming(acmDefinition);
 210         acDefinitionProvider.updateAcDefinition(acmDefinition,
 211                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 212
 213         executor.execute(
 214                 () -> participantPrimePublisher.sendPriming(preparation, acmDefinition.getCompositionId(), null));
 215     }
 216
 217     private void deprime(AutomationCompositionDefinition acmDefinition) {
 218         acmDefinition.setStateChangeResult(StateChangeResult.NO_ERROR);
 219         var participantIds = new HashSet<UUID>();
 220         for (var elementState : acmDefinition.getElementStateMap().values()) {
 221             var participantId = elementState.getParticipantId();
 222             if (participantId != null) {
 223                 elementState.setState(AcTypeState.DEPRIMING);
 224                 participantIds.add(participantId);
 225             }
 226         }
 227         if (!participantIds.isEmpty()) {
 228             participantProvider.verifyParticipantState(participantIds);
 229         }
 230         acmDefinition.setState(AcTypeState.DEPRIMING);
 231         acmDefinition.setLastMsg(TimestampHelper.now());
 232         acDefinitionProvider.updateAcDefinition(acmDefinition,
 233                 acRuntimeParameterGroup.getAcmParameters().getToscaCompositionName());
 234
 235         executor.execute(() -> participantPrimePublisher.sendDepriming(acmDefinition.getCompositionId()));
 236     }
 237
 238 }