Methods for managing VIMs, SDNs
[osm/NBI.git] / osm_nbi / validation.py
diff --git a/osm_nbi/validation.py b/osm_nbi/validation.py
new file mode 100644 (file)
index 0000000..2419c1a
--- /dev/null
@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+
+from jsonschema import validate as js_v, exceptions as js_e
+
+__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
+__version__ = "0.1"
+version_date = "Mar 2018"
+
+"""
+Validator of input data using JSON schemas for those items that not contains an  OSM yang information model
+"""
+
+# Basis schemas
+patern_name = "^[ -~]+$"
+passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
+nameshort_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()'\"]+$"}
+name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
+xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
+description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
+id_schema_fake = {"type": "string", "minLength": 2,
+                  "maxLength": 36}  # "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}$"
+id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
+pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
+http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
+bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
+memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
+integer0_schema = {"type": "integer", "minimum": 0}
+integer1_schema = {"type": "integer", "minimum": 1}
+path_schema = {"type": "string", "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
+vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
+vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
+mac_schema = {"type": "string",
+              "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"}  # must be unicast: LSB bit of MSB byte ==0
+# mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
+ip_schema = {"type": "string",
+             "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]?)$"}
+ip_prefix_schema = {"type": "string",
+                    "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]?)/(30|[12]?[0-9])$"}
+port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
+object_schema = {"type": "object"}
+schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
+# schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
+log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
+checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
+size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
+
+schema_version = {"type": "string", "enum": ["1.0"]}
+schema_type = {"type": "string"}
+
+vim_new_schema = {
+    "title": "vims new user 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,
+        "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
+        "vim_url": description_schema,
+        # "vim_url_admin": description_schema,
+        # "vim_tenant": name_schema,
+        "vim_tenant_name": name_schema,
+        "vim_user": nameshort_schema,
+        "vim_password": nameshort_schema,
+        "config": {"type": "object"}
+    },
+    "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
+    "additionalProperties": False
+}
+vim_edit_schema = {
+    "title": "datacenter edit nformation schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": {
+        "name": name_schema,
+        "description": description_schema,
+        "type": nameshort_schema,  # currently "openvim" or "openstack", can be enlarged with plugins
+        "vim_url": description_schema,
+        "vim_url_admin": description_schema,
+        "vim_tenant": name_schema,
+        "vim_tenant_name": name_schema,
+        "vim_username": nameshort_schema,
+        "vim_password": nameshort_schema,
+        "config": {"type": "object"}
+    },
+    "additionalProperties": False
+}
+
+
+sdn_properties = {
+    "name": name_schema,
+    "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
+    "ip": ip_schema,
+    "port": port_schema,
+    "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
+    "version": {"type": "string", "minLength": 1, "maxLength": 12},
+    "user": nameshort_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'],
+    "additionalProperties": False
+}
+sdn_edit_schema = {
+    "title": "sdn controller update information schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": sdn_properties,
+    "required": ["name", "port", 'ip', 'dpid', 'type'],
+    "additionalProperties": False
+}
+sdn_port_mapping_schema = {
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "sdn port mapping information schema",
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "compute_node": nameshort_schema,
+            "ports": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "pci": pci_schema,
+                        "switch_port": nameshort_schema,
+                        "switch_mac": mac_schema
+                    },
+                    "required": ["pci"]
+                }
+            }
+        },
+        "required": ["compute_node", "ports"]
+    }
+}
+sdn_external_port_schema = {
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "External port ingformation",
+    "type": "object",
+    "properties": {
+        "port": {"type": "string", "minLength": 1, "maxLength": 60},
+        "vlan": vlan_schema,
+        "mac": mac_schema
+    },
+    "required": ["port"]
+}
+
+
+nbi_new_input_schemas = {
+    "vims": vim_new_schema,
+    "sdns": sdn_new_schema
+}
+
+nbi_edit_input_schemas = {
+    "vims": vim_edit_schema,
+    "sdns": sdn_edit_schema
+}
+
+
+class ValidationError(Exception):
+    pass
+
+
+def validate_input(indata, item, new=True):
+    """
+    Validates input data agains json schema
+    :param indata: user input data. Should be a dictionary
+    :param item: can be users, projects, vims, sdns
+    :param new: True if the validation is for creating or False if it is for editing
+    :return: None if ok, raises ValidationError exception otherwise
+    """
+    try:
+        if new:
+            schema_to_use = nbi_new_input_schemas.get(item)
+        else:
+            schema_to_use = nbi_edit_input_schemas.get(item)
+        if schema_to_use:
+            js_v(indata, schema_to_use)
+        return None
+    except js_e.ValidationError as e:
+        if e.path:
+            error_pos = "at '" + ":".join(e.path) + "'"
+        else:
+            error_pos = ""
+        raise ValidationError("Format error {} '{}' ".format(error_pos, e))