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