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