X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fonap%2Faai%2Fbabel%2Fcsar%2Fvnfcatalog%2FVnfVendorImageExtractor.java;h=5f3d15bc5a1805cff8cd96e05f8464aef7e252d8;hb=c1824169b0cfa25101c1efa8118d6b0b085edd15;hp=eb841e690f10815952c4729c562c5bb95ef3a334;hpb=1bde7e38ed218f9ba337ee5cd9acfe524206e996;p=aai%2Fbabel.git diff --git a/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java b/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java index eb841e6..5f3d15b 100644 --- a/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java +++ b/src/main/java/org/onap/aai/babel/csar/vnfcatalog/VnfVendorImageExtractor.java @@ -18,31 +18,31 @@ * 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.Collection; +import java.util.Collections; 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 java.util.stream.Stream; 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.parser.ToscaParser; 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.tosca.parser.impl.SdcTypes; 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. @@ -50,38 +50,42 @@ import org.onap.sdc.toscaparser.api.SubstitutionMappings; *

* 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; - private static final String AN_ERROR_OCCURRED = "An error occurred trying to get the vnf catalog from a csar file."; + 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. + // 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"; @@ -92,7 +96,10 @@ public class VnfVendorImageExtractor { // 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 + // Name of property key that contains the Vendor Information + private static final String VENDOR_INFO = "vendor_info"; + + // Name of property key that contains the value of model of the Vendor application private static final String VENDOR_MODEL = "vendor_model"; /** @@ -100,10 +107,12 @@ public class VnfVendorImageExtractor { * 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. + * 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: @@ -116,20 +125,22 @@ public class VnfVendorImageExtractor { * * * All ImageInfo sections found apply to all "Deployment Flavors", therefore we can apply a cross product of - * "Deployment Flavors" x "ImageInfo" - concretely + * "Deployment Flavors" x "ImageInfo" + *

