ice_validator/preload_vnfapi/vnfapi_generator.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START====================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2019 AT&T Intellectual Property. All rights reserved.
   6 # ===================================================================
   7 #
   8 # Unless otherwise specified, all software contained herein is licensed
   9 # under the Apache License, Version 2.0 (the "License");
  10 # you may not use this software except in compliance with the License.
  11 # You may obtain a copy of the License at
  12 #
  13 #             http://www.apache.org/licenses/LICENSE-2.0
  14 #
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS,
  17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18 # See the License for the specific language governing permissions and
  19 # limitations under the License.
  20 #
  21 #
  22 #
  23 # Unless otherwise specified, all documentation contained herein is licensed
  24 # under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  25 # you may not use this documentation except in compliance with the License.
  26 # You may obtain a copy of the License at
  27 #
  28 #             https://creativecommons.org/licenses/by/4.0/
  29 #
  30 # Unless required by applicable law or agreed to in writing, documentation
  31 # distributed under the License is distributed on an "AS IS" BASIS,
  32 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  33 # See the License for the specific language governing permissions and
  34 # limitations under the License.
  35 #
  36 # ============LICENSE_END============================================
  37 #
  38 #
  39
  40 import json
  41 import os
  42
  43 from preload.generator import (
  44     get_json_template,
  45     get_or_create_template,
  46     AbstractPreloadGenerator,
  47 )
  48
  49 THIS_DIR = os.path.dirname(os.path.abspath(__file__))
  50 DATA_DIR = os.path.join(THIS_DIR, "vnfapi_data")
  51
  52
  53 def get_or_create_network_template(network_role, vm_networks):
  54     """
  55     If the network role already exists in vm_networks, then
  56     return that otherwise create a blank template and return that
  57     """
  58     return get_or_create_template(
  59         DATA_DIR, "network-role", network_role, vm_networks, "vm-network"
  60     )
  61
  62
  63 class VnfApiPreloadGenerator(AbstractPreloadGenerator):
  64     @classmethod
  65     def supports_output_passing(cls):
  66         return False
  67
  68     @classmethod
  69     def format_name(cls):
  70         return "VNF-API"
  71
  72     @classmethod
  73     def output_sub_dir(cls):
  74         return "vnfapi"
  75
  76     def generate_module(self, vnf_module, output_dir):
  77         preload = get_json_template(DATA_DIR, "preload_template")
  78         self._populate(preload, vnf_module)
  79         incomplete = "_incomplete" if self.module_incomplete else ""
  80         outfile = "{}/{}{}.json".format(output_dir, vnf_module.vnf_name, incomplete)
  81         with open(outfile, "w") as f:
  82             json.dump(preload, f, indent=4)
  83
  84     def _populate(self, preload, vnf_module):
  85         self._add_vnf_metadata(preload)
  86         self._add_availability_zones(preload, vnf_module)
  87         self._add_vnf_networks(preload, vnf_module)
  88         self._add_vms(preload, vnf_module)
  89         self._add_parameters(preload, vnf_module)
  90
  91     def _add_vnf_metadata(self, preload):
  92         vnf_meta = preload["input"]["vnf-topology-information"]["vnf-topology-identifier"]
  93         vnf_meta["vnf-name"] = self.replace("vnf_name")
  94         vnf_meta["generic-vnf-type"] = self.replace(
  95             "vnf-type",
  96             "VALUE FOR: Concatenation of <Service Name>/"
  97             "<VF Instance Name> MUST MATCH SDC",
  98         )
  99         vnf_meta["vnf-type"] = self.replace(
 100             "vf-module-model-name", "VALUE FOR: <vfModuleModelName> from CSAR or SDC"
 101         )
 102
 103     def add_floating_ips(self, network_template, network):
 104         # only one floating IP is really supported, in the preload model
 105         # so for now we'll just use the last one.  We might revisit this
 106         # and if multiple floating params exist, then come up with an
 107         # approach to pick just one
 108         for ip in network.floating_ips:
 109             key = "floating-ip" if ip.ip_version == 4 else "floating-ip-v6"
 110             network_template[key] = self.replace(ip.param, single=True)
 111
 112     def add_fixed_ips(self, network_template, port):
 113         for ip in port.fixed_ips:
 114             if ip.ip_version == 4:
 115                 network_template["network-ips"].append(
 116                     {"ip-address": self.replace(ip.param, single=True)}
 117                 )
 118                 network_template["ip-count"] += 1
 119             else:
 120                 network_template["network-ips-v6"].append(
 121                     {"ip-address": self.replace(ip.param, single=True)}
 122                 )
 123                 network_template["ip-count-ipv6"] += 1
 124
 125     def _add_availability_zones(self, preload, vnf_module):
 126         zones = preload["input"]["vnf-topology-information"]["vnf-assignments"][
 127             "availability-zones"
 128         ]
 129         for zone in vnf_module.availability_zones:
 130             zones.append({"availability-zone": self.replace(zone, single=True)})
 131
 132     def _add_vnf_networks(self, preload, vnf_module):
 133         networks = preload["input"]["vnf-topology-information"]["vnf-assignments"][
 134             "vnf-networks"
 135         ]
 136         for network in vnf_module.networks:
 137             network_data = {
 138                 "network-role": network.network_role,
 139                 "network-name": self.replace(
 140                     network.name_param,
 141                     "VALUE FOR: network name for {}".format(network.name_param),
 142                 ),
 143             }
 144             for subnet in network.subnet_params:
 145                 key = "ipv6-subnet-id" if "_v6_" in subnet else "subnet-id"
 146                 network_data[key] = subnet
 147             networks.append(network_data)
 148
 149     def _add_vms(self, preload, vnf_module):
 150         vm_list = preload["input"]["vnf-topology-information"]["vnf-assignments"][
 151             "vnf-vms"
 152         ]
 153         for vm in vnf_module.virtual_machine_types:
 154             vm_template = get_json_template(DATA_DIR, "vm")
 155             vm_template["vm-type"] = vm.vm_type
 156             vm_template["vm-count"] = vm.vm_count
 157             for name in vm.names:
 158                 value = self.replace(name, single=True)
 159                 vm_template["vm-names"]["vm-name"].append(value)
 160             vm_list.append(vm_template)
 161             vm_networks = vm_template["vm-networks"]
 162             for port in vm.ports:
 163                 role = port.network.network_role
 164                 network_template = get_or_create_network_template(role, vm_networks)
 165                 network_template["network-role"] = role
 166                 network_template["network-role-tag"] = role
 167                 network_template["use-dhcp"] = "Y" if port.uses_dhcp else "N"
 168                 self.add_fixed_ips(network_template, port)
 169                 self.add_floating_ips(network_template, port)
 170
 171     def _add_parameters(self, preload, vnf_module):
 172         params = preload["input"]["vnf-topology-information"]["vnf-parameters"]
 173         for key, value in vnf_module.preload_parameters.items():
 174             params.append(
 175                 {
 176                     "vnf-parameter-name": key,
 177                     "vnf-parameter-value": self.replace(key, value),
 178                 }
 179             )