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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 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.controlloop.runtime.commissioning;
  23
  24 import com.fasterxml.jackson.core.JsonProcessingException;
  25 import com.fasterxml.jackson.databind.ObjectMapper;
  26 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
  27 import com.fasterxml.jackson.module.jsonSchema.factories.SchemaFactoryWrapper;
  28 import java.util.ArrayList;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.stream.Collectors;
  34 import javax.ws.rs.core.Response.Status;
  35 import org.apache.commons.collections4.CollectionUtils;
  36 import org.apache.commons.collections4.MapUtils;
  37 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  38 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
  39 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantProvider;
  40 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ServiceTemplateProvider;
  41 import org.onap.policy.clamp.controlloop.models.messages.rest.commissioning.CommissioningResponse;
  42 import org.onap.policy.clamp.controlloop.runtime.supervision.SupervisionHandler;
  43 import org.onap.policy.models.base.PfModelException;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaCapabilityType;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaDataType;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplates;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaTopologyTemplate;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
  55 import org.springframework.stereotype.Component;
  56
  57 /**
  58  * This class provides the create, read and delete actions on Commissioning of Control Loop concepts in the database to
  59  * the callers.
  60  */
  61 @Component
  62 public class CommissioningProvider {
  63     public static final String CONTROL_LOOP_NODE_TYPE = "org.onap.policy.clamp.controlloop.ControlLoop";
  64     private static final String INSTANCE_TEXT = "_Instance";
  65
  66     private final ServiceTemplateProvider serviceTemplateProvider;
  67     private final ControlLoopProvider clProvider;
  68     private final ObjectMapper mapper = new ObjectMapper();
  69     private final ParticipantProvider participantProvider;
  70     private final SupervisionHandler supervisionHandler;
  71
  72     private static final Object lockit = new Object();
  73
  74     /**
  75      * Create a commissioning provider.
  76      *
  77      * @param serviceTemplateProvider the ServiceTemplate Provider
  78      * @param clProvider the ControlLoop Provider
  79      * @param supervisionHandler the Supervision Handler
  80      * @param participantProvider the Participant Provider
  81      */
  82     public CommissioningProvider(ServiceTemplateProvider serviceTemplateProvider, ControlLoopProvider clProvider,
  83             SupervisionHandler supervisionHandler, ParticipantProvider participantProvider) {
  84         this.serviceTemplateProvider = serviceTemplateProvider;
  85         this.clProvider = clProvider;
  86         this.supervisionHandler = supervisionHandler;
  87         this.participantProvider = participantProvider;
  88         mapper.setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE);
  89     }
  90
  91     /**
  92      * Create control loops from a service template.
  93      *
  94      * @param serviceTemplate the service template
  95      * @return the result of the commissioning operation
  96      * @throws PfModelException on creation errors
  97      */
  98     public CommissioningResponse createControlLoopDefinitions(ToscaServiceTemplate serviceTemplate)
  99             throws PfModelException {
 100
 101         if (verifyIfInstancePropertiesExists()) {
 102             throw new PfModelException(Status.BAD_REQUEST, "Delete instances, to commission control loop definitions");
 103         }
 104
 105         synchronized (lockit) {
 106             serviceTemplateProvider.createServiceTemplate(serviceTemplate);
 107             List<Participant> participantList = participantProvider.getParticipants();
 108             if (!participantList.isEmpty()) {
 109                 supervisionHandler.handleSendCommissionMessage(serviceTemplate.getName(), serviceTemplate.getVersion());
 110             }
 111         }
 112
 113         var response = new CommissioningResponse();
 114         // @formatter:off
 115         response.setAffectedControlLoopDefinitions(serviceTemplate.getToscaTopologyTemplate().getNodeTemplates()
 116                 .values()
 117                 .stream()
 118                 .map(template -> template.getKey().asIdentifier())
 119                 .collect(Collectors.toList()));
 120         // @formatter:on
 121
 122         return response;
 123     }
 124
 125     /**
 126      * Delete the control loop definition with the given name and version.
 127      *
 128      * @param name the name of the control loop definition to delete
 129      * @param version the version of the control loop to delete
 130      * @return the result of the deletion
 131      * @throws PfModelException on deletion errors
 132      */
 133     public CommissioningResponse deleteControlLoopDefinition(String name, String version) throws PfModelException {
 134
 135         if (verifyIfInstancePropertiesExists()) {
 136             throw new PfModelException(Status.BAD_REQUEST, "Delete instances, to commission control loop definitions");
 137         }
 138
 139         synchronized (lockit) {
 140             List<Participant> participantList = participantProvider.getParticipants();
 141             if (!participantList.isEmpty()) {
 142                 supervisionHandler.handleSendDeCommissionMessage();
 143             }
 144             serviceTemplateProvider.deleteServiceTemplate(name, version);
 145         }
 146
 147         var response = new CommissioningResponse();
 148         response.setAffectedControlLoopDefinitions(List.of(new ToscaConceptIdentifier(name, version)));
 149
 150         return response;
 151     }
 152
 153     /**
 154      * Get control loop node templates.
 155      *
 156      * @param clName the name of the control loop, null for all
 157      * @param clVersion the version of the control loop, null for all
 158      * @return list of control loop node templates
 159      * @throws PfModelException on errors getting control loop definitions
 160      */
 161     public List<ToscaNodeTemplate> getControlLoopDefinitions(String clName, String clVersion) throws PfModelException {
 162
 163         // @formatter:off
 164         ToscaTypedEntityFilter<ToscaNodeTemplate> nodeTemplateFilter = ToscaTypedEntityFilter
 165                 .<ToscaNodeTemplate>builder()
 166                 .name(clName)
 167                 .version(clVersion)
 168                 .type(CONTROL_LOOP_NODE_TYPE)
 169                 .build();
 170         // @formatter:on
 171
 172         return clProvider.getFilteredNodeTemplates(nodeTemplateFilter);
 173     }
 174
 175     /**
 176      * Get the control loop elements from a control loop node template.
 177      *
 178      * @param controlLoopNodeTemplate the control loop node template
 179      * @return a list of the control loop element node templates in a control loop node template
 180      * @throws PfModelException on errors get control loop element node templates
 181      */
 182     public List<ToscaNodeTemplate> getControlLoopElementDefinitions(ToscaNodeTemplate controlLoopNodeTemplate)
 183             throws PfModelException {
 184         if (!CONTROL_LOOP_NODE_TYPE.equals(controlLoopNodeTemplate.getType())) {
 185             return Collections.emptyList();
 186         }
 187
 188         if (MapUtils.isEmpty(controlLoopNodeTemplate.getProperties())) {
 189             return Collections.emptyList();
 190         }
 191
 192         @SuppressWarnings("unchecked")
 193         List<Map<String, String>> controlLoopElements =
 194                 (List<Map<String, String>>) controlLoopNodeTemplate.getProperties().get("elements");
 195
 196         if (CollectionUtils.isEmpty(controlLoopElements)) {
 197             return Collections.emptyList();
 198         }
 199
 200         List<ToscaNodeTemplate> controlLoopElementList = new ArrayList<>();
 201         // @formatter:off
 202         controlLoopElementList.addAll(
 203                 controlLoopElements
 204                         .stream()
 205                         .map(elementMap -> clProvider.getNodeTemplates(elementMap.get("name"),
 206                                 elementMap.get("version")))
 207                         .flatMap(List::stream)
 208                         .collect(Collectors.toList())
 209         );
 210         // @formatter:on
 211
 212         return controlLoopElementList;
 213     }
 214
 215     /**
 216      * Get node templates with common properties added.
 217      *
 218      * @param common boolean indicating common or instance properties to be used
 219      * @param name the name of the definition to use, null for all definitions
 220      * @param version the version of the definition to use, null for all definitions
 221      * @return the nodes templates with common or instance properties
 222      * @throws PfModelException on errors getting common or instance properties from node_templates
 223      */
 224     public Map<String, ToscaNodeTemplate> getNodeTemplatesWithCommonOrInstanceProperties(boolean common, String name,
 225             String version) throws PfModelException {
 226
 227         if (common && verifyIfInstancePropertiesExists()) {
 228             throw new PfModelException(Status.BAD_REQUEST,
 229                     "Cannot create or edit common properties, delete all the instantiations first");
 230         }
 231
 232         var serviceTemplateList = serviceTemplateProvider.getServiceTemplateList(name, version);
 233         var commonOrInstanceNodeTypeProps =
 234                 serviceTemplateProvider.getCommonOrInstancePropertiesFromNodeTypes(common, serviceTemplateList.get(0));
 235
 236         var serviceTemplates = new ToscaServiceTemplates();
 237         serviceTemplates.setServiceTemplates(filterToscaNodeTemplateInstance(serviceTemplateList));
 238
 239         return serviceTemplateProvider.getDerivedCommonOrInstanceNodeTemplates(
 240                 serviceTemplates.getServiceTemplates().get(0).getToscaTopologyTemplate().getNodeTemplates(),
 241                 commonOrInstanceNodeTypeProps);
 242     }
 243
 244     /**
 245      * Get the requested control loop definitions.
 246      *
 247      * @param name the name of the definition to get, null for all definitions
 248      * @param version the version of the definition to get, null for all definitions
 249      * @return the control loop definitions
 250      * @throws PfModelException on errors getting control loop definitions
 251      */
 252     public ToscaServiceTemplate getToscaServiceTemplate(String name, String version) throws PfModelException {
 253         return serviceTemplateProvider.getToscaServiceTemplate(name, version);
 254     }
 255
 256     /**
 257      * Get the tosca service template with only required sections.
 258      *
 259      * @param name the name of the template to get, null for all definitions
 260      * @param version the version of the template to get, null for all definitions
 261      * @return the tosca service template
 262      * @throws PfModelException on errors getting tosca service template
 263      */
 264     public String getToscaServiceTemplateReduced(String name, String version) throws PfModelException {
 265
 266         var serviceTemplateList = serviceTemplateProvider.getServiceTemplateList(name, version);
 267
 268         List<ToscaServiceTemplate> filteredServiceTemplateList = filterToscaNodeTemplateInstance(serviceTemplateList);
 269
 270         if (filteredServiceTemplateList.isEmpty()) {
 271             throw new PfModelException(Status.BAD_REQUEST, "Invalid Service Template");
 272         }
 273
 274         ToscaServiceTemplate fullTemplate = filteredServiceTemplateList.get(0);
 275
 276         var template = new HashMap<String, Object>();
 277         template.put("tosca_definitions_version", fullTemplate.getToscaDefinitionsVersion());
 278         template.put("data_types", fullTemplate.getDataTypes());
 279         template.put("policy_types", fullTemplate.getPolicyTypes());
 280         template.put("node_types", fullTemplate.getNodeTypes());
 281         template.put("topology_template", fullTemplate.getToscaTopologyTemplate());
 282
 283         try {
 284             return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(template);
 285
 286         } catch (JsonProcessingException e) {
 287             throw new PfModelException(Status.BAD_REQUEST, "Converion to Json Schema failed", e);
 288         }
 289     }
 290
 291     /**
 292      * Get the requested json schema.
 293      *
 294      * @param section section of the tosca service template to get schema for
 295      * @return the specified tosca service template or section Json Schema
 296      * @throws PfModelException on errors with retrieving the classes
 297      */
 298     public String getToscaServiceTemplateSchema(String section) throws PfModelException {
 299         var visitor = new SchemaFactoryWrapper();
 300
 301         try {
 302             switch (section) {
 303                 case "data_types":
 304                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaDataType.class), visitor);
 305                     break;
 306                 case "capability_types":
 307                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaCapabilityType.class), visitor);
 308                     break;
 309                 case "node_types":
 310                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaNodeType.class), visitor);
 311                     break;
 312                 case "relationship_types":
 313                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaRelationshipType.class), visitor);
 314                     break;
 315                 case "policy_types":
 316                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaPolicyType.class), visitor);
 317                     break;
 318                 case "topology_template":
 319                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaTopologyTemplate.class), visitor);
 320                     break;
 321                 case "node_templates":
 322                     mapper.acceptJsonFormatVisitor(
 323                             mapper.getTypeFactory().constructCollectionType(List.class, ToscaNodeTemplate.class),
 324                             visitor);
 325                     break;
 326                 default:
 327                     mapper.acceptJsonFormatVisitor(mapper.constructType(ToscaServiceTemplate.class), visitor);
 328             }
 329
 330             var jsonSchema = visitor.finalSchema();
 331             return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(jsonSchema);
 332         } catch (JsonProcessingException e) {
 333             throw new PfModelException(Status.BAD_REQUEST, "Converion to Json Schema failed", e);
 334         }
 335     }
 336
 337     private List<ToscaServiceTemplate> filterToscaNodeTemplateInstance(List<ToscaServiceTemplate> serviceTemplates) {
 338
 339         List<ToscaServiceTemplate> toscaServiceTemplates = new ArrayList<>();
 340
 341         serviceTemplates.stream().forEach(serviceTemplate -> {
 342
 343             Map<String, ToscaNodeTemplate> toscaNodeTemplates = new HashMap<>();
 344
 345             serviceTemplate.getToscaTopologyTemplate().getNodeTemplates().forEach((key, nodeTemplate) -> {
 346                 if (!nodeTemplate.getName().contains(INSTANCE_TEXT)) {
 347                     toscaNodeTemplates.put(key, nodeTemplate);
 348                 }
 349             });
 350
 351             serviceTemplate.getToscaTopologyTemplate().getNodeTemplates().clear();
 352             serviceTemplate.getToscaTopologyTemplate().setNodeTemplates(toscaNodeTemplates);
 353
 354             toscaServiceTemplates.add(serviceTemplate);
 355         });
 356
 357         return toscaServiceTemplates;
 358     }
 359
 360     /**
 361      * Validates to see if there is any instance properties saved.
 362      *
 363      * @return true if exists instance properties
 364      */
 365     private boolean verifyIfInstancePropertiesExists() {
 366         return clProvider.getNodeTemplates(null, null).stream()
 367                 .anyMatch(nodeTemplate -> nodeTemplate.getKey().getName().contains(INSTANCE_TEXT));
 368
 369     }
 370 }