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
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Nordix Foundation
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.openecomp.sdc.be.plugins.etsi.nfv.nsd.generator;
import java.io.ByteArrayInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOUtils;
import org.onap.sdc.tosca.services.YamlUtil;
import org.openecomp.core.utilities.file.FileContentHandler;
import org.openecomp.core.utilities.file.FileUtils;
import org.openecomp.sdc.be.csar.storage.StorageFactory;
import org.openecomp.sdc.be.model.ArtifactDefinition;
import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.builder.NsdToscaMetadataBuilder;
import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.exception.VnfDescriptorException;
import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.model.VnfDescriptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.yaml.snakeyaml.Yaml;
/**
* Implementation of a VNF Descriptor Generator
*/
@Component("vnfPackageGenerator")
public class VnfDescriptorGeneratorImpl implements VnfDescriptorGenerator {
private static final Logger LOGGER = LoggerFactory.getLogger(VnfDescriptorGeneratorImpl.class);
private static final String SPACE_REGEX = "\\s+";
private static final String CSAR = "csar";
private static final String COLON = ":";
private static final String EMPTY_STRING = "";
private static final String SLASH = "/";
private static final String DEFINITIONS_DIRECTORY = "Definitions";
private static final String TOSCA_META_PATH = "TOSCA-Metadata/TOSCA.meta";
private static boolean isACsarArtifact(final ArtifactDefinition definition) {
return definition.getPayloadData() != null && definition.getArtifactName() != null && CSAR
.equalsIgnoreCase(FilenameUtils.getExtension(definition.getArtifactName()));
}
public Optional<VnfDescriptor> generate(final String name, final ArtifactDefinition onboardedPackageArtifact) throws VnfDescriptorException {
if (!isACsarArtifact(onboardedPackageArtifact)) {
return Optional.empty();
}
final FileContentHandler fileContentHandler;
try {
final var artifactStorageManager = new StorageFactory().createArtifactStorageManager();
final byte[] payloadData = onboardedPackageArtifact.getPayloadData();
if (artifactStorageManager.isEnabled()) {
final var inputStream = artifactStorageManager.get(getFromPayload(payloadData, "bucket"),
getFromPayload(payloadData, "object") + ".reduced");
fileContentHandler = FileUtils.getFileContentMapFromZip(inputStream);
} else {
fileContentHandler = FileUtils.getFileContentMapFromZip(new ByteArrayInputStream(payloadData));
}
} catch (final IOException e) {
final String errorMsg = String.format("Could not unzip artifact '%s' content", onboardedPackageArtifact.getArtifactName());
throw new VnfDescriptorException(errorMsg, e);
}
if (MapUtils.isEmpty(fileContentHandler.getFiles())) {
return Optional.empty();
}
final String mainDefinitionFile;
try {
mainDefinitionFile = getMainFilePathFromMetaFile(fileContentHandler).orElse(null);
} catch (final IOException e) {
final String errorMsg = String.format("Could not read main definition file of artifact '%s'",
onboardedPackageArtifact.getArtifactName());
throw new VnfDescriptorException(errorMsg, e);
}
LOGGER.debug("found main file: {}", mainDefinitionFile);
if (mainDefinitionFile == null) {
return Optional.empty();
}
final var vnfDescriptor = new VnfDescriptor();
vnfDescriptor.setName(name);
final String vnfdFileName = FilenameUtils.getName(mainDefinitionFile);
vnfDescriptor.setVnfdFileName(vnfdFileName);
vnfDescriptor.setDefinitionFiles(getFiles(fileContentHandler, mainDefinitionFile));
vnfDescriptor.setNodeType(getNodeType(getFileContent(fileContentHandler, mainDefinitionFile)));
return Optional.of(vnfDescriptor);
}
private String getFromPayload(final byte[] payload, final String name) {
final String[] strings = new String(payload).split("\n");
for (final String str : strings) {
if (str.contains(name)) {
return str.split(": ")[1];
}
}
return "";
}
private Map<String, byte[]> getFiles(final FileContentHandler fileContentHandler, final String filePath) {
final Map<String, byte[]> files = new HashMap<>();
final byte[] fileContent = fileContentHandler.getFileContent(filePath);
if (fileContent != null) {
final String mainYmlFile = new String(fileContent);
LOGGER.debug("file content: {}", mainYmlFile);
files.put(appendDefinitionDirPath(filePath.substring(filePath.lastIndexOf(SLASH) + 1)), getVnfdWithoutTopologyTemplate(fileContent));
final List<Object> imports = getImportFilesPath(mainYmlFile);
LOGGER.info("found imports {}", imports);
for (final Object importObject : imports) {
if (importObject != null) {
final String importFilename = importObject.toString();
final String importFileFullPath = appendDefinitionDirPath(importFilename);
final byte[] importFileContent = fileContentHandler.getFileContent(importFileFullPath);
files.put(appendDefinitionDirPath(importFilename), importFileContent);
}
}
}
return files;
}
private String getFileContent(final FileContentHandler fileContentHandler, final String filePath) {
final byte[] fileContent = fileContentHandler.getFileContent(filePath);
if (fileContent != null) {
return new String(fileContent);
}
return null;
}
private Optional<String> getMainFilePathFromMetaFile(final FileContentHandler fileContentHandler) throws IOException {
final Map<String, String> metaFileContent = getMetaFileContent(fileContentHandler);
final String mainFile = metaFileContent.get(NsdToscaMetadataBuilder.ENTRY_DEFINITIONS);
if (mainFile != null) {
return Optional.of(mainFile.replaceAll(SPACE_REGEX, EMPTY_STRING));
}
LOGGER.error("{} entry not found in {}", NsdToscaMetadataBuilder.ENTRY_DEFINITIONS, TOSCA_META_PATH);
return Optional.empty();
}
private Map<String, String> getMetaFileContent(final FileContentHandler fileContentHandler) throws IOException {
final InputStream inputStream = fileContentHandler.getFileContentAsStream(TOSCA_META_PATH);
if (inputStream == null) {
throw new FileNotFoundException("Unable find " + TOSCA_META_PATH + " file");
}
final List<String> lines = IOUtils.readLines(inputStream, StandardCharsets.UTF_8);
return lines.stream().map(str -> str.split(COLON)).collect(Collectors.toMap(str -> str[0], str -> str.length > 1 ? str[1] : EMPTY_STRING));
}
private String appendDefinitionDirPath(final String filename) {
return DEFINITIONS_DIRECTORY + SLASH + filename;
}
private List<Object> getImportFilesPath(final String mainYmlFile) {
final Map<Object, Object> fileContentMap = new YamlUtil().yamlToObject(mainYmlFile, Map.class);
final Object importsObject = fileContentMap.get("imports");
if (importsObject instanceof List) {
return (List<Object>) importsObject;
}
return Collections.emptyList();
}
private byte[] getVnfdWithoutTopologyTemplate(final byte[] vnfdFileContent) {
final Yaml yaml = new Yaml();
final Map<String, Object> toscaFileContent = (Map<String, Object>) yaml.load(new String(vnfdFileContent));
toscaFileContent.remove("topology_template");
return yaml.dumpAsMap(toscaFileContent).getBytes();
}
private String getNodeType(final String mainYmlFile) {
final Map<Object, Object> fileContentMap = new YamlUtil().yamlToObject(mainYmlFile, Map.class);
final Object nodeTypesObject = fileContentMap.get("node_types");
if (nodeTypesObject instanceof Map && ((Map<String, Object>) nodeTypesObject).size() == 1) {
return ((Map<String, Object>) nodeTypesObject).keySet().iterator().next();
}
return null;
}
}
|
