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