change version to be aligned with OSM version
[osm/NBI.git] / osm_nbi / engine.py
index db45ce7..8233c90 100644 (file)
@@ -21,12 +21,14 @@ from osm_common.fsbase import FsException
 from osm_common.msgbase import MsgException
 from http import HTTPStatus
 
 from osm_common.msgbase import MsgException
 from http import HTTPStatus
 
-from authconn_keystone import AuthconnKeystone
-from base_topic import EngineException, versiontuple
-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 osm_nbi.authconn_keystone import AuthconnKeystone
+from osm_nbi.authconn_internal import AuthconnInternal
+from osm_nbi.base_topic import EngineException, versiontuple
+from osm_nbi.admin_topics import VimAccountTopic, WimAccountTopic, SdnTopic
+from osm_nbi.admin_topics import UserTopicAuth, ProjectTopicAuth, RoleTopicAuth
+from osm_nbi.descriptor_topics import VnfdTopic, NsdTopic, PduTopic, NstTopic
+from osm_nbi.instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic, NsiTopic, NsiLcmOpTopic
+from osm_nbi.pmjobs_topics import PmJobsTopic
 from base64 import b64encode
 from os import urandom, path
 from threading import Lock
 from base64 import b64encode
 from os import urandom, path
 from threading import Lock
@@ -47,11 +49,20 @@ class Engine(object):
         "vim_accounts": VimAccountTopic,
         "wim_accounts": WimAccountTopic,
         "sdns": SdnTopic,
         "vim_accounts": VimAccountTopic,
         "wim_accounts": WimAccountTopic,
         "sdns": SdnTopic,
-        "users": UserTopic,
-        "projects": ProjectTopic,
+        "users": UserTopicAuth,   # Valid for both internal and keystone authentication backends
+        "projects": ProjectTopicAuth,   # Valid for both internal and keystone authentication backends
+        "roles": RoleTopicAuth,   # Valid for both internal and keystone authentication backends
         "nsis": NsiTopic,
         "nsilcmops": NsiLcmOpTopic
         # [NEW_TOPIC]: add an entry here
         "nsis": NsiTopic,
         "nsilcmops": NsiLcmOpTopic
         # [NEW_TOPIC]: add an entry here
+        # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
+    }
+
+    map_target_version_to_int = {
+        "1.0": 1000,
+        "1.1": 1001,
+        "1.2": 1002,
+        # Add new versions here
     }
 
     def __init__(self):
     }
 
     def __init__(self):
@@ -107,7 +118,9 @@ class Engine(object):
                         config["message"]["driver"]))
             if not self.auth:
                 if config["authentication"]["backend"] == "keystone":
                         config["message"]["driver"]))
             if not self.auth:
                 if config["authentication"]["backend"] == "keystone":
-                    self.auth = AuthconnKeystone(config["authentication"])
+                    self.auth = AuthconnKeystone(config["authentication"], self.db, None)
+                else:
+                    self.auth = AuthconnInternal(config["authentication"], self.db, dict())
             if not self.operations:
                 if "resources_to_operations" in config["rbac"]:
                     resources_to_operations_file = config["rbac"]["resources_to_operations"]
             if not self.operations:
                 if "resources_to_operations" in config["rbac"]:
                     resources_to_operations_file = config["rbac"]["resources_to_operations"]
@@ -120,22 +133,17 @@ class Engine(object):
                         if path.isfile(config_file):
                             resources_to_operations_file = config_file
                             break
                         if path.isfile(config_file):
                             resources_to_operations_file = config_file
                             break
-                    if not resources_to_operations_file:                        
+                    if not resources_to_operations_file:                   
                         raise EngineException("Invalid permission configuration: resources_to_operations file missing")
                         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)
                 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 = []
 
                 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.operations += [value]
 
             self.write_lock = Lock()
             # create one class per topic
 
             self.write_lock = Lock()
             # create one class per topic
@@ -147,6 +155,8 @@ class Engine(object):
                                                         self.operations)
                 else:
                     self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)
                                                         self.operations)
                 else:
                     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)
 
@@ -162,25 +172,24 @@ class Engine(object):
         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)
 
-    def new_item(self, rollback, session, topic, indata=None, kwargs=None, headers=None, force=False):
+    def new_item(self, rollback, session, topic, indata=None, kwargs=None, headers=None):
         """
         Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED  entry,
         that must be completed with a call to method upload_content
         :param rollback: list to append created items at database in case a rollback must to be done
         """
         Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED  entry,
         that must be completed with a call to method upload_content
         :param rollback: list to append created items at database in case a rollback must to be done
