X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fvalidation.py;h=f6c90c1e2983e511b62491386e32378c68065e20;hp=bb966e23b2b79abafa9f7ae0231ea0cc6a0044d8;hb=f269fa5cd7c46515aab49ad8af6da7e918afa592;hpb=55ba2e6f758ae650a2dbbc20638c0108df726809;ds=sidebyside diff --git a/osm_nbi/validation.py b/osm_nbi/validation.py index bb966e2..f6c90c1 100644 --- a/osm_nbi/validation.py +++ b/osm_nbi/validation.py @@ -16,6 +16,7 @@ from jsonschema import validate as js_v, exceptions as js_e from http import HTTPStatus from copy import deepcopy +from uuid import UUID # To test for valid UUID __author__ = "Alfonso Tierno " __version__ = "0.1" @@ -27,7 +28,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} @@ -69,7 +70,7 @@ size_schema = {"type": "integer", "minimum": 1, "maximum": 100} array_edition_schema = { "type": "object", "patternProperties": { - "^\\$": "Any" + "^\\$": {} }, "additionalProperties": False, "minProperties": 1, @@ -77,7 +78,7 @@ array_edition_schema = { nameshort_list_schema = { "type": "array", "minItems": 1, - "items": nameshort_schema, + "items": shortname_schema, } @@ -178,6 +179,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", @@ -200,6 +202,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#", @@ -209,9 +225,12 @@ ns_instantiate = { "nsInstanceId": id_schema, "netsliceInstanceId": id_schema, "nsName": name_schema, - "nsDescription": {"oneOf": [description_schema, {"type": "null"}]}, + "nsDescription": {"oneOf": [description_schema, null_schema]}, "nsdId": id_schema, "vimAccountId": id_schema, + "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, + "additionalParamsForNs": object_schema, + "additionalParamsForVnf": additional_params_for_vnf, "ssh_keys": {"type": "array", "items": {"type": "string"}}, "nsr_id": id_schema, "vduImage": name_schema, @@ -247,6 +266,9 @@ ns_instantiate = { "properties": { "name": string_schema, "vim-network-name": {"OneOf": [string_schema, object_schema]}, + "vim-network-id": {"OneOf": [string_schema, object_schema]}, + "ns-net": object_schema, + "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, "ip-profile": object_schema, "vnfd-connection-point-ref": { "type": "array", @@ -284,6 +306,7 @@ ns_action = { # TODO for the moment it is only contemplated the vnfd primitive "member_vnf_index": name_schema, "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future "vdu_id": name_schema, + "vdu_count_index": integer0_schema, "primitive": name_schema, "primitive_params": {"type": "object"}, }, @@ -333,14 +356,14 @@ vim_account_edit_schema = { "properties": { "name": name_schema, "description": description_schema, - "type": nameshort_schema, + "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"} }, @@ -358,12 +381,12 @@ vim_account_new_schema = { "description": description_schema, "vim": name_schema, "datacenter": name_schema, - "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]}, + "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}, "vim_url": description_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"} }, @@ -378,10 +401,10 @@ wim_account_edit_schema = { "properties": { "name": name_schema, "description": description_schema, - "type": nameshort_schema, + "type": shortname_schema, "wim": name_schema, "wim_url": description_schema, - "user": nameshort_schema, + "user": shortname_schema, "password": passwd_schema, "config": {"type": "object"} }, @@ -398,11 +421,16 @@ wim_account_new_schema = { "name": name_schema, "description": description_schema, "wim": name_schema, - "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac"]}, + "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}, "wim_url": description_schema, - "user": nameshort_schema, + "user": shortname_schema, "password": passwd_schema, - "config": {"type": "object"} + "config": { + "type": "object", + "patternProperties": { + ".": {"not": {"type": "null"}} + } + } }, "required": ["name", "wim_url", "wim_type"], "additionalProperties": False @@ -416,7 +444,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 = { @@ -442,14 +470,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"] @@ -475,18 +503,18 @@ 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, # 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 - # TODO "vim-network-id": nameshort_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": nameshort_schema, - # "switch-mac": nameshort_schema, + # "switch-port": shortname_schema, + # "switch-mac": shortname_schema, # "switch-vlan": vlan_schema, }, "required": ["name", "mgmt", "ip-address"], @@ -497,8 +525,8 @@ 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, @@ -518,8 +546,8 @@ 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": {"oneOf": [array_edition_schema, nameshort_list_schema]}, @@ -538,16 +566,32 @@ pdu_edit_schema = { } # USERS +project_role_mapping = { + "title": "", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "project": shortname_schema, + "role": shortname_schema + }, + "required": ["project", "role"], + "additionalProperties": False +} user_new_schema = { "$schema": "http://json-schema.org/draft-04/schema#", "title": "New user schema", "type": "object", "properties": { - "username": nameshort_schema, + "username": shortname_schema, "password": passwd_schema, "projects": nameshort_list_schema, + "project_role_mappings": { + "type": "array", + "items": project_role_mapping, + "minItems": 1 + }, }, - "required": ["username", "password", "projects"], + "required": ["username", "password"], "additionalProperties": False } user_edit_schema = { @@ -556,12 +600,18 @@ user_edit_schema = { "type": "object", "properties": { "password": passwd_schema, + "username": shortname_schema, # To allow User Name modification "projects": { "oneOf": [ nameshort_list_schema, array_edition_schema ] }, + "project_role_mappings": { + "type": "array", + "items": project_role_mapping, + "minItems": 1 + }, }, "minProperties": 1, "additionalProperties": False @@ -573,7 +623,7 @@ project_new_schema = { "title": "New project schema for administrators", "type": "object", "properties": { - "name": nameshort_schema, + "name": shortname_schema, "admin": bool_schema, }, "required": ["name"], @@ -585,11 +635,36 @@ project_edit_schema = { "type": "object", "properties": { "admin": bool_schema, + "name": shortname_schema, # To allow Project Name modification }, "additionalProperties": False, "minProperties": 1 } +# ROLES +roles_new_schema = { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "New role schema for administrators", + "type": "object", + "properties": { + "name": shortname_schema, + }, + "required": ["name"], + "additionalProperties": True +} +roles_edit_schema = { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Roles edit schema for administrators", + "type": "object", + "properties": { + "_id": id_schema, + "name": shortname_schema, + }, + "required": ["_id", "name"], + "additionalProperties": True, + "minProperties": 1 +} + # GLOBAL SCHEMAS nbi_new_input_schemas = { @@ -612,10 +687,10 @@ nbi_edit_input_schemas = { } # 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 -del nsi_slice_instantiate["required"] +nsi_subnet_instantiate = deepcopy(ns_instantiate) +nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema" +nsi_subnet_instantiate["properties"]["id"] = name_schema +del nsi_subnet_instantiate["required"] nsi_vld_instantiate = { "title": "netslice vld instantiation params input schema", @@ -624,9 +699,10 @@ nsi_vld_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, }, - "required": ["name"], + "required": ["name"], "additionalProperties": False } @@ -638,15 +714,16 @@ nsi_instantiate = { "lcmOperationType": string_schema, "nsiInstanceId": id_schema, "nsiName": name_schema, - "nsiDescription": {"oneOf": [description_schema, {"type": "null"}]}, + "nsiDescription": {"oneOf": [description_schema, null_schema]}, "nstId": string_schema, "vimAccountId": id_schema, "ssh_keys": {"type": "string"}, "nsi_id": id_schema, + "additionalParamsForNsi": object_schema, "netslice-subnet": { "type": "array", "minItems": 1, - "items": nsi_slice_instantiate + "items": nsi_subnet_instantiate }, "netslice-vld": { "type": "array", @@ -663,7 +740,7 @@ nsi_action = { } nsi_terminate = { - + } @@ -692,3 +769,16 @@ def validate_input(indata, schema_to_use): 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) + + +def is_valid_uuid(x): + """ + Test for a valid UUID + :param x: string to test + :return: True if x is a valid uuid, False otherwise + """ + try: + if UUID(x): + return True + except (TypeError, ValueError): + return False