/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* Copyright © 2017-2018 European Software Marketing Ltd.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.aai.babel.csar.vnfcatalog;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.time.StopWatch;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.onap.aai.babel.logging.ApplicationMsgs;
import org.onap.aai.babel.logging.LogHelper;
import org.onap.aai.babel.service.data.BabelArtifact;
import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
import org.onap.sdc.tosca.parser.enums.SdcTypes;
import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException;
import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
import org.onap.sdc.toscaparser.api.NodeTemplate;
import org.onap.sdc.toscaparser.api.SubstitutionMappings;
/**
* This class is responsible for extracting Virtual Network Function (VNF) information from a TOSCA 1.1 CSAR package.
*
*
* CSAR is a compressed format that stores multiple TOSCA files. Each TOSCA file may define Topology Templates and/or
* Node Templates along with other model data.
*
*
*
* A VNF is a virtualized functional capability (e.g. a Router) that may be defined by an external Vendor. Within the
* model defined by the TOSCA files the VNF is considered to be a Resource (part of a Service).
*
*
*
* A VNF is specified by a Topology Template. Because this TOSCA construct does not allow properties to be defined
* directly, Node Templates are defined (identified by a VNF type value) storing the VNF metadata and properties.
*
*
*
* A VNF may be composed of multiple images, each running on its own Virtual Machine. The function of a deployed image
* is designated the Virtual Function Component (VFC). A VFC is a sub-component of the VNF. A VFC may have different
* "Flavors" (see the Deployment Flavors description below).
*
*
*
* An individual VNF (template) may be deployed with varying configuration values, according to
* environment/customer/business needs. For example, a VNF deployed in a testing environment would typically use fewer
* computational resources than in a production setting.
*
*
*
* A Vendor may define one or more "Deployment Flavors". A Deployment Flavor describes a set of pre-determined
* parameterised values for a specific aspect of the model. Within the TOSCA model there is a DeploymentFlavor
* definition, which has its own data types, and also an ImageInfo definition.
*
*/
public class VnfVendorImageExtractor {
private static LogHelper applicationLogger = LogHelper.INSTANCE;
// The following constants describe the expected naming conventions for TOSCA Node Templates which
// store the VNF configuration and the VFC data items.
// The name of the property (for a VNF Configuration type) storing the Images Information
private static final String IMAGES = "images";
// Name of property key that contains the value of the software version
private static final String SOFTWARE_VERSION = "software_version";
// The name of the property (for a VNF Configuration type) storing the Vendor Information
private static final String VNF_CONF_TYPE_PROPERTY_VENDOR_INFO_CONTAINER = "allowed_flavors";
// Name of property key that contains the value of model of the Vendor application
private static final String VENDOR_MODEL = "vendor_model";
/**
* This method is responsible for parsing the vnfConfiguration entity in the same topology_template (there's an
* assumption that there's only one per file, awaiting verification).
*
*
* It is possible that CSAR file does not contain a vnfConfiguration and this is valid.
*
*
*
* Where multiple vnfConfigurations are found an exception will be thrown.
*
*
*
* The ASDC model anticipates the following permutations of vnfConfiguration and multiflavorVFC:
*
*
*
* - Single vnfConfiguration, single multiFlavorVFC with multiple images.
* - Single vnfConfiguration, multi multiFlavorVFC with single images.
*
*
*
* All ImageInfo sections found apply to all "Deployment Flavors", therefore we can apply a cross product of
* "Deployment Flavors" x "ImageInfo"
*
*
* @param csar compressed format that stores multiple TOSCA files and in particular a vnfConfiguration
* @return BabelArtifact VendorImageConfiguration objects created during processing represented as the Babel service
* public data structure
* @throws ToscaToCatalogException if the CSAR content is not valid
*/
public BabelArtifact extract(byte[] csar) throws ToscaToCatalogException {
StopWatch stopwatch = new StopWatch();
stopwatch.start();
Objects.requireNonNull(csar, "A CSAR file must be supplied");
applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Extracting VNF Configuration data");
List vendorImageConfigurations;
Path path = null;
try {
path = createTempFile(csar);
vendorImageConfigurations = createVendorImageConfigurations(path.toAbsolutePath().toString());
} catch (InvalidNumberOfNodesException | IOException | SdcToscaParserException e) {
throw new ToscaToCatalogException(
"An error occurred trying to get the VNF Catalog from a CSAR file. " + e.getLocalizedMessage(), e);
} finally {
if (path != null) {
FileUtils.deleteQuietly(path.toFile());
}
}
applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, vendorImageConfigurations.toString());
applicationLogger.logMetrics(stopwatch, LogHelper.getCallerMethodName(0));
return ConfigurationsToBabelArtifactConverter.convert(vendorImageConfigurations);
}
/**
* Creates a temporary file to store the CSAR content.
*
* @param bytes the CSAR content
* @return Path to a temporary file containing the CSAR bytes
* @throws IOException if an I/O error occurs or the temporary-file directory does not exist
*/
private Path createTempFile(byte[] bytes) throws IOException {
Path path = Files.createTempFile("temp", ".csar");
applicationLogger.debug("Created temp file " + path);
Files.write(path, bytes);
return path;
}
/**
* Build VNF Vendor Image Configurations for the VNF Configuration node (if present) in the CSAR file referenced by
* the supplied Path.
*
* @param csarFilepath the path to the CSAR file
* @return a List of Vendor Image Configurations
* @throws SdcToscaParserException
* @throws ToscaToCatalogException
* @throws InvalidNumberOfNodesException
*/
private List createVendorImageConfigurations(String csarFilepath)
throws SdcToscaParserException, ToscaToCatalogException, InvalidNumberOfNodesException {
List vendorImageConfigurations = new ArrayList<>();
ISdcCsarHelper csarHelper = SdcToscaParserFactory.getInstance().getSdcCsarHelper(csarFilepath);
NodeTemplate vnfConfigurationNode = findVnfConfigurationNode(csarHelper);
applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT,
String.format("Found VNF Configuration node \"%s\"", vnfConfigurationNode));
if (vnfConfigurationNode != null) {
for (NodeTemplate node : csarHelper.getServiceVfList()) {
vendorImageConfigurations.addAll(buildVendorImageConfigurations(vnfConfigurationNode, node));
}
}
return vendorImageConfigurations;
}
/**
* Find VNF configuration node.
*
* @param csarHelper the csar helper
* @return the node template
* @throws InvalidNumberOfNodesException
*/
private NodeTemplate findVnfConfigurationNode(ISdcCsarHelper csarHelper) throws InvalidNumberOfNodesException {
List nodeTemplates = csarHelper.getServiceNodeTemplateBySdcType(SdcTypes.VF);
applicationLogger.debug(nodeTemplates.toString());
List configNodes = nodeTemplates.stream() //
.map(serviceNodeTemplate -> {
String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNodeTemplate);
applicationLogger.debug(serviceNodeTemplate + " Customization UUID is " + uuid);
return csarHelper.getVnfConfig(uuid);
}) //
.filter(Objects::nonNull) //
.collect(Collectors.toList());
if (configNodes.size() > 1) {
throw new InvalidNumberOfNodesException("Only one vnf configuration node is allowed however "
+ configNodes.size() + " nodes were found in the csar.");
}
return configNodes.size() == 1 ? configNodes.get(0) : null;
}
/**
* Builds the Vendor image configurations.
*
* @param vendorInfoNode the vendor info node
* @param node the node
* @return the list
* @throws ToscaToCatalogException if there are no software versions
*/
private List buildVendorImageConfigurations(NodeTemplate vendorInfoNode,
NodeTemplate node) throws ToscaToCatalogException {
List vendorImageConfigurations = new ArrayList<>();
List softwareVersions = extractSoftwareVersions(node.getSubMappingToscaTemplate());
Consumer super Pair> buildConfigurations =
vi -> vendorImageConfigurations.addAll(softwareVersions.stream() //
.map(sv -> (new VendorImageConfiguration(vi.getRight(), vi.getLeft(), sv)))
.collect(Collectors.toList()));
String resourceVendor = node.getMetaData().getValue("resourceVendor");
applicationLogger.debug("Resource Vendor " + resourceVendor);
buildVendorInfo(resourceVendor, vendorInfoNode).forEach(buildConfigurations);
applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT,
"Built " + vendorImageConfigurations.size() + " Vendor Image Configurations");
return vendorImageConfigurations;
}
/**
* Builds the Vendor info.
*
* @param resourceVendor the resource vendor
* @param vendorInfoNode the vendor info node
* @return the list
*/
@SuppressWarnings("unchecked")
private List> buildVendorInfo(String resourceVendor, NodeTemplate vendorInfoNode) {
Map otherFlavorProperties =
(Map) vendorInfoNode.getPropertyValue(VNF_CONF_TYPE_PROPERTY_VENDOR_INFO_CONTAINER);
return otherFlavorProperties.keySet().stream()
.map(key -> createVendorInfoPair((Map) otherFlavorProperties.get(key), resourceVendor))
.collect(Collectors.toList());
}
/**
* Creates the Vendor info pair.
*
* @param otherFlavor the other flavor
* @param resourceVendor the resource Vendor
* @return the pair
*/
private Pair createVendorInfoPair(Map otherFlavor, String resourceVendor) {
@SuppressWarnings("unchecked")
String vendorModel = otherFlavor.entrySet().stream() //
.filter(entry -> "vendor_info".equals(entry.getKey()))
.map(e -> ((Map) e.getValue()).get(VENDOR_MODEL)) //
.findFirst().orElse(null);
applicationLogger.debug("Creating Vendor info pair object for vendorModel = " + vendorModel
+ " and resourceVendor = " + resourceVendor);
return new ImmutablePair<>(resourceVendor, vendorModel);
}
/**
* Extract software versions.
*
* @param sm the substitution mappings
* @return a List of Software Version Strings
* @throws ToscaToCatalogException the tosca to catalog exception
*/
@SuppressWarnings("unchecked")
List extractSoftwareVersions(SubstitutionMappings sm) throws ToscaToCatalogException {
applicationLogger.debug("Extracting software versions from " + sm);
List imagesNodes = sm.getNodeTemplates().stream()
.filter(nodeTemplate -> nodeTemplate.getPropertyValue(IMAGES) != null).collect(Collectors.toList());
if (imagesNodes != null && !imagesNodes.isEmpty()) {
return imagesNodes.stream()
.flatMap(imagesNode -> ((Map) imagesNode.getPropertyValue(IMAGES)) //
.entrySet().stream())
.map(property -> findSoftwareVersion((Map) property.getValue()))
.collect(Collectors.toList());
} else {
throw new ToscaToCatalogException("No software versions could be found for this CSAR file");
}
}
/**
* Get the first software version value from the properties Map.
*
* @param image the properties Map
* @return the software version value as a String
*/
private String findSoftwareVersion(Map image) {
applicationLogger.debug("Finding " + SOFTWARE_VERSION + " from " + image);
return (String) image.entrySet().stream()//
.filter(entry -> SOFTWARE_VERSION.equals(entry.getKey())) //
.map(Entry::getValue).findFirst().orElse(null);
}
}