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