Added vnfR support
[osm/NBI.git] / osm_nbi / nbi.py
index 99f90aa..a8f891d 100644 (file)
@@ -10,6 +10,7 @@ import logging
 from engine import Engine, EngineException
 from dbbase import DbException
 from fsbase import FsException
+from msgbase import MsgException
 from base64 import standard_b64decode
 #from os import getenv
 from http import HTTPStatus
@@ -18,8 +19,11 @@ from codecs import getreader
 from os import environ
 
 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
-__version__ = "0.2"
-version_date = "Mar 2018"
+
+# TODO consider to remove and provide version using the static version file
+__version__ = "0.1.3"
+version_date = "Apr 2018"
+database_version = '1.0'
 
 """
 North Bound Interface  (O: OSM specific; 5,X: SOL005 not implemented yet; O5: SOL005 implemented)
@@ -39,6 +43,8 @@ URL: /osm                                                       GET     POST
                 /<subscriptionId>                               5                       X
 
         /vnfpkgm/v1
+            /vnf_packages_content                               O       O
+                /<vnfPkgId>                                     O                       O     
             /vnf_packages                                       O5      O5
                 /<vnfPkgId>                                     O5                      O5      5
                     /package_content                            O5               O5
@@ -53,10 +59,16 @@ URL: /osm                                                       GET     POST
                 /<nsInstanceId>                                 O                       O     
             /ns_instances                                       5       5
                 /<nsInstanceId>                                 5                       5     
-                    TO BE COMPLETED                             
+                    instantiate                                         O5
+                    terminate                                           O5
+                    action                                              O
+                    scale                                               O5
+                    heal                                                5
             /ns_lcm_op_occs                                     5       5
                 /<nsLcmOpOccId>                                 5                       5       5
                     TO BE COMPLETED                             5               5
+            /vnfrs                                              O
+                /<vnfrId>                                       O
             /subscriptions                                      5       5
                 /<subscriptionId>                               5                       X
         /admin/v1
@@ -66,6 +78,10 @@ URL: /osm                                                       GET     POST
                 /<id>                                           O                       O     
             /projects                                           O       O
                 /<id>                                           O                       O     
+            /vims_accounts  (also vims for compatibility)       O       O
+                /<id>                                           O                       O       O     
+            /sdns                                               O       O
+                /<id>                                           O                       O       O     
 
 query string.
     <attrName>[.<attrName>...]*[.<op>]=<value>[,<value>...]&...
@@ -123,14 +139,23 @@ class Server(object):
         self.valid_methods = {   # contains allowed URL and methods
             "admin": {
                 "v1": {
-                    "tokens": { "METHODS": ("GET", "POST", "DELETE"),
+                    "tokens": {"METHODS": ("GET", "POST", "DELETE"),
                         "<ID>": { "METHODS": ("GET", "DELETE")}
                     },
-                    "users": { "METHODS": ("GET", "POST"),
+                    "users": {"METHODS": ("GET", "POST"),
                         "<ID>": {"METHODS": ("GET", "POST", "DELETE")}
                     },
-                    "projects": { "METHODS": ("GET", "POST"),
-                        "<ID>": {"METHODS": ("GET", "POST", "DELETE")}
+                    "projects": {"METHODS": ("GET", "POST"),
+                        "<ID>": {"METHODS": ("GET", "DELETE")}
+                    },
+                    "vims": {"METHODS": ("GET", "POST"),
+                        "<ID>": {"METHODS": ("GET", "DELETE")}
+                    },
+                    "vim_accounts": {"METHODS": ("GET", "POST"),
+                        "<ID>": {"METHODS": ("GET", "DELETE")}
+                    },
+                    "sdns": {"METHODS": ("GET", "POST"),
+                        "<ID>": {"METHODS": ("GET", "DELETE")}
                     },
                 }
             },
@@ -140,7 +165,7 @@ class Server(object):
                         "<ID>": {"METHODS": ("GET", "PUT", "DELETE")}
                     },
                     "ns_descriptors": { "METHODS": ("GET", "POST"),
-                        "<ID>": { "METHODS": ("GET", "DELETE"), "TODO": "PATCH",
+                        "<ID>": {"METHODS": ("GET", "DELETE"), "TODO": "PATCH",
                             "nsd_content": { "METHODS": ("GET", "PUT")},
                             "nsd": {"METHODS": "GET"},  # descriptor inside package
                             "artifacts": {"*": {"METHODS": "GET"}}
@@ -182,9 +207,20 @@ class Server(object):
                     "ns_instances_content": {"METHODS": ("GET", "POST"),
                         "<ID>": {"METHODS": ("GET", "DELETE")}
                     },
-                    "ns_instances": {"TODO": ("GET", "POST"),
-                        "<ID>": {"TODO": ("GET", "DELETE")}
-                    }
+                    "ns_instances": {"METHODS": ("GET", "POST"),
+                        "<ID>": {"TODO": ("GET", "DELETE"),
+                             "scale": {"TODO": "POST"},
+                             "terminate": {"METHODS": "POST"},
+                             "instantiate": {"METHODS": "POST"},
+                             "action": {"METHODS": "POST"},
+                        }
+                    },
+                    "ns_lcm_op_occs": {"METHODS": "GET",
+                        "<ID>": {"METHODS": "GET"},
+                    },
+                    "vnfrs": {"METHODS": ("GET"),
+                        "<ID>": {"METHODS": ("GET")}
+                    },
                 }
             },
         }
@@ -317,8 +353,11 @@ class Server(object):
         :param _format: The format to be set as Content-Type ir data is a file
         :return: None
         """
