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 schema",
 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 schema",
 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 provider_network_schema = {
 176     "title": "provider network validation schema",
 177     "$schema": "http://json-schema.org/draft-04/schema#",
 178     "type": "object",
 179     "properties": {
 180         "physical-network": name_schema,
 181         "segmentation-id": name_schema,
 182         "sdn-ports": {  # external ports to append to the SDN-assist network
 183             "type": "array",
 184             "items": {
 185                 "type": "object",
 186                 "properties": {
 187                     "switch_id": shortname_schema,
 188                     "switch_port": shortname_schema,
 189                     "mac_address": mac_schema,
 190                     "vlan": vlan_schema,
 191                 },
 192                 "additionalProperties": True
 193             }
 194         },
 195         "network-type": shortname_schema,
 196     },
 197     "additionalProperties": True
 198 }
 199
 200 ns_instantiate_internal_vld = {
 201     "title": "ns action instantiate input schema for vdu",
 202     "$schema": "http://json-schema.org/draft-04/schema#",
 203     "type": "object",
 204     "properties": {
 205         "name": name_schema,
 206         "vim-network-name": name_schema,
 207         "vim-network-id": name_schema,
 208         "ip-profile": ip_profile_update_schema,
 209         "provider-network": provider_network_schema,
 210         "internal-connection-point": {
 211             "type": "array",
 212             "minItems": 1,
 213             "items": {
 214                 "type": "object",
 215                 "properties": {
 216                     "id-ref": name_schema,
 217                     "ip-address": ip_schema,
 218                     # "mac-address": mac_schema,
 219                 },
 220                 "required": ["id-ref"],
 221                 "minProperties": 2,
 222                 "additionalProperties": False
 223             },
 224         }
 225     },
 226     "required": ["name"],
 227     "minProperties": 2,
 228     "additionalProperties": False
 229 }
 230
 231 additional_params_for_vnf = {
 232     "type": "array",
 233     "items": {
 234         "type": "object",
 235         "properties": {
 236             "member-vnf-index": name_schema,
 237             "additionalParams": object_schema,
 238             "k8s-namespace": name_schema,
 239             "config-units": integer1_schema,  # number of configuration units of this vnf, by default 1
 240             "additionalParamsForVdu": {
 241                 "type": "array",
 242                 "items": {
 243                     "type": "object",
 244                     "properties": {
 245                         "vdu_id": name_schema,
 246                         "additionalParams": object_schema,
 247                         "config-units": integer1_schema,   # number of configuration units of this vdu, by default 1
 248                     },
 249                     "required": ["vdu_id"],
 250                     "minProperties": 2,
 251                     "additionalProperties": False,
 252                 },
 253             },
 254             "additionalParamsForKdu": {
 255                 "type": "array",
 256                 "items": {
 257                     "type": "object",
 258                     "properties": {
 259                         "kdu_name": name_schema,
 260                         "additionalParams": object_schema,
 261                         "kdu_model": name_schema,
 262                         "k8s-namespace": name_schema,
 263                         "config-units": integer1_schema,    # number of configuration units of this knf, by default 1
 264                     },
 265                     "required": ["kdu_name"],
 266                     "minProperties": 2,
 267                     "additionalProperties": False,
 268                 },
 269             },
 270         },
 271         "required": ["member-vnf-index"],
 272         "minProperties": 2,
 273         "additionalProperties": False
 274     }
 275 }
 276
 277 ns_instantiate = {
 278     "title": "ns action instantiate input schema",
 279     "$schema": "http://json-schema.org/draft-04/schema#",
 280     "type": "object",
 281     "properties": {
 282         "lcmOperationType": string_schema,
 283         "nsInstanceId": id_schema,
 284         "netsliceInstanceId": id_schema,
 285         "nsName": name_schema,
 286         "nsDescription": {"oneOf": [description_schema, null_schema]},
 287         "nsdId": id_schema,
 288         "vimAccountId": id_schema,
 289         "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
 290         "placement-engine": string_schema,
 291         "placement-constraints": object_schema,
 292         "additionalParamsForNs": object_schema,
 293         "additionalParamsForVnf": additional_params_for_vnf,
 294         "config-units": integer1_schema,    # number of configuration units of this ns, by default 1
 295         "k8s-namespace": name_schema,
 296         "ssh_keys": {"type": "array", "items": {"type": "string"}},
 297         "timeout_ns_deploy": integer1_schema,
 298         "nsr_id": id_schema,
 299         "vduImage": name_schema,
 300         "vnf": {
 301             "type": "array",
 302             "minItems": 1,
 303             "items": {
 304                 "type": "object",
 305                 "properties": {
 306                     "member-vnf-index": name_schema,
 307                     "vimAccountId": id_schema,
 308                     "vdu": {
 309                         "type": "array",
 310                         "minItems": 1,
 311                         "items": ns_instantiate_vdu,
 312                     },
 313                     "internal-vld": {
 314                         "type": "array",
 315                         "minItems": 1,
 316                         "items": ns_instantiate_internal_vld
 317                     }
 318                 },
 319                 "required": ["member-vnf-index"],
 320                 "minProperties": 2,
 321                 "additionalProperties": False
 322             }
 323         },
 324         "vld": {
 325             "type": "array",
 326             "minItems": 1,
 327             "items": {
 328                 "type": "object",
 329                 "properties": {
 330                     "name": string_schema,
 331                     "vim-network-name": {"OneOf": [string_schema, object_schema]},
 332                     "vim-network-id": {"OneOf": [string_schema, object_schema]},
 333                     "ns-net": object_schema,
 334                     "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
 335                     "ip-profile": object_schema,
 336                     "provider-network": provider_network_schema,
 337                     "vnfd-connection-point-ref": {
 338                         "type": "array",
 339                         "minItems": 1,
 340                         "items": {
 341                             "type": "object",
 342                             "properties": {
 343                                 "member-vnf-index-ref": name_schema,
 344                                 "vnfd-connection-point-ref": name_schema,
 345                                 "ip-address": ip_schema,
 346                                 # "mac-address": mac_schema,
 347                             },
 348                             "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
 349                             "minProperties": 3,
 350                             "additionalProperties": False
 351                         },
 352                     }
 353                 },
 354                 "required": ["name"],
 355                 "additionalProperties": False
 356             }
 357         },
 358     },
 359     "required": ["nsName", "nsdId", "vimAccountId"],
 360     "additionalProperties": False
 361 }
 362
 363 ns_terminate = {
 364     "title": "ns terminate input schema",
 365     "$schema": "http://json-schema.org/draft-04/schema#",
 366     "type": "object",
 367     "properties": {
 368         "lcmOperationType": string_schema,
 369         "nsInstanceId": id_schema,
 370         "autoremove": bool_schema,
 371         "timeout_ns_terminate": integer1_schema,
 372         "skip_terminate_primitives": bool_schema,
 373         "netsliceInstanceId": id_schema,
 374     },
 375     "additionalProperties": False
 376 }
 377
 378 ns_action = {   # TODO for the moment it is only contemplated the vnfd primitive execution
 379     "title": "ns action input schema",
 380     "$schema": "http://json-schema.org/draft-04/schema#",
 381     "type": "object",
 382     "properties": {
 383         "lcmOperationType": string_schema,
 384         "nsInstanceId": id_schema,
 385         "member_vnf_index": name_schema,
 386         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 387         "vdu_id": name_schema,
 388         "vdu_count_index": integer0_schema,
 389         "kdu_name": name_schema,
 390         "primitive": name_schema,
 391         "timeout_ns_action": integer1_schema,
 392         "primitive_params": {"type": "object"},
 393     },
 394     "required": ["primitive", "primitive_params"],   # TODO add member_vnf_index
 395     "additionalProperties": False
 396 }
 397 ns_scale = {   # TODO for the moment it is only VDU-scaling
 398     "title": "ns scale input schema",
 399     "$schema": "http://json-schema.org/draft-04/schema#",
 400     "type": "object",
 401     "properties": {
 402         "lcmOperationType": string_schema,
 403         "nsInstanceId": id_schema,
 404         "scaleType": {"enum": ["SCALE_VNF"]},
 405         "timeout_ns_scale": integer1_schema,
 406         "scaleVnfData": {
 407             "type": "object",
 408             "properties": {
 409                 "vnfInstanceId": name_schema,
 410                 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
 411                 "scaleByStepData": {
 412                     "type": "object",
 413                     "properties": {
 414                         "scaling-group-descriptor": name_schema,
 415                         "member-vnf-index": name_schema,
 416                         "scaling-policy": name_schema,
 417                     },
 418                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 419                     "additionalProperties": False
 420                 },
 421             },
 422             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 423             "additionalProperties": False
 424         },
 425         "scaleTime": time_schema,
 426     },
 427     "required": ["scaleType", "scaleVnfData"],
 428     "additionalProperties": False
 429 }
 430
 431
 432 schema_version = {"type": "string", "enum": ["1.0"]}
 433 schema_type = {"type": "string"}
 434 vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 435
 436 vim_account_edit_schema = {
 437     "title": "vim_account edit input schema",
 438     "$schema": "http://json-schema.org/draft-04/schema#",
 439     "type": "object",
 440     "properties": {
 441         "name": name_schema,
 442         "description": description_schema,
 443         "vim": name_schema,
 444         "datacenter": name_schema,
 445         "vim_type": vim_type,
 446         "vim_url": description_schema,
 447         # "vim_url_admin": description_schema,
 448         # "vim_tenant": name_schema,
 449         "vim_tenant_name": name_schema,
 450         "vim_user": shortname_schema,
 451         "vim_password": passwd_schema,
 452         "config": {"type": "object"}
 453     },
 454     "additionalProperties": False
 455 }
 456
 457 vim_account_new_schema = {
 458     "title": "vim_account creation input schema",
 459     "$schema": "http://json-schema.org/draft-04/schema#",
 460     "type": "object",
 461     "properties": {
 462         "schema_version": schema_version,
 463         "schema_type": schema_type,
 464         "name": name_schema,
 465         "description": description_schema,
 466         "vim": name_schema,
 467         "datacenter": name_schema,
 468         "vim_type": vim_type,
 469         "vim_url": description_schema,
 470         # "vim_url_admin": description_schema,
 471         # "vim_tenant": name_schema,
 472         "vim_tenant_name": name_schema,
 473         "vim_user": shortname_schema,
 474         "vim_password": passwd_schema,
 475         "config": {"type": "object"}
 476     },
 477     "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
 478     "additionalProperties": False
 479 }
 480
 481 wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
 482
 483 wim_account_edit_schema = {
 484     "title": "wim_account edit input schema",
 485     "$schema": "http://json-schema.org/draft-04/schema#",
 486     "type": "object",
 487     "properties": {
 488         "name": name_schema,
 489         "description": description_schema,
 490         "wim": name_schema,
 491         "wim_type": wim_type,
 492         "wim_url": description_schema,
 493         "user": shortname_schema,
 494         "password": passwd_schema,
 495         "config": {"type": "object"}
 496     },
 497     "additionalProperties": False
 498 }
 499
 500 wim_account_new_schema = {
 501     "title": "wim_account creation input schema",
 502     "$schema": "http://json-schema.org/draft-04/schema#",
 503     "type": "object",
 504     "properties": {
 505         "schema_version": schema_version,
 506         "schema_type": schema_type,
 507         "name": name_schema,
 508         "description": description_schema,
 509         "wim": name_schema,
 510         "wim_type": wim_type,
 511         "wim_url": description_schema,
 512         "user": shortname_schema,
 513         "password": passwd_schema,
 514         "config": {
 515             "type": "object",
 516             "patternProperties": {
 517                 ".": {"not": {"type": "null"}}
 518             }
 519         }
 520     },
 521     "required": ["name", "wim_url", "wim_type"],
 522     "additionalProperties": False
 523 }
 524
 525 sdn_properties = {
 526     "name": name_schema,
 527     "type": {"type": "string"},
 528     "url": {"type": "string"},
 529     "user": shortname_schema,
 530     "password": passwd_schema,
 531     "config": {"type": "object"},
 532     "description": description_schema,
 533     # The folowing are deprecated. Maintanied for backward compatibility
 534     "dpid": dpid_Schema,
 535     "ip": ip_schema,
 536     "port": port_schema,
 537     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 538 }
 539 sdn_new_schema = {
 540     "title": "sdn controller information schema",
 541     "$schema": "http://json-schema.org/draft-04/schema#",
 542     "type": "object",
 543     "properties": sdn_properties,
 544     "required": ["name", 'type'],
 545     "additionalProperties": False
 546 }
 547 sdn_edit_schema = {
 548     "title": "sdn controller update information schema",
 549     "$schema": "http://json-schema.org/draft-04/schema#",
 550     "type": "object",
 551     "properties": sdn_properties,
 552     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 553     "additionalProperties": False
 554 }
 555 sdn_port_mapping_schema = {
 556     "$schema": "http://json-schema.org/draft-04/schema#",
 557     "title": "sdn port mapping information schema",
 558     "type": "array",
 559     "items": {
 560         "type": "object",
 561         "properties": {
 562             "compute_node": shortname_schema,
 563             "ports": {
 564                 "type": "array",
 565                 "items": {
 566                     "type": "object",
 567                     "properties": {
 568                         "pci": pci_extended_schema,
 569                         "switch_port": shortname_schema,
 570                         "switch_mac": mac_schema
 571                     },
 572                     "required": ["pci"]
 573                 }
 574             }
 575         },
 576         "required": ["compute_node", "ports"]
 577     }
 578 }
 579 sdn_external_port_schema = {
 580     "$schema": "http://json-schema.org/draft-04/schema#",
 581     "title": "External port information",
 582     "type": "object",
 583     "properties": {
 584         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 585         "vlan": vlan_schema,
 586         "mac": mac_schema
 587     },
 588     "required": ["port"]
 589 }
 590
 591 # K8s Clusters
 592 k8scluster_nets_schema = {
 593     "title": "k8scluster nets input schema",
 594     "$schema": "http://json-schema.org/draft-04/schema#",
 595     "type": "object",
 596     "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
 597     "minProperties": 1,
 598     "additionalProperties": False
 599 }
 600 k8scluster_new_schema = {
 601     "title": "k8scluster creation input schema",
 602     "$schema": "http://json-schema.org/draft-04/schema#",
 603     "type": "object",
 604     "properties": {
 605         "schema_version": schema_version,
 606         "schema_type": schema_type,
 607         "name": name_schema,
 608         "description": description_schema,
 609         "credentials": object_schema,
 610         "vim_account": id_schema,
 611         "k8s_version": string_schema,
 612         "nets": k8scluster_nets_schema,
 613         "namespace": name_schema,
 614         "cni": nameshort_list_schema,
 615     },
 616     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 617     "additionalProperties": False
 618 }
 619 k8scluster_edit_schema = {
 620     "title": "vim_account edit input schema",
 621     "$schema": "http://json-schema.org/draft-04/schema#",
 622     "type": "object",
 623     "properties": {
 624         "name": name_schema,
 625         "description": description_schema,
 626         "credentials": object_schema,
 627         "vim_account": id_schema,
 628         "k8s_version": string_schema,
 629         "nets": k8scluster_nets_schema,
 630         "namespace": name_schema,
 631         "cni": nameshort_list_schema,
 632     },
 633     "additionalProperties": False
 634 }
 635
 636 # K8s Repos
 637 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
 638 k8srepo_properties = {
 639     "name": name_schema,
 640     "description": description_schema,
 641     "type": k8srepo_types,
 642     "url": description_schema,
 643 }
 644 k8srepo_new_schema = {
 645     "title": "k8scluster creation input schema",
 646     "$schema": "http://json-schema.org/draft-04/schema#",
 647     "type": "object",
 648     "properties": k8srepo_properties,
 649     "required": ["name", "type", "url"],
 650     "additionalProperties": False
 651 }
 652 k8srepo_edit_schema = {
 653     "title": "vim_account edit input schema",
 654     "$schema": "http://json-schema.org/draft-04/schema#",
 655     "type": "object",
 656     "properties": k8srepo_properties,
 657     "additionalProperties": False
 658 }
 659
 660 # PDUs
 661 pdu_interface = {
 662     "type": "object",
 663     "properties": {
 664         "name": shortname_schema,
 665         "mgmt": bool_schema,
 666         "type": {"enum": ["overlay", 'underlay']},
 667         "ip-address": ip_schema,
 668         # TODO, add user, password, ssh-key
 669         "mac-address": mac_schema,
 670         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 671         "vim-network-id": shortname_schema,
 672         # # provide this in case SDN assist must deal with this interface
 673         # "switch-dpid": dpid_Schema,
 674         # "switch-port": shortname_schema,
 675         # "switch-mac": shortname_schema,
 676         # "switch-vlan": vlan_schema,
 677     },
 678     "required": ["name", "mgmt", "ip-address"],
 679     "additionalProperties": False
 680 }
 681 pdu_new_schema = {
 682     "title": "pdu creation input schema",
 683     "$schema": "http://json-schema.org/draft-04/schema#",
 684     "type": "object",
 685     "properties": {
 686         "name": shortname_schema,
 687         "type": shortname_schema,
 688         "description": description_schema,
 689         "shared": bool_schema,
 690         "vims": nameshort_list_schema,
 691         "vim_accounts": nameshort_list_schema,
 692         "interfaces": {
 693             "type": "array",
 694             "items": pdu_interface,
 695             "minItems": 1
 696         }
 697     },
 698     "required": ["name", "type", "interfaces"],
 699     "additionalProperties": False
 700 }
 701 pdu_edit_schema = {
 702     "title": "pdu edit input schema",
 703     "$schema": "http://json-schema.org/draft-04/schema#",
 704     "type": "object",
 705     "properties": {
 706         "name": shortname_schema,
 707         "type": shortname_schema,
 708         "description": description_schema,
 709         "shared": bool_schema,
 710         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 711         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 712         "interfaces": {"oneOf": [
 713             array_edition_schema,
 714             {
 715                 "type": "array",
 716                 "items": pdu_interface,
 717                 "minItems": 1
 718             }
 719         ]}
 720     },
 721     "additionalProperties": False,
 722     "minProperties": 1
 723 }
 724
 725 # VNF PKG OPERATIONS
 726 vnfpkgop_new_schema = {
 727     "title": "VNF PKG operation creation input schema",
 728     "$schema": "http://json-schema.org/draft-04/schema#",
 729     "type": "object",
 730     "properties": {
 731         "lcmOperationType": string_schema,
 732         "vnfPkgId": id_schema,
 733         "kdu_name": name_schema,
 734         "primitive": name_schema,
 735         "primitive_params": {"type": "object"},
 736     },
 737     "required": ["lcmOperationType", "vnfPkgId", "kdu_name", "primitive", "primitive_params"],
 738     "additionalProperties": False
 739 }
 740
 741 # USERS
 742 project_role_mappings = {
 743     "title": "list pf projects/roles",
 744     "$schema": "http://json-schema.org/draft-04/schema#",
 745     "type": "array",
 746     "items": {
 747         "type": "object",
 748         "properties": {
 749             "project": shortname_schema,
 750             "role": shortname_schema
 751         },
 752         "required": ["project", "role"],
 753         "additionalProperties": False
 754     },
 755     "minItems": 1
 756 }
 757 project_role_mappings_optional = {
 758     "title": "list of projects/roles or projects only",
 759     "$schema": "http://json-schema.org/draft-04/schema#",
 760     "type": "array",
 761     "items": {
 762         "type": "object",
 763         "properties": {
 764             "project": shortname_schema,
 765             "role": shortname_schema
 766         },
 767         "required": ["project"],
 768         "additionalProperties": False
 769     },
 770     "minItems": 1
 771 }
 772 user_new_schema = {
 773     "$schema": "http://json-schema.org/draft-04/schema#",
 774     "title": "New user schema",
 775     "type": "object",
 776     "properties": {
 777         "username": shortname_schema,
 778         "domain_name": shortname_schema,
 779         "password": passwd_schema,
 780         "projects": nameshort_list_schema,
 781         "project_role_mappings": project_role_mappings,
 782     },
 783     "required": ["username", "password"],
 784     "additionalProperties": False
 785 }
 786 user_edit_schema = {
 787     "$schema": "http://json-schema.org/draft-04/schema#",
 788     "title": "User edit schema for administrators",
 789     "type": "object",
 790     "properties": {
 791         "password": passwd_schema,
 792         "username": shortname_schema,     # To allow User Name modification
 793         "projects": {
 794             "oneOf": [
 795                 nameshort_list_schema,
 796                 array_edition_schema
 797             ]
 798         },
 799         "project_role_mappings": project_role_mappings,
 800         "add_project_role_mappings": project_role_mappings,
 801         "remove_project_role_mappings": project_role_mappings_optional,
 802     },
 803     "minProperties": 1,
 804     "additionalProperties": False
 805 }
 806
 807 # PROJECTS
 808 topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
 809                      "k8sclusters", "k8srepos"]
 810 project_new_schema = {
 811     "$schema": "http://json-schema.org/draft-04/schema#",
 812     "title": "New project schema for administrators",
 813     "type": "object",
 814     "properties": {
 815         "name": shortname_schema,
 816         "admin": bool_schema,
 817         "domain_name": shortname_schema,
 818         "quotas": {
 819             "type": "object",
 820             "properties": {topic: integer0_schema for topic in topics_with_quota},
 821             "additionalProperties": False
 822         },
 823     },
 824     "required": ["name"],
 825     "additionalProperties": False
 826 }
 827 project_edit_schema = {
 828     "$schema": "http://json-schema.org/draft-04/schema#",
 829     "title": "Project edit schema for administrators",
 830     "type": "object",
 831     "properties": {
 832         "admin": bool_schema,
 833         "name": shortname_schema,     # To allow Project Name modification
 834         "quotas": {
 835             "type": "object",
 836             "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
 837             "additionalProperties": False
 838         },
 839     },
 840     "additionalProperties": False,
 841     "minProperties": 1
 842 }
 843
 844 # ROLES
 845 roles_new_schema = {
 846     "$schema": "http://json-schema.org/draft-04/schema#",
 847     "title": "New role schema for administrators",
 848     "type": "object",
 849     "properties": {
 850         "name": shortname_schema,
 851         "permissions": {
 852             "type": "object",
 853             "patternProperties": {
 854                 ".": bool_schema,
 855             },
 856             # "minProperties": 1,
 857         }
 858     },
 859     "required": ["name"],
 860     "additionalProperties": False
 861 }
 862 roles_edit_schema = {
 863     "$schema": "http://json-schema.org/draft-04/schema#",
 864     "title": "Roles edit schema for administrators",
 865     "type": "object",
 866     "properties": {
 867         "name": shortname_schema,
 868         "permissions": {
 869             "type": "object",
 870             "patternProperties": {
 871                 ".": {
 872                     "oneOf": [bool_schema, null_schema]
 873                 }
 874             },
 875             # "minProperties": 1,
 876         }
 877     },
 878     "additionalProperties": False,
 879     "minProperties": 1
 880 }
 881
 882 # GLOBAL SCHEMAS
 883
 884 nbi_new_input_schemas = {
 885     "users": user_new_schema,
 886     "projects": project_new_schema,
 887     "vim_accounts": vim_account_new_schema,
 888     "sdns": sdn_new_schema,
 889     "ns_instantiate": ns_instantiate,
 890     "ns_action": ns_action,
 891     "ns_scale": ns_scale,
 892     "pdus": pdu_new_schema,
 893 }
 894
 895 nbi_edit_input_schemas = {
 896     "users": user_edit_schema,
 897     "projects": project_edit_schema,
 898     "vim_accounts": vim_account_edit_schema,
 899     "sdns": sdn_edit_schema,
 900     "pdus": pdu_edit_schema,
 901 }
 902
 903 # NETSLICE SCHEMAS
 904 nsi_subnet_instantiate = deepcopy(ns_instantiate)
 905 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
 906 nsi_subnet_instantiate["properties"]["id"] = name_schema
 907 del nsi_subnet_instantiate["required"]
 908
 909 nsi_vld_instantiate = {
 910     "title": "netslice vld instantiation params input schema",
 911     "$schema": "http://json-schema.org/draft-04/schema#",
 912     "type": "object",
 913     "properties": {
 914         "name": string_schema,
 915         "vim-network-name": {"OneOf": [string_schema, object_schema]},
 916         "vim-network-id": {"OneOf": [string_schema, object_schema]},
 917         "ip-profile": object_schema,
 918     },
 919     "required": ["name"],
 920     "additionalProperties": False
 921 }
 922
 923 nsi_instantiate = {
 924     "title": "netslice action instantiate input schema",
 925     "$schema": "http://json-schema.org/draft-04/schema#",
 926     "type": "object",
 927     "properties": {
 928         "lcmOperationType": string_schema,
 929         "netsliceInstanceId": id_schema,
 930         "nsiName": name_schema,
 931         "nsiDescription": {"oneOf": [description_schema, null_schema]},
 932         "nstId": string_schema,
 933         "vimAccountId": id_schema,
 934         "timeout_nsi_deploy": integer1_schema,
 935         "ssh_keys": {"type": "string"},
 936         "nsi_id": id_schema,
 937         "additionalParamsForNsi": object_schema,
 938         "netslice-subnet": {
 939             "type": "array",
 940             "minItems": 1,
 941             "items": nsi_subnet_instantiate
 942         },
 943         "netslice-vld": {
 944             "type": "array",
 945             "minItems": 1,
 946             "items": nsi_vld_instantiate
 947         },
 948     },
 949     "required": ["nsiName", "nstId", "vimAccountId"],
 950     "additionalProperties": False
 951 }
 952
 953 nsi_action = {
 954
 955 }
 956
 957 nsi_terminate = {
 958
 959 }
 960
 961
 962 class ValidationError(Exception):
 963     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
 964         self.http_code = http_code
 965         Exception.__init__(self, message)
 966
 967
 968 def validate_input(indata, schema_to_use):
 969     """
 970     Validates input data against json schema
 971     :param indata: user input data. Should be a dictionary
 972     :param schema_to_use: jsonschema to test
 973     :return: None if ok, raises ValidationError exception on error
 974     """
 975     try:
 976         if schema_to_use:
 977             js_v(indata, schema_to_use)
 978         return None
 979     except js_e.ValidationError as e:
 980         if e.path:
 981             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
 982         else:
 983             error_pos = ""
 984         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
 985     except js_e.SchemaError:
 986         raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
 987
 988
 989 def is_valid_uuid(x):
 990     """
 991     Test for a valid UUID
 992     :param x: string to test
 993     :return: True if x is a valid uuid, False otherwise
 994     """
 995     try:
 996         if UUID(x):
 997             return True
 998     except (TypeError, ValueError, AttributeError):
 999         return False