fix 1046. Allow auth_internal.user_list filtering with the _id
[osm/NBI.git] / osm_nbi / validation.py
index 81b288d..9cfd9a6 100644 (file)
@@ -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 <alfonso.tiernosepulveda@telefonica.com>"
 __version__ = "0.1"
@@ -144,7 +145,7 @@ ip_profile_dhcp_schema = {
 }
 
 ip_profile_schema = {
-    "title": "ip profile validation schame",
+    "title": "ip profile validation schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
@@ -157,7 +158,7 @@ ip_profile_schema = {
 }
 
 ip_profile_update_schema = {
-    "title": "ip profile validation schame",
+    "title": "ip profile validation schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
@@ -171,6 +172,31 @@ ip_profile_update_schema = {
     "additionalProperties": False
 }
 
+provider_network_schema = {
+    "title": "provider network validation schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": {
+        "physical-network": name_schema,
+        "segmentation-id": name_schema,
+        "sdn-ports": {  # external ports to append to the SDN-assist network
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "switch_id": shortname_schema,
+                    "switch_port": shortname_schema,
+                    "mac_address": mac_schema,
+                    "vlan": vlan_schema,
+                },
+                "additionalProperties": True
+            }
+        },
+        "network-type": shortname_schema,
+    },
+    "additionalProperties": True
+}
+
 ns_instantiate_internal_vld = {
     "title": "ns action instantiate input schema for vdu",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -180,6 +206,7 @@ ns_instantiate_internal_vld = {
         "vim-network-name": name_schema,
         "vim-network-id": name_schema,
         "ip-profile": ip_profile_update_schema,
+        "provider-network": provider_network_schema,
         "internal-connection-point": {
             "type": "array",
             "minItems": 1,
@@ -208,11 +235,35 @@ additional_params_for_vnf = {
         "properties": {
             "member-vnf-index": name_schema,
             "additionalParams": object_schema,
+            "additionalParamsForVdu": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "vdu_id": name_schema,
+                        "additionalParams": object_schema,
+                    },
+                    "required": ["vdu_id", "additionalParams"],
+                    "additionalProperties": False,
+                },
+            },
+            "additionalParamsForKdu": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "kdu_name": name_schema,
+                        "additionalParams": object_schema,
+                    },
+                    "required": ["kdu_name", "additionalParams"],
+                    "additionalProperties": False,
+                },
+            },
         },
-        "required": ["member-vnf-index", "additionalParams"],
+        "required": ["member-vnf-index"],
+        "minProperties": 2,
         "additionalProperties": False
     }