+        accept = cherrypy.request.headers.get("Accept")
         if data is None:
-            cherrypy.response.status = HTTPStatus.NO_CONTENT.value
+            if accept and "text/html" in accept:
+                return html.format(data, cherrypy.request, cherrypy.response, session)
+            # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
             return
         elif hasattr(data, "read"):  # file object
             if _format:
@@ -329,8 +368,7 @@ class Server(object):
                 cherrypy.response.headers["Content-Type"] = 'text/plain'
             # TODO check that cherrypy close file. If not implement pending things to close  per thread next
             return data
-        if "Accept" in cherrypy.request.headers:
-            accept = cherrypy.request.headers["Accept"]
+        if accept:
             if "application/json" in accept:
                 cherrypy.response.headers["Content-Type"] = 'application/json; charset=utf-8'
                 a = json.dumps(data, indent=4) + "\n"
@@ -367,6 +405,25 @@ class Server(object):
             return self._format_out("Welcome to OSM!", session)
 
     @cherrypy.expose
+    def version(self, *args, **kwargs):
+        # TODO consider to remove and provide version using the static version file
+        global __version__, version_date
+        try:
+            if cherrypy.request.method != "GET":
+                raise NbiException("Only method GET is allowed", HTTPStatus.METHOD_NOT_ALLOWED)
+            elif args or kwargs:
+                raise NbiException("Invalid URL or query string for version", HTTPStatus.METHOD_NOT_ALLOWED)
+            return __version__ + " " + version_date
+        except NbiException as e:
+            cherrypy.response.status = e.http_code.value
+            problem_details = {
+                "code": e.http_code.name,
+                "status": e.http_code.value,
+                "detail": str(e),
+            }
+            return self._format_out(problem_details, None)
+
+    @cherrypy.expose
     def token(self, method, token_id=None, kwargs=None):
         session = None
         # self.engine.load_dbase(cherrypy.request.app.config)
@@ -390,6 +447,7 @@ class Server(object):
                 outdata = self.engine.new_token(session, indata, cherrypy.request.remote)
                 session = outdata
                 cherrypy.session['Authorization'] = outdata["_id"]
+                self._set_location_header("admin", "v1", "tokens", outdata["_id"])
                 # cherrypy.response.cookie["Authorization"] = outdata["id"]
                 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
             elif method == "DELETE":
@@ -399,6 +457,7 @@ class Server(object):
                     session = self._authorization()
                     token_id = session["_id"]
                 outdata = self.engine.del_token(token_id)
+                oudata = None
                 session = None
                 cherrypy.session['Authorization'] = "logout"
                 # cherrypy.response.cookie["Authorization"] = token_id
