catalog-be/src/main/java/org/openecomp/sdc/be/components/impl/CategoriesImportManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.be.components.impl;
  22
  23 import fj.data.Either;
  24 import org.openecomp.sdc.be.dao.api.ActionStatus;
  25 import org.openecomp.sdc.be.dao.neo4j.GraphPropertiesDictionary;
  26 import org.openecomp.sdc.be.datamodel.api.CategoryTypeEnum;
  27 import org.openecomp.sdc.be.datamodel.utils.NodeTypeConvertUtils;
  28 import org.openecomp.sdc.be.datatypes.category.MetadataKeyDataDefinition;
  29 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  30 import org.openecomp.sdc.be.datatypes.enums.MetadataKeyEnum;
  31 import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
  32 import org.openecomp.sdc.be.impl.ComponentsUtils;
  33 import org.openecomp.sdc.be.model.category.CategoryDefinition;
  34 import org.openecomp.sdc.be.model.category.GroupingDefinition;
  35 import org.openecomp.sdc.be.model.category.SubCategoryDefinition;
  36 import org.openecomp.sdc.be.model.operations.api.IElementOperation;
  37 import org.openecomp.sdc.be.model.operations.impl.UniqueIdBuilder;
  38 import org.openecomp.sdc.common.log.wrappers.Logger;
  39 import org.openecomp.sdc.common.util.ValidationUtils;
  40 import org.openecomp.sdc.exception.ResponseFormat;
  41 import org.springframework.stereotype.Component;
  42 import org.yaml.snakeyaml.Yaml;
  43
  44 import java.util.ArrayList;
  45 import java.util.Collections;
  46 import java.util.HashMap;
  47 import java.util.Iterator;
  48 import java.util.List;
  49 import java.util.Map;
  50 import java.util.Map.Entry;
  51
  52 @Component("categoriesImportManager")
  53 public class CategoriesImportManager {
  54
  55     @javax.annotation.Resource
  56     private IElementOperation elementOperation;
  57
  58     @javax.annotation.Resource
  59     private ComponentsUtils componentsUtils;
  60
  61     private static final Logger log = Logger.getLogger(CategoriesImportManager.class.getName());
  62
  63     public Either<Map<String, List<CategoryDefinition>>, ResponseFormat> createCategories(String categoriesTypesYml) {
  64
  65         Map<String, List<CategoryDefinition>> allCategories = createCategoriesFromYml(categoriesTypesYml);
  66         return createCategoriesByDao(allCategories);
  67     }
  68
  69     private Either<Map<String, List<CategoryDefinition>>, ResponseFormat> createCategoriesByDao(Map<String, List<CategoryDefinition>> allCategories) {
  70         Map<String, List<CategoryDefinition>> result = new HashMap<>();
  71         log.debug("createCategoriesByDao: starting to create Categories.");
  72         for (Map.Entry<String, List<CategoryDefinition>> entry : allCategories.entrySet()) {
  73             ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(entry.getKey());
  74             NodeTypeEnum nodeTypeCategory = NodeTypeConvertUtils.getCategoryNodeTypeByComponentParam(componentType, CategoryTypeEnum.CATEGORY);
  75             NodeTypeEnum nodeTypeSubCategory = NodeTypeConvertUtils.getCategoryNodeTypeByComponentParam(componentType, CategoryTypeEnum.SUBCATEGORY);
  76             NodeTypeEnum nodeTypeGroup = NodeTypeConvertUtils.getCategoryNodeTypeByComponentParam(componentType, CategoryTypeEnum.GROUPING);
  77             log.debug("createCategoriesByDao: creating componentType:{}  nodeTypeCategory:{} nodeTypeSubCategory:{} nodeTypeGroup:{}", componentType, nodeTypeCategory, nodeTypeSubCategory, nodeTypeGroup);
  78             List<CategoryDefinition> newCategoriesvalue = new ArrayList<>();
  79             for (CategoryDefinition category : entry.getValue()) {
  80
  81                 Either<CategoryDefinition, ResponseFormat> createdCategoryRes = createCategorieDeo(entry, category, nodeTypeCategory);
  82                 if (createdCategoryRes.isRight()) {
  83                     return Either.right(createdCategoryRes.right().value());
  84                 }
  85
  86                 CategoryDefinition newcategory = createdCategoryRes.left().value();
  87                 log.debug("createCategoriesByDao: create category was successful {}", newcategory);
  88                 List<SubCategoryDefinition> newsubcategories = new ArrayList<>();
  89                 List<SubCategoryDefinition> subcategories = category.getSubcategories();
  90                 if (subcategories != null) {
  91                     boolean createdNewSubCategory = isCreatedNewSubCategory(entry, nodeTypeSubCategory, nodeTypeGroup, category, newcategory, newsubcategories, subcategories);
  92                     if (!createdNewSubCategory) {
  93                         return Either.right(createdCategoryRes.right().value());
  94                     }
  95                     newcategory.setSubcategories(newsubcategories);
  96                 }
  97                 newCategoriesvalue.add(newcategory);
  98             }
  99             result.put(entry.getKey(), newCategoriesvalue);
 100         }
 101         return Either.left(result);
 102     }
 103
 104     private boolean isCreatedNewSubCategory(Entry<String, List<CategoryDefinition>> entry, NodeTypeEnum nodeTypeSubCategory, NodeTypeEnum nodeTypeGroup, CategoryDefinition category, CategoryDefinition newcategory, List<SubCategoryDefinition> newsubcategories, List<SubCategoryDefinition> subcategories) {
 105         for (SubCategoryDefinition subcategory : subcategories) {
 106             Either<SubCategoryDefinition, ResponseFormat> createdSubCategory = createSubCategorieDeo(entry, newcategory, subcategory, nodeTypeSubCategory);
 107             if (createdSubCategory.isRight()) {
 108                 return false;
 109             }
 110             SubCategoryDefinition newsubcategory = createdSubCategory.left().value();
 111             List<GroupingDefinition> groupings = subcategory.getGroupings();
 112             if (groupings != null) {
 113                 List<GroupingDefinition> newgroupings = new ArrayList<>();
 114                 for (GroupingDefinition grouping : groupings) {
 115                     Either<GroupingDefinition, ResponseFormat> createdGrouping = createGroupingDeo(entry, grouping, subcategory, category, nodeTypeGroup);
 116                     if (createdGrouping.isRight()) {
 117                         return false;
 118                     }
 119                     newgroupings.add(createdGrouping.left().value());
 120                 }
 121                 newsubcategory.setGroupings(newgroupings);
 122             }
 123             newsubcategories.add(newsubcategory);
 124         }
 125         return true;
 126     }
 127
 128     private Either<GroupingDefinition, ResponseFormat> createGroupingDeo(Map.Entry<String, List<CategoryDefinition>> entry, GroupingDefinition grouping, SubCategoryDefinition subcategory, CategoryDefinition category, NodeTypeEnum nodeTypeGroup) {
 129
 130         log.debug("createGroupingDeo: creating grouping  {}", grouping);
 131         Either<GroupingDefinition, ActionStatus> createdGrouping = elementOperation.createGrouping(subcategory.getUniqueId(), grouping, nodeTypeGroup);
 132         if (createdGrouping.isRight()) {
 133             if (ActionStatus.COMPONENT_GROUPING_EXISTS_FOR_SUB_CATEGORY == createdGrouping.right().value()) {
 134                 log.debug(" create grouping for {}  group {} already exists ", entry.getKey(), grouping.getName());
 135                 String groupingId = UniqueIdBuilder.buildGroupingUid(grouping.getUniqueId(), grouping.getNormalizedName());
 136                 createdGrouping = elementOperation.getGroupingUniqueForType(nodeTypeGroup, groupingId);
 137                 if (createdGrouping.isRight()) {
 138                     log.debug("failed to get grouping that exists groupingId: {} type: {}", groupingId, nodeTypeGroup);
 139                     return Either.right(componentsUtils.getResponseFormat(createdGrouping.right().value()));
 140                 }
 141             }
 142             log.debug("Failed to create groupingcategory for {}  category {} subcategory {} grouping {} error {}", entry.getKey(),
 143                     category.getName(), subcategory.getName(), grouping != null ? grouping.getName() : null,
 144                             createdGrouping != null && createdGrouping.right() != null ? createdGrouping.right().value() : null);
 145
 146             return Either.right(componentsUtils.getResponseFormat(createdGrouping.right().value()));
 147         } else {
 148             log.debug("createGroupingDeo: create Grouping was successful {}", createdGrouping.left().value());
 149         }
 150         return Either.left(createdGrouping.left().value());
 151
 152     }
 153
 154     private Either<SubCategoryDefinition, ResponseFormat> createSubCategorieDeo(Map.Entry<String, List<CategoryDefinition>> entry, CategoryDefinition newcategory, SubCategoryDefinition subcategory, NodeTypeEnum nodeTypeSubCategory) {
 155         log.debug("createSubCategorieDeo: creating subcategory  {}", subcategory);
 156         Either<SubCategoryDefinition, ActionStatus> createdSubCategory = elementOperation.createSubCategory(newcategory.getUniqueId(), subcategory, nodeTypeSubCategory);
 157         if (createdSubCategory.isRight() && ActionStatus.COMPONENT_SUB_CATEGORY_EXISTS_FOR_CATEGORY == createdSubCategory.right().value()) {
 158             log.debug(" create subcategory for {}  category {} subcategory {} already exists, updating", entry.getKey(), newcategory.getName(), subcategory.getName());
 159             String subCategoryId = UniqueIdBuilder.buildSubCategoryUid(newcategory.getUniqueId(), subcategory.getNormalizedName());
 160             createdSubCategory = elementOperation.updateSubCategory(subCategoryId, subcategory, nodeTypeSubCategory);
 161         }
 162         if (createdSubCategory.isRight()) {
 163             log.debug("Failed to create subcategory for {}  category: {} subcategory: {} error {}", entry.getKey(), newcategory.getName(), subcategory.getName(), createdSubCategory.right().value());
 164             return Either.right(componentsUtils.getResponseFormat(createdSubCategory.right().value()));
 165         } else {
 166             log.debug("createSubCategorieDeo: create subcategory was successful {}", createdSubCategory.left().value());
 167         }
 168         return Either.left(createdSubCategory.left().value());
 169     }
 170
 171     private Either<CategoryDefinition, ResponseFormat> createCategorieDeo(Map.Entry<String, List<CategoryDefinition>> entry, CategoryDefinition category, NodeTypeEnum nodeTypeCategory) {
 172         log.debug("createCategorieDeo: creating category {}", category);
 173         Either<CategoryDefinition, ActionStatus> createdCategory = elementOperation.createCategory(category, nodeTypeCategory);
 174         if (createdCategory.isRight() && ActionStatus.COMPONENT_CATEGORY_ALREADY_EXISTS == createdCategory.right().value()) {
 175             log.debug("createCategorieDeo: already exists, updating {}", category);
 176             createdCategory = elementOperation.updateCategory(category, nodeTypeCategory);
 177         }
 178
 179         if (createdCategory.isRight()) {
 180             log.debug("Failed to create category for {}  {} error {}", entry.getKey(), category.getName(), createdCategory.right().value());
 181             return Either.right(componentsUtils.getResponseFormat(createdCategory.right().value()));
 182         } else {
 183             log.debug("createCategorieDeo: create category was successful {}", createdCategory.left().value());
 184         }
 185         return Either.left(createdCategory.left().value());
 186     }
 187
 188     private Map<String, List<CategoryDefinition>> createCategoriesFromYml(String categoriesTypesYml) {
 189         Map<String, Object> toscaJson = (Map<String, Object>) new Yaml().load(categoriesTypesYml);
 190         Map<String, List<CategoryDefinition>> allCategories = new HashMap<>();
 191
 192         Iterator<Entry<String, Object>> categoryEntryItr = toscaJson.entrySet().iterator();
 193         while (categoryEntryItr.hasNext()) {
 194             Entry<String, Object> categoryTypeEntry = categoryEntryItr.next();
 195             String categoryType = categoryTypeEntry.getKey();
 196             List<CategoryDefinition> categoriesPerType = null;
 197             Map<String, Object> categoryPerType = null;
 198             switch (categoryType) {
 199             case ComponentTypeEnum.SERVICE_PARAM_NAME:
 200                 categoryPerType = (Map<String, Object>) categoryTypeEntry.getValue();
 201                 categoriesPerType = createServiceCategories(categoryPerType);
 202                 break;
 203             case ComponentTypeEnum.RESOURCE_PARAM_NAME:
 204                 categoryPerType = (Map<String, Object>) categoryTypeEntry.getValue();
 205                 categoriesPerType = createResourceCategories(categoryPerType);
 206                 break;
 207             case ComponentTypeEnum.PRODUCT_PARAM_NAME:
 208                 // TODO
 209                 break;
 210             default:
 211                 log.debug("Not supported category type - {}", categoryType);
 212                 break;
 213             }
 214             if (categoriesPerType != null) {
 215                 allCategories.put(categoryType, categoriesPerType);
 216             }
 217         }
 218         return allCategories;
 219     }
 220
 221     private List<CategoryDefinition> createServiceCategories(Map<String, Object> categories) {
 222         List<CategoryDefinition> categoriesDef = new ArrayList<>();
 223         String catName = null;
 224         List<String> icons = null;
 225         for (Entry<String, Object> entry : categories.entrySet()) {
 226             CategoryDefinition catDef = new CategoryDefinition();
 227             Map<String, Object> category = (Map<String, Object>) entry.getValue();
 228             catName = (String) category.get("name");
 229             catDef.setName(catName);
 230             icons = (List<String>) category.get("icons");
 231             catDef.setIcons(icons);
 232             String normalizedName = ValidationUtils.normalizeCategoryName4Uniqueness(catName);
 233             catDef.setNormalizedName(normalizedName);
 234             final Object useServiceSubstitutionForNestedServicesProperty = category.get("useServiceSubstitutionForNestedServices");
 235             final boolean useServiceSubstitutionForNestedServices = useServiceSubstitutionForNestedServicesProperty == null ?
 236                     false : (Boolean) useServiceSubstitutionForNestedServicesProperty;
 237             catDef.setUseServiceSubstitutionForNestedServices(useServiceSubstitutionForNestedServices);
 238             catDef.setMetadataKeys(getMetadataKeys(category));
 239             categoriesDef.add(catDef);
 240         }
 241
 242         return categoriesDef;
 243     }
 244
 245     private List<MetadataKeyDataDefinition> getMetadataKeys(Map<String, Object> parentObject) {
 246         Map<String, Object> metadataKeys = (Map<String, Object>) parentObject.getOrDefault(MetadataKeyEnum.METADATA_KEYS.getName(), Collections.EMPTY_MAP);
 247         List<MetadataKeyDataDefinition> metadataKeyDefs = new ArrayList<>();
 248         for (Entry<String, Object> metadataKey : metadataKeys.entrySet()) {
 249             Map<String, Object> metadataKeyInfo = (Map<String, Object>) metadataKey.getValue();
 250             MetadataKeyDataDefinition metadataKeyDef = new MetadataKeyDataDefinition();
 251             String metadataKeyName = (String) metadataKeyInfo.get(MetadataKeyEnum.NAME.getName());
 252             metadataKeyDef.setName(metadataKeyName);
 253             final Object mandatoryProperty = metadataKeyInfo.get(MetadataKeyEnum.MANDATORY.getName());
 254             final boolean mandatory = mandatoryProperty == null ? false : (Boolean) mandatoryProperty;
 255             metadataKeyDef.setMandatory(mandatory);
 256             List<String> validValues = (List<String>) metadataKeyInfo.get(MetadataKeyEnum.VALID_VALUES.getName());
 257             metadataKeyDef.setValidValues(validValues);
 258             metadataKeyDef.setDefaultValue((String) metadataKeyInfo.get(MetadataKeyEnum.DEFAULT.getName()));
 259             metadataKeyDefs.add(metadataKeyDef);
 260         }
 261         return metadataKeyDefs;
 262     }
 263
 264     private List<CategoryDefinition> createResourceCategories(Map<String, Object> categoryPerType) {
 265         List<CategoryDefinition> categroiesDef = new ArrayList<>();
 266         for (Map.Entry<String, Object> entry : categoryPerType.entrySet()) {
 267             Map<String, Object> category = (Map<String, Object>) entry.getValue();
 268             CategoryDefinition catDef = new CategoryDefinition();
 269             String catName = (String) category.get("name");
 270             catDef.setName(catName);
 271             String normalizedName = ValidationUtils.normalizeCategoryName4Uniqueness(catName);
 272             catDef.setNormalizedName(normalizedName);
 273             Map<String, Object> subcategories = (Map<String, Object>) category.get("subcategories");
 274             List<SubCategoryDefinition> subcateDef = new ArrayList<>();
 275             for (Entry<String, Object> subcategory : subcategories.entrySet()) {
 276                 Map<String, Object> subcategoryInfo = (Map<String, Object>) subcategory.getValue();
 277                 SubCategoryDefinition subDef = new SubCategoryDefinition();
 278                 String subcategoryName = (String) subcategoryInfo.get("name");
 279                 subDef.setName(subcategoryName);
 280                 List<String> subcategoryIcons = (List<String>) subcategoryInfo.get("icons");
 281                 subDef.setIcons(subcategoryIcons);
 282                 normalizedName = ValidationUtils.normalizeCategoryName4Uniqueness(subcategoryName);
 283                 subDef.setNormalizedName(normalizedName);
 284                 subDef.setMetadataKeys(getMetadataKeys(subcategoryInfo));
 285                 subcateDef.add(subDef);
 286             }
 287
 288             catDef.setSubcategories(subcateDef);
 289             categroiesDef.add(catDef);
 290         }
 291         return categroiesDef;
 292     }
 293 }