-        :param session: contains the used login username and working project
+        :param session: contains the used login username and working project, force to avoid checkins, public
         :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
         :param headers: http request headers
         :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
         :param headers: http request headers
-        :param force: If True avoid some dependence checks
         :return: _id: identity of the inserted data.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
         :return: _id: identity of the inserted data.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
-            return self.map_topic[topic].new(rollback, session, indata, kwargs, headers, force)
+            return self.map_topic[topic].new(rollback, session, indata, kwargs, headers)
 
 
-    def upload_content(self, session, topic, _id, indata, kwargs, headers, force=False):
+    def upload_content(self, session, topic, _id, indata, kwargs, headers):
         """
         Upload content for an already created entry (_id)
         :param session: contains the used login username and working project
         """
         Upload content for an already created entry (_id)
         :param session: contains the used login username and working project
@@ -189,13 +198,12 @@ class Engine(object):
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
         :param headers: http request headers
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
         :param headers: http request headers
-        :param force: If True avoid some dependence checks
         :return: _id: identity of the inserted data.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
         :return: _id: identity of the inserted data.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
-            return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers, force)
+            return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers)
 
     def get_item_list(self, session, topic, filter_q=None):
         """
 
     def get_item_list(self, session, topic, filter_q=None):
         """
@@ -248,21 +256,20 @@ class Engine(object):
         with self.write_lock:
             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):
         """
         Delete item by its internal id
         :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
         """
         Delete item by its internal id
         :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 force: indicates if deletion must be forced in case of conflict
         :return: dictionary with deleted item _id. It raises exception if not found.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
         :return: dictionary with deleted item _id. It raises exception if not found.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
-            return self.map_topic[topic].delete(session, _id, force)
+            return self.map_topic[topic].delete(session, _id)
 
 
-    def edit_item(self, session, topic, _id, indata=None, kwargs=None, force=False):
+    def edit_item(self, session, topic, _id, indata=None, kwargs=None):
         """
         Update an existing entry at database
         :param session: contains the used login username and working project
         """
         Update an existing entry at database
         :param session: contains the used login username and working project
@@ -270,80 +277,54 @@ class Engine(object):
         :param _id: identifier to be updated
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
         :param _id: identifier to be updated
         :param indata: data to be inserted
         :param kwargs: used to override the indata descriptor
-        :param force: If True avoid some dependence checks
-        :return: dictionary, raise exception if not found.
+        :return: dictionary with edited item _id, raise exception if not found.
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
         """
         if topic not in self.map_topic:
             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
         with self.write_lock:
-            return self.map_topic[topic].edit(session, _id, indata, kwargs, force)
+            return self.map_topic[topic].edit(session, _id, indata, kwargs)
 
 
-    def create_admin_project(self):
-        """
-        Creates a new project 'admin' into database if database is empty. Useful for initialization.
-        :return: _id identity of the inserted data, or None
-        """
+    def upgrade_db(self, current_version, target_version):
+        if target_version not in self.map_target_version_to_int.keys():
+            raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version),
+                                  http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
 
 
-        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
+        if current_version == target_version:
+            return
+        
+        target_version_int = self.map_target_version_to_int[target_version]
 
 
-    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
-        """
-        users = self.db.get_one("users", fail_on_empty=False, fail_on_more=False)
-        if users:
-            return None
-            # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
-        user_desc = {"username": "admin", "password": "admin", "projects": ["admin"]}
-        fake_session = {"project_id": "admin", "username": "admin", "admin": True}
-        roolback_list = []
-        _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}
+        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)
+            current_version = "1.0"
+            
+        if current_version in ("1.0", "1.1") and target_version_int >= self.map_target_version_to_int["1.2"]:
+            if self.config['authentication']['backend'] == "internal":
+                self.db.del_list("roles")
 
 
-    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
+            version_data = {
+                "_id": "version",
+                "version_int": 1002,
+                "version": "1.2",
+                "date": "2019-06-11",
+                "description": "set new format for roles_operations"
+            }
 
 
-        raise EngineException("Wrong database version '{}'. Expected '{}'"
-                              ". It cannot be up/down-grade".format(current_version, target_version),
-                              http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+            self.db.set_one("admin", {"_id": "version"}, version_data)
+            current_version = "1.2"
+            # TODO add future migrations here
 
     def init_db(self, target_version='1.0'):
         """
 
     def init_db(self, target_version='1.0'):
         """
@@ -364,6 +345,4 @@ class Engine(object):
         if db_version != target_version:
             self.upgrade_db(db_version, target_version)
 
         if db_version != target_version:
             self.upgrade_db(db_version, target_version)
 
-        # create user admin if not exist
-        self.create_admin()
         return
         return