@@ -417,18 +476,11 @@ class Server(object):
             return self._format_out(problem_details, session)
 
     @cherrypy.expose
-    def test2(self, args0=None, args1=None, args2=None, args3=None, *args, **kwargs):
-        return_text = (
-            "<html><pre>\n{} {} {} {} {} {} \n".format(args0, args1, args2, args3, args, kwargs))
-        return_text += "</pre></html>"
-        return return_text
-
-    @cherrypy.expose
     def test(self, *args, **kwargs):
         thread_info = None
         if args and args[0] == "help":
             return "<html><pre>\ninit\nfile/<name>  download file\ndb-clear/table\nprune\nlogin\nlogin2\n"\
-                    "sleep/<time>\n</pre></html>"
+                    "sleep/<time>\nmessage/topic\n</pre></html>"
 
         elif args and args[0] == "init":
             try:
@@ -445,8 +497,8 @@ class Server(object):
             f_path = cherrypy.tree.apps['/osm'].config["storage"]["path"] + "/" + args[1]
             f = open(f_path, "r")
             cherrypy.response.headers["Content-type"] = "text/plain"
-
             return f
+
         elif len(args) == 2 and args[0] == "db-clear":
             return self.engine.del_item_list({"project_id": "admin"}, args[1], {})
         elif args and args[0] == "prune":
@@ -472,12 +524,21 @@ class Server(object):
             # thread_info
         elif len(args) >= 2 and args[0] == "message":
             topic = args[1]
+            return_text = "<html><pre>{} ->\n".format(topic)
             try:
-                for k, v in kwargs.items():
-                    self.engine.msg.write(topic, k, yaml.load(v))
-                return "ok"
+                if cherrypy.request.method == 'POST':
+                    to_send = yaml.load(cherrypy.request.body)
+                    for k, v in to_send.items():
+                        self.engine.msg.write(topic, k, v)
+                        return_text += "  {}: {}\n".format(k, v)
+                elif cherrypy.request.method == 'GET':
+                    for k, v in kwargs.items():
+                        self.engine.msg.write(topic, k, yaml.load(v))
+                        return_text += "  {}: {}\n".format(k, yaml.load(v))
             except Exception as e:
