docs

/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdc.translator.services.heattotosca.impl.resourcetranslation;

import org.apache.commons.collections4.CollectionUtils;
import org.openecomp.sdc.common.errors.CoreException;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
import org.openecomp.sdc.heat.datatypes.model.Resource;
import org.openecomp.sdc.logging.context.impl.MdcDataDebugMessage;
import org.openecomp.sdc.logging.context.impl.MdcDataErrorMessage;
import org.openecomp.sdc.logging.types.LoggerConstants;
import org.openecomp.sdc.logging.types.LoggerErrorCode;
import org.openecomp.sdc.logging.types.LoggerErrorDescription;
import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
import org.openecomp.sdc.tosca.datatypes.ToscaCapabilityType;
import org.openecomp.sdc.tosca.datatypes.ToscaRelationshipType;
import org.openecomp.sdc.tosca.datatypes.ToscaTopologyTemplateElements;
import org.openecomp.sdc.tosca.datatypes.model.RequirementAssignment;
import org.openecomp.sdc.tosca.datatypes.model.ServiceTemplate;
import org.openecomp.sdc.tosca.services.DataModelUtil;
import org.openecomp.sdc.tosca.services.ToscaConstants;
import org.openecomp.sdc.translator.datatypes.heattotosca.TranslationContext;
import org.openecomp.sdc.translator.datatypes.heattotosca.to.TranslateTo;
import org.openecomp.sdc.translator.services.heattotosca.ConsolidationDataUtil;
import org.openecomp.sdc.translator.services.heattotosca.ConsolidationEntityType;
import org.openecomp.sdc.translator.services.heattotosca.HeatToToscaUtil;
import org.openecomp.sdc.translator.services.heattotosca.ResourceTranslationFactory;
import org.openecomp.sdc.translator.services.heattotosca.errors.ResourceNotFoundInHeatFileErrorBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.Collectors;

public abstract class ResourceTranslationBase {

  protected static Logger logger = (Logger) LoggerFactory.getLogger(ResourceTranslationBase.class);
  protected static MdcDataDebugMessage mdcDataDebugMessage = new MdcDataDebugMessage();

  protected abstract void translate(TranslateTo translateTo);

  /**
   * Translate resource.
   *
   * @param heatFileName              the heat file name
   * @param serviceTemplate           the service template
   * @param heatOrchestrationTemplate the heat orchestration template
   * @param resource                  the resource
   * @param resourceId                the resource id
   * @param context                   the context
   * @return the translated id if this resource is supported, or empty value if not supported
   */
  public Optional<String> translateResource(String heatFileName, ServiceTemplate serviceTemplate,
                                            HeatOrchestrationTemplate heatOrchestrationTemplate,
                                            Resource resource, String resourceId,
                                            TranslationContext context) {

    mdcDataDebugMessage.debugEntryMessage("file, resource", heatFileName, resourceId);
    Optional<String> translatedId =
        getResourceTranslatedId(heatFileName, heatOrchestrationTemplate, resourceId, context);
    context.getTranslatedResources().putIfAbsent(heatFileName, new HashSet<>());
    if (context.getTranslatedResources().get(heatFileName).contains(resourceId)) {
      return translatedId;
    }
    if (!translatedId.isPresent()) {
      return Optional.empty();
    }
    logger.debug("Translate- file:" + heatFileName + " resource Id:" + resourceId
        + " translated resource id:" + translatedId.get());
    TranslateTo translateTo = new TranslateTo(heatFileName, serviceTemplate,
        heatOrchestrationTemplate, resource, resourceId, translatedId.get(), context);
    translate(translateTo);
    context.getTranslatedResources().get(heatFileName).add(resourceId);

    if (DataModelUtil.isNodeTemplate(translatedId.get(), serviceTemplate)) {
      if (!context.getHeatStackGroupMembers().containsKey(heatFileName)) {
        context.getHeatStackGroupMembers().put(heatFileName, new HashSet<>());
      }
      context.getHeatStackGroupMembers().get(heatFileName).add(translatedId.get());
      updateResourceDependency(translateTo);
    }

    mdcDataDebugMessage.debugExitMessage("file, resource", heatFileName, resourceId);
    return translatedId;
  }

  /**
   * Gets resource translated id.
   *
   * @param heatFileName              the heat file name
   * @param heatOrchestrationTemplate the heat orchestration template
   * @param resourceId                the resource id
   * @param context                   the context
   * @return the resource translated id
   */
  public static Optional<String> getResourceTranslatedId(String heatFileName,
                                                         HeatOrchestrationTemplate
                                                             heatOrchestrationTemplate,
                                                         String resourceId,
                                                         TranslationContext context) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    if (!context.getTranslatedIds().containsKey(heatFileName)) {
      context.getTranslatedIds().put(heatFileName, new HashMap<>());
    }

    Map<String, String> translatedIdsPerFile = context.getTranslatedIds().get(heatFileName);
    String translatedId = translatedIdsPerFile.get(resourceId);
    if (translatedId != null) {
      return Optional.of(translatedId);
    }

