src/main/java/org/onap/aai/modelloader/entity/catalog/VnfCatalogArtifactHandler.java

   1 /**\r
   2  * ============LICENSE_START=======================================================\r
   3  * org.onap.aai\r
   4  * ================================================================================\r
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.\r
   6  * Copyright © 2017-2018 European Software Marketing Ltd.\r
   7  * ================================================================================\r
   8  * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * you may not use this file except in compliance with the License.\r
  10  * You may obtain a copy of the License at\r
  11  *\r
  12  *       http://www.apache.org/licenses/LICENSE-2.0\r
  13  *\r
  14  * Unless required by applicable law or agreed to in writing, software\r
  15  * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * See the License for the specific language governing permissions and\r
  18  * limitations under the License.\r
  19  * ============LICENSE_END=========================================================\r
  20  */\r
  21 package org.onap.aai.modelloader.entity.catalog;\r
  22 \r
  23 import com.google.gson.Gson;\r
  24 import com.google.gson.reflect.TypeToken;\r
  25 import java.io.StringReader;\r
  26 import java.net.URISyntaxException;\r
  27 import java.util.ArrayList;\r
  28 import java.util.HashMap;\r
  29 import java.util.List;\r
  30 import java.util.Map;\r
  31 import java.util.Map.Entry;\r
  32 import java.util.UUID;\r
  33 import javax.xml.parsers.DocumentBuilder;\r
  34 import javax.xml.parsers.DocumentBuilderFactory;\r
  35 import org.apache.commons.text.StringEscapeUtils;\r
  36 import org.apache.http.client.utils.URIBuilder;\r
  37 import org.onap.aai.cl.api.Logger;\r
  38 import org.onap.aai.cl.eelf.LoggerFactory;\r
  39 import org.onap.aai.modelloader.config.ModelLoaderConfig;\r
  40 import org.onap.aai.modelloader.entity.Artifact;\r
  41 import org.onap.aai.modelloader.entity.ArtifactHandler;\r
  42 import org.onap.aai.modelloader.entity.vnf.VnfImages;\r
  43 import org.onap.aai.modelloader.restclient.AaiRestClient;\r
  44 import org.onap.aai.modelloader.service.ModelLoaderMsgs;\r
  45 import org.springframework.http.HttpStatus;\r
  46 import org.springframework.http.MediaType;\r
  47 import org.springframework.http.ResponseEntity;\r
  48 import org.springframework.stereotype.Component;\r
  49 import org.w3c.dom.Document;\r
  50 import org.w3c.dom.Element;\r
  51 import org.w3c.dom.Node;\r
  52 import org.w3c.dom.NodeList;\r
  53 import org.xml.sax.InputSource;\r
  54 \r
  55 /**\r
  56  * VNF Catalog specific handling\r
  57  */\r
  58 @Component\r
  59 public class VnfCatalogArtifactHandler extends ArtifactHandler {\r
  60 \r
  61     private static Logger logger = LoggerFactory.getInstance().getLogger(VnfCatalogArtifactHandler.class.getName());\r
  62 \r
  63     public static final String ATTR_UUID = "uuid";\r
  64 \r
  65     public VnfCatalogArtifactHandler(ModelLoaderConfig config) {\r
  66         super(config);\r
  67     }\r
  68 \r
  69     /*\r
  70      * (non-Javadoc)\r
  71      * \r
  72      * @see org.openecomp.modelloader.entity.ArtifactHandler#pushArtifacts(java.util.List, java.lang.String)\r
  73      */\r
  74     @Override\r
  75     public boolean pushArtifacts(List<Artifact> artifacts, String distributionId, List<Artifact> completedArtifacts,\r
  76             AaiRestClient aaiClient) {\r
  77         for (Artifact artifact : artifacts) {\r
  78             try {\r
  79                 distributeVnfcData(aaiClient, distributionId, artifact, completedArtifacts);\r
  80             } catch (VnfImageException e) {\r
  81                 if (e.getResultCode().isPresent()) {\r
  82                     logger.error(ModelLoaderMsgs.DISTRIBUTION_EVENT_ERROR,\r
  83                             "Ingestion failed on vnf-image " + e.getImageId() + " with status "\r
  84                                     + e.getResultCode().orElse(0) + ". Rolling back distribution.");\r
  85                 } else {\r
  86                     logger.error(ModelLoaderMsgs.DISTRIBUTION_EVENT_ERROR,\r
  87                             "Ingestion failed on " + e.getImageId() + ". Rolling back distribution.");\r
  88                 }\r
  89                 return false;\r
  90             }\r
  91         }\r
  92 \r
  93         return true;\r
  94     }\r
  95 \r
  96     /*\r
  97      * If something fails in the middle of ingesting the catalog we want to roll back any changes to the DB\r
  98      */\r
  99     @Override\r
 100     public void rollback(List<Artifact> completedArtifacts, String distributionId, AaiRestClient aaiClient) {\r
 101         for (Artifact completedArtifact : completedArtifacts) {\r
 102             Map<String, String> data = new Gson().fromJson(completedArtifact.getPayload(),\r
 103                     new TypeToken<Map<String, String>>() {}.getType());\r
 104             String url = config.getAaiBaseUrl() + config.getAaiVnfImageUrl() + "/vnf-image/" + data.get(ATTR_UUID);\r
 105             // Try to delete the image. If something goes wrong we can't really do anything here\r
 106             aaiClient.getAndDeleteResource(url, distributionId);\r
 107         }\r
 108     }\r
 109 \r
 110     private void distributeVnfcData(AaiRestClient restClient, String distributionId, Artifact vnfcArtifact,\r
 111             List<Artifact> completedArtifacts) throws VnfImageException {\r
 112         List<Map<String, String>> vnfcData;\r
 113         switch (vnfcArtifact.getType()) {\r
 114             case VNF_CATALOG:\r
 115                 vnfcData = unmarshallVnfcData(vnfcArtifact);\r
 116                 break;\r
 117             case VNF_CATALOG_XML:\r
 118                 vnfcData = parseXmlVnfcData(vnfcArtifact);\r
 119                 break;\r
 120             default:\r
 121                 throw new VnfImageException("Unsupported type " + vnfcArtifact.getType());\r
 122         }\r
 123         distributeVnfcData(restClient, distributionId, completedArtifacts, vnfcData);\r
 124     }\r
 125 \r
 126     /**\r
 127      * Build a VNF image from each of the supplied data items, and distribute to AAI\r
 128      * \r
 129      * @param restClient\r
 130      * @param distributionId\r
 131      * @param completedArtifacts\r
 132      * @param vnfcData\r
 133      * @throws VnfImageException\r
 134      */\r
 135     private void distributeVnfcData(AaiRestClient restClient, String distributionId, List<Artifact> completedArtifacts,\r
 136             List<Map<String, String>> vnfcData) throws VnfImageException {\r
 137         for (Map<String, String> dataItem : vnfcData) {\r
 138             // If an empty dataItem is supplied, do nothing.\r
 139             if (dataItem.isEmpty()) {\r
 140                 logger.warn(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Empty image data supplied, skipping ingestion.");\r
 141                 continue;\r
 142             }\r
 143 \r
 144             StringBuilder imageIdBuilder = new StringBuilder("vnf image");\r
 145             for (Entry<String, String> entry : dataItem.entrySet()) {\r
 146                 imageIdBuilder.append(" ").append(entry.getValue());\r
 147             }\r
 148             String imageId = imageIdBuilder.toString();\r
 149             int resultCode = getVnfImage(restClient, distributionId, imageId, dataItem);\r
 150 \r
 151             if (resultCode == HttpStatus.NOT_FOUND.value()) {\r
 152                 // This vnf-image is missing, so add it\r
 153                 boolean success = putVnfImage(restClient, dataItem, distributionId);\r
 154                 if (success) {\r
 155                     completedArtifacts.add(new VnfCatalogArtifact(new Gson().toJson(dataItem)));\r
 156                     logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, imageId + " successfully ingested.");\r
 157                 } else {\r
 158                     throw new VnfImageException(imageId);\r
 159                 }\r
 160             } else if (resultCode == HttpStatus.OK.value()) {\r
 161                 logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, imageId + " already exists. Skipping ingestion.");\r
 162             } else {\r
 163                 // if other than 404 or 200, something went wrong\r
 164                 throw new VnfImageException(imageId, resultCode);\r
 165             }\r
 166         }\r
 167     }\r
 168 \r
 169     private int getVnfImage(AaiRestClient restClient, String distributionId, String imageId,\r
 170             Map<String, String> dataItem) throws VnfImageException {\r
 171         try {\r
 172             URIBuilder b = new URIBuilder(config.getAaiBaseUrl() + config.getAaiVnfImageUrl());\r
 173             for (Entry<String, String> entry : dataItem.entrySet()) {\r
 174                 b.addParameter(entry.getKey(), entry.getValue());\r
 175             }\r
 176             ResponseEntity<VnfImages> tryGet =\r
 177                     restClient.getResource(b.build().toString(), distributionId, MediaType.APPLICATION_JSON, VnfImages.class);\r
 178             if (tryGet == null) {\r
 179                 throw new VnfImageException(imageId);\r
 180             }\r
 181             return tryGet.getStatusCodeValue();\r
 182         } catch (URISyntaxException ex) {\r
 183             throw new VnfImageException(ex);\r
 184         }\r
 185     }\r
 186 \r
 187     private boolean putVnfImage(AaiRestClient restClient, Map<String, String> dataItem, String distributionId) {\r
 188         // Generate a new UUID for the image data item\r
 189         String uuid = UUID.randomUUID().toString();\r
 190         dataItem.put(ATTR_UUID, uuid);\r
 191 \r
 192         // TODO: Get rid of the dataItem map and replace it with the VnfImage object\r
 193         String payload = new Gson().toJson(dataItem);\r
 194         String putUrl = config.getAaiBaseUrl() + config.getAaiVnfImageUrl() + "/vnf-image/" + uuid;\r
 195         ResponseEntity<String> putResp =\r
 196                 restClient.putResource(putUrl, payload, distributionId, MediaType.APPLICATION_JSON, String.class);\r
 197         return putResp != null && putResp.getStatusCode() == HttpStatus.CREATED;\r
 198     }\r
 199 \r
 200     private List<Map<String, String>> unmarshallVnfcData(Artifact vnfcArtifact) {\r
 201         // Unmarshall Babel JSON payload into a List of Maps of JSON attribute name/values.\r
 202         return new Gson().fromJson(StringEscapeUtils.unescapeJson(vnfcArtifact.getPayload()),\r
 203                 new TypeToken<List<Map<String, String>>>() {}.getType());\r
 204     }\r
 205 \r
 206     /**\r
 207      * Parse the VNF Catalog XML and transform into Key/Value pairs.\r
 208      * \r
 209      * @param vnfcArtifact\r
 210      * @return VNF Image data in Map form\r
 211      * @throws VnfImageException\r
 212      */\r
 213     private List<Map<String, String>> parseXmlVnfcData(Artifact vnfcArtifact) throws VnfImageException {\r
 214         List<Map<String, String>> vnfcData = new ArrayList<>();\r
 215         try {\r
 216             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();\r
 217             factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);\r
 218             DocumentBuilder builder = factory.newDocumentBuilder();\r
 219             InputSource is = new InputSource(new StringReader(vnfcArtifact.getPayload()));\r
 220             Document doc = builder.parse(is);\r
 221             doc.getDocumentElement().normalize();\r
 222 \r
 223             NodeList pnl = doc.getElementsByTagName("part-number-list");\r
 224             for (int i = 0; i < pnl.getLength(); i++) {\r
 225                 Node partNumber = pnl.item(i);\r
 226                 if (partNumber.getNodeType() == Node.ELEMENT_NODE) {\r
 227                     Element vendorInfo = getFirstChildNodeByName(partNumber, "vendor-info");\r
 228                     if (vendorInfo != null) {\r
 229                         Map<String, String> application = new HashMap<>();\r
 230                         application.put("application",\r
 231                                 vendorInfo.getElementsByTagName("vendor-model").item(0).getTextContent());\r
 232                         application.put("application-vendor",\r
 233                                 vendorInfo.getElementsByTagName("vendor-name").item(0).getTextContent());\r
 234                         populateSoftwareVersions(vnfcData, application, partNumber);\r
 235                     }\r
 236                 }\r
 237             }\r
 238         } catch (Exception ex) {\r
 239             throw new VnfImageException(ex);\r
 240         }\r
 241         return vnfcData;\r
 242     }\r
 243 \r
 244     /**\r
 245      * @param vnfcData to populate\r
 246      * @param applicationData\r
 247      * @param partNumber\r
 248      */\r
 249     private void populateSoftwareVersions(List<Map<String, String>> vnfcData, Map<String, String> applicationData,\r
 250             Node partNumber) {\r
 251         NodeList nodes = partNumber.getChildNodes();\r
 252         for (int i = 0; i < nodes.getLength(); i++) {\r
 253             Node childNode = nodes.item(i);\r
 254             if (childNode.getNodeName().equalsIgnoreCase("software-version-list")) {\r
 255                 Element softwareVersion = getFirstChildNodeByName(childNode, "software-version");\r
 256                 if (softwareVersion != null) {\r
 257                     HashMap<String, String> vnfImageData = new HashMap<>(applicationData);\r
 258                     vnfImageData.put("application-version", softwareVersion.getTextContent());\r
 259                     vnfcData.add(vnfImageData);\r
 260                 }\r
 261             }\r
 262         }\r
 263     }\r
 264 \r
 265     /**\r
 266      * @param node\r
 267      * @param childNodeName\r
 268      * @return the first child node matching the given name\r
 269      */\r
 270     private Element getFirstChildNodeByName(Node node, String childNodeName) {\r
 271         NodeList nodes = node.getChildNodes();\r
 272         for (int i = 0; i < nodes.getLength(); i++) {\r
 273             Node childNode = nodes.item(i);\r
 274             if (childNode.getNodeName().equalsIgnoreCase(childNodeName)) {\r
 275                 return (Element) childNode;\r
 276             }\r
 277         }\r
 278         return null;\r
 279     }\r
 280 \r
 281 }\r