-                return "Error: " + format(e)
+                return_text += "Error: " + str(e)
+            return_text += "</pre></html>\n"
+            return return_text
 
         return_text = (
             "<html><pre>\nheaders:\n  args: {}\n".format(args) +
@@ -545,6 +606,9 @@ class Server(object):
         session = None
         outdata = None
         _format = None
+        method = "DONE"
+        engine_item = None
+        rollback = None
         try:
             if not topic or not version or not item:
                 raise NbiException("URL must contain at least 'topic/version/item'", HTTPStatus.METHOD_NOT_ALLOWED)
@@ -578,6 +642,12 @@ class Server(object):
                 engine_item = "vnfds"
             elif topic == "nslcm":
                 engine_item = "nsrs"
+                if item == "ns_lcm_op_occs":
+                    engine_item = "nslcmops"
+                if item == "vnfrs":
+                    engine_item = "vnfrs"
+            if engine_item == "vims":   # TODO this is for backward compatibility, it will remove in the future
+                engine_item = "vim_accounts"
 
             if method == "GET":
                 if item2 in ("nsd_content", "package_content", "artifacts", "vnfd", "nsd"):
@@ -601,29 +671,47 @@ class Server(object):
                     _id = cherrypy.request.headers.get("Transaction-Id")
                     if not _id:
                         _id = self.engine.new_item(session, engine_item, {}, None, cherrypy.request.headers)
+                        rollback = {"session": session, "item": engine_item, "_id": _id, "force": True}
                     completed = self.engine.upload_content(session, engine_item, _id, indata, kwargs, cherrypy.request.headers)
                     if completed:
                         self._set_location_header(topic, version, item, _id)
                     else:
                         cherrypy.response.headers["Transaction-Id"] = _id
                     outdata = {"id": _id}
-                elif item in ("ns_descriptors", "vnf_packages"):
-                    _id = self.engine.new_item(session, engine_item, indata, kwargs, cherrypy.request.headers)
+                elif item == "ns_instances_content":
+                    _id = self.engine.new_item(session, engine_item, indata, kwargs)
+                    rollback = {"session": session, "item": engine_item, "_id": _id, "force": True}
+                    self.engine.ns_action(session, _id, "instantiate", {}, None)
                     self._set_location_header(topic, version, item, _id)
-                    #TODO form NsdInfo
                     outdata = {"id": _id}
+                elif item == "ns_instances" and item2:
+                    _id = self.engine.ns_action(session, _id, item2, indata, kwargs)
+                    self._set_location_header(topic, version, "ns_lcm_op_occs", _id)
+                    outdata = {"id": _id}
+                    cherrypy.response.status = HTTPStatus.ACCEPTED.value
                 else:
                     _id = self.engine.new_item(session, engine_item, indata, kwargs, cherrypy.request.headers)
                     self._set_location_header(topic, version, item, _id)
                     outdata = {"id": _id}
+                    # TODO form NsdInfo when item in ("ns_descriptors", "vnf_packages")
                 cherrypy.response.status = HTTPStatus.CREATED.value
+
             elif method == "DELETE":
                 if not _id:
                     outdata = self.engine.del_item_list(session, engine_item, kwargs)
+                    cherrypy.response.status = HTTPStatus.OK.value
                 else:  # len(args) > 1
-                    outdata = self.engine.del_item(session, engine_item, _id)
-                if item in ("ns_descriptors", "vnf_packages"):  # SOL005
-                    outdata = None
+                    if item == "ns_instances_content":
+                        opp_id = self.engine.ns_action(session, _id, "terminate", {"autoremove": True}, None)
+                        outdata = {"_id": opp_id}
+                        cherrypy.response.status = HTTPStatus.ACCEPTED.value
+                    else:
+                        force = kwargs.get("FORCE")
+                        self.engine.del_item(session, engine_item, _id, force)
+                        cherrypy.response.status = HTTPStatus.NO_CONTENT.value
+                if engine_item in ("vim_accounts", "sdns"):
+                    cherrypy.response.status = HTTPStatus.ACCEPTED.value
+
             elif method == "PUT":
                 if not indata and not kwargs:
                     raise NbiException("Nothing to update. Provide payload and/or query string",
@@ -632,17 +720,27 @@ class Server(object):
                     completed = self.engine.upload_content(session, engine_item, _id, indata, kwargs, cherrypy.request.headers)
                     if not completed:
                         cherrypy.response.headers["Transaction-Id"] = id
+                    cherrypy.response.status = HTTPStatus.NO_CONTENT.value
                     outdata = None
                 else:
                     outdata = {"id": self.engine.edit_item(session, engine_item, args[1], indata, kwargs)}
             else:
                 raise NbiException("Method {} not allowed".format(method), HTTPStatus.METHOD_NOT_ALLOWED)
             return self._format_out(outdata, session, _format)
-        except (NbiException, EngineException, DbException, FsException) as e:
-            if hasattr(outdata, "close"):  # is an open file
-                outdata.close()
+        except (NbiException, EngineException, DbException, FsException, MsgException) as e:
             cherrypy.log("Exception {}".format(e))
             cherrypy.response.status = e.http_code.value
+            if hasattr(outdata, "close"):  # is an open file
+                outdata.close()
+            if rollback:
+                try:
+                    self.engine.del_item(**rollback)
+                except Exception as e2:
+                    cherrypy.log("Rollback Exception {}: {}".format(rollback, e2))
+            error_text = str(e)
+            if isinstance(e, MsgException):
+                error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
+                    engine_item[:-1], method, error_text)
             problem_details = {
                 "code": e.http_code.name,
                 "status": e.http_code.value,
@@ -745,7 +843,7 @@ def _start_service():
     # TODO add more entries, e.g.: storage
     cherrypy.tree.apps['/osm'].root.engine.start(engine_config)
     try:
-        cherrypy.tree.apps['/osm'].root.engine.create_admin()
+        cherrypy.tree.apps['/osm'].root.engine.init_db(target_version=database_version)
     except EngineException:
         pass
     # getenv('OSMOPENMANO_TENANT', None)