openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-core/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/etsi/ETSIServiceImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019, Nordix Foundation. 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.vendorsoftwareproduct.services.impl.etsi;
  22
  23 import static org.openecomp.sdc.tosca.csar.CSARConstants.ARTIFACTS_FOLDER;
  24 import static org.openecomp.sdc.tosca.csar.CSARConstants.MAIN_SERVICE_TEMPLATE_MF_FILE_NAME;
  25 import static org.openecomp.sdc.tosca.csar.CSARConstants.MANIFEST_PNF_METADATA;
  26 import static org.openecomp.sdc.tosca.csar.CSARConstants.TOSCA_META_ORIG_PATH_FILE_NAME;
  27 import static org.openecomp.sdc.tosca.csar.ManifestTokenType.COMPATIBLE_SPECIFICATION_VERSIONS;
  28 import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ENTRY_DEFINITIONS;
  29 import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ETSI_ENTRY_CHANGE_LOG;
  30 import static org.openecomp.sdc.tosca.csar.ToscaMetaEntry.ETSI_ENTRY_MANIFEST;
  31 import static org.openecomp.sdc.tosca.csar.ToscaMetadataFileInfo.TOSCA_META_PATH_FILE_NAME;
  32 import static org.openecomp.sdc.tosca.csar.CSARConstants.ETSI_VERSION_2_6_1;
  33
  34 import java.io.IOException;
  35 import java.io.InputStream;
  36 import java.nio.file.Path;
  37 import java.nio.file.Paths;
  38 import java.util.Arrays;
  39 import java.util.HashMap;
  40 import java.util.List;
  41 import java.util.Map;
  42 import java.util.Objects;
  43 import java.util.Optional;
  44 import java.util.stream.Collectors;
  45
  46 import org.apache.commons.collections.MapUtils;
  47 import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;
  48 import org.onap.sdc.tosca.services.YamlUtil;
  49 import org.openecomp.core.utilities.file.FileContentHandler;
  50 import org.openecomp.sdc.be.config.NonManoConfiguration;
  51 import org.openecomp.sdc.be.config.NonManoConfigurationManager;
  52 import org.openecomp.sdc.be.config.NonManoFolderType;
  53 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
  54 import org.openecomp.sdc.logging.api.Logger;
  55 import org.openecomp.sdc.logging.api.LoggerFactory;
  56 import org.openecomp.sdc.tosca.csar.Manifest;
  57 import org.openecomp.sdc.tosca.csar.OnboardingToscaMetadata;
  58 import org.openecomp.sdc.tosca.csar.SOL004ManifestOnboarding;
  59 import org.openecomp.sdc.tosca.csar.ToscaMetadata;
  60 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
  61
  62 import com.vdurmont.semver4j.Semver;
  63
  64 public class ETSIServiceImpl implements ETSIService {
  65
  66     private static final Logger LOGGER = LoggerFactory.getLogger(ETSIServiceImpl.class);
  67
  68     private final NonManoConfiguration nonManoConfiguration;
  69
  70     public ETSIServiceImpl() {
  71         nonManoConfiguration = NonManoConfigurationManager.getInstance().getNonManoConfiguration();
  72     }
  73
  74     public ETSIServiceImpl(final NonManoConfiguration nonManoConfiguration) {
  75         this.nonManoConfiguration = nonManoConfiguration;
  76     }
  77
  78     @Override
  79     public boolean isSol004WithToscaMetaDirectory(FileContentHandler handler) throws IOException {
  80         final Map<String, byte[]> templates = handler.getFiles();
  81         return isMetaFilePresent(templates) && hasMetaMandatoryEntries(getMetadata(handler));
  82     }
  83
  84     @Override
  85     public Optional<Map<String, Path>> moveNonManoFileToArtifactFolder(final FileContentHandler handler) throws IOException {
  86         final Manifest manifest;
  87         try {
  88             manifest = getManifest(handler);
  89         } catch (final IOException ex) {
  90             if (LOGGER.isErrorEnabled()) {
  91                 LOGGER.error("An error occurred while getting the manifest file", ex);
  92             }
  93             throw ex;
  94         }
  95         final Path originalManifestPath;
  96         try {
  97             originalManifestPath = getOriginalManifestPath(handler);
  98         } catch (final IOException ex) {
  99             if (LOGGER.isErrorEnabled()) {
 100                 LOGGER.error("An error occurred while getting the original manifest path", ex);
 101             }
 102             throw ex;
 103         }
 104         final Map<String, Path> fromToPathMap = new HashMap<>();
 105         final Map<String, NonManoFolderType> nonManoKeyFolderMapping = nonManoConfiguration.getNonManoKeyFolderMapping();
 106         manifest.getNonManoSources().entrySet().stream()
 107             .filter(manifestNonManoSourceEntry -> nonManoKeyFolderMapping.containsKey(manifestNonManoSourceEntry.getKey()))
 108             .forEach(manifestNonManoSourceEntry -> {
 109                 final NonManoFolderType nonManoFolderType = nonManoKeyFolderMapping.get(manifestNonManoSourceEntry.getKey());
 110                 final List<String> nonManoFileList = manifestNonManoSourceEntry.getValue();
 111                 final Map<String, Path> actualFromToPathMap = nonManoFileList.stream()
 112                     .map(nonManoFilePath -> {
 113                         final Path normalizedFilePath = resolveNonManoFilePath(originalManifestPath, nonManoFilePath);
 114                         final Optional<Path> changedPath = updateNonManoPathInHandler(handler, nonManoFolderType, normalizedFilePath);
 115                         if (changedPath.isPresent()) {
 116                             final Map<String, Path> fromAndToPathMap = new HashMap<>();
 117                             fromAndToPathMap.put(nonManoFilePath, Paths.get(ARTIFACTS_FOLDER).resolve(changedPath.get()));
 118                             return fromAndToPathMap;
 119                         }
 120                         return null;
 121                     })
 122                     .filter(Objects::nonNull)
 123                     .collect(Collectors.toMap(
 124                         fromToPathEntry -> fromToPathEntry.keySet().iterator().next(),
 125                         fromToPathEntry -> fromToPathEntry.values().iterator().next()
 126                     ));
 127                 fromToPathMap.putAll(actualFromToPathMap);
 128             });
 129
 130         return MapUtils.isEmpty(fromToPathMap) ? Optional.empty() : Optional.of(fromToPathMap);
 131     }
 132
 133     /**
 134      * Resolves the non mano file path based on the original manifest path of the onboarded package.
 135      *
 136      * @param originalManifestPath The original path from the onboarded package manifest
 137      * @param nonManoFilePath The non mano file path defined in the manifest
 138      * @return The resolved and normalized non mano path.
 139      */
 140     private Path resolveNonManoFilePath(final Path originalManifestPath, final String nonManoFilePath) {
 141         return originalManifestPath.resolve(Paths.get(nonManoFilePath)).normalize();
 142     }
 143
 144     /**
 145      * Updates the non mano file path in the package file handler based on the non mano type.
 146      *
 147      * @param handler The package file handler
 148      * @param nonManoFolderType The Non Mano type of the file to update
 149      * @param nonManoOriginalFilePath The Non Mano file original path
 150      * @return The new file path if it was updated in the package file handler, otherwise empty.
 151      */
 152     private Optional<Path> updateNonManoPathInHandler(final FileContentHandler handler, final NonManoFolderType nonManoFolderType,
 153                                                       final Path nonManoOriginalFilePath) {
 154         final Path fixedSourcePath = fixNonManoPath(nonManoOriginalFilePath);
 155         if (handler.containsFile(fixedSourcePath.toString())) {
 156             final Path newNonManoPath = Paths.get(nonManoFolderType.getType(), nonManoFolderType.getLocation()
 157                 , fixedSourcePath.getFileName().toString());
 158             if (!handler.containsFile(newNonManoPath.toString())) {
 159                 handler.addFile(newNonManoPath.toString(), handler.remove(fixedSourcePath.toString()));
 160                 return Optional.of(newNonManoPath);
 161             }
 162         }
 163
 164         return Optional.empty();
 165     }
 166
 167     /**
 168      * Fix the original non mano file path to the ONAP package file path.
 169      *
 170      * Non mano artifacts that were inside the {@link org.openecomp.sdc.tosca.csar.CSARConstants#ARTIFACTS_FOLDER} path
 171      * are not moved when parsed to ONAP package, but the Manifest declaration can still have the {@link
 172      * org.openecomp.sdc.tosca.csar.CSARConstants#ARTIFACTS_FOLDER} reference in it. If so, that reference is removed.
 173      *
 174      * @param nonManoOriginalFilePath The original non mano file path
 175      * @return The non mano fixed path to ONAP package structure.
 176      */
 177     private Path fixNonManoPath(final Path nonManoOriginalFilePath) {
 178         final Path rootArtifactsPath = Paths.get("/", ARTIFACTS_FOLDER);
 179         if (nonManoOriginalFilePath.startsWith(rootArtifactsPath)) {
 180             return rootArtifactsPath.relativize(nonManoOriginalFilePath);
 181         }
 182         final Path relativeArtifactsPath = Paths.get(ARTIFACTS_FOLDER);
 183         if (nonManoOriginalFilePath.startsWith(relativeArtifactsPath)) {
 184             return relativeArtifactsPath.relativize(nonManoOriginalFilePath);
 185         }
 186
 187         return nonManoOriginalFilePath;
 188     }
 189
 190     @Override
 191     public void updateMainDescriptorPaths(final ToscaServiceModel toscaServiceModel,
 192                                           final Map<String, Path> fromToMovedArtifactMap) {
 193         final ServiceTemplate entryDefinition = toscaServiceModel.getServiceTemplates()
 194             .get(toscaServiceModel.getEntryDefinitionServiceTemplate());
 195         final YamlUtil yamlUtil = new YamlUtil();
 196         final String[] entryDefinitionYaml = {yamlUtil.objectToYaml(entryDefinition)};
 197         fromToMovedArtifactMap.forEach((fromPath, toPath) -> entryDefinitionYaml[0] = entryDefinitionYaml[0]
 198             .replaceAll(fromPath, toPath.toString()));
 199
 200         toscaServiceModel.addServiceTemplate(toscaServiceModel.getEntryDefinitionServiceTemplate()
 201             , yamlUtil.yamlToObject(entryDefinitionYaml[0], ServiceTemplate.class));
 202     }
 203
 204     private boolean hasMetaMandatoryEntries(final ToscaMetadata toscaMetadata) {
 205         final Map<String, String> metaDataEntries = toscaMetadata.getMetaEntries();
 206         return metaDataEntries.containsKey(ENTRY_DEFINITIONS.getName()) && metaDataEntries
 207             .containsKey(ETSI_ENTRY_MANIFEST.getName())
 208             && metaDataEntries.containsKey(ETSI_ENTRY_CHANGE_LOG.getName());
 209     }
 210
 211     @Override
 212     public Semver getHighestCompatibleSpecificationVersion(final FileContentHandler handler) {
 213         try {
 214             Map<String, String> metadata = getManifest(handler).getMetadata();
 215             if (metadata.containsKey(COMPATIBLE_SPECIFICATION_VERSIONS.getToken())) {
 216                 return Arrays.asList(metadata.get(COMPATIBLE_SPECIFICATION_VERSIONS.getToken()).split(","))
 217                         .stream().map(Semver::new).max((v1, v2) -> v1.compareTo(v2))
 218                         .orElse(new Semver(ETSI_VERSION_2_6_1));
 219             }
 220         } catch (Exception ex) {
 221             LOGGER.error("An error occurred while getting highest compatible version from manifest file", ex);
 222         }
 223         return new Semver(ETSI_VERSION_2_6_1);
 224
 225     }
 226
 227     private boolean isMetaFilePresent(Map<String, byte[]> handler) {
 228         return handler.containsKey(TOSCA_META_PATH_FILE_NAME) || handler.containsKey(TOSCA_META_ORIG_PATH_FILE_NAME);
 229     }
 230
 231     public ResourceTypeEnum getResourceType(FileContentHandler handler) throws IOException {
 232         ToscaMetadata metadata = getMetadata(handler);
 233         Manifest manifest = getManifest(handler, metadata.getMetaEntries().get(ETSI_ENTRY_MANIFEST.getName()));
 234         return getResourceType(manifest);
 235     }
 236
 237     public ResourceTypeEnum getResourceType(Manifest manifest) {
 238         // Valid manifest should contain whether vnf or pnf related metadata data exclusively in SOL004 standard,
 239         // validation of manifest done during package upload stage
 240         if (manifest != null && !manifest.getMetadata().isEmpty()
 241             && MANIFEST_PNF_METADATA.stream().anyMatch(e -> manifest.getMetadata().containsKey(e))) {
 242             return ResourceTypeEnum.PNF;
 243         }
 244         // VNF is default resource type
 245         return ResourceTypeEnum.VF;
 246     }
 247
 248     public Manifest getManifest(FileContentHandler handler) throws IOException {
 249         ToscaMetadata metadata = getMetadata(handler);
 250         return getManifest(handler, metadata.getMetaEntries().get(ETSI_ENTRY_MANIFEST.getName()));
 251     }
 252
 253     private Manifest getManifest(FileContentHandler handler, String manifestLocation) throws IOException {
 254         try (InputStream manifestInputStream = getManifestInputStream(handler, manifestLocation)) {
 255             Manifest onboardingManifest = new SOL004ManifestOnboarding();
 256             onboardingManifest.parse(manifestInputStream);
 257             return onboardingManifest;
 258         }
 259     }
 260
 261     public Path getOriginalManifestPath(final FileContentHandler handler) throws IOException {
 262         final ToscaMetadata metadata = getOriginalMetadata(handler);
 263         final String originalMetadataPath = metadata.getMetaEntries().get(ETSI_ENTRY_MANIFEST.getName());
 264         final Path path = Paths.get(originalMetadataPath);
 265         return path.getParent() == null ? Paths.get("") : path.getParent();
 266     }
 267
 268     private ToscaMetadata getMetadata(FileContentHandler handler) throws IOException {
 269         ToscaMetadata metadata;
 270         if (handler.containsFile(TOSCA_META_PATH_FILE_NAME)) {
 271             metadata = OnboardingToscaMetadata
 272                 .parseToscaMetadataFile(handler.getFileContentAsStream(TOSCA_META_PATH_FILE_NAME));
 273         } else if (handler.containsFile(TOSCA_META_ORIG_PATH_FILE_NAME)) {
 274             metadata = OnboardingToscaMetadata
 275                 .parseToscaMetadataFile(handler.getFileContentAsStream(TOSCA_META_ORIG_PATH_FILE_NAME));
 276         } else {
 277             throw new IOException("TOSCA.meta file not found!");
 278         }
 279         return metadata;
 280     }
 281
 282     private ToscaMetadata getOriginalMetadata(final FileContentHandler handler) throws IOException {
 283         if (handler.containsFile(TOSCA_META_ORIG_PATH_FILE_NAME)) {
 284             return OnboardingToscaMetadata
 285                 .parseToscaMetadataFile(handler.getFileContentAsStream(TOSCA_META_ORIG_PATH_FILE_NAME));
 286         } else {
 287             throw new IOException(String.format("%s file not found", TOSCA_META_ORIG_PATH_FILE_NAME));
 288         }
 289     }
 290
 291     private InputStream getManifestInputStream(FileContentHandler handler, String manifestLocation) throws IOException {
 292         InputStream io;
 293         if (manifestLocation == null || !handler.containsFile(manifestLocation)) {
 294             io = handler.getFileContentAsStream(MAIN_SERVICE_TEMPLATE_MF_FILE_NAME);
 295         } else {
 296             io = handler.getFileContentAsStream(manifestLocation);
 297         }
 298
 299         if (io == null) {
 300             throw new IOException("Manifest file not found!");
 301         }
 302         return io;
 303     }
 304
 305     public NonManoConfiguration getConfiguration() {
 306         return nonManoConfiguration;
 307     }
 308 }