    Resource resource = heatOrchestrationTemplate.getResources().get(resourceId);
    if (resource == null) {
      MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_DB,
          LoggerTragetServiceName.GET_RESOURCE, ErrorLevel.ERROR.name(),
          LoggerErrorCode.DATA_ERROR.getErrorCode(), LoggerErrorDescription.TRANSLATE_HEAT);
      throw new CoreException(
          new ResourceNotFoundInHeatFileErrorBuilder(resourceId, heatFileName).build());
    }
    TranslateTo translateTo =
        generateTranslationTo(heatFileName, null, heatOrchestrationTemplate, resource, resourceId,
            null, context);
    translatedId =
        ResourceTranslationFactory.getInstance(resource).generateTranslatedId(translateTo);
    if (translatedId != null) {
      context.getTranslatedIds().get(heatFileName).put(resourceId, translatedId);
    }

    mdcDataDebugMessage.debugExitMessage(null, null);
    return Optional.ofNullable(translatedId);
  }


  /**
   * Gets resource translated element template.
   *
   * @param heatFileName              the heat file name
   * @param heatOrchestrationTemplate the heat orchestration template
   * @param resourceId                the resource id
   * @param context                   the context
   * @return the resource translated element template
   */
  public static Optional<ToscaTopologyTemplateElements> getResourceTranslatedElementTemplate(
      String heatFileName,
      HeatOrchestrationTemplate heatOrchestrationTemplate,
      String resourceId, TranslationContext context) {

    mdcDataDebugMessage.debugEntryMessage(null, null);

    Resource resource = heatOrchestrationTemplate.getResources().get(resourceId);
    if (resource == null) {
      MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_DB,
          LoggerTragetServiceName.GET_RESOURCE, ErrorLevel.ERROR.name(),
          LoggerErrorCode.DATA_ERROR.getErrorCode(), LoggerErrorDescription.TRANSLATE_HEAT);
      throw new CoreException(
          new ResourceNotFoundInHeatFileErrorBuilder(resourceId, heatFileName).build());
    }
    TranslateTo translateTo =
        generateTranslationTo(heatFileName, null, heatOrchestrationTemplate, resource, resourceId,
            null, context);

    Optional<ToscaTopologyTemplateElements> translatedElementTemplate =
        ResourceTranslationFactory.getInstance(resource)
            .getTranslatedToscaTopologyElement(translateTo);

    mdcDataDebugMessage.debugExitMessage(null, null);
    return translatedElementTemplate;
  }

  protected String generateTranslatedId(TranslateTo translateTo) {
    if (isEssentialRequirementsValid(translateTo)) {
      return translateTo.getResourceId();
    } else {
      return null;
    }

  }

  protected Optional<ToscaTopologyTemplateElements> getTranslatedToscaTopologyElement(
      TranslateTo translateTo) {
    if (isEssentialRequirementsValid(translateTo)) {
      return Optional.of(ToscaTopologyTemplateElements.NODE_TEMPLATE);
    } else {
      return Optional.empty();
    }
  }

  protected boolean isEssentialRequirementsValid(TranslateTo translateTo) {
    return true;
  }

  private static TranslateTo generateTranslationTo(String heatFileName,
                                                   ServiceTemplate serviceTemplate,
                                                   HeatOrchestrationTemplate
                                                       heatOrchestrationTemplate,
                                                   Resource resource, String resourceId,
                                                   String translatedId,
                                                   TranslationContext context) {
    TranslateTo to = new TranslateTo();
    to.setHeatFileName(heatFileName);
    to.setServiceTemplate(serviceTemplate);
    to.setHeatOrchestrationTemplate(heatOrchestrationTemplate);
    to.setResource(resource);
    to.setResourceId(resourceId);
    to.setTranslatedId(translatedId);
    to.setContext(context);
    return to;
  }

  private void updateResourceDependency(TranslateTo translateTo) {

    String heatFileName = translateTo.getHeatFileName();
    mdcDataDebugMessage.debugEntryMessage("file", heatFileName);

    Resource resource = translateTo.getResource();
    HeatOrchestrationTemplate heatOrchestrationTemplate = translateTo
        .getHeatOrchestrationTemplate();
    String translatedId = translateTo.getTranslatedId();
    ServiceTemplate serviceTemplate = translateTo.getServiceTemplate();
    TranslationContext context = translateTo.getContext();
    if (resource.getDepends_on() == null) {
      return;
    }

    if (resource.getDepends_on() instanceof List) {
      List<String> dependsOnList = (List<String>) resource.getDepends_on();
      for (String dependsOnResourceId : dependsOnList) {
        addDependOnRequirement(dependsOnResourceId, translateTo);
      }
    } else {
      String dependsOnResourceId = (String) resource.getDepends_on();
      addDependOnRequirement(dependsOnResourceId, translateTo);
    }

    mdcDataDebugMessage.debugExitMessage("file", heatFileName);
  }

  private void addDependOnRequirement(String dependsOnResourceId, TranslateTo translateTo) {

    mdcDataDebugMessage.debugEntryMessage(null, null);
    String nodeTemplateId = translateTo.getTranslatedId();
    ServiceTemplate serviceTemplate = translateTo.getServiceTemplate();
    String heatFileName = translateTo.getHeatFileName();
    HeatOrchestrationTemplate heatOrchestrationTemplate = translateTo
        .getHeatOrchestrationTemplate();
    TranslationContext context = translateTo.getContext();
    RequirementAssignment requirementAssignment = new RequirementAssignment();
    Optional<String> resourceTranslatedId =
        getResourceTranslatedId(heatFileName, heatOrchestrationTemplate, dependsOnResourceId,
            context);

    Optional<ToscaTopologyTemplateElements> resourceTranslatedElementTemplate =
        getResourceTranslatedElementTemplate(heatFileName, heatOrchestrationTemplate,
            dependsOnResourceId, context);

    if (resourceTranslatedId.isPresent()
        && (resourceTranslatedElementTemplate.isPresent() && resourceTranslatedElementTemplate
        .get() == ToscaTopologyTemplateElements.NODE_TEMPLATE)) {
      Resource sourceResource = translateTo.getResource();
      Resource targetResource = HeatToToscaUtil
          .getResource(heatOrchestrationTemplate, dependsOnResourceId,
              translateTo.getHeatFileName());
      if (HeatToToscaUtil
          .isValidDependsOnCandidate(heatOrchestrationTemplate, sourceResource, targetResource,
              ConsolidationEntityType.OTHER, translateTo.getContext())) {
        requirementAssignment.setNode(resourceTranslatedId.get());
        requirementAssignment.setCapability(ToscaCapabilityType.NATIVE_NODE);
        requirementAssignment.setRelationship(ToscaRelationshipType.NATIVE_DEPENDS_ON);
        DataModelUtil.addRequirementAssignment(
            serviceTemplate.getTopology_template().getNode_templates().get(nodeTemplateId),
            ToscaConstants.DEPENDS_ON_REQUIREMENT_ID, requirementAssignment);
        Resource dependsOnResource = targetResource;
        ConsolidationDataUtil
            .updateNodesConnectedData(translateTo, dependsOnResourceId, dependsOnResource,
                sourceResource, nodeTemplateId, ToscaConstants.DEPENDS_ON_REQUIREMENT_ID,
                requirementAssignment);
      }
    }
    mdcDataDebugMessage.debugExitMessage(null, null);
  }

  Optional<List<Map.Entry<String, Resource>>> getResourceByTranslatedResourceId(
      String heatFileName,
      HeatOrchestrationTemplate heatOrchestrationTemplate,
      String translatedResourceId,
      TranslateTo translateTo,
      String heatResourceType) {
    mdcDataDebugMessage.debugEntryMessage(null, null);
    List<Map.Entry<String, Resource>> list = heatOrchestrationTemplate.getResources().entrySet()
        .stream()
        .filter(entry -> getPredicatesForTranslatedIdToResourceId(heatFileName,
            heatOrchestrationTemplate, translatedResourceId, translateTo.getContext(),
            heatResourceType)
            .stream()
            .allMatch(p -> p.test(entry)))
        .collect(Collectors.toList());
    if (CollectionUtils.isEmpty(list)) {
      mdcDataDebugMessage.debugExitMessage(null, null);
      return Optional.empty();
    } else {
      mdcDataDebugMessage.debugExitMessage(null, null);
      return Optional.of(list);
    }
  }

  private List<Predicate<Map.Entry<String, Resource>>> getPredicatesForTranslatedIdToResourceId(
      String heatFileName, HeatOrchestrationTemplate heatOrchestrationTemplate,
      String translatedResourceId, TranslationContext context, String heatResourceType) {
    List<Predicate<Map.Entry<String, Resource>>> list = new ArrayList<>();
    list.add(entry ->
        entry.getValue().getType().equals(heatResourceType));
    list.add(entry -> {
      Optional<String> resourceTranslatedId =
          getResourceTranslatedId(heatFileName, heatOrchestrationTemplate, entry.getKey(), context);
      return resourceTranslatedId.isPresent()
          && resourceTranslatedId.get().equals(translatedResourceId);
    });
    return list;
  }

  boolean isResourceTypeSupported(Resource resource, List<String> supporteTypes) {
    return Objects.nonNull(resource) && supporteTypes.contains(resource.getType());
  }

}
Mode	Name	Size
d---------	_static	219	log stats plain
d---------	api / swagger	34	log stats plain
-rw-r--r--	architecture.rst	1852	log stats plain
-rwxr-xr-x	conf.py	361	log stats plain
-rw-r--r--	conf.yaml	119	log stats plain
-rwxr-xr-x	design.rst	790	log stats plain
-rwxr-xr-x	index.rst	544	log stats plain
-rw-r--r--	modeling.rst	1726	log stats plain
-rw-r--r--	overview.rst	1666	log stats plain
-rwxr-xr-x	release-notes.rst	7320	log stats plain
-rw-r--r--	requirements-docs.txt	241	log stats plain
-rw-r--r--	tox.ini	592	log stats plain