Gerrit id-7270 Enhancing NBI to define APIs for metric collection

[osm/NBI.git] / osm_nbi / engine.py

diff --git a/osm_nbi/engine.py b/osm_nbi/engine.py
index ab7eec0..5e42858 100644 (file)
--- a/osm_nbi/engine.py
+++ b/osm_nbi/engine.py
@@ -1,42 +1,71 @@
 # -*- coding: utf-8 -*-
 
 # -*- 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.
+

 import logging
 import logging

+import yaml

 from osm_common import dbmongo, dbmemory, fslocal, msglocal, msgkafka, version as common_version
 from osm_common.dbbase import DbException
 from osm_common.fsbase import FsException
 from osm_common.msgbase import MsgException
 from http import HTTPStatus
 from osm_common import dbmongo, dbmemory, fslocal, msglocal, msgkafka, version as common_version
 from osm_common.dbbase import DbException
 from osm_common.fsbase import FsException
 from osm_common.msgbase import MsgException
 from http import HTTPStatus

+
+from authconn_keystone import AuthconnKeystone

 from base_topic import EngineException, versiontuple
 from base_topic import EngineException, versiontuple

-from admin_topics import UserTopic, ProjectTopic, VimAccountTopic, SdnTopic
-from descriptor_topics import VnfdTopic, NsdTopic, PduTopic
-from instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic
+from admin_topics import UserTopic, ProjectTopic, VimAccountTopic, WimAccountTopic, SdnTopic
+from admin_topics import UserTopicAuth, ProjectTopicAuth, RoleTopicAuth
+from descriptor_topics import VnfdTopic, NsdTopic, PduTopic, NstTopic
+from instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic, NsiTopic, NsiLcmOpTopic
+from pmjobs_topics import PmJobsTopic
+from base64 import b64encode
+from os import urandom, path
+from threading import Lock

 
 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
 
 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"

-min_common_version = "0.1.8"
+min_common_version = "0.1.16"

 
 
 class Engine(object):
     map_from_topic_to_class = {
         "vnfds": VnfdTopic,
         "nsds": NsdTopic,
 
 
 class Engine(object):
     map_from_topic_to_class = {
         "vnfds": VnfdTopic,
         "nsds": NsdTopic,

+        "nsts": NstTopic,

         "pdus": PduTopic,
         "nsrs": NsrTopic,
         "vnfrs": VnfrTopic,
         "nslcmops": NsLcmOpTopic,
         "vim_accounts": VimAccountTopic,
         "pdus": PduTopic,
         "nsrs": NsrTopic,
         "vnfrs": VnfrTopic,
         "nslcmops": NsLcmOpTopic,
         "vim_accounts": VimAccountTopic,

+        "wim_accounts": WimAccountTopic,

         "sdns": SdnTopic,
         "users": UserTopic,
         "projects": ProjectTopic,
         "sdns": SdnTopic,
         "users": UserTopic,
         "projects": ProjectTopic,

+        "nsis": NsiTopic,
+        "nsilcmops": NsiLcmOpTopic

         # [NEW_TOPIC]: add an entry here
         # [NEW_TOPIC]: add an entry here

+        # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters

     }
 
     def __init__(self):
         self.db = None
         self.fs = None
         self.msg = None
     }
 
     def __init__(self):
         self.db = None
         self.fs = None
         self.msg = None

+        self.auth = None

         self.config = None
         self.config = None

+        self.operations = None

         self.logger = logging.getLogger("nbi.engine")
         self.map_topic = {}
         self.logger = logging.getLogger("nbi.engine")
         self.map_topic = {}

+        self.write_lock = None

 
     def start(self, config):
         """
 
     def start(self, config):
         """


@@ -77,11 +106,51 @@ class Engine(object):
                     self.msg.connect(config["message"])
                 else:
                     raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
                     self.msg.connect(config["message"])
                 else:
                     raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(

-                        config["storage"]["driver"]))
+                        config["message"]["driver"]))
+            if not self.auth:
+                if config["authentication"]["backend"] == "keystone":
+                    self.auth = AuthconnKeystone(config["authentication"])
+            if not self.operations:
+                if "resources_to_operations" in config["rbac"]:
+                    resources_to_operations_file = config["rbac"]["resources_to_operations"]
+                else:
+                    possible_paths = (
+                        __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
+                        "./resources_to_operations.yml"
+                    )
+                    for config_file in possible_paths:
+                        if path.isfile(config_file):
+                            resources_to_operations_file = config_file
+                            break
+                    if not resources_to_operations_file:                        
+                        raise EngineException("Invalid permission configuration: resources_to_operations file missing")
+                
+                with open(resources_to_operations_file, 'r') as f:
+                    resources_to_operations = yaml.load(f)
+                
+                self.operations = []
+
+                for _, value in resources_to_operations["resources_to_operations"].items():
+                    if value not in self.operations:
+                        self.operations += value

 
 

