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