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