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