-
 }
 
 ns_instantiate = {
@@ -228,9 +279,12 @@ ns_instantiate = {
         "nsdId": id_schema,
         "vimAccountId": id_schema,
         "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
+        "placement-engine": string_schema,
+        "placement-constraints": object_schema,
         "additionalParamsForNs": object_schema,
         "additionalParamsForVnf": additional_params_for_vnf,
         "ssh_keys": {"type": "array", "items": {"type": "string"}},
+        "timeout_ns_deploy": integer1_schema,
         "nsr_id": id_schema,
         "vduImage": name_schema,
         "vnf": {
@@ -269,6 +323,7 @@ ns_instantiate = {
                     "ns-net": object_schema,
                     "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
                     "ip-profile": object_schema,
+                    "provider-network": provider_network_schema,
                     "vnfd-connection-point-ref": {
                         "type": "array",
                         "minItems": 1,
@@ -295,6 +350,20 @@ ns_instantiate = {
     "additionalProperties": False
 }
 
+ns_terminate = {
+    "title": "ns terminate input schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": {
+        "lcmOperationType": string_schema,
+        "nsInstanceId": id_schema,
+        "autoremove": bool_schema,
+        "timeout_ns_terminate": integer1_schema,
+        "skip_terminate_primitives": bool_schema,
+    },
+    "additionalProperties": False
+}
+
 ns_action = {   # TODO for the moment it is only contemplated the vnfd primitive execution
     "title": "ns action input schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -306,6 +375,7 @@ ns_action = {   # TODO for the moment it is only contemplated the vnfd primitive
         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
         "vdu_id": name_schema,
         "vdu_count_index": integer0_schema,
+        "kdu_name": name_schema,
         "primitive": name_schema,
         "primitive_params": {"type": "object"},
     },
@@ -348,6 +418,8 @@ ns_scale = {   # TODO for the moment it is only VDU-scaling
 
 schema_version = {"type": "string", "enum": ["1.0"]}
 schema_type = {"type": "string"}
+vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
+
 vim_account_edit_schema = {
     "title": "vim_account edit input schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -355,14 +427,14 @@ vim_account_edit_schema = {
     "properties": {
         "name": name_schema,
         "description": description_schema,
-        "type": shortname_schema,
         "vim": name_schema,
         "datacenter": name_schema,
+        "vim_type": vim_type,
         "vim_url": description_schema,
-        "vim_url_admin": description_schema,
-        "vim_tenant": name_schema,
+        "vim_url_admin": description_schema,
+        "vim_tenant": name_schema,
         "vim_tenant_name": name_schema,
-        "vim_username": shortname_schema,
+        "vim_user": shortname_schema,
         "vim_password": passwd_schema,
         "config": {"type": "object"}
     },
@@ -380,7 +452,7 @@ vim_account_new_schema = {
         "description": description_schema,
         "vim": name_schema,
         "datacenter": name_schema,
-        "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
+        "vim_type": vim_type,
         "vim_url": description_schema,
         # "vim_url_admin": description_schema,
         # "vim_tenant": name_schema,
@@ -393,6 +465,8 @@ vim_account_new_schema = {
     "additionalProperties": False
 }
 
+wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
+
 wim_account_edit_schema = {
     "title": "wim_account edit input schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -400,8 +474,8 @@ wim_account_edit_schema = {
     "properties": {
         "name": name_schema,
         "description": description_schema,
-        "type": shortname_schema,
         "wim": name_schema,
+        "wim_type": wim_type,
         "wim_url": description_schema,
         "user": shortname_schema,
         "password": passwd_schema,
@@ -420,7 +494,7 @@ wim_account_new_schema = {
         "name": name_schema,
         "description": description_schema,
         "wim": name_schema,
-        "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac"]},
+        "wim_type": wim_type,
         "wim_url": description_schema,
         "user": shortname_schema,
         "password": passwd_schema,
@@ -437,21 +511,24 @@ wim_account_new_schema = {
 
 sdn_properties = {
     "name": name_schema,
+    "type": {"type": "string"},
+    "url": {"type": "string"},
+    "user": shortname_schema,
+    "password": passwd_schema,
+    "config": {"type": "object"},
     "description": description_schema,
+    # The folowing are deprecated. Maintanied for backward compatibility
     "dpid": dpid_Schema,
     "ip": ip_schema,
     "port": port_schema,
-    "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
     "version": {"type": "string", "minLength": 1, "maxLength": 12},
-    "user": shortname_schema,
-    "password": passwd_schema
 }
 sdn_new_schema = {
     "title": "sdn controller information schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": sdn_properties,
-    "required": ["name", "port", 'ip', 'dpid', 'type'],
+    "required": ["name", 'type'],
     "additionalProperties": False
 }
 sdn_edit_schema = {
@@ -498,6 +575,75 @@ sdn_external_port_schema = {
     "required": ["port"]
 }
 
+# K8s Clusters
+k8scluster_nets_schema = {
+    "title": "k8scluster nets input schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
+    "minProperties": 1,
+    "additionalProperties": False
+}
+k8scluster_new_schema = {
+    "title": "k8scluster 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,
+        "credentials": object_schema,
+        "vim_account": id_schema,
+        "k8s_version": string_schema,
+        "nets": k8scluster_nets_schema,
+        "namespace": name_schema,
+        "cni": nameshort_list_schema,
+    },
+    "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
+    "additionalProperties": False
+}
+k8scluster_edit_schema = {
+    "title": "vim_account edit input schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": {
+        "name": name_schema,
+        "description": description_schema,
+        "credentials": object_schema,
+        "vim_account": id_schema,
+        "k8s_version": string_schema,
+        "nets": k8scluster_nets_schema,
+        "namespace": name_schema,
+        "cni": nameshort_list_schema,
+    },
+    "additionalProperties": False
+}
+
+# K8s Repos
+k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
+k8srepo_properties = {
+    "name": name_schema,
+    "description": description_schema,
+    "type": k8srepo_types,
+    "url": description_schema,
+}
+k8srepo_new_schema = {
+    "title": "k8scluster creation input schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": k8srepo_properties,
+    "required": ["name", "type", "url"],
+    "additionalProperties": False
+}
+k8srepo_edit_schema = {
+    "title": "vim_account edit input schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": k8srepo_properties,
+    "additionalProperties": False
+}
+
 # PDUs
 pdu_interface = {
     "type": "object",
@@ -539,7 +685,6 @@ pdu_new_schema = {
     "required": ["name", "type", "interfaces"],
     "additionalProperties": False
 }
-
 pdu_edit_schema = {
     "title": "pdu edit input schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -564,31 +709,63 @@ pdu_edit_schema = {
     "minProperties": 1
 }
 
-# USERS
-project_role_mapping = {
-    "title": "",
+# VNF PKG OPERATIONS
+vnfpkgop_new_schema = {
+    "title": "VNF PKG operation creation input schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
     "type": "object",
     "properties": {
-        "project": shortname_schema,
-        "role": shortname_schema
+        "lcmOperationType": string_schema,
+        "vnfPkgId": id_schema,
+        "kdu_name": name_schema,
+        "primitive": name_schema,
+        "primitive_params": {"type": "object"},
     },
-    "required": ["project", "role"],
+    "required": ["lcmOperationType", "vnfPkgId", "kdu_name", "primitive", "primitive_params"],
     "additionalProperties": False
 }
+
+# USERS
+project_role_mappings = {
+    "title": "list pf projects/roles",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "project": shortname_schema,
+            "role": shortname_schema
+        },
+        "required": ["project", "role"],
+        "additionalProperties": False
+    },
+    "minItems": 1
+}
+project_role_mappings_optional = {
+    "title": "list of projects/roles or projects only",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "project": shortname_schema,
+            "role": shortname_schema
+        },
+        "required": ["project"],
+        "additionalProperties": False
+    },
+    "minItems": 1
+}
 user_new_schema = {
     "$schema": "http://json-schema.org/draft-04/schema#",
     "title": "New user schema",
     "type": "object",
     "properties": {
         "username": shortname_schema,
+        "domain_name": shortname_schema,
         "password": passwd_schema,
         "projects": nameshort_list_schema,
-        "project_role_mappings": {
-            "type": "array",
-            "items": project_role_mapping,
-            "minItems": 1
-        },
+        "project_role_mappings": project_role_mappings,
     },
     "required": ["username", "password"],
     "additionalProperties": False
@@ -599,23 +776,24 @@ 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
-        },
+        "project_role_mappings": project_role_mappings,
+        "add_project_role_mappings": project_role_mappings,
+        "remove_project_role_mappings": project_role_mappings_optional,
     },
     "minProperties": 1,
     "additionalProperties": False
 }
 
 # PROJECTS
+topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
+                     "k8sclusters", "k8srepos"]
 project_new_schema = {
     "$schema": "http://json-schema.org/draft-04/schema#",
     "title": "New project schema for administrators",
@@ -623,6 +801,12 @@ project_new_schema = {
     "properties": {
         "name": shortname_schema,
         "admin": bool_schema,
+        "domain_name": shortname_schema,
+        "quotas": {
+            "type": "object",
+            "properties": {topic: integer0_schema for topic in topics_with_quota},
+            "additionalProperties": False
+        },
     },
     "required": ["name"],
     "additionalProperties": False
@@ -633,6 +817,12 @@ project_edit_schema = {
     "type": "object",
     "properties": {
         "admin": bool_schema,
+        "name": shortname_schema,     # To allow Project Name modification
+        "quotas": {
+            "type": "object",
+            "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
+            "additionalProperties": False
+        },
     },
     "additionalProperties": False,
     "minProperties": 1
@@ -645,7 +835,13 @@ roles_new_schema = {
     "type": "object",
     "properties": {
         "name": shortname_schema,
-        "definition": object_schema,
+        "permissions": {
+            "type": "object",
+            "patternProperties": {
+                ".": bool_schema,
+            },
+            # "minProperties": 1,
+        }
     },
     "required": ["name"],
     "additionalProperties": False
@@ -655,11 +851,17 @@ roles_edit_schema = {
     "title": "Roles edit schema for administrators",
     "type": "object",
     "properties": {
-        "_id": id_schema,
         "name": shortname_schema,
-        "definition": object_schema,
+        "permissions": {
+            "type": "object",
+            "patternProperties": {
+                ".": {
+                    "oneOf": [bool_schema, null_schema]
+                }
+            },
+            # "minProperties": 1,
+        }
     },
-    "required": ["_id", "name", "definition"],
     "additionalProperties": False,
     "minProperties": 1
 }
@@ -701,7 +903,7 @@ nsi_vld_instantiate = {
         "vim-network-id": {"OneOf": [string_schema, object_schema]},
         "ip-profile": object_schema,
     },
-    "required": ["name"], 
+    "required": ["name"],
     "additionalProperties": False
 }
 
@@ -711,11 +913,12 @@ nsi_instantiate = {
     "type": "object",
     "properties": {
         "lcmOperationType": string_schema,
-        "nsiInstanceId": id_schema,
+        "netsliceInstanceId": id_schema,
         "nsiName": name_schema,
         "nsiDescription": {"oneOf": [description_schema, null_schema]},
         "nstId": string_schema,
         "vimAccountId": id_schema,
+        "timeout_nsi_deploy": integer1_schema,
         "ssh_keys": {"type": "string"},
         "nsi_id": id_schema,
         "additionalParamsForNsi": object_schema,
@@ -739,7 +942,7 @@ nsi_action = {
 }
 
 nsi_terminate = {
-    
+
 }
 
 
@@ -768,3 +971,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, AttributeError):
+        return False