gerrit.onap Code Review - sdc.git/blob

   1  /*
   2   * ============LICENSE_START=======================================================
   3   *  Copyright (C) 2020 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   *  Unless required by applicable law or agreed to in writing, software
  11   *  distributed under the License is distributed on an "AS IS" BASIS,
  12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   *  See the License for the specific language governing permissions and
  14   *  limitations under the License.
  15   *
  16   *  SPDX-License-Identifier: Apache-2.0
  17   *  ============LICENSE_END=========================================================
  18   */
  19  package org.openecomp.sdc.be.plugins.etsi.nfv.nsd.generator;
  20
  21  import java.io.ByteArrayInputStream;
  22  import java.io.FileNotFoundException;
  23  import java.io.IOException;
  24  import java.io.InputStream;
  25  import java.nio.charset.StandardCharsets;
  26  import java.util.Collections;
  27  import java.util.HashMap;
  28  import java.util.List;
  29  import java.util.Map;
  30  import java.util.Optional;
  31  import java.util.stream.Collectors;
  32  import org.apache.commons.collections.MapUtils;
  33  import org.apache.commons.io.FilenameUtils;
  34  import org.apache.commons.io.IOUtils;
  35  import org.onap.sdc.tosca.services.YamlUtil;
  36  import org.openecomp.core.utilities.file.FileContentHandler;
  37  import org.openecomp.core.utilities.file.FileUtils;
  38  import org.openecomp.sdc.be.csar.storage.ArtifactStorageManager;
  39  import org.openecomp.sdc.be.csar.storage.StorageFactory;
  40  import org.openecomp.sdc.be.model.ArtifactDefinition;
  41  import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.builder.NsdToscaMetadataBuilder;
  42  import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.exception.VnfDescriptorException;
  43  import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.model.VnfDescriptor;
  44  import org.slf4j.Logger;
  45  import org.slf4j.LoggerFactory;
  46  import org.springframework.stereotype.Component;
  47  import org.yaml.snakeyaml.Yaml;
  48
  49  /**
  50   * Implementation of a VNF Descriptor Generator
  51   */
  52  @Component("vnfPackageGenerator")
  53  public class VnfDescriptorGeneratorImpl implements VnfDescriptorGenerator {
  54
  55      private static final Logger LOGGER = LoggerFactory.getLogger(VnfDescriptorGeneratorImpl.class);
  56      private static final String SPACE_REGEX = "\\s+";
  57      private static final String CSAR = "csar";
  58      private static final String COLON = ":";
  59      private static final String EMPTY_STRING = "";
  60      private static final String SLASH = "/";
  61      private static final String DEFINITIONS_DIRECTORY = "Definitions";
  62      private static final String TOSCA_META_PATH = "TOSCA-Metadata/TOSCA.meta";
  63
  64      private static boolean isACsarArtifact(final ArtifactDefinition definition) {
  65          return definition.getPayloadData() != null && definition.getArtifactName() != null && CSAR
  66              .equalsIgnoreCase(FilenameUtils.getExtension(definition.getArtifactName()));
  67      }
  68
  69      public Optional<VnfDescriptor> generate(final String name, final ArtifactDefinition onboardedPackageArtifact) throws VnfDescriptorException {
  70          if (!isACsarArtifact(onboardedPackageArtifact)) {
  71              return Optional.empty();
  72          }
  73          final FileContentHandler fileContentHandler;
  74          try {
  75              final var artifactStorageManager = new StorageFactory().createArtifactStorageManager();
  76              final byte[] payloadData = onboardedPackageArtifact.getPayloadData();
  77              if (artifactStorageManager.isEnabled()) {
  78                  final var inputStream = artifactStorageManager.get(getFromPayload(payloadData, "bucket"),
  79                      getFromPayload(payloadData, "object") + ".reduced");
  80                  fileContentHandler = FileUtils.getFileContentMapFromZip(inputStream);
  81              } else {
  82                  fileContentHandler = FileUtils.getFileContentMapFromZip(new ByteArrayInputStream(payloadData));
  83              }
  84          } catch (final IOException e) {
  85              final String errorMsg = String.format("Could not unzip artifact '%s' content", onboardedPackageArtifact.getArtifactName());
  86              throw new VnfDescriptorException(errorMsg, e);
  87          }
  88          if (MapUtils.isEmpty(fileContentHandler.getFiles())) {
  89              return Optional.empty();
  90          }
  91          final String mainDefinitionFile;
  92          try {
  93              mainDefinitionFile = getMainFilePathFromMetaFile(fileContentHandler).orElse(null);
  94          } catch (final IOException e) {
  95              final String errorMsg = String.format("Could not read main definition file of artifact '%s'",
  96                  onboardedPackageArtifact.getArtifactName());
  97              throw new VnfDescriptorException(errorMsg, e);
  98          }
  99          LOGGER.debug("found main file: {}", mainDefinitionFile);
 100          if (mainDefinitionFile == null) {
 101              return Optional.empty();
 102          }
 103          final var vnfDescriptor = new VnfDescriptor();
 104          vnfDescriptor.setName(name);
 105          final String vnfdFileName = FilenameUtils.getName(mainDefinitionFile);
 106          vnfDescriptor.setVnfdFileName(vnfdFileName);
 107          vnfDescriptor.setDefinitionFiles(getFiles(fileContentHandler, mainDefinitionFile));
 108          vnfDescriptor.setNodeType(getNodeType(getFileContent(fileContentHandler, mainDefinitionFile)));
 109          return Optional.of(vnfDescriptor);
 110      }
 111
 112      private String getFromPayload(final byte[] payload, final String name) {
 113          final String[] strings = new String(payload).split("\n");
 114          for (final String str : strings) {
 115              if (str.contains(name)) {
 116                  return str.split(": ")[1];
 117              }
 118          }
 119          return "";
 120      }
 121
 122      private Map<String, byte[]> getFiles(final FileContentHandler fileContentHandler, final String filePath) {
 123          final Map<String, byte[]> files = new HashMap<>();
 124          final byte[] fileContent = fileContentHandler.getFileContent(filePath);
 125          if (fileContent != null) {
 126              final String mainYmlFile = new String(fileContent);
 127              LOGGER.debug("file content: {}", mainYmlFile);
 128              files.put(appendDefinitionDirPath(filePath.substring(filePath.lastIndexOf(SLASH) + 1)), getVnfdWithoutTopologyTemplate(fileContent));
 129              final List<Object> imports = getImportFilesPath(mainYmlFile);
 130              LOGGER.info("found imports {}", imports);
 131              for (final Object importObject : imports) {
 132                  if (importObject != null) {
 133                      final String importFilename = importObject.toString();
 134                      final String importFileFullPath = appendDefinitionDirPath(importFilename);
 135                      final byte[] importFileContent = fileContentHandler.getFileContent(importFileFullPath);
 136                      files.put(appendDefinitionDirPath(importFilename), importFileContent);
 137                  }
 138              }
 139          }
 140          return files;
 141      }
 142
 143      private String getFileContent(final FileContentHandler fileContentHandler, final String filePath) {
 144          final byte[] fileContent = fileContentHandler.getFileContent(filePath);
 145          if (fileContent != null) {
 146              return new String(fileContent);
 147          }
 148          return null;
 149      }
 150
 151      private Optional<String> getMainFilePathFromMetaFile(final FileContentHandler fileContentHandler) throws IOException {
 152          final Map<String, String> metaFileContent = getMetaFileContent(fileContentHandler);
 153          final String mainFile = metaFileContent.get(NsdToscaMetadataBuilder.ENTRY_DEFINITIONS);
 154          if (mainFile != null) {
 155              return Optional.of(mainFile.replaceAll(SPACE_REGEX, EMPTY_STRING));
 156          }
 157          LOGGER.error("{} entry not found in {}", NsdToscaMetadataBuilder.ENTRY_DEFINITIONS, TOSCA_META_PATH);
 158          return Optional.empty();
 159      }
 160
 161      private Map<String, String> getMetaFileContent(final FileContentHandler fileContentHandler) throws IOException {
 162          final InputStream inputStream = fileContentHandler.getFileContentAsStream(TOSCA_META_PATH);
 163          if (inputStream == null) {
 164              throw new FileNotFoundException("Unable find " + TOSCA_META_PATH + " file");
 165          }
 166          final List<String> lines = IOUtils.readLines(inputStream, StandardCharsets.UTF_8);
 167          return lines.stream().map(str -> str.split(COLON)).collect(Collectors.toMap(str -> str[0], str -> str.length > 1 ? str[1] : EMPTY_STRING));
 168      }
 169
 170      private String appendDefinitionDirPath(final String filename) {
 171          return DEFINITIONS_DIRECTORY + SLASH + filename;
 172      }
 173
 174      private List<Object> getImportFilesPath(final String mainYmlFile) {
 175          final Map<Object, Object> fileContentMap = new YamlUtil().yamlToObject(mainYmlFile, Map.class);
 176          final Object importsObject = fileContentMap.get("imports");
 177          if (importsObject instanceof List) {
 178              return (List<Object>) importsObject;
 179          }
 180          return Collections.emptyList();
 181      }
 182
 183      private byte[] getVnfdWithoutTopologyTemplate(final byte[] vnfdFileContent) {
 184          final Yaml yaml = new Yaml();
 185          final Map<String, Object> toscaFileContent = (Map<String, Object>) yaml.load(new String(vnfdFileContent));
 186          toscaFileContent.remove("topology_template");
 187          return yaml.dumpAsMap(toscaFileContent).getBytes();
 188      }
 189
 190      private String getNodeType(final String mainYmlFile) {
 191          final Map<Object, Object> fileContentMap = new YamlUtil().yamlToObject(mainYmlFile, Map.class);
 192          final Object nodeTypesObject = fileContentMap.get("node_types");
 193          if (nodeTypesObject instanceof Map && ((Map<String, Object>) nodeTypesObject).size() == 1) {
 194              return ((Map<String, Object>) nodeTypesObject).keySet().iterator().next();
 195          }
 196          return null;
 197      }
 198  }