+            if config["authentication"]["backend"] == "keystone":
+                self.map_from_topic_to_class["users"] = UserTopicAuth
+                self.map_from_topic_to_class["projects"] = ProjectTopicAuth
+                self.map_from_topic_to_class["roles"] = RoleTopicAuth
+
+            self.write_lock = Lock()

             # create one class per topic
             for topic, topic_class in self.map_from_topic_to_class.items():
             # create one class per topic
             for topic, topic_class in self.map_from_topic_to_class.items():

+                if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
+                    self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
+                elif self.auth and topic_class == RoleTopicAuth:
+                    self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth,
+                                                        self.operations)
+                else:
+                    self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)

                 self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)
                 self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)

+            self.map_topic["pm_jobs"] = PmJobsTopic(config["prometheus"].get("host"), config["prometheus"].get("port"))

         except (DbException, FsException, MsgException) as e:
             raise EngineException(str(e), http_code=e.http_code)
 
         except (DbException, FsException, MsgException) as e:
             raise EngineException(str(e), http_code=e.http_code)
 


@@ -91,8 +160,9 @@ class Engine(object):
                 self.db.db_disconnect()
             if self.fs:
                 self.fs.fs_disconnect()
                 self.db.db_disconnect()
             if self.fs:
                 self.fs.fs_disconnect()

-            if self.fs:
-                self.fs.fs_disconnect()
+            if self.msg:
+                self.msg.disconnect()
+            self.write_lock = None

         except (DbException, FsException, MsgException) as e:
             raise EngineException(str(e), http_code=e.http_code)
 
         except (DbException, FsException, MsgException) as e:
             raise EngineException(str(e), http_code=e.http_code)
 


@@ -111,7 +181,8 @@ class Engine(object):
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)

-        return self.map_topic[topic].new(rollback, session, indata, kwargs, headers, force)
+        with self.write_lock:
+            return self.map_topic[topic].new(rollback, session, indata, kwargs, headers, force)

 
     def upload_content(self, session, topic, _id, indata, kwargs, headers, force=False):
         """
 
     def upload_content(self, session, topic, _id, indata, kwargs, headers, force=False):
         """


@@ -127,7 +198,8 @@ class Engine(object):
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)

-        return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers, force)
+        with self.write_lock:
+            return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers, force)

 
     def get_item_list(self, session, topic, filter_q=None):
         """
 
     def get_item_list(self, session, topic, filter_q=None):
         """


@@ -153,6 +225,20 @@ class Engine(object):
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         return self.map_topic[topic].show(session, _id)
 
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         return self.map_topic[topic].show(session, _id)
 

+    def get_file(self, session, topic, _id, path=None, accept_header=None):
+        """
+        Get descriptor package or artifact file content
+        :param session: contains the used login username and working project
+        :param topic: it can be: users, projects, vnfds, nsds,
+        :param _id: server id of the item
+        :param path: artifact path or "$DESCRIPTOR" or None
+        :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
+        :return: opened file plus Accept format or raises an exception
+        """
+        if topic not in self.map_topic:
+            raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
+        return self.map_topic[topic].get_file(session, _id, path, accept_header)
+

     def del_item_list(self, session, topic, _filter=None):
         """
         Delete a list of items
     def del_item_list(self, session, topic, _filter=None):
         """
         Delete a list of items


@@ -163,7 +249,8 @@ class Engine(object):
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)

-        return self.map_topic[topic].delete_list(session, _filter)
+        with self.write_lock:
+            return self.map_topic[topic].delete_list(session, _filter)

 
     def del_item(self, session, topic, _id, force=False):
         """
 
     def del_item(self, session, topic, _id, force=False):
         """


@@ -176,7 +263,8 @@ class Engine(object):
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)

-        return self.map_topic[topic].delete(session, _id, force)
+        with self.write_lock:
+            return self.map_topic[topic].delete(session, _id, force)

 
     def edit_item(self, session, topic, _id, indata=None, kwargs=None, force=False):
         """
 
     def edit_item(self, session, topic, _id, indata=None, kwargs=None, force=False):
         """


@@ -191,16 +279,25 @@ class Engine(object):
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)

