X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fvalidation.py;h=0ec83040a4904e999b38070be15aa9d0a75b9f63;hp=da3dd04a361a0de06ea8b89d174ee4b438821abb;hb=7b7ffa61e6282094c1bd528e60b3b395c3ab1358;hpb=42fce59a553debba41506932e1c42d0578324656 diff --git a/osm_nbi/validation.py b/osm_nbi/validation.py index da3dd04..0ec8304 100644 --- a/osm_nbi/validation.py +++ b/osm_nbi/validation.py @@ -1,6 +1,21 @@ # -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + from jsonschema import validate as js_v, exceptions as js_e +from http import HTTPStatus +from copy import deepcopy __author__ = "Alfonso Tierno " __version__ = "0.1" @@ -12,7 +27,7 @@ Validator of input data using JSON schemas for those items that not contains an # Basis schemas patern_name = "^[ -~]+$" -nameshort_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"} +shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"} passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60} name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"} string_schema = {"type": "string", "minLength": 1, "maxLength": 255} @@ -54,7 +69,7 @@ size_schema = {"type": "integer", "minimum": 1, "maximum": 100} array_edition_schema = { "type": "object", "patternProperties": { - "^\\$": "Any" + "^\\$": {} }, "additionalProperties": False, "minProperties": 1, @@ -62,7 +77,7 @@ array_edition_schema = { nameshort_list_schema = { "type": "array", "minItems": 1, - "items": nameshort_schema, + "items": shortname_schema, } @@ -163,6 +178,7 @@ ns_instantiate_internal_vld = { "properties": { "name": name_schema, "vim-network-name": name_schema, + "vim-network-id": name_schema, "ip-profile": ip_profile_update_schema, "internal-connection-point": { "type": "array", @@ -185,6 +201,20 @@ ns_instantiate_internal_vld = { "additionalProperties": False } +additional_params_for_vnf = { + "type": "array", + "items": { + "type": "object", + "properties": { + "member-vnf-index": name_schema, + "additionalParams": object_schema, + }, + "required": ["member-vnf-index", "additionalParams"], + "additionalProperties": False + } + +} + ns_instantiate = { "title": "ns action instantiate input schema", "$schema": "http://json-schema.org/draft-04/schema#", @@ -192,10 +222,13 @@ ns_instantiate = { "properties": { "lcmOperationType": string_schema, "nsInstanceId": id_schema, + "netsliceInstanceId": id_schema, "nsName": name_schema, "nsDescription": {"oneOf": [description_schema, {"type": "null"}]}, "nsdId": id_schema, "vimAccountId": id_schema, + "additionalParamsForNs": object_schema, + "additionalParamsForVnf": additional_params_for_vnf, "ssh_keys": {"type": "array", "items": {"type": "string"}}, "nsr_id": id_schema, "vduImage": name_schema, @@ -231,6 +264,7 @@ ns_instantiate = { "properties": { "name": string_schema, "vim-network-name": {"OneOf": [string_schema, object_schema]}, + "vim-network-id": {"OneOf": [string_schema, object_schema]}, "ip-profile": object_schema, "vnfd-connection-point-ref": { "type": "array", @@ -309,6 +343,7 @@ ns_scale = { # TODO for the moment it is only VDU-scaling schema_version = {"type": "string", "enum": ["1.0"]} +schema_type = {"type": "string"} vim_account_edit_schema = { "title": "vim_account edit input schema", "$schema": "http://json-schema.org/draft-04/schema#", @@ -316,20 +351,19 @@ vim_account_edit_schema = { "properties": { "name": name_schema, "description": description_schema, - "type": nameshort_schema, # currently "openvim" or "openstack", can be enlarged with plugins + "type": shortname_schema, "vim": name_schema, "datacenter": name_schema, "vim_url": description_schema, "vim_url_admin": description_schema, "vim_tenant": name_schema, "vim_tenant_name": name_schema, - "vim_username": nameshort_schema, + "vim_username": shortname_schema, "vim_password": passwd_schema, "config": {"type": "object"} }, "additionalProperties": False } -schema_type = {"type": "string"} vim_account_new_schema = { "title": "vim_account creation input schema", @@ -347,7 +381,7 @@ vim_account_new_schema = { # "vim_url_admin": description_schema, # "vim_tenant": name_schema, "vim_tenant_name": name_schema, - "vim_user": nameshort_schema, + "vim_user": shortname_schema, "vim_password": passwd_schema, "config": {"type": "object"} }, @@ -355,6 +389,42 @@ vim_account_new_schema = { "additionalProperties": False } +wim_account_edit_schema = { + "title": "wim_account edit input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": name_schema, + "description": description_schema, + "type": shortname_schema, + "wim": name_schema, + "wim_url": description_schema, + "user": shortname_schema, + "password": passwd_schema, + "config": {"type": "object"} + }, + "additionalProperties": False +} + +wim_account_new_schema = { + "title": "wim_account creation input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "schema_version": schema_version, + "schema_type": schema_type, + "name": name_schema, + "description": description_schema, + "wim": name_schema, + "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac"]}, + "wim_url": description_schema, + "user": shortname_schema, + "password": passwd_schema, + "config": {"type": "object"} + }, + "required": ["name", "wim_url", "wim_type"], + "additionalProperties": False +} sdn_properties = { "name": name_schema, @@ -364,7 +434,7 @@ sdn_properties = { "port": port_schema, "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]}, "version": {"type": "string", "minLength": 1, "maxLength": 12}, - "user": nameshort_schema, + "user": shortname_schema, "password": passwd_schema } sdn_new_schema = { @@ -390,14 +460,14 @@ sdn_port_mapping_schema = { "items": { "type": "object", "properties": { - "compute_node": nameshort_schema, + "compute_node": shortname_schema, "ports": { "type": "array", "items": { "type": "object", "properties": { "pci": pci_extended_schema, - "switch_port": nameshort_schema, + "switch_port": shortname_schema, "switch_mac": mac_schema }, "required": ["pci"] @@ -423,21 +493,21 @@ sdn_external_port_schema = { pdu_interface = { "type": "object", "properties": { - "name": nameshort_schema, + "name": shortname_schema, "mgmt": bool_schema, "type": {"enum": ["overlay", 'underlay']}, - "ip_address": ip_schema, + "ip-address": ip_schema, # TODO, add user, password, ssh-key - "mac_address": mac_schema, - "vim_network_name": nameshort_schema, # interface is connected to one vim network, or switch port - "vim_network_id": nameshort_schema, - # provide this in case SDN assist must deal with this interface - "switch_dpid": dpid_Schema, - "switch_port": nameshort_schema, - "switch_mac": nameshort_schema, - "switch_vlan": vlan_schema, + "mac-address": mac_schema, + "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port + "vim-network-id": shortname_schema, + # # provide this in case SDN assist must deal with this interface + # "switch-dpid": dpid_Schema, + # "switch-port": shortname_schema, + # "switch-mac": shortname_schema, + # "switch-vlan": vlan_schema, }, - "required": ["name", "mgmt", "ip_address"], + "required": ["name", "mgmt", "ip-address"], "additionalProperties": False } pdu_new_schema = { @@ -445,15 +515,15 @@ pdu_new_schema = { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "name": nameshort_schema, - "type": nameshort_schema, + "name": shortname_schema, + "type": shortname_schema, "description": description_schema, "shared": bool_schema, "vims": nameshort_list_schema, "vim_accounts": nameshort_list_schema, "interfaces": { "type": "array", - "items": {"type": pdu_interface}, + "items": pdu_interface, "minItems": 1 } }, @@ -466,17 +536,17 @@ pdu_edit_schema = { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { - "name": nameshort_schema, - "type": nameshort_schema, + "name": shortname_schema, + "type": shortname_schema, "description": description_schema, "shared": bool_schema, - "vims": {"oneOff": [array_edition_schema, nameshort_list_schema]}, - "vim_accounts": {"oneOff": [array_edition_schema, nameshort_list_schema]}, - "interfaces": {"oneOff": [ + "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]}, + "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]}, + "interfaces": {"oneOf": [ array_edition_schema, { "type": "array", - "items": {"type": pdu_interface}, + "items": pdu_interface, "minItems": 1 } ]} @@ -491,7 +561,7 @@ user_new_schema = { "title": "New user schema", "type": "object", "properties": { - "username": nameshort_schema, + "username": shortname_schema, "password": passwd_schema, "projects": nameshort_list_schema, }, @@ -505,7 +575,7 @@ user_edit_schema = { "properties": { "password": passwd_schema, "projects": { - "oneOff": [ + "oneOf": [ nameshort_list_schema, array_edition_schema ] @@ -521,7 +591,7 @@ project_new_schema = { "title": "New project schema for administrators", "type": "object", "properties": { - "name": nameshort_schema, + "name": shortname_schema, "admin": bool_schema, }, "required": ["name"], @@ -559,9 +629,83 @@ nbi_edit_input_schemas = { "pdus": pdu_edit_schema, } +# NETSLICE SCHEMAS +nsi_slice_instantiate = deepcopy(ns_instantiate) +nsi_slice_instantiate["title"] = "netslice subnet instantiation params input schema" +nsi_slice_instantiate["properties"]["id"] = name_schema +nsi_slice_instantiate["properties"]["additionalParamsForNsi"] = object_schema +nsi_slice_instantiate["properties"]["additionalParamsForSubnet"] = { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": name_schema, + "additionalParamsForNs": object_schema, + "additionalParamsForVnf": additional_params_for_vnf + }, + "required": ["id"], + "additionalProperties": False + } +} +del nsi_slice_instantiate["required"] +del nsi_slice_instantiate["properties"]["additionalParamsForNs"] +del nsi_slice_instantiate["properties"]["additionalParamsForVnf"] + +nsi_vld_instantiate = { + "title": "netslice vld instantiation params input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": string_schema, + "vim-network-name": {"OneOf": [string_schema, object_schema]}, + "vim-network-id": {"OneOf": [string_schema, object_schema]}, + "ip-profile": object_schema, + }, + "required": ["name"], + "additionalProperties": False +} + +nsi_instantiate = { + "title": "netslice action instantiate input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "lcmOperationType": string_schema, + "nsiInstanceId": id_schema, + "nsiName": name_schema, + "nsiDescription": {"oneOf": [description_schema, {"type": "null"}]}, + "nstId": string_schema, + "vimAccountId": id_schema, + "ssh_keys": {"type": "string"}, + "nsi_id": id_schema, + "netslice-subnet": { + "type": "array", + "minItems": 1, + "items": nsi_slice_instantiate + }, + "netslice-vld": { + "type": "array", + "minItems": 1, + "items": nsi_vld_instantiate + }, + }, + "required": ["nsiName", "nstId", "vimAccountId"], + "additionalProperties": False +} + +nsi_action = { + +} + +nsi_terminate = { + +} + class ValidationError(Exception): - pass + def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY): + self.http_code = http_code + Exception.__init__(self, message) def validate_input(indata, schema_to_use): @@ -581,3 +725,5 @@ def validate_input(indata, schema_to_use): else: error_pos = "" raise ValidationError("Format error {} '{}' ".format(error_pos, e.message)) + except js_e.SchemaError: + raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)