fix error ns_instances_content when not instantiated, rollback problems and pdu usage...
[osm/NBI.git] / osm_nbi / validation.py
index 292ec97..3579c11 100644 (file)
@@ -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 <alfonso.tiernosepulveda@telefonica.com>"
 __version__ = "0.1"
@@ -25,6 +40,8 @@ null_schema = {"type": "null"}
 id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
 time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
 pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
+# allows [] for wildcards. For that reason huge length limit is set
+pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
 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])?$"}
@@ -161,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",
@@ -190,12 +208,14 @@ 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,
-        "ssh_keys": {"type": "string"},
+        "ssh_keys": {"type": "array", "items": {"type": "string"}},
         "nsr_id": id_schema,
+        "vduImage": name_schema,
         "vnf": {
             "type": "array",
             "minItems": 1,
@@ -228,6 +248,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",
@@ -306,6 +327,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#",
@@ -313,7 +335,7 @@ vim_account_edit_schema = {
     "properties": {
         "name": name_schema,
         "description": description_schema,
-        "type": nameshort_schema,  # currently "openvim" or "openstack", can be enlarged with plugins
+        "type": nameshort_schema,
         "vim": name_schema,
         "datacenter": name_schema,
         "vim_url": description_schema,
@@ -326,7 +348,6 @@ vim_account_edit_schema = {
     },
     "additionalProperties": False
 }
-schema_type = {"type": "string"}
 
 vim_account_new_schema = {
     "title": "vim_account creation input schema",
@@ -352,6 +373,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": nameshort_schema,
+        "wim": name_schema,
+        "wim_url": description_schema,
+        "user": nameshort_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": nameshort_schema,
+        "password": passwd_schema,
+        "config": {"type": "object"}
+    },
+    "required": ["name", "wim_url", "wim_type"],
+    "additionalProperties": False
+}
 
 sdn_properties = {
     "name": name_schema,
@@ -393,7 +450,7 @@ sdn_port_mapping_schema = {
                 "items": {
                     "type": "object",
                     "properties": {
-                        "pci": pci_schema,
+                        "pci": pci_extended_schema,
                         "switch_port": nameshort_schema,
                         "switch_mac": mac_schema
                     },
@@ -423,18 +480,18 @@ pdu_interface = {
         "name": nameshort_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": 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,
     },
-    "required": ["name", "mgmt", "ip_address"],
+    "required": ["name", "mgmt", "ip-address"],
     "additionalProperties": False
 }
 pdu_new_schema = {
@@ -450,7 +507,7 @@ pdu_new_schema = {
         "vim_accounts": nameshort_list_schema,
         "interfaces": {
             "type": "array",
-            "items": {"type": pdu_interface},
+            "items": pdu_interface,
             "minItems": 1
         }
     },
@@ -467,13 +524,13 @@ pdu_edit_schema = {
         "type": nameshort_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
             }
         ]}
@@ -502,7 +559,7 @@ user_edit_schema = {
     "properties": {
         "password": passwd_schema,
         "projects": {
-            "oneOff": [
+            "oneOf": [
                 nameshort_list_schema,
                 array_edition_schema
             ]
@@ -556,9 +613,67 @@ 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
+del nsi_slice_instantiate["required"]
+
+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):
@@ -578,3 +693,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)