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