catalog-be-plugins/etsi-nfv-nsd-csar-plugin/src/main/java/org/openecomp/sdc/be/plugins/etsi/nfv/nsd/generator/EtsiNfvNsCsarEntryGenerator.java

   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 static org.openecomp.sdc.common.api.ArtifactTypeEnum.ETSI_PACKAGE;
  22
  23 import java.util.Collections;
  24 import java.util.HashMap;
  25 import java.util.Map;
  26 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  27 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.generator.config.CategoriesToGenerateNsd;
  28 import org.openecomp.sdc.be.model.Component;
  29 import org.openecomp.sdc.be.plugins.CsarEntryGenerator;
  30 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.exception.NsdException;
  31 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.factory.EtsiNfvNsdCsarGeneratorFactory;
  32 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.generator.config.EtsiVersion;
  33 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.model.NsdCsar;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Generates a Network Service CSAR based on a SERVICE component and wraps it in a SDC CSAR entry.
  39  */
  40 @org.springframework.stereotype.Component("etsiNfvNsCsarEntryGenerator")
  41 public class EtsiNfvNsCsarEntryGenerator implements CsarEntryGenerator {
  42
  43     static final String NSD_FILE_PATH_FORMAT = "Artifacts/%s/%s.%s";
  44     static final String SIGNED_CSAR_EXTENSION = "zip";
  45     static final String UNSIGNED_CSAR_EXTENSION = "csar";
  46     static final String ETSI_VERSION_METADATA = "ETSI Version";
  47     private static final Logger LOGGER = LoggerFactory.getLogger(EtsiNfvNsCsarEntryGenerator.class);
  48     private final EtsiNfvNsdCsarGeneratorFactory etsiNfvNsdCsarGeneratorFactory;
  49
  50     public EtsiNfvNsCsarEntryGenerator(final EtsiNfvNsdCsarGeneratorFactory etsiNfvNsdCsarGeneratorFactory) {
  51         this.etsiNfvNsdCsarGeneratorFactory = etsiNfvNsdCsarGeneratorFactory;
  52     }
  53
  54     /**
  55      * Generates a Network Service CSAR based on a SERVICE component that has category configured in
  56      * {@link CategoriesToGenerateNsd } enum and wraps it in a SDC CSAR entry.
  57      *
  58      * @param component the component to create the NS CSAR from
  59      * @return an entry to be added in the Component CSAR by SDC
  60      */
  61     @Override
  62     public Map<String, byte[]> generateCsarEntries(final Component component) {
  63         final String componentName = component == null ? "null" : component.getName();
  64         if (component == null || ComponentTypeEnum.SERVICE != component.getComponentType()) {
  65             LOGGER.debug("Ignoring NSD CSAR generation for component '{}' as it is not a SERVICE", componentName);
  66             return Collections.emptyMap();
  67         }
  68         final boolean isEOTemplate = component.getCategories().stream().anyMatch(category ->
  69                 CategoriesToGenerateNsd.hasCategoryName(category.getName()));
  70         if (!isEOTemplate) {
  71             LOGGER.debug("Ignoring NSD CSAR generation for component '{}' as it does not belong to any of the categories '{}'",
  72                     componentName, CategoriesToGenerateNsd.getCategories());
  73             return Collections.emptyMap();
  74         }
  75
  76         final NsdCsar nsdCsar;
  77         try {
  78             final EtsiVersion etsiVersion = getComponentEtsiVersion(component);
  79             final EtsiNfvNsdCsarGenerator etsiNfvNsdCsarGenerator = etsiNfvNsdCsarGeneratorFactory.create(etsiVersion);
  80             nsdCsar = etsiNfvNsdCsarGenerator.generateNsdCsar(component);
  81         } catch (final NsdException e) {
  82             LOGGER.error("Could not create NSD CSAR entry for component '{}'", component.getName(), e);
  83             return Collections.emptyMap();
  84         } catch (final Exception e) {
  85             LOGGER.error("Could not create NSD CSAR entry for component '{}'. An unexpected exception occurred", component.getName(), e);
  86             return Collections.emptyMap();
  87         }
  88
  89         return createEntry(nsdCsar);
  90     }
  91
  92     private EtsiVersion getComponentEtsiVersion(Component component) {
  93         final String etsiVersion = component.getCategorySpecificMetadata().get(ETSI_VERSION_METADATA);
  94         return EtsiVersion.convertOrNull(etsiVersion);
  95     }
  96
  97     private Map<String, byte[]> createEntry(final NsdCsar nsdCsar) {
  98         final Map<String, byte[]> entryMap = new HashMap<>();
  99         final String extension = nsdCsar.isSigned() ? SIGNED_CSAR_EXTENSION : UNSIGNED_CSAR_EXTENSION;
 100         final String entryKey = String.format(NSD_FILE_PATH_FORMAT, ETSI_PACKAGE, nsdCsar.getFileName(), extension);
 101         entryMap.put(entryKey, nsdCsar.getCsarPackage());
 102         return entryMap;
 103     }
 104 }