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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.models.acm.persistence.provider;
  22
  23 import java.util.HashMap;
  24 import java.util.List;
  25 import java.util.Map;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.Response.Status;
  28 import lombok.RequiredArgsConstructor;
  29 import org.onap.policy.clamp.models.acm.persistence.repository.ToscaServiceTemplateRepository;
  30 import org.onap.policy.models.base.PfConceptKey;
  31 import org.onap.policy.models.base.PfModelException;
  32 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeType;
  34 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
  35 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  36 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  37 import org.springframework.stereotype.Service;
  38 import org.springframework.transaction.annotation.Transactional;
  39
  40 @Service
  41 @Transactional
  42 @RequiredArgsConstructor
  43 public class ServiceTemplateProvider {
  44
  45     private final ToscaServiceTemplateRepository serviceTemplateRepository;
  46
  47     /**
  48      * Create service template.
  49      *
  50      * @param serviceTemplate the service template to be created
  51      * @return the created service template
  52      * @throws PfModelException on errors creating the service template
  53      */
  54     public ToscaServiceTemplate createServiceTemplate(final ToscaServiceTemplate serviceTemplate)
  55             throws PfModelException {
  56         try {
  57             var result = serviceTemplateRepository.save(ProviderUtils.getJpaAndValidate(serviceTemplate,
  58                     JpaToscaServiceTemplate::new, "toscaServiceTemplate"));
  59             return result.toAuthorative();
  60         } catch (IllegalArgumentException e) {
  61             throw new PfModelException(Status.BAD_REQUEST, "Error in save serviceTemplate", e);
  62         }
  63     }
  64
  65     /**
  66      * Delete service template.
  67      *
  68      * @param name the name of the service template to delete.
  69      * @param version the version of the service template to delete.
  70      * @return the TOSCA service template that was deleted
  71      * @throws PfModelException on errors deleting policy types
  72      */
  73     public ToscaServiceTemplate deleteServiceTemplate(final String name, final String version) throws PfModelException {
  74         var serviceTemplateKey = new PfConceptKey(name, version);
  75         var jpaDelete = serviceTemplateRepository.findById(serviceTemplateKey);
  76         if (jpaDelete.isEmpty()) {
  77             String errorMessage = "delete of serviceTemplate \"" + serviceTemplateKey.getId()
  78                     + "\" failed, serviceTemplate does not exist";
  79             throw new PfModelException(Response.Status.BAD_REQUEST, errorMessage);
  80         }
  81         serviceTemplateRepository.deleteById(serviceTemplateKey);
  82         return jpaDelete.get().toAuthorative();
  83     }
  84
  85     /**
  86      * Get the requested automation composition definitions.
  87      *
  88      * @param name the name of the definition to get, null for all definitions
  89      * @param version the version of the definition to get, null for all definitions
  90      * @return the automation composition definitions
  91      * @throws PfModelException on errors getting automation composition definitions
  92      */
  93     @Transactional(readOnly = true)
  94     public ToscaServiceTemplate getToscaServiceTemplate(String name, String version) throws PfModelException {
  95         var serviceTemplateKey = new PfConceptKey(name, version);
  96         var jpaServiceTemplates = serviceTemplateRepository.findById(serviceTemplateKey);
  97         if (jpaServiceTemplates.isEmpty()) {
  98             throw new PfModelException(Status.NOT_FOUND, "Automation composition definitions not found");
  99         }
 100         return jpaServiceTemplates.get().toAuthorative();
 101     }
 102
 103     /**
 104      * Get service templates.
 105      *
 106      * @return the topology templates found
 107      * @throws PfModelException on errors getting service templates
 108      */
 109     @Transactional(readOnly = true)
 110     public List<ToscaServiceTemplate> getAllServiceTemplates() throws PfModelException {
 111         var jpaList = serviceTemplateRepository.findAll();
 112         return ProviderUtils.asEntityList(jpaList);
 113     }
 114
 115     /**
 116      * Get service templates.
 117      *
 118      * @param name the name of the topology template to get, set to null to get all service templates
 119      * @param version the version of the service template to get, set to null to get all service templates
 120      * @return the topology templates found
 121      * @throws PfModelException on errors getting service templates
 122      */
 123     @Transactional(readOnly = true)
 124     public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
 125             throws PfModelException {
 126         var jpaList = serviceTemplateRepository.getFiltered(JpaToscaServiceTemplate.class, name, version);
 127         return ProviderUtils.asEntityList(jpaList);
 128     }
 129
 130     /**
 131      * Get the initial node types with common or instance properties.
 132      *
 133      * @param fullNodeTypes map of all the node types in the specified template
 134      * @param common boolean to indicate whether common or instance properties are required
 135      * @return node types map that only has common properties
 136      */
 137     private Map<String, ToscaNodeType> getInitialNodeTypesMap(Map<String, ToscaNodeType> fullNodeTypes,
 138             boolean common) {
 139
 140         var tempNodeTypesMap = new HashMap<String, ToscaNodeType>();
 141
 142         fullNodeTypes.forEach((key, nodeType) -> {
 143             var tempToscaNodeType = new ToscaNodeType();
 144             tempToscaNodeType.setName(key);
 145
 146             var resultantPropertyMap = findCommonOrInstancePropsInNodeTypes(nodeType, common);
 147
 148             if (!resultantPropertyMap.isEmpty()) {
 149                 tempToscaNodeType.setProperties(resultantPropertyMap);
 150                 tempNodeTypesMap.put(key, tempToscaNodeType);
 151             }
 152         });
 153         return tempNodeTypesMap;
 154     }
 155
 156     private Map<String, ToscaProperty> findCommonOrInstancePropsInNodeTypes(ToscaNodeType nodeType, boolean common) {
 157
 158         var tempCommonPropertyMap = new HashMap<String, ToscaProperty>();
 159         var tempInstancePropertyMap = new HashMap<String, ToscaProperty>();
 160
 161         nodeType.getProperties().forEach((propKey, prop) -> {
 162
 163             if (prop.getMetadata() != null) {
 164                 prop.getMetadata().forEach((k, v) -> {
 165                     if (k.equals("common") && v.equals("true") && common) {
 166                         tempCommonPropertyMap.put(propKey, prop);
 167                     } else if (k.equals("common") && v.equals("false") && !common) {
 168                         tempInstancePropertyMap.put(propKey, prop);
 169                     }
 170
 171                 });
 172             } else {
 173                 tempInstancePropertyMap.put(propKey, prop);
 174             }
 175         });
 176
 177         if (tempCommonPropertyMap.isEmpty() && !common) {
 178             return tempInstancePropertyMap;
 179         } else {
 180             return tempCommonPropertyMap;
 181         }
 182     }
 183
 184     /**
 185      * Get the node types derived from those that have common properties.
 186      *
 187      * @param initialNodeTypes map of all the node types in the specified template
 188      * @param filteredNodeTypes map of all the node types that have common or instance properties
 189      * @return all node types that have common properties including their children
 190      * @throws PfModelException on errors getting node type with common properties
 191      */
 192     private Map<String, ToscaNodeType> getFinalNodeTypesMap(Map<String, ToscaNodeType> initialNodeTypes,
 193             Map<String, ToscaNodeType> filteredNodeTypes) {
 194         for (var i = 0; i < initialNodeTypes.size(); i++) {
 195             initialNodeTypes.forEach((key, nodeType) -> {
 196                 var tempToscaNodeType = new ToscaNodeType();
 197                 tempToscaNodeType.setName(key);
 198
 199                 if (filteredNodeTypes.get(nodeType.getDerivedFrom()) != null) {
 200                     tempToscaNodeType.setName(key);
 201
 202                     var finalProps = new HashMap<String, ToscaProperty>(
 203                             filteredNodeTypes.get(nodeType.getDerivedFrom()).getProperties());
 204
 205                     tempToscaNodeType.setProperties(finalProps);
 206                 } else {
 207                     return;
 208                 }
 209                 filteredNodeTypes.putIfAbsent(key, tempToscaNodeType);
 210
 211             });
 212         }
 213         return filteredNodeTypes;
 214     }
 215
 216     /**
 217      * Get the node types derived from those that have been saved by instantiation.
 218      *
 219      * @param initialNodeTypes map of all the node types in the specified template
 220      * @param filteredNodeTypes map of all the node types that have common or instance properties
 221      * @param instanceName automation composition name
 222      * @return all node types that have common properties including their children
 223      */
 224     private Map<String, ToscaNodeType> getFinalSavedInstanceNodeTypesMap(
 225             Map<String, ToscaNodeType> initialNodeTypes,
 226             Map<String, ToscaNodeType> filteredNodeTypes, String instanceName) {
 227
 228         for (var i = 0; i < initialNodeTypes.size(); i++) {
 229             initialNodeTypes.forEach((key, nodeType) -> {
 230                 var tempToscaNodeType = new ToscaNodeType();
 231                 tempToscaNodeType.setName(key);
 232
 233                 if (filteredNodeTypes.get(nodeType.getDerivedFrom()) != null) {
 234                     tempToscaNodeType.setName(key);
 235
 236                     var finalProps = new HashMap<String, ToscaProperty>(
 237                             filteredNodeTypes.get(nodeType.getDerivedFrom()).getProperties());
 238
 239                     tempToscaNodeType.setProperties(finalProps);
 240                 } else {
 241                     return;
 242                 }
 243                 filteredNodeTypes.putIfAbsent(key, tempToscaNodeType);
 244
 245             });
 246         }
 247         return filteredNodeTypes;
 248     }
 249
 250     /**
 251      * Get the requested node types by automation composition.
 252      *
 253      * @param instanceName automation composition name
 254      * @param serviceTemplate the ToscaServiceTemplate
 255      * @return the node types with common or instance properties
 256      */
 257     public Map<String, ToscaNodeType> getSavedInstanceInstancePropertiesFromNodeTypes(
 258             String instanceName, ToscaServiceTemplate serviceTemplate) {
 259         var tempNodeTypesMap =
 260                 this.getInitialNodeTypesMap(serviceTemplate.getNodeTypes(), false);
 261
 262         return this.getFinalSavedInstanceNodeTypesMap(serviceTemplate.getNodeTypes(), tempNodeTypesMap, instanceName);
 263
 264     }
 265
 266     /**
 267      * Get the requested node types with common or instance properties.
 268      *
 269      * @param common boolean indicating common or instance properties
 270      * @param serviceTemplate the ToscaServiceTemplate
 271      * @return the node types with common or instance properties
 272      * @throws PfModelException on errors getting node type properties
 273      */
 274     public Map<String, ToscaNodeType> getCommonOrInstancePropertiesFromNodeTypes(boolean common,
 275             ToscaServiceTemplate serviceTemplate) throws PfModelException {
 276         var tempNodeTypesMap = this.getInitialNodeTypesMap(serviceTemplate.getNodeTypes(), common);
 277
 278         return this.getFinalNodeTypesMap(serviceTemplate.getNodeTypes(), tempNodeTypesMap);
 279
 280     }
 281
 282     /**
 283      * Get node templates with appropriate common or instance properties added.
 284      *
 285      * @param initialNodeTemplates map of all the node templates in the specified template
 286      * @param nodeTypeProps map of all the node types that have common or instance properties including children
 287      * @return all node templates with appropriate common or instance properties added
 288      * @throws PfModelException on errors getting map of node templates with common or instance properties added
 289      */
 290     public Map<String, ToscaNodeTemplate> getDerivedCommonOrInstanceNodeTemplates(
 291             Map<String, ToscaNodeTemplate> initialNodeTemplates, Map<String, ToscaNodeType> nodeTypeProps) {
 292
 293         var finalNodeTemplatesMap = new HashMap<String, ToscaNodeTemplate>();
 294
 295         initialNodeTemplates.forEach((templateKey, template) -> {
 296             if (nodeTypeProps.containsKey(template.getType())) {
 297                 var finalMergedProps = new HashMap<String, Object>();
 298
 299                 nodeTypeProps.get(template.getType()).getProperties().forEach(finalMergedProps::putIfAbsent);
 300
 301                 template.setProperties(finalMergedProps);
 302
 303                 finalNodeTemplatesMap.put(templateKey, template);
 304             } else {
 305                 return;
 306             }
 307         });
 308         return finalNodeTemplatesMap;
 309     }
 310 }