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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
# -*- coding: utf8 -*-
# ============LICENSE_START====================================================
# org.onap.vvp/validation-scripts
# ===================================================================
# Copyright © 2019 AT&T Intellectual Property. All rights reserved.
# ===================================================================
#
# Unless otherwise specified, all software contained herein is licensed
# under the Apache License, Version 2.0 (the "License");
# you may not use this software 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.
#
#
#
# Unless otherwise specified, all documentation contained herein is licensed
# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
# you may not use this documentation except in compliance with the License.
# You may obtain a copy of the License at
#
# https://creativecommons.org/licenses/by/4.0/
#
# Unless required by applicable law or agreed to in writing, documentation
# 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============================================
import json
import os
from pathlib import Path
from typing import Mapping
from preload.data import AbstractPreloadInstance
from preload.generator import (
get_json_template,
get_or_create_template,
AbstractPreloadGenerator,
)
from preload.model import VnfModule, Port
THIS_DIR = os.path.dirname(os.path.abspath(__file__))
DATA_DIR = os.path.join(THIS_DIR, "vnfapi_data")
def get_or_create_network_template(network_role, vm_networks):
"""
If the network role already exists in vm_networks, then
return that otherwise create a blank template and return that
"""
return get_or_create_template(
DATA_DIR, "network-role", network_role, vm_networks, "vm-network"
)
class VnfApiPreloadGenerator(AbstractPreloadGenerator):
@classmethod
def supports_output_passing(cls):
return False
@classmethod
def format_name(cls):
return "VNF-API"
@classmethod
def output_sub_dir(cls):
return "vnfapi"
def generate_module(
self,
vnf_module: VnfModule,
preload_data: AbstractPreloadInstance,
output_dir: Path,
):
self.module_incomplete = False
template = get_json_template(DATA_DIR, "preload_template")
self._populate(template, preload_data, vnf_module)
incomplete = (
"_incomplete"
if preload_data.flag_incompletes and self.module_incomplete
else ""
)
filename = "{}{}.json".format(preload_data.preload_basename, incomplete)
outfile = output_dir.joinpath(filename)
with outfile.open("w") as f:
json.dump(template, f, indent=4)
def _populate(
self,
template: Mapping,
preload_data: AbstractPreloadInstance,
vnf_module: VnfModule,
):
self._add_vnf_metadata(template, preload_data)
self._add_availability_zones(template, preload_data, vnf_module)
self._add_vnf_networks(template, preload_data, vnf_module)
self._add_vms(template, preload_data, vnf_module)
self._add_parameters(template, preload_data, vnf_module)
def _add_vnf_metadata(self, template: Mapping, preload: AbstractPreloadInstance):
vnf_meta = template["input"]["vnf-topology-information"][
"vnf-topology-identifier"
]
vnf_meta["vnf-name"] = self.normalize(preload.vnf_name, "vnf_name")
vnf_meta["generic-vnf-type"] = self.normalize(
preload.vnf_type,
"vnf-type",
"VALUE FOR: Concatenation of <Service Name>/"
"<VF Instance Name> MUST MATCH SDC",
)
vnf_meta["vnf-type"] = self.normalize(
preload.vf_module_model_name,
"vf-module-model-name",
"VALUE FOR: <vfModuleModelName> from CSAR or SDC",
)
def _add_availability_zones(
self, template: Mapping, preload: AbstractPreloadInstance, vnf_module: VnfModule
):
zones = template["input"]["vnf-topology-information"]["vnf-assignments"][
"availability-zones"
]
for i, zone_param in enumerate(vnf_module.availability_zones):
zone = preload.get_availability_zone(i, zone_param)
zones.append({"availability-zone": self.normalize(zone, zone_param, index=i)})
def add_floating_ips(
self, network_template: dict, port: Port, preload: AbstractPreloadInstance
):
# only one floating IP is really supported, in the preload model
# so for now we'll just use the last one. We might revisit this
# and if multiple floating params exist, then come up with an
# approach to pick just one
for ip in port.floating_ips:
ip_value = preload.get_floating_ip(
port.vm.vm_type, port.network.network_role, ip.ip_version, ip.param
)
key = "floating-ip" if ip.ip_version == 4 else "floating-ip-v6"
network_template[key] = self.normalize(ip_value, ip.param)
def add_fixed_ips(
self, network_template: dict, port: Port, preload: AbstractPreloadInstance
):
for index, ip in port.fixed_ips_with_index:
ip_value = preload.get_fixed_ip(
port.vm.vm_type,
port.network.network_role,
ip.ip_version,
index,
ip.param,
)
ip_value = self.normalize(ip_value, ip.param, index=index)
if ip.ip_version == 4:
network_template["network-ips"].append({"ip-address": ip_value})
network_template["ip-count"] += 1
else:
network_template["network-ips-v6"].append({"ip-address": ip_value})
network_template["ip-count-ipv6"] += 1
def _add_vnf_networks(
self, template: Mapping, preload: AbstractPreloadInstance, vnf_module: VnfModule
):
networks = template["input"]["vnf-topology-information"]["vnf-assignments"][
"vnf-networks"
]
for network in vnf_module.networks:
network_data = {
"network-role": network.network_role,
"network-name": self.normalize(
preload.get_network_name(network.network_role, network.name_param),
network.name_param,
"VALUE FOR: network name for {}".format(network.name_param),
),
}
for subnet in network.subnet_params:
subnet_id = preload.get_subnet_id(
network.network_role, subnet.ip_version, subnet.param_name
)
if subnet_id:
key = (
"ipv6-subnet-id" if "_v6_" in subnet.param_name else "subnet-id"
)
network_data[key] = self.normalize(subnet_id, subnet.param_name)
else:
subnet_name = preload.get_subnet_name(
network.network_role, subnet.ip_version, ""
)
key = (
"ipv6-subnet-name"
if "_v6_" in subnet.param_name
else "subnet-name"
)
msg = "VALUE FOR: name for {}".format(subnet.param_name)
value = self.normalize(
subnet_name, subnet.param_name, alt_message=msg
)
network_data[key] = value
networks.append(network_data)
def _add_vms(
self, template: Mapping, preload: AbstractPreloadInstance, vnf_module: VnfModule
):
vm_list = template["input"]["vnf-topology-information"]["vnf-assignments"][
"vnf-vms"
]
for vm in vnf_module.virtual_machine_types:
vm_template = get_json_template(DATA_DIR, "vm")
vm_template["vm-type"] = vm.vm_type
vm_template["vm-count"] = vm.vm_count
for i, param in enumerate(sorted(vm.names)):
name = preload.get_vm_name(vm.vm_type, i, param)
vm_template["vm-names"]["vm-name"].append(self.normalize(name, param, index=i))
vm_list.append(vm_template)
vm_networks = vm_template["vm-networks"]
for port in vm.ports:
role = port.network.network_role
network_template = get_or_create_network_template(role, vm_networks)
network_template["network-role"] = role
network_template["network-role-tag"] = role
network_template["use-dhcp"] = "Y" if port.uses_dhcp else "N"
self.add_fixed_ips(network_template, port, preload)
self.add_floating_ips(network_template, port, preload)
def _add_parameters(
self, template: Mapping, preload: AbstractPreloadInstance, vnf_module: VnfModule
):
params = template["input"]["vnf-topology-information"]["vnf-parameters"]
for key, value in vnf_module.preload_parameters.items():
preload_value = preload.get_vnf_parameter(key, value)
value = preload_value or value
params.append(
{
"vnf-parameter-name": key,
"vnf-parameter-value": self.normalize(value, key),
}
)
for key, value in preload.get_additional_parameters().items():
params.append(
{
"vnf-parameter-name": key,
"vnf-parameter-value": self.normalize(value, key),
}
)
|
