aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-sdc-translator-lib/openecomp-sdc-translator-core/src/main/java/org/openecomp/sdc/translator/services/heattotosca/impl/resourcetranslation/ResourceTranslationCinderVolumeAttachmentImpl.java
blob: 4cf817bcae9bf1acc13e148e8b30937be4b9cdde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/*-
 * ============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 static org.openecomp.sdc.translator.services.heattotosca.HeatToToscaUtil.getResource;

import org.apache.commons.lang3.StringUtils;
import org.openecomp.sdc.common.errors.CoreException;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.heat.datatypes.manifest.FileData;
import org.openecomp.sdc.heat.datatypes.model.HeatResourcesTypes;
import org.openecomp.sdc.heat.datatypes.model.Resource;
import org.openecomp.sdc.heat.services.HeatConstants;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
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.ToscaRelationshipType;
import org.openecomp.sdc.tosca.datatypes.ToscaTopologyTemplateElements;
import org.openecomp.sdc.tosca.datatypes.model.NodeTemplate;
import org.openecomp.sdc.tosca.datatypes.model.RelationshipTemplate;
import org.openecomp.sdc.tosca.datatypes.model.RequirementAssignment;
import org.openecomp.sdc.tosca.services.DataModelUtil;
import org.openecomp.sdc.tosca.services.ToscaConstants;
import org.openecomp.sdc.translator.datatypes.heattotosca.AttachedResourceId;
import org.openecomp.sdc.translator.datatypes.heattotosca.to.ResourceFileDataAndIDs;
import org.openecomp.sdc.translator.datatypes.heattotosca.to.TranslateTo;
import org.openecomp.sdc.translator.services.heattotosca.ConsolidationDataUtil;
import org.openecomp.sdc.translator.services.heattotosca.HeatToToscaUtil;
import org.openecomp.sdc.translator.services.heattotosca.ResourceTranslationFactory;
import org.openecomp.sdc.translator.services.heattotosca.errors.MissingMandatoryPropertyErrorBuilder;
import org.openecomp.sdc.translator.services.heattotosca.helper.VolumeTranslationHelper;
import org.openecomp.sdc.translator.services.heattotosca.mapping.TranslatorHeatToToscaPropertyConverter;

import java.util.List;
import java.util.Optional;

public class ResourceTranslationCinderVolumeAttachmentImpl extends ResourceTranslationBase {
  protected static Logger logger =
      (Logger) LoggerFactory.getLogger(ResourceTranslationCinderVolumeAttachmentImpl.class);
  private String volumeIdPropertyName = "volume_id";
  private String toscaCapabilityAttachment = "tosca.capabilities.Attachment";

  @Override
  protected void translate(TranslateTo translateTo) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    RelationshipTemplate relationTemplate = new RelationshipTemplate();
    relationTemplate.setType(ToscaRelationshipType.CINDER_VOLUME_ATTACHES_TO);
    String relationshipTemplateId = translateTo.getTranslatedId();
    String heatFileName = translateTo.getHeatFileName();
    relationTemplate.setProperties(TranslatorHeatToToscaPropertyConverter
        .getToscaPropertiesSimpleConversion(translateTo.getServiceTemplate(),translateTo
            .getResourceId(),translateTo.getResource().getProperties(),
            relationTemplate.getProperties(), heatFileName,
            translateTo.getHeatOrchestrationTemplate(), translateTo.getResource().getType(),
            relationTemplate, translateTo.getContext()));

    AttachedResourceId attachedVolumeId = getAttachedResourceId(translateTo, volumeIdPropertyName);
    String instanceUuid = HeatConstants.INSTANCE_UUID_PROPERTY_NAME;
    AttachedResourceId attachedNovaServerId = getAttachedResourceId(translateTo, instanceUuid);

    if (attachedNovaServerId.isGetResource()) {
      handleNovaGetResource(translateTo, relationTemplate, relationshipTemplateId, heatFileName,
          attachedVolumeId, (String) attachedNovaServerId.getEntityId());
    } else {
      logger.warn("Heat resource: '" + translateTo.getResourceId() + "' with type: '"
          + translateTo.getResource().getType()
          + "' include 'instance_uuid' property without 'get_resource' function, therefore this "
          + "resource will be ignored in TOSCA translation.");
    }

    mdcDataDebugMessage.debugExitMessage(null, null);
  }

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

  private AttachedResourceId getAttachedResourceId(TranslateTo translateTo, String propertyName) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    Optional<AttachedResourceId> attachedResourceId =
        HeatToToscaUtil.extractAttachedResourceId(translateTo, propertyName);
    if (!attachedResourceId.isPresent()) {
      MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_DB,
          LoggerTragetServiceName.GET_RESOURCE, ErrorLevel.ERROR.name(),
          LoggerErrorCode.DATA_ERROR.getErrorCode(),
          LoggerErrorDescription.MISSING_MANDATORY_PROPERTY);
      throw new CoreException(new MissingMandatoryPropertyErrorBuilder(propertyName).build());
    }

    mdcDataDebugMessage.debugExitMessage(null, null);
    return attachedResourceId.get();
  }

  private void handleNovaGetResource(TranslateTo translateTo, RelationshipTemplate relationTemplate,
                                     String relationshipTemplateId, String heatFileName,
                                     AttachedResourceId volResourceId, String novaResourceId) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    RequirementAssignment requirement = new RequirementAssignment();
    requirement.setCapability(toscaCapabilityAttachment);
    if (volResourceId.isGetResource()) {
      Resource volServerResource = getResource(translateTo.getHeatOrchestrationTemplate(),
          (String) volResourceId.getTranslatedId(), heatFileName);
      if (!StringUtils.equals(HeatResourcesTypes.CINDER_VOLUME_RESOURCE_TYPE.getHeatResource(),
          volServerResource.getType())) {
        logger.warn("Volume attachment with id '" + translateTo.getResourceId()
            + "' is pointing to unsupported resource type(" + volServerResource.getType()
            + ") through the property 'volume_id'."
            + " The connection to the volume is ignored. "
            + "Supported types are: "
            + HeatResourcesTypes.CINDER_VOLUME_RESOURCE_TYPE.getHeatResource());

        mdcDataDebugMessage.debugExitMessage(null, null);
        return;
      }
      requirement.setNode((String) volResourceId.getTranslatedId());
      requirement.setRelationship(relationshipTemplateId);
      DataModelUtil
          .addRelationshipTemplate(translateTo.getServiceTemplate(), relationshipTemplateId,
              relationTemplate);
    } else if (volResourceId.isGetParam() && volResourceId.getEntityId() instanceof String) {
      String volumeResourceIdParamName = (String) volResourceId.getEntityId();
      if (translateTo.getContext().getHeatSharedResourcesByParam()
          .containsKey(volumeResourceIdParamName) && !isHeatFileNested(translateTo, heatFileName)) {
        Resource volServerResource =
            translateTo.getContext().getHeatSharedResourcesByParam().get(volumeResourceIdParamName)
                .getHeatResource();
        if (!StringUtils.equals(HeatResourcesTypes.CINDER_VOLUME_RESOURCE_TYPE.getHeatResource(),
            volServerResource.getType())) {
          logger.warn("Volume attachment with id '" + translateTo.getResourceId()
              + "' is pointing to unsupported resource type(" + volServerResource.getType()
              + ") through the property 'volume_id'."
              + " The connection to the volume is ignored. "
              + "Supported types are: "
              + HeatResourcesTypes.CINDER_VOLUME_RESOURCE_TYPE.getHeatResource());

          mdcDataDebugMessage.debugExitMessage(null, null);
          return;
        }
        requirement.setNode(
            translateTo.getContext().getHeatSharedResourcesByParam().get(volumeResourceIdParamName)
                .getTranslatedId());
        requirement.setRelationship(relationshipTemplateId);
        DataModelUtil
            .addRelationshipTemplate(translateTo.getServiceTemplate(), relationshipTemplateId,
                relationTemplate);
      } else {
        handleUnsharedVolume(translateTo, relationTemplate, relationshipTemplateId, heatFileName,
            requirement, volumeResourceIdParamName);
      }
    }
    Resource novaServerResource =
        getResource(translateTo.getHeatOrchestrationTemplate(), novaResourceId, heatFileName);
    if (!StringUtils.equals(HeatResourcesTypes.NOVA_SERVER_RESOURCE_TYPE.getHeatResource(),
        novaServerResource.getType())) {
      logger.warn("Volume attachment with id '" + translateTo.getResourceId()
          + "' is pointing to unsupported resource type(" + novaServerResource.getType()
          + ") through the property 'instance_uuid'."
          + " The connection to the nova server is ignored. "
          + "Supported types are: "
          + HeatResourcesTypes.NOVA_SERVER_RESOURCE_TYPE.getHeatResource());

      mdcDataDebugMessage.debugExitMessage(null, null);
      return;
    }
    Optional<String> translatedNovaServerId =
        ResourceTranslationFactory.getInstance(novaServerResource)
            .translateResource(heatFileName, translateTo.getServiceTemplate(),
                translateTo.getHeatOrchestrationTemplate(), novaServerResource, novaResourceId,
                translateTo.getContext());

    if (translatedNovaServerId.isPresent() && StringUtils.isNotEmpty(requirement.getNode())) {
      NodeTemplate novaServerNodeTemplate = DataModelUtil
          .getNodeTemplate(translateTo.getServiceTemplate(), translatedNovaServerId.get());
      DataModelUtil.addRequirementAssignment(novaServerNodeTemplate, ToscaConstants
          .LOCAL_STORAGE_REQUIREMENT_ID, requirement);
      //Add volume information to consolidation data
      ConsolidationDataUtil.updateComputeConsolidationDataVolumes(translateTo,
          novaServerNodeTemplate.getType(), translatedNovaServerId.get(), ToscaConstants
          .LOCAL_STORAGE_REQUIREMENT_ID, requirement);
    }

    mdcDataDebugMessage.debugExitMessage(null, null);
  }

  private void handleUnsharedVolume(TranslateTo translateTo, RelationshipTemplate relationTemplate,
                                    String relationshipTemplateId, String heatFileName,
                                    RequirementAssignment requirement, String volumeResourceId) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    List<FileData> allFilesData = translateTo.getContext().getManifest().getContent().getData();
    Optional<FileData> fileData = HeatToToscaUtil.getFileData(heatFileName, allFilesData);
    if (fileData.isPresent()) {
      Optional<ResourceFileDataAndIDs> fileDataContainingResource =
          new VolumeTranslationHelper(logger)
              .getFileDataContainingVolume(fileData.get().getData(), volumeResourceId, translateTo,
                  FileData.Type.HEAT_VOL);
      fileDataContainingResource.ifPresent(
          resourceFileDataAndIDs -> addRelationshipToServiceTemplate(translateTo, relationTemplate,
              relationshipTemplateId, requirement, resourceFileDataAndIDs));
    }

    mdcDataDebugMessage.debugExitMessage(null, null);
  }

  private boolean isHeatFileNested(TranslateTo translateTo, String heatFileName) {
    return translateTo.getContext().getNestedHeatsFiles().contains(heatFileName);
  }

  private void addRelationshipToServiceTemplate(TranslateTo translateTo,
                                                RelationshipTemplate relationTemplate,
                                                String relationshipTemplateId,
                                                RequirementAssignment requirement,
                                                ResourceFileDataAndIDs resourceFileDataAndIDs) {


    mdcDataDebugMessage.debugEntryMessage(null, null);

    String translatedId = resourceFileDataAndIDs.getTranslatedResourceId();
    String toscaVolIdPropName =
        HeatToToscaUtil.getToscaPropertyName(translateTo, HeatConstants.VOL_ID_PROPERTY_NAME);
    relationTemplate.getProperties().put(toscaVolIdPropName, translatedId);
    requirement.setNode(translatedId);
    requirement.setRelationship(relationshipTemplateId);
    DataModelUtil.addRelationshipTemplate(translateTo.getServiceTemplate(), relationshipTemplateId,
        relationTemplate);

    mdcDataDebugMessage.debugExitMessage(null, null);
  }
}