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