-        return self.map_topic[topic].edit(session, _id, indata, kwargs, force)
+        with self.write_lock:
+            return self.map_topic[topic].edit(session, _id, indata, kwargs, force)

 
 

-    def prune(self):
+    def create_admin_project(self):

         """
         """

-        Prune database not needed content
-        :return: None
+        Creates a new project 'admin' into database if database is empty. Useful for initialization.
+        :return: _id identity of the inserted data, or None

         """
         """

-        return self.db.del_list("nsrs", {"_admin.to_delete": True})

 
 

-    def create_admin(self):
+        projects = self.db.get_one("projects", fail_on_empty=False, fail_on_more=False)
+        if projects:
+            return None
+        project_desc = {"name": "admin"}
+        fake_session = {"project_id": "admin", "username": "admin", "admin": True}
+        rollback_list = []
+        _id = self.map_topic["projects"].new(rollback_list, fake_session, project_desc, force=True)
+        return _id
+
+    def create_admin_user(self):

         """
         Creates a new user admin/admin into database if database is empty. Useful for initialization
         :return: _id identity of the inserted data, or None
         """
         Creates a new user admin/admin into database if database is empty. Useful for initialization
         :return: _id identity of the inserted data, or None


@@ -215,30 +312,62 @@ class Engine(object):
         _id = self.map_topic["users"].new(roolback_list, fake_session, user_desc, force=True)
         return _id
 
         _id = self.map_topic["users"].new(roolback_list, fake_session, user_desc, force=True)
         return _id
 

+    def create_admin(self):
+        """
+        Creates new 'admin' user and project into database if database is empty. Useful for initialization.
+        :return: _id identity of the inserted data, or None
+        """
+        project_id = self.create_admin_project()
+        user_id = self.create_admin_user()
+        if not project_id and not user_id:
+            return None
+        else:
+            return {'project_id': project_id, 'user_id': user_id}
+
+    def upgrade_db(self, current_version, target_version):
+        if not target_version or current_version == target_version:
+            return
+        if target_version == '1.0':
+            if not current_version:
+                # create database version
+                serial = urandom(32)
+                version_data = {
+                    "_id": 'version',               # Always 'version'
+                    "version_int": 1000,            # version number
+                    "version": '1.0',               # version text
+                    "date": "2018-10-25",           # version date
+                    "description": "added serial",  # changes in this version
+                    'status': 'ENABLED',            # ENABLED, DISABLED (migration in process), ERROR,
+                    'serial': b64encode(serial)
+                }
+                self.db.create("admin", version_data)
+                self.db.set_secret_key(serial)
+                return
+            # TODO add future migrations here
+
+        raise EngineException("Wrong database version '{}'. Expected '{}'"
+                              ". It cannot be up/down-grade".format(current_version, target_version),
+                              http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+

     def init_db(self, target_version='1.0'):
         """
     def init_db(self, target_version='1.0'):
         """

-        Init database if empty. If not empty it checks that database version is ok.
+        Init database if empty. If not empty it checks that database version and migrates if needed

         If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
         If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'

+        :param target_version: check desired database version. Migrate to it if possible or raises exception

         :return: None if ok, exception if error or if the version is different.
         """
         :return: None if ok, exception if error or if the version is different.
         """

-        version = self.db.get_one("version", fail_on_empty=False, fail_on_more=False)
-        if not version:
-            # create user admin
-            self.create_admin()
-            # create database version
-            version_data = {
-                "_id": '1.0',                     # version text
-                "version": 1000,                  # version number
-                "date": "2018-04-12",             # version date
-                "description": "initial design",  # changes in this version
-                'status': 'ENABLED'               # ENABLED, DISABLED (migration in process), ERROR,
-            }
-            self.db.create("version", version_data)
-        elif version["_id"] != target_version:
-            # TODO implement migration process
-            raise EngineException("Wrong database version '{}'. Expected '{}'".format(
-                version["_id"], target_version), HTTPStatus.INTERNAL_SERVER_ERROR)
-        elif version["status"] != 'ENABLED':
+
+        version_data = self.db.get_one("admin", {"_id": "version"}, fail_on_empty=False, fail_on_more=True)
+        # check database status is ok
+        if version_data and version_data.get("status") != 'ENABLED':

             raise EngineException("Wrong database status '{}'".format(
             raise EngineException("Wrong database status '{}'".format(

-                version["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
+                version_data["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
+
+        # check version
+        db_version = None if not version_data else version_data.get("version")
+        if db_version != target_version:
+            self.upgrade_db(db_version, target_version)
+
+        # create user admin if not exist
+        self.create_admin()

         return
         return