blob: 81b288dab362f0c8cff3ecea815fbf4d5184b47e [file] [log] [blame]
tierno0f98af52018-03-19 10:28:22 +01001# -*- coding: utf-8 -*-
2
tiernod125caf2018-11-22 16:05:54 +00003# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12# implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
tierno0f98af52018-03-19 10:28:22 +010016from jsonschema import validate as js_v, exceptions as js_e
tierno36ec8602018-11-02 17:27:11 +010017from http import HTTPStatus
garciadeblasdaf8cc52018-11-30 14:17:20 +010018from copy import deepcopy
tierno0f98af52018-03-19 10:28:22 +010019
20__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
21__version__ = "0.1"
22version_date = "Mar 2018"
23
24"""
25Validator of input data using JSON schemas for those items that not contains an OSM yang information model
26"""
27
28# Basis schemas
29patern_name = "^[ -~]+$"
tiernofd160572019-01-21 10:41:37 +000030shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"}
tierno0f98af52018-03-19 10:28:22 +010031passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
tierno0f98af52018-03-19 10:28:22 +010032name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
tierno0da52252018-06-27 15:47:22 +020033string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
tierno0f98af52018-03-19 10:28:22 +010034xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
35description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
tierno441dbbf2018-07-10 12:52:48 +020036id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
37bool_schema = {"type": "boolean"}
38null_schema = {"type": "null"}
tierno2236d202018-05-16 19:05:16 +020039# "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
tierno0f98af52018-03-19 10:28:22 +010040id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
tiernof759d822018-06-11 18:54:54 +020041time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
tierno87006042018-10-24 12:50:20 +020042pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
tierno42fce592018-11-02 09:23:43 +010043# allows [] for wildcards. For that reason huge length limit is set
44pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
tierno0f98af52018-03-19 10:28:22 +010045http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
46bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
47memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
48integer0_schema = {"type": "integer", "minimum": 0}
49integer1_schema = {"type": "integer", "minimum": 1}
tierno87006042018-10-24 12:50:20 +020050path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
tierno0f98af52018-03-19 10:28:22 +010051vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
52vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
53mac_schema = {"type": "string",
54 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0
tiernocb83c942018-09-24 17:28:13 +020055dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
tierno0f98af52018-03-19 10:28:22 +010056# mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
57ip_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020058 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"}
tierno0f98af52018-03-19 10:28:22 +010059ip_prefix_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020060 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
tierno2236d202018-05-16 19:05:16 +020061 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
tierno0f98af52018-03-19 10:28:22 +010062port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
63object_schema = {"type": "object"}
64schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
65# schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
66log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
67checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
68size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
tiernocd54a4a2018-09-12 16:40:35 +020069array_edition_schema = {
70 "type": "object",
71 "patternProperties": {
tiernofd160572019-01-21 10:41:37 +000072 "^\\$": {}
tiernocd54a4a2018-09-12 16:40:35 +020073 },
74 "additionalProperties": False,
75 "minProperties": 1,
76}
tiernocb83c942018-09-24 17:28:13 +020077nameshort_list_schema = {
78 "type": "array",
79 "minItems": 1,
tiernofd160572019-01-21 10:41:37 +000080 "items": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +020081}
tiernocd54a4a2018-09-12 16:40:35 +020082
tierno0f98af52018-03-19 10:28:22 +010083
tierno441dbbf2018-07-10 12:52:48 +020084ns_instantiate_vdu = {
85 "title": "ns action instantiate input schema for vdu",
86 "$schema": "http://json-schema.org/draft-04/schema#",
87 "type": "object",
88 "properties": {
89 "id": name_schema,
90 "volume": {
91 "type": "array",
92 "minItems": 1,
93 "items": {
94 "type": "object",
95 "properties": {
96 "name": name_schema,
97 "vim-volume-id": name_schema,
98 },
99 "required": ["name", "vim-volume-id"],
100 "additionalProperties": False
101 }
102 },
103 "interface": {
104 "type": "array",
105 "minItems": 1,
106 "items": {
107 "type": "object",
108 "properties": {
109 "name": name_schema,
110 "ip-address": ip_schema,
111 "mac-address": mac_schema,
112 "floating-ip-required": bool_schema,
113 },
114 "required": ["name"],
115 "additionalProperties": False
116 }
117 }
118 },
119 "required": ["id"],
120 "additionalProperties": False
121}
122
123ip_profile_dns_schema = {
124 "type": "array",
125 "minItems": 1,
126 "items": {
127 "type": "object",
128 "properties": {
129 "address": ip_schema,
130 },
131 "required": ["address"],
132 "additionalProperties": False
133 }
134}
135
136ip_profile_dhcp_schema = {
137 "type": "object",
138 "properties": {
139 "enabled": {"type": "boolean"},
140 "count": integer1_schema,
141 "start-address": ip_schema
142 },
143 "additionalProperties": False,
144}
145
146ip_profile_schema = {
147 "title": "ip profile validation schame",
148 "$schema": "http://json-schema.org/draft-04/schema#",
149 "type": "object",
150 "properties": {
151 "ip-version": {"enum": ["ipv4", "ipv6"]},
152 "subnet-address": ip_prefix_schema,
153 "gateway-address": ip_schema,
154 "dns-server": ip_profile_dns_schema,
155 "dhcp-params": ip_profile_dhcp_schema,
156 }
157}
158
159ip_profile_update_schema = {
160 "title": "ip profile validation schame",
161 "$schema": "http://json-schema.org/draft-04/schema#",
162 "type": "object",
163 "properties": {
164 "ip-version": {"enum": ["ipv4", "ipv6"]},
165 "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
166 "gateway-address": {"oneOf": [null_schema, ip_schema]},
167 "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
168
169 "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
170 },
171 "additionalProperties": False
172}
173
174ns_instantiate_internal_vld = {
175 "title": "ns action instantiate input schema for vdu",
176 "$schema": "http://json-schema.org/draft-04/schema#",
177 "type": "object",
178 "properties": {
179 "name": name_schema,
180 "vim-network-name": name_schema,
gcalvino17d5b732018-12-17 16:26:21 +0100181 "vim-network-id": name_schema,
tierno441dbbf2018-07-10 12:52:48 +0200182 "ip-profile": ip_profile_update_schema,
183 "internal-connection-point": {
184 "type": "array",
185 "minItems": 1,
186 "items": {
187 "type": "object",
188 "properties": {
189 "id-ref": name_schema,
190 "ip-address": ip_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200191 # "mac-address": mac_schema,
tierno441dbbf2018-07-10 12:52:48 +0200192 },
tiernob7c6f2a2018-09-03 14:32:10 +0200193 "required": ["id-ref"],
194 "minProperties": 2,
tierno441dbbf2018-07-10 12:52:48 +0200195 "additionalProperties": False
196 },
197 }
198 },
199 "required": ["name"],
200 "minProperties": 2,
201 "additionalProperties": False
202}
tierno65acb4d2018-04-06 16:42:40 +0200203
tiernofd160572019-01-21 10:41:37 +0000204additional_params_for_vnf = {
205 "type": "array",
206 "items": {
207 "type": "object",
208 "properties": {
209 "member-vnf-index": name_schema,
210 "additionalParams": object_schema,
211 },
212 "required": ["member-vnf-index", "additionalParams"],
213 "additionalProperties": False
214 }
215
216}
217
tierno65acb4d2018-04-06 16:42:40 +0200218ns_instantiate = {
219 "title": "ns action instantiate input schema",
220 "$schema": "http://json-schema.org/draft-04/schema#",
221 "type": "object",
tierno0da52252018-06-27 15:47:22 +0200222 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200223 "lcmOperationType": string_schema,
224 "nsInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100225 "netsliceInstanceId": id_schema,
tierno0da52252018-06-27 15:47:22 +0200226 "nsName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000227 "nsDescription": {"oneOf": [description_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200228 "nsdId": id_schema,
229 "vimAccountId": id_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000230 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tiernobee085c2018-12-12 17:03:04 +0000231 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000232 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100233 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tierno441dbbf2018-07-10 12:52:48 +0200234 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200235 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200236 "vnf": {
237 "type": "array",
238 "minItems": 1,
239 "items": {
240 "type": "object",
241 "properties": {
242 "member-vnf-index": name_schema,
243 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200244 "vdu": {
245 "type": "array",
246 "minItems": 1,
247 "items": ns_instantiate_vdu,
248 },
249 "internal-vld": {
250 "type": "array",
251 "minItems": 1,
252 "items": ns_instantiate_internal_vld
253 }
tierno0da52252018-06-27 15:47:22 +0200254 },
tierno441dbbf2018-07-10 12:52:48 +0200255 "required": ["member-vnf-index"],
256 "minProperties": 2,
257 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200258 }
259 },
260 "vld": {
261 "type": "array",
262 "minItems": 1,
263 "items": {
264 "type": "object",
265 "properties": {
266 "name": string_schema,
267 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100268 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100269 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000270 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200271 "ip-profile": object_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200272 "vnfd-connection-point-ref": {
273 "type": "array",
274 "minItems": 1,
275 "items": {
276 "type": "object",
277 "properties": {
278 "member-vnf-index-ref": name_schema,
279 "vnfd-connection-point-ref": name_schema,
280 "ip-address": ip_schema,
281 # "mac-address": mac_schema,
282 },
283 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
284 "minProperties": 3,
285 "additionalProperties": False
286 },
287 }
tierno0da52252018-06-27 15:47:22 +0200288 },
tierno441dbbf2018-07-10 12:52:48 +0200289 "required": ["name"],
290 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200291 }
292 },
293 },
tierno441dbbf2018-07-10 12:52:48 +0200294 "required": ["nsName", "nsdId", "vimAccountId"],
295 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200296}
tierno0da52252018-06-27 15:47:22 +0200297
tierno65acb4d2018-04-06 16:42:40 +0200298ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200299 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200300 "$schema": "http://json-schema.org/draft-04/schema#",
301 "type": "object",
302 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200303 "lcmOperationType": string_schema,
304 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200305 "member_vnf_index": name_schema,
306 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200307 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000308 "vdu_count_index": integer0_schema,
tierno65acb4d2018-04-06 16:42:40 +0200309 "primitive": name_schema,
310 "primitive_params": {"type": "object"},
311 },
tiernof5298be2018-05-16 14:43:57 +0200312 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200313 "additionalProperties": False
314}
tiernof759d822018-06-11 18:54:54 +0200315ns_scale = { # TODO for the moment it is only VDU-scaling
316 "title": "ns scale input schema",
317 "$schema": "http://json-schema.org/draft-04/schema#",
318 "type": "object",
319 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200320 "lcmOperationType": string_schema,
321 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200322 "scaleType": {"enum": ["SCALE_VNF"]},
323 "scaleVnfData": {
324 "type": "object",
325 "properties": {
326 "vnfInstanceId": name_schema,
327 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
328 "scaleByStepData": {
329 "type": "object",
330 "properties": {
331 "scaling-group-descriptor": name_schema,
332 "member-vnf-index": name_schema,
333 "scaling-policy": name_schema,
334 },
335 "required": ["scaling-group-descriptor", "member-vnf-index"],
336 "additionalProperties": False
337 },
338 },
339 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
340 "additionalProperties": False
341 },
342 "scaleTime": time_schema,
343 },
344 "required": ["scaleType", "scaleVnfData"],
345 "additionalProperties": False
346}
tierno65acb4d2018-04-06 16:42:40 +0200347
348
tierno0f98af52018-03-19 10:28:22 +0100349schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000350schema_type = {"type": "string"}
tierno09c073e2018-04-26 13:36:48 +0200351vim_account_edit_schema = {
352 "title": "vim_account edit input schema",
353 "$schema": "http://json-schema.org/draft-04/schema#",
354 "type": "object",
355 "properties": {
356 "name": name_schema,
357 "description": description_schema,
tiernofd160572019-01-21 10:41:37 +0000358 "type": shortname_schema,
tierno09c073e2018-04-26 13:36:48 +0200359 "vim": name_schema,
360 "datacenter": name_schema,
361 "vim_url": description_schema,
362 "vim_url_admin": description_schema,
363 "vim_tenant": name_schema,
364 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000365 "vim_username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200366 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200367 "config": {"type": "object"}
368 },
369 "additionalProperties": False
370}
tierno0f98af52018-03-19 10:28:22 +0100371
tierno09c073e2018-04-26 13:36:48 +0200372vim_account_new_schema = {
373 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100374 "$schema": "http://json-schema.org/draft-04/schema#",
375 "type": "object",
376 "properties": {
377 "schema_version": schema_version,
378 "schema_type": schema_type,
379 "name": name_schema,
380 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200381 "vim": name_schema,
382 "datacenter": name_schema,
tierno0f98af52018-03-19 10:28:22 +0100383 "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
384 "vim_url": description_schema,
385 # "vim_url_admin": description_schema,
386 # "vim_tenant": name_schema,
387 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000388 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200389 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100390 "config": {"type": "object"}
391 },
392 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
393 "additionalProperties": False
394}
tierno0f98af52018-03-19 10:28:22 +0100395
tierno55ba2e62018-12-11 17:22:22 +0000396wim_account_edit_schema = {
397 "title": "wim_account edit input schema",
398 "$schema": "http://json-schema.org/draft-04/schema#",
399 "type": "object",
400 "properties": {
401 "name": name_schema,
402 "description": description_schema,
tiernofd160572019-01-21 10:41:37 +0000403 "type": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000404 "wim": name_schema,
405 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000406 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000407 "password": passwd_schema,
408 "config": {"type": "object"}
409 },
410 "additionalProperties": False
411}
412
413wim_account_new_schema = {
414 "title": "wim_account creation input schema",
415 "$schema": "http://json-schema.org/draft-04/schema#",
416 "type": "object",
417 "properties": {
418 "schema_version": schema_version,
419 "schema_type": schema_type,
420 "name": name_schema,
421 "description": description_schema,
422 "wim": name_schema,
423 "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac"]},
424 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000425 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000426 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000427 "config": {
428 "type": "object",
429 "patternProperties": {
430 ".": {"not": {"type": "null"}}
431 }
432 }
tierno55ba2e62018-12-11 17:22:22 +0000433 },
434 "required": ["name", "wim_url", "wim_type"],
435 "additionalProperties": False
436}
tierno0f98af52018-03-19 10:28:22 +0100437
438sdn_properties = {
439 "name": name_schema,
tiernocfb07c62018-05-10 18:30:51 +0200440 "description": description_schema,
tiernocb83c942018-09-24 17:28:13 +0200441 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100442 "ip": ip_schema,
443 "port": port_schema,
444 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
445 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tiernofd160572019-01-21 10:41:37 +0000446 "user": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100447 "password": passwd_schema
448}
449sdn_new_schema = {
450 "title": "sdn controller information schema",
451 "$schema": "http://json-schema.org/draft-04/schema#",
452 "type": "object",
453 "properties": sdn_properties,
454 "required": ["name", "port", 'ip', 'dpid', 'type'],
455 "additionalProperties": False
456}
457sdn_edit_schema = {
458 "title": "sdn controller update information schema",
459 "$schema": "http://json-schema.org/draft-04/schema#",
460 "type": "object",
461 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200462 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100463 "additionalProperties": False
464}
465sdn_port_mapping_schema = {
466 "$schema": "http://json-schema.org/draft-04/schema#",
467 "title": "sdn port mapping information schema",
468 "type": "array",
469 "items": {
470 "type": "object",
471 "properties": {
tiernofd160572019-01-21 10:41:37 +0000472 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100473 "ports": {
474 "type": "array",
475 "items": {
476 "type": "object",
477 "properties": {
tierno42fce592018-11-02 09:23:43 +0100478 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000479 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100480 "switch_mac": mac_schema
481 },
482 "required": ["pci"]
483 }
484 }
485 },
486 "required": ["compute_node", "ports"]
487 }
488}
489sdn_external_port_schema = {
490 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200491 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100492 "type": "object",
493 "properties": {
494 "port": {"type": "string", "minLength": 1, "maxLength": 60},
495 "vlan": vlan_schema,
496 "mac": mac_schema
497 },
498 "required": ["port"]
499}
500
tiernocb83c942018-09-24 17:28:13 +0200501# PDUs
502pdu_interface = {
503 "type": "object",
504 "properties": {
tiernofd160572019-01-21 10:41:37 +0000505 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200506 "mgmt": bool_schema,
507 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100508 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200509 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100510 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000511 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
512 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100513 # # provide this in case SDN assist must deal with this interface
514 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000515 # "switch-port": shortname_schema,
516 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100517 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200518 },
tierno36ec8602018-11-02 17:27:11 +0100519 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200520 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200521}
tiernocb83c942018-09-24 17:28:13 +0200522pdu_new_schema = {
523 "title": "pdu creation input schema",
524 "$schema": "http://json-schema.org/draft-04/schema#",
525 "type": "object",
526 "properties": {
tiernofd160572019-01-21 10:41:37 +0000527 "name": shortname_schema,
528 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200529 "description": description_schema,
530 "shared": bool_schema,
531 "vims": nameshort_list_schema,
532 "vim_accounts": nameshort_list_schema,
533 "interfaces": {
534 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100535 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200536 "minItems": 1
537 }
538 },
539 "required": ["name", "type", "interfaces"],
540 "additionalProperties": False
541}
542
543pdu_edit_schema = {
544 "title": "pdu edit input schema",
545 "$schema": "http://json-schema.org/draft-04/schema#",
546 "type": "object",
547 "properties": {
tiernofd160572019-01-21 10:41:37 +0000548 "name": shortname_schema,
549 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200550 "description": description_schema,
551 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100552 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
553 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
554 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200555 array_edition_schema,
556 {
557 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100558 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200559 "minItems": 1
560 }
561 ]}
562 },
563 "additionalProperties": False,
564 "minProperties": 1
565}
566
567# USERS
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100568project_role_mapping = {
569 "title": "",
570 "$schema": "http://json-schema.org/draft-04/schema#",
571 "type": "object",
572 "properties": {
573 "project": shortname_schema,
574 "role": shortname_schema
575 },
576 "required": ["project", "role"],
577 "additionalProperties": False
578}
tiernocd54a4a2018-09-12 16:40:35 +0200579user_new_schema = {
580 "$schema": "http://json-schema.org/draft-04/schema#",
581 "title": "New user schema",
582 "type": "object",
583 "properties": {
tiernofd160572019-01-21 10:41:37 +0000584 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200585 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200586 "projects": nameshort_list_schema,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100587 "project_role_mappings": {
588 "type": "array",
589 "items": project_role_mapping,
590 "minItems": 1
591 },
tiernocd54a4a2018-09-12 16:40:35 +0200592 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100593 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200594 "additionalProperties": False
595}
596user_edit_schema = {
597 "$schema": "http://json-schema.org/draft-04/schema#",
598 "title": "User edit schema for administrators",
599 "type": "object",
600 "properties": {
601 "password": passwd_schema,
602 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100603 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200604 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200605 array_edition_schema
606 ]
607 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100608 "project_role_mappings": {
609 "type": "array",
610 "items": project_role_mapping,
611 "minItems": 1
612 },
tiernocb83c942018-09-24 17:28:13 +0200613 },
614 "minProperties": 1,
615 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200616}
617
618# PROJECTS
619project_new_schema = {
620 "$schema": "http://json-schema.org/draft-04/schema#",
621 "title": "New project schema for administrators",
622 "type": "object",
623 "properties": {
tiernofd160572019-01-21 10:41:37 +0000624 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200625 "admin": bool_schema,
626 },
627 "required": ["name"],
628 "additionalProperties": False
629}
630project_edit_schema = {
631 "$schema": "http://json-schema.org/draft-04/schema#",
632 "title": "Project edit schema for administrators",
633 "type": "object",
634 "properties": {
635 "admin": bool_schema,
636 },
637 "additionalProperties": False,
638 "minProperties": 1
639}
640
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100641# ROLES
642roles_new_schema = {
643 "$schema": "http://json-schema.org/draft-04/schema#",
644 "title": "New role schema for administrators",
645 "type": "object",
646 "properties": {
647 "name": shortname_schema,
648 "definition": object_schema,
649 },
650 "required": ["name"],
651 "additionalProperties": False
652}
653roles_edit_schema = {
654 "$schema": "http://json-schema.org/draft-04/schema#",
655 "title": "Roles edit schema for administrators",
656 "type": "object",
657 "properties": {
658 "_id": id_schema,
659 "name": shortname_schema,
660 "definition": object_schema,
661 },
662 "required": ["_id", "name", "definition"],
663 "additionalProperties": False,
664 "minProperties": 1
665}
666
tiernocd54a4a2018-09-12 16:40:35 +0200667# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100668
669nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200670 "users": user_new_schema,
671 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200672 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200673 "sdns": sdn_new_schema,
674 "ns_instantiate": ns_instantiate,
675 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200676 "ns_scale": ns_scale,
677 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100678}
679
680nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200681 "users": user_edit_schema,
682 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200683 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200684 "sdns": sdn_edit_schema,
685 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100686}
687
Felipe Vicens07f31722018-10-29 15:16:44 +0100688# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000689nsi_subnet_instantiate = deepcopy(ns_instantiate)
690nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
691nsi_subnet_instantiate["properties"]["id"] = name_schema
692del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100693
694nsi_vld_instantiate = {
695 "title": "netslice vld instantiation params input schema",
696 "$schema": "http://json-schema.org/draft-04/schema#",
697 "type": "object",
698 "properties": {
699 "name": string_schema,
700 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100701 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100702 "ip-profile": object_schema,
703 },
704 "required": ["name"],
705 "additionalProperties": False
706}
707
Felipe Vicens07f31722018-10-29 15:16:44 +0100708nsi_instantiate = {
709 "title": "netslice action instantiate input schema",
710 "$schema": "http://json-schema.org/draft-04/schema#",
711 "type": "object",
712 "properties": {
713 "lcmOperationType": string_schema,
714 "nsiInstanceId": id_schema,
715 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000716 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000717 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100718 "vimAccountId": id_schema,
719 "ssh_keys": {"type": "string"},
720 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000721 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100722 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100723 "type": "array",
724 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000725 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100726 },
727 "netslice-vld": {
728 "type": "array",
729 "minItems": 1,
730 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100731 },
732 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100733 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100734 "additionalProperties": False
735}
736
737nsi_action = {
738
739}
740
741nsi_terminate = {
742
743}
744
tierno0f98af52018-03-19 10:28:22 +0100745
746class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100747 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
748 self.http_code = http_code
749 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100750
751
tiernob24258a2018-10-04 18:39:49 +0200752def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100753 """
tiernocd54a4a2018-09-12 16:40:35 +0200754 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100755 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200756 :param schema_to_use: jsonschema to test
757 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100758 """
759 try:
tierno0f98af52018-03-19 10:28:22 +0100760 if schema_to_use:
761 js_v(indata, schema_to_use)
762 return None
763 except js_e.ValidationError as e:
764 if e.path:
tierno0da52252018-06-27 15:47:22 +0200765 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100766 else:
767 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200768 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100769 except js_e.SchemaError:
770 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)