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