* - * @param csar compressed format that stores multiple TOSCA files and in particular a vnfConfiguration + * @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, - "Starting to find and extract any vnf configuration data"); + applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Extracting VNF Configuration data"); List vendorImageConfigurations; Path path = null; @@ -138,128 +149,168 @@ public class VnfVendorImageExtractor { path = createTempFile(csar); vendorImageConfigurations = createVendorImageConfigurations(path.toAbsolutePath().toString()); } catch (InvalidNumberOfNodesException | IOException | SdcToscaParserException e) { - throw new ToscaToCatalogException(AN_ERROR_OCCURRED + " " + e.getLocalizedMessage(), 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()); } } - String msg = vendorImageConfigurations.isEmpty() ? "No Vnf Configuration has been found in the csar" - : "Vnf Configuration has been found in the csar"; - applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, msg); + 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 { - applicationLogger.debug("Creating temp file on file system for the csar"); 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 { - applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, - "Getting instance of ISdcCsarHelper to use in finding vnf configuration data"); + throws SdcToscaParserException, InvalidNumberOfNodesException { ISdcCsarHelper csarHelper = SdcToscaParserFactory.getInstance().getSdcCsarHelper(csarFilepath); - List vendorImageConfigurations = new ArrayList<>(); - NodeTemplate vnfConfigurationNode = findVnfConfigurationNode(csarHelper); + List serviceVfList = ToscaParser.getServiceNodeTemplates(csarHelper) + .filter(ToscaParser.filterOnType(SdcTypes.VF)).collect(Collectors.toList()); - if (vnfConfigurationNode != null) { - List serviceVfNodes = csarHelper.getServiceVfList(); - - for (NodeTemplate node : serviceVfNodes) { - vendorImageConfigurations.addAll(buildVendorImageConfigurations(vnfConfigurationNode, node)); - } - } + List vnfConfigs = serviceVfList.stream() + .flatMap(vf -> vf.getSubMappingToscaTemplate().getNodeTemplates().stream() + .filter(ToscaParser.filterOnType(SdcTypes.VFC)) // + .filter(vfc -> vfc.getType().endsWith("VnfConfiguration"))) + .filter(Objects::nonNull) // + .collect(Collectors.toList()); - return vendorImageConfigurations; - } + if (!vnfConfigs.isEmpty()) { + NodeTemplate vnfConfigurationNode = vnfConfigs.get(0); - private NodeTemplate findVnfConfigurationNode(ISdcCsarHelper csarHelper) throws InvalidNumberOfNodesException { - applicationLogger.debug("Tryng to find the vnf configuration node"); + applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, + String.format("Found VNF Configuration node \"%s\"", vnfConfigurationNode)); - List configNodes = - csarHelper.getServiceNodeTemplateBySdcType(SdcTypes.VF).stream().map(serviceNodeTemplate -> { - String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNodeTemplate); - applicationLogger.debug("Node Template Customization Uuid is " + uuid); - return csarHelper.getVnfConfig(uuid); - }).filter(Objects::nonNull).collect(Collectors.toList()); + if (vnfConfigs.size() > 1) { + throw new InvalidNumberOfNodesException("Only one VNF configuration node is allowed however " + + vnfConfigs.size() + " nodes were found in the CSAR."); + } - if (configNodes.size() > 1) { - throw new InvalidNumberOfNodesException("Only one vnf configuration node is allowed however " - + configNodes.size() + " nodes were found in the csar."); + return createVendorImageConfigurations(serviceVfList, vnfConfigurationNode); } - return configNodes.size() == 1 ? configNodes.get(0) : null; + return Collections.emptyList(); } - private List buildVendorImageConfigurations(NodeTemplate vendorInfoNode, - NodeTemplate node) throws ToscaToCatalogException { - List vendorImageConfigurations = new ArrayList<>(); - - List softwareVersions = extractSoftwareVersions(node.getSubMappingToscaTemplate()); + /** + * Build VNF Vendor Image Configurations for each Service VF, using the flavors of the specified VNF Configuration + * node. + * + * @param serviceVfList + * the Service level VF node templates + * @param vnfConfigurationNode + * the VNF node template + * @return a new List of Vendor Image Configurations + */ + private List createVendorImageConfigurations(List serviceVfList, + NodeTemplate vnfConfigurationNode) { + List vendorImageConfigurations = Collections.emptyList(); - Consumer> buildConfigurations = vi -> vendorImageConfigurations.addAll( - softwareVersions.stream().map(sv -> (new VendorImageConfiguration(vi.getRight(), vi.getLeft(), sv))) - .collect(Collectors.toList())); + Object allowedFlavorProperties = + vnfConfigurationNode.getPropertyValue(VNF_CONF_TYPE_PROPERTY_VENDOR_INFO_CONTAINER); - String resourceVendor = node.getMetaData().getValue("resourceVendor"); - buildVendorInfo(resourceVendor, vendorInfoNode).forEach(buildConfigurations); + if (allowedFlavorProperties instanceof Map) { + @SuppressWarnings("unchecked") + Collection>> flavorMaps = + ((Map>>) allowedFlavorProperties).values(); - return vendorImageConfigurations; - } + vendorImageConfigurations = serviceVfList.stream() // + .flatMap(node -> buildVendorImageConfigurations(flavorMaps, node)) // + .collect(Collectors.toList()); - @SuppressWarnings("unchecked") - private List> buildVendorInfo(String resourceVendor, NodeTemplate vendorInfoNode) { - Map otherFlavorProperties = - (Map) vendorInfoNode.getPropertyValue(VNF_CONF_TYPE_PROPERTY_VENDOR_INFO_CONTAINER); + applicationLogger.info(ApplicationMsgs.DISTRIBUTION_EVENT, + "Built " + vendorImageConfigurations.size() + " Vendor Image Configurations"); + } - return otherFlavorProperties.keySet().stream() - .map(key -> createVendorInfoPair((Map) otherFlavorProperties.get(key), resourceVendor)) - .collect(Collectors.toList()); + return vendorImageConfigurations; } - 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); + /** + * Builds the Vendor Image configurations. + * + * @param flavorMaps + * the collection of flavors and the properties for those flavors + * @param vfNodeTemplate + * the node template for the VF + * + * @return a stream of VendorImageConfiguration objects + */ + private Stream buildVendorImageConfigurations( + Collection>> flavorMaps, NodeTemplate vfNodeTemplate) { + String resourceVendor = vfNodeTemplate.getMetaData().getValue("resourceVendor"); + applicationLogger.debug("Resource Vendor " + resourceVendor); + + List softwareVersions = + extractSoftwareVersions(vfNodeTemplate.getSubMappingToscaTemplate().getNodeTemplates()); + applicationLogger.debug("Software Versions: " + softwareVersions); + + return flavorMaps.stream() // + .map(value -> value.entrySet().stream() // + .filter(entry -> VENDOR_INFO.equals(entry.getKey())) // + .map(e -> e.getValue().get(VENDOR_MODEL)) // + .findFirst()) // + .flatMap(vendorModel -> softwareVersions.stream().map( + version -> new VendorImageConfiguration(vendorModel.orElse(null), resourceVendor, version))); } + /** + * Extract Image software versions from node templates. + * + * @param nodeTemplates + * the node templates to search for software versions + * @return a List of Software Version Strings + */ @SuppressWarnings("unchecked") - private List extractSoftwareVersions(SubstitutionMappings sm) throws ToscaToCatalogException { - applicationLogger.debug("Trying to extract the software versions for the vnf configuration"); - - List imagesNodes = sm.getNodeTemplates().stream() - .filter(nodeTemplate -> nodeTemplate.getPropertyValue(IMAGES) != null).collect(Collectors.toList()); - - if (imagesNodes != null && !imagesNodes.isEmpty()) { - applicationLogger.debug("Found NodeTemplates containing properties with a key called 'images'"); - 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"); - } + List extractSoftwareVersions(Collection nodeTemplates) { + return nodeTemplates.stream() // + .filter(nodeTemplate -> nodeTemplate.getPropertyValue(IMAGES) != null) // + .flatMap(imagesNode -> ((Map) imagesNode.getPropertyValue(IMAGES)).entrySet().stream()) + .map(property -> findSoftwareVersion((Map) property.getValue())) + .collect(Collectors.toList()); } - private String findSoftwareVersion(Map image) { - applicationLogger.debug("Getting the software version value from the map of image properties"); + /** + * Get the first software_version value from the properties Map. + * + * @param properties + * the properties map containing the software_version key + * @return the software_version value as a String, or else null + */ + private String findSoftwareVersion(Map properties) { + applicationLogger.debug("Finding " + SOFTWARE_VERSION + " from " + properties); - return (String) image.entrySet().stream().filter(entry -> SOFTWARE_VERSION.equals(entry.getKey())) - .map(Entry::getValue).findFirst().orElse(null); + return properties.entrySet().stream() // + .filter(entry -> SOFTWARE_VERSION.equals(entry.getKey())) // + .map(Entry::getValue).findFirst() // + .map(Object::toString).orElse(null); } }