osm_nbi/validation.py

   1 # -*- coding: utf-8 -*-
   2
   3 # 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
  16 from jsonschema import validate as js_v, exceptions as js_e
  17 from http import HTTPStatus
  18 from copy import deepcopy
  19 from uuid import UUID   # To test for valid UUID
  20
  21 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  22 __version__ = "0.1"
  23 version_date = "Mar 2018"
  24
  25 """
  26 Validator of input data using JSON schemas for those items that not contains an  OSM yang information model
  27 """
  28
  29 # Basis schemas
  30 patern_name = "^[ -~]+$"
  31 shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"}
  32 passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
  33 name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
  34 string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
  35 xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
  36 description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
  37 id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
  38 bool_schema = {"type": "boolean"}
  39 null_schema = {"type": "null"}
  40 # "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}$"
  41 id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
  42 time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
  43 pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
  44 # allows [] for wildcards. For that reason huge length limit is set
  45 pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
  46 http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
  47 bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
  48 memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
  49 integer0_schema = {"type": "integer", "minimum": 0}
  50 integer1_schema = {"type": "integer", "minimum": 1}
  51 path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
  52 vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
  53 vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
  54 mac_schema = {"type": "string",
  55               "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"}  # must be unicast: LSB bit of MSB byte ==0
  56 dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
  57 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
  58 ip_schema = {"type": "string",
  59              "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]?)$"}
  60 ip_prefix_schema = {"type": "string",
  61                     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
  62                                "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
  63 port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
  64 object_schema = {"type": "object"}
  65 schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
  66 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
  67 log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
  68 checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
  69 size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
  70 array_edition_schema = {
  71     "type": "object",
  72     "patternProperties": {
  73         "^\\$": {}
  74     },
  75     "additionalProperties": False,
  76     "minProperties": 1,
  77 }
  78 nameshort_list_schema = {
  79     "type": "array",
  80     "minItems": 1,
  81     "items": shortname_schema,
  82 }
  83
  84
  85 ns_instantiate_vdu = {
  86     "title": "ns action instantiate input schema for vdu",
  87     "$schema": "http://json-schema.org/draft-04/schema#",
  88     "type": "object",
  89     "properties": {
  90         "id": name_schema,
  91         "volume": {
  92             "type": "array",
  93             "minItems": 1,
  94             "items": {
  95                 "type": "object",
  96                 "properties": {
  97                     "name": name_schema,
  98                     "vim-volume-id": name_schema,
  99                 },
 100                 "required": ["name", "vim-volume-id"],
 101                 "additionalProperties": False
 102             }
 103         },
 104         "interface": {
 105             "type": "array",
 106             "minItems": 1,
 107             "items": {
 108                 "type": "object",
 109                 "properties": {
 110                     "name": name_schema,
 111                     "ip-address": ip_schema,
 112                     "mac-address": mac_schema,
 113                     "floating-ip-required": bool_schema,
 114                 },
 115                 "required": ["name"],
 116                 "additionalProperties": False
 117             }
 118         }
 119     },
 120     "required": ["id"],
 121     "additionalProperties": False
 122 }
 123
 124 ip_profile_dns_schema = {
 125     "type": "array",
 126     "minItems": 1,
 127     "items": {
 128         "type": "object",
 129         "properties": {
 130             "address": ip_schema,
 131         },
 132         "required": ["address"],
 133         "additionalProperties": False
 134     }
 135 }
 136
 137 ip_profile_dhcp_schema = {
 138     "type": "object",
 139     "properties": {
 140         "enabled": {"type": "boolean"},
 141         "count": integer1_schema,
 142         "start-address": ip_schema
 143     },
 144     "additionalProperties": False,
 145 }
 146
 147 ip_profile_schema = {
 148     "title": "ip profile validation schame",
 149     "$schema": "http://json-schema.org/draft-04/schema#",
 150     "type": "object",
 151     "properties": {
 152         "ip-version": {"enum": ["ipv4", "ipv6"]},
 153         "subnet-address": ip_prefix_schema,
 154         "gateway-address": ip_schema,
 155         "dns-server": ip_profile_dns_schema,
 156         "dhcp-params": ip_profile_dhcp_schema,
 157     }
 158 }
 159
 160 ip_profile_update_schema = {
 161     "title": "ip profile validation schame",
 162     "$schema": "http://json-schema.org/draft-04/schema#",
 163     "type": "object",
 164     "properties": {
 165         "ip-version": {"enum": ["ipv4", "ipv6"]},
 166         "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
 167         "gateway-address": {"oneOf": [null_schema, ip_schema]},
 168         "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
 169
 170         "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
 171     },
 172     "additionalProperties": False
 173 }
 174
 175 ns_instantiate_internal_vld = {
 176     "title": "ns action instantiate input schema for vdu",
 177     "$schema": "http://json-schema.org/draft-04/schema#",
 178     "type": "object",
 179     "properties": {
 180         "name": name_schema,
 181         "vim-network-name": name_schema,
 182         "vim-network-id": name_schema,
 183         "ip-profile": ip_profile_update_schema,
 184         "internal-connection-point": {
 185             "type": "array",
 186             "minItems": 1,
 187             "items": {
 188                 "type": "object",
 189                 "properties": {
 190                     "id-ref": name_schema,
 191                     "ip-address": ip_schema,
 192                     # "mac-address": mac_schema,
 193                 },
 194                 "required": ["id-ref"],
 195                 "minProperties": 2,
 196                 "additionalProperties": False
 197             },
 198         }
 199     },
 200     "required": ["name"],
 201     "minProperties": 2,
 202     "additionalProperties": False
 203 }
 204
 205 additional_params_for_vnf = {
 206     "type": "array",
 207     "items": {
 208         "type": "object",
 209         "properties": {
 210             "member-vnf-index": name_schema,
 211             "additionalParams": object_schema,
 212         },
 213         "required": ["member-vnf-index", "additionalParams"],
 214         "additionalProperties": False
 215     }
 216
 217 }
 218
 219 ns_instantiate = {
 220     "title": "ns action instantiate input schema",
 221     "$schema": "http://json-schema.org/draft-04/schema#",
 222     "type": "object",
 223     "properties": {
 224         "lcmOperationType": string_schema,
 225         "nsInstanceId": id_schema,
 226         "netsliceInstanceId": id_schema,
 227         "nsName": name_schema,
 228         "nsDescription": {"oneOf": [description_schema, null_schema]},
 229         "nsdId": id_schema,
 230         "vimAccountId": id_schema,
 231         "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
 232         "additionalParamsForNs": object_schema,
 233         "additionalParamsForVnf": additional_params_for_vnf,
 234         "ssh_keys": {"type": "array", "items": {"type": "string"}},
 235         "nsr_id": id_schema,
 236         "vduImage": name_schema,
 237         "vnf": {
 238             "type": "array",
 239             "minItems": 1,
 240             "items": {
 241                 "type": "object",
 242                 "properties": {
 243                     "member-vnf-index": name_schema,
 244                     "vimAccountId": id_schema,
 245                     "vdu": {
 246                         "type": "array",
 247                         "minItems": 1,
 248                         "items": ns_instantiate_vdu,
 249                     },
 250                     "internal-vld": {
 251                         "type": "array",
 252                         "minItems": 1,
 253                         "items": ns_instantiate_internal_vld
 254                     }
 255                 },
 256                 "required": ["member-vnf-index"],
 257                 "minProperties": 2,
 258                 "additionalProperties": False
 259             }
 260         },
 261         "vld": {
 262             "type": "array",
 263             "minItems": 1,
 264             "items": {
 265                 "type": "object",
 266                 "properties": {
 267                     "name": string_schema,
 268                     "vim-network-name": {"OneOf": [string_schema, object_schema]},
 269                     "vim-network-id": {"OneOf": [string_schema, object_schema]},
 270                     "ns-net": object_schema,
 271                     "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
 272                     "ip-profile": object_schema,
 273                     "vnfd-connection-point-ref": {
 274                         "type": "array",
 275                         "minItems": 1,
 276                         "items": {
 277                             "type": "object",
 278                             "properties": {
 279                                 "member-vnf-index-ref": name_schema,
 280                                 "vnfd-connection-point-ref": name_schema,
 281                                 "ip-address": ip_schema,
 282                                 # "mac-address": mac_schema,
 283                             },
 284                             "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
 285                             "minProperties": 3,
 286                             "additionalProperties": False
 287                         },
 288                     }
 289                 },
 290                 "required": ["name"],
 291                 "additionalProperties": False
 292             }
 293         },
 294     },
 295     "required": ["nsName", "nsdId", "vimAccountId"],
 296     "additionalProperties": False
 297 }
 298
 299 ns_action = {   # TODO for the moment it is only contemplated the vnfd primitive execution
 300     "title": "ns action input schema",
 301     "$schema": "http://json-schema.org/draft-04/schema#",
 302     "type": "object",
 303     "properties": {
 304         "lcmOperationType": string_schema,
 305         "nsInstanceId": id_schema,
 306         "member_vnf_index": name_schema,
 307         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 308         "vdu_id": name_schema,
 309         "vdu_count_index": integer0_schema,
 310         "primitive": name_schema,
 311         "primitive_params": {"type": "object"},
 312     },
 313     "required": ["primitive", "primitive_params"],   # TODO add member_vnf_index
 314     "additionalProperties": False
 315 }
 316 ns_scale = {   # TODO for the moment it is only VDU-scaling
 317     "title": "ns scale input schema",
 318     "$schema": "http://json-schema.org/draft-04/schema#",
 319     "type": "object",
 320     "properties": {
 321         "lcmOperationType": string_schema,
 322         "nsInstanceId": id_schema,
 323         "scaleType": {"enum": ["SCALE_VNF"]},
 324         "scaleVnfData": {
 325             "type": "object",
 326             "properties": {
 327                 "vnfInstanceId": name_schema,
 328                 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
 329                 "scaleByStepData": {
 330                     "type": "object",
 331                     "properties": {
 332                         "scaling-group-descriptor": name_schema,
 333                         "member-vnf-index": name_schema,
 334                         "scaling-policy": name_schema,
 335                     },
 336                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 337                     "additionalProperties": False
 338                 },
 339             },
 340             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 341             "additionalProperties": False
 342         },
 343         "scaleTime": time_schema,
 344     },
 345     "required": ["scaleType", "scaleVnfData"],
 346     "additionalProperties": False
 347 }
 348
 349
 350 schema_version = {"type": "string", "enum": ["1.0"]}
 351 schema_type = {"type": "string"}
 352 vim_type = {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 353
 354 vim_account_edit_schema = {
 355     "title": "vim_account edit input schema",
 356     "$schema": "http://json-schema.org/draft-04/schema#",
 357     "type": "object",
 358     "properties": {
 359         "name": name_schema,
 360         "description": description_schema,
 361         "vim": name_schema,
 362         "datacenter": name_schema,
 363         "vim_type": vim_type,
 364         "vim_url": description_schema,
 365         # "vim_url_admin": description_schema,
 366         # "vim_tenant": name_schema,
 367         "vim_tenant_name": name_schema,
 368         "vim_user": shortname_schema,
 369         "vim_password": passwd_schema,
 370         "config": {"type": "object"}
 371     },
 372     "additionalProperties": False
 373 }
 374
 375 vim_account_new_schema = {
 376     "title": "vim_account creation input schema",
 377     "$schema": "http://json-schema.org/draft-04/schema#",
 378     "type": "object",
 379     "properties": {
 380         "schema_version": schema_version,
 381         "schema_type": schema_type,
 382         "name": name_schema,
 383         "description": description_schema,
 384         "vim": name_schema,
 385         "datacenter": name_schema,
 386         "vim_type": vim_type,
 387         "vim_url": description_schema,
 388         # "vim_url_admin": description_schema,
 389         # "vim_tenant": name_schema,
 390         "vim_tenant_name": name_schema,
 391         "vim_user": shortname_schema,
 392         "vim_password": passwd_schema,
 393         "config": {"type": "object"}
 394     },
 395     "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
 396     "additionalProperties": False
 397 }
 398
 399 wim_type = {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
 400
 401 wim_account_edit_schema = {
 402     "title": "wim_account edit input schema",
 403     "$schema": "http://json-schema.org/draft-04/schema#",
 404     "type": "object",
 405     "properties": {
 406         "name": name_schema,
 407         "description": description_schema,
 408         "wim": name_schema,
 409         "wim_type": wim_type,
 410         "wim_url": description_schema,
 411         "user": shortname_schema,
 412         "password": passwd_schema,
 413         "config": {"type": "object"}
 414     },
 415     "additionalProperties": False
 416 }
 417
 418 wim_account_new_schema = {
 419     "title": "wim_account creation input schema",
 420     "$schema": "http://json-schema.org/draft-04/schema#",
 421     "type": "object",
 422     "properties": {
 423         "schema_version": schema_version,
 424         "schema_type": schema_type,
 425         "name": name_schema,
 426         "description": description_schema,
 427         "wim": name_schema,
 428         "wim_type": wim_type,
 429         "wim_url": description_schema,
 430         "user": shortname_schema,
 431         "password": passwd_schema,
 432         "config": {
 433             "type": "object",
 434             "patternProperties": {
 435                 ".": {"not": {"type": "null"}}
 436             }
 437         }
 438     },
 439     "required": ["name", "wim_url", "wim_type"],
 440     "additionalProperties": False
 441 }
 442
 443 sdn_properties = {
 444     "name": name_schema,
 445     "description": description_schema,
 446     "dpid": dpid_Schema,
 447     "ip": ip_schema,
 448     "port": port_schema,
 449     "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
 450     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 451     "user": shortname_schema,
 452     "password": passwd_schema
 453 }
 454 sdn_new_schema = {
 455     "title": "sdn controller information schema",
 456     "$schema": "http://json-schema.org/draft-04/schema#",
 457     "type": "object",
 458     "properties": sdn_properties,
 459     "required": ["name", "port", 'ip', 'dpid', 'type'],
 460     "additionalProperties": False
 461 }
 462 sdn_edit_schema = {
 463     "title": "sdn controller update information schema",
 464     "$schema": "http://json-schema.org/draft-04/schema#",
 465     "type": "object",
 466     "properties": sdn_properties,
 467     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 468     "additionalProperties": False
 469 }
 470 sdn_port_mapping_schema = {
 471     "$schema": "http://json-schema.org/draft-04/schema#",
 472     "title": "sdn port mapping information schema",
 473     "type": "array",
 474     "items": {
 475         "type": "object",
 476         "properties": {
 477             "compute_node": shortname_schema,
 478             "ports": {
 479                 "type": "array",
 480                 "items": {
 481                     "type": "object",
 482                     "properties": {
 483                         "pci": pci_extended_schema,
 484                         "switch_port": shortname_schema,
 485                         "switch_mac": mac_schema
 486                     },
 487                     "required": ["pci"]
 488                 }
 489             }
 490         },
 491         "required": ["compute_node", "ports"]
 492     }
 493 }
 494 sdn_external_port_schema = {
 495     "$schema": "http://json-schema.org/draft-04/schema#",
 496     "title": "External port information",
 497     "type": "object",
 498     "properties": {
 499         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 500         "vlan": vlan_schema,
 501         "mac": mac_schema
 502     },
 503     "required": ["port"]
 504 }
 505
 506 # K8s Clusters
 507 k8scluster_nets_schema = {
 508     "title": "k8scluster nets input schema",
 509     "$schema": "http://json-schema.org/draft-04/schema#",
 510     "type": "object",
 511     "patternProperties": {".": string_schema},
 512     "minProperties": 1,
 513     "additionalProperties": False
 514 }
 515 k8scluster_new_schema = {
 516     "title": "k8scluster creation input schema",
 517     "$schema": "http://json-schema.org/draft-04/schema#",
 518     "type": "object",
 519     "properties": {
 520         "schema_version": schema_version,
 521         "schema_type": schema_type,
 522         "name": name_schema,
 523         "description": description_schema,
 524         "credentials": object_schema,
 525         "vim_account": id_schema,
 526         "k8s_version": string_schema,
 527         "nets": k8scluster_nets_schema,
 528         "namespace": name_schema,
 529         "cni": nameshort_list_schema,
 530     },
 531     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 532     "additionalProperties": False
 533 }
 534 k8scluster_edit_schema = {
 535     "title": "vim_account edit input schema",
 536     "$schema": "http://json-schema.org/draft-04/schema#",
 537     "type": "object",
 538     "properties": {
 539         "name": name_schema,
 540         "description": description_schema,
 541         "credentials": object_schema,
 542         "vim_account": id_schema,
 543         "k8s_version": string_schema,
 544         "nets": k8scluster_nets_schema,
 545         "namespace": name_schema,
 546         "cni": nameshort_list_schema,
 547     },
 548     "additionalProperties": False
 549 }
 550
 551 # K8s Repos
 552 k8srepo_types = {"enum": ["chart", "bundle"]}
 553 k8srepo_properties = {
 554     "name": name_schema,
 555     "description": description_schema,
 556     "type": k8srepo_types,
 557     "url": description_schema,
 558 }
 559 k8srepo_new_schema = {
 560     "title": "k8scluster creation input schema",
 561     "$schema": "http://json-schema.org/draft-04/schema#",
 562     "type": "object",
 563     "properties": k8srepo_properties,
 564     "required": ["name", "type", "url"],
 565     "additionalProperties": False
 566 }
 567 k8srepo_edit_schema = {
 568     "title": "vim_account edit input schema",
 569     "$schema": "http://json-schema.org/draft-04/schema#",
 570     "type": "object",
 571     "properties": k8srepo_properties,
 572     "additionalProperties": False
 573 }
 574
 575 # PDUs
 576 pdu_interface = {
 577     "type": "object",
 578     "properties": {
 579         "name": shortname_schema,
 580         "mgmt": bool_schema,
 581         "type": {"enum": ["overlay", 'underlay']},
 582         "ip-address": ip_schema,
 583         # TODO, add user, password, ssh-key
 584         "mac-address": mac_schema,
 585         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 586         "vim-network-id": shortname_schema,
 587         # # provide this in case SDN assist must deal with this interface
 588         # "switch-dpid": dpid_Schema,
 589         # "switch-port": shortname_schema,
 590         # "switch-mac": shortname_schema,
 591         # "switch-vlan": vlan_schema,
 592     },
 593     "required": ["name", "mgmt", "ip-address"],
 594     "additionalProperties": False
 595 }
 596 pdu_new_schema = {
 597     "title": "pdu creation input schema",
 598     "$schema": "http://json-schema.org/draft-04/schema#",
 599     "type": "object",
 600     "properties": {
 601         "name": shortname_schema,
 602         "type": shortname_schema,
 603         "description": description_schema,
 604         "shared": bool_schema,
 605         "vims": nameshort_list_schema,
 606         "vim_accounts": nameshort_list_schema,
 607         "interfaces": {
 608             "type": "array",
 609             "items": pdu_interface,
 610             "minItems": 1
 611         }
 612     },
 613     "required": ["name", "type", "interfaces"],
 614     "additionalProperties": False
 615 }
 616
 617 pdu_edit_schema = {
 618     "title": "pdu edit input schema",
 619     "$schema": "http://json-schema.org/draft-04/schema#",
 620     "type": "object",
 621     "properties": {
 622         "name": shortname_schema,
 623         "type": shortname_schema,
 624         "description": description_schema,
 625         "shared": bool_schema,
 626         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 627         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 628         "interfaces": {"oneOf": [
 629             array_edition_schema,
 630             {
 631                 "type": "array",
 632                 "items": pdu_interface,
 633                 "minItems": 1
 634             }
 635         ]}
 636     },
 637     "additionalProperties": False,
 638     "minProperties": 1
 639 }
 640
 641 # USERS
 642 project_role_mappings = {
 643     "title": "list pf projects/roles",
 644     "$schema": "http://json-schema.org/draft-04/schema#",
 645     "type": "array",
 646     "items": {
 647         "type": "object",
 648         "properties": {
 649             "project": shortname_schema,
 650             "role": shortname_schema
 651         },
 652         "required": ["project", "role"],
 653         "additionalProperties": False
 654     },
 655     "minItems": 1
 656 }
 657 project_role_mappings_optional = {
 658     "title": "list of projects/roles or projects only",
 659     "$schema": "http://json-schema.org/draft-04/schema#",
 660     "type": "array",
 661     "items": {
 662         "type": "object",
 663         "properties": {
 664             "project": shortname_schema,
 665             "role": shortname_schema
 666         },
 667         "required": ["project"],
 668         "additionalProperties": False
 669     },
 670     "minItems": 1
 671 }
 672 user_new_schema = {
 673     "$schema": "http://json-schema.org/draft-04/schema#",
 674     "title": "New user schema",
 675     "type": "object",
 676     "properties": {
 677         "username": shortname_schema,
 678         "password": passwd_schema,
 679         "projects": nameshort_list_schema,
 680         "project_role_mappings": project_role_mappings,
 681     },
 682     "required": ["username", "password"],
 683     "additionalProperties": False
 684 }
 685 user_edit_schema = {
 686     "$schema": "http://json-schema.org/draft-04/schema#",
 687     "title": "User edit schema for administrators",
 688     "type": "object",
 689     "properties": {
 690         "password": passwd_schema,
 691         "username": shortname_schema,     # To allow User Name modification
 692         "projects": {
 693             "oneOf": [
 694                 nameshort_list_schema,
 695                 array_edition_schema
 696             ]
 697         },
 698         "project_role_mappings": project_role_mappings,
 699         "add_project_role_mappings": project_role_mappings,
 700         "remove_project_role_mappings": project_role_mappings_optional,
 701     },
 702     "minProperties": 1,
 703     "additionalProperties": False
 704 }
 705
 706 # PROJECTS
 707 topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
 708                      "k8sclusters", "k8srepos"]
 709 project_new_schema = {
 710     "$schema": "http://json-schema.org/draft-04/schema#",
 711     "title": "New project schema for administrators",
 712     "type": "object",
 713     "properties": {
 714         "name": shortname_schema,
 715         "admin": bool_schema,
 716         "quotas": {
 717             "type": "object",
 718             "properties": {topic: integer0_schema for topic in topics_with_quota},
 719             "additionalProperties": False
 720         },
 721     },
 722     "required": ["name"],
 723     "additionalProperties": False
 724 }
 725 project_edit_schema = {
 726     "$schema": "http://json-schema.org/draft-04/schema#",
 727     "title": "Project edit schema for administrators",
 728     "type": "object",
 729     "properties": {
 730         "admin": bool_schema,
 731         "name": shortname_schema,     # To allow Project Name modification
 732         "quotas": {
 733             "type": "object",
 734             "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
 735             "additionalProperties": False
 736         },
 737     },
 738     "additionalProperties": False,
 739     "minProperties": 1
 740 }
 741
 742 # ROLES
 743 roles_new_schema = {
 744     "$schema": "http://json-schema.org/draft-04/schema#",
 745     "title": "New role schema for administrators",
 746     "type": "object",
 747     "properties": {
 748         "name": shortname_schema,
 749         "permissions": {
 750             "type": "object",
 751             "patternProperties": {
 752                 ".": bool_schema,
 753             },
 754             # "minProperties": 1,
 755         }
 756     },
 757     "required": ["name"],
 758     "additionalProperties": False
 759 }
 760 roles_edit_schema = {
 761     "$schema": "http://json-schema.org/draft-04/schema#",
 762     "title": "Roles edit schema for administrators",
 763     "type": "object",
 764     "properties": {
 765         "name": shortname_schema,
 766         "permissions": {
 767             "type": "object",
 768             "patternProperties": {
 769                 ".": {
 770                     "oneOf": [bool_schema, null_schema]
 771                 }
 772             },
 773             # "minProperties": 1,
 774         }
 775     },
 776     "additionalProperties": False,
 777     "minProperties": 1
 778 }
 779
 780 # GLOBAL SCHEMAS
 781
 782 nbi_new_input_schemas = {
 783     "users": user_new_schema,
 784     "projects": project_new_schema,
 785     "vim_accounts": vim_account_new_schema,
 786     "sdns": sdn_new_schema,
 787     "ns_instantiate": ns_instantiate,
 788     "ns_action": ns_action,
 789     "ns_scale": ns_scale,
 790     "pdus": pdu_new_schema,
 791 }
 792
 793 nbi_edit_input_schemas = {
 794     "users": user_edit_schema,
 795     "projects": project_edit_schema,
 796     "vim_accounts": vim_account_edit_schema,
 797     "sdns": sdn_edit_schema,
 798     "pdus": pdu_edit_schema,
 799 }
 800
 801 # NETSLICE SCHEMAS
 802 nsi_subnet_instantiate = deepcopy(ns_instantiate)
 803 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
 804 nsi_subnet_instantiate["properties"]["id"] = name_schema
 805 del nsi_subnet_instantiate["required"]
 806
 807 nsi_vld_instantiate = {
 808     "title": "netslice vld instantiation params input schema",
 809     "$schema": "http://json-schema.org/draft-04/schema#",
 810     "type": "object",
 811     "properties": {
 812         "name": string_schema,
 813         "vim-network-name": {"OneOf": [string_schema, object_schema]},
 814         "vim-network-id": {"OneOf": [string_schema, object_schema]},
 815         "ip-profile": object_schema,
 816     },
 817     "required": ["name"],
 818     "additionalProperties": False
 819 }
 820
 821 nsi_instantiate = {
 822     "title": "netslice action instantiate input schema",
 823     "$schema": "http://json-schema.org/draft-04/schema#",
 824     "type": "object",
 825     "properties": {
 826         "lcmOperationType": string_schema,
 827         "netsliceInstanceId": id_schema,
 828         "nsiName": name_schema,
 829         "nsiDescription": {"oneOf": [description_schema, null_schema]},
 830         "nstId": string_schema,
 831         "vimAccountId": id_schema,
 832         "ssh_keys": {"type": "string"},
 833         "nsi_id": id_schema,
 834         "additionalParamsForNsi": object_schema,
 835         "netslice-subnet": {
 836             "type": "array",
 837             "minItems": 1,
 838             "items": nsi_subnet_instantiate
 839         },
 840         "netslice-vld": {
 841             "type": "array",
 842             "minItems": 1,
 843             "items": nsi_vld_instantiate
 844         },
 845     },
 846     "required": ["nsiName", "nstId", "vimAccountId"],
 847     "additionalProperties": False
 848 }
 849
 850 nsi_action = {
 851
 852 }
 853
 854 nsi_terminate = {
 855
 856 }
 857
 858
 859 class ValidationError(Exception):
 860     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
 861         self.http_code = http_code
 862         Exception.__init__(self, message)
 863
 864
 865 def validate_input(indata, schema_to_use):
 866     """
 867     Validates input data against json schema
 868     :param indata: user input data. Should be a dictionary
 869     :param schema_to_use: jsonschema to test
 870     :return: None if ok, raises ValidationError exception on error
 871     """
 872     try:
 873         if schema_to_use:
 874             js_v(indata, schema_to_use)
 875         return None
 876     except js_e.ValidationError as e:
 877         if e.path:
 878             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
 879         else:
 880             error_pos = ""
 881         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
 882     except js_e.SchemaError:
 883         raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
 884
 885
 886 def is_valid_uuid(x):
 887     """
 888     Test for a valid UUID
 889     :param x: string to test
 890     :return: True if x is a valid uuid, False otherwise
 891     """
 892     try:
 893         if UUID(x):
 894             return True
 895     except (TypeError, ValueError, AttributeError):
 896         return False