osm_nbi/engine.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 import logging
  17 import yaml
  18 from osm_common import dbmongo, dbmemory, fslocal, msglocal, msgkafka, version as common_version
  19 from osm_common.dbbase import DbException
  20 from osm_common.fsbase import FsException
  21 from osm_common.msgbase import MsgException
  22 from http import HTTPStatus
  23
  24 from authconn_keystone import AuthconnKeystone
  25 from base_topic import EngineException, versiontuple
  26 from admin_topics import UserTopic, ProjectTopic, VimAccountTopic, WimAccountTopic, SdnTopic
  27 from admin_topics import UserTopicAuth, ProjectTopicAuth, RoleTopicAuth
  28 from descriptor_topics import VnfdTopic, NsdTopic, PduTopic, NstTopic
  29 from instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic, NsiTopic, NsiLcmOpTopic
  30 from pmjobs_topics import PmJobsTopic
  31 from base64 import b64encode
  32 from os import urandom, path
  33 from threading import Lock
  34
  35 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  36 min_common_version = "0.1.16"
  37
  38
  39 class Engine(object):
  40     map_from_topic_to_class = {
  41         "vnfds": VnfdTopic,
  42         "nsds": NsdTopic,
  43         "nsts": NstTopic,
  44         "pdus": PduTopic,
  45         "nsrs": NsrTopic,
  46         "vnfrs": VnfrTopic,
  47         "nslcmops": NsLcmOpTopic,
  48         "vim_accounts": VimAccountTopic,
  49         "wim_accounts": WimAccountTopic,
  50         "sdns": SdnTopic,
  51         "users": UserTopic,
  52         "projects": ProjectTopic,
  53         "nsis": NsiTopic,
  54         "nsilcmops": NsiLcmOpTopic
  55         # [NEW_TOPIC]: add an entry here
  56         # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
  57     }
  58
  59     def __init__(self):
  60         self.db = None
  61         self.fs = None
  62         self.msg = None
  63         self.auth = None
  64         self.config = None
  65         self.operations = None
  66         self.logger = logging.getLogger("nbi.engine")
  67         self.map_topic = {}
  68         self.write_lock = None
  69
  70     def start(self, config):
  71         """
  72         Connect to database, filesystem storage, and messaging
  73         :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
  74         :return: None
  75         """
  76         self.config = config
  77         # check right version of common
  78         if versiontuple(common_version) < versiontuple(min_common_version):
  79             raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
  80                 common_version, min_common_version))
  81
  82         try:
  83             if not self.db:
  84                 if config["database"]["driver"] == "mongo":
  85                     self.db = dbmongo.DbMongo()
  86                     self.db.db_connect(config["database"])
  87                 elif config["database"]["driver"] == "memory":
  88                     self.db = dbmemory.DbMemory()
  89                     self.db.db_connect(config["database"])
  90                 else:
  91                     raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
  92                         config["database"]["driver"]))
  93             if not self.fs:
  94                 if config["storage"]["driver"] == "local":
  95                     self.fs = fslocal.FsLocal()
  96                     self.fs.fs_connect(config["storage"])
  97                 else:
  98                     raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
  99                         config["storage"]["driver"]))
 100             if not self.msg:
 101                 if config["message"]["driver"] == "local":
 102                     self.msg = msglocal.MsgLocal()
 103                     self.msg.connect(config["message"])
 104                 elif config["message"]["driver"] == "kafka":
 105                     self.msg = msgkafka.MsgKafka()
 106                     self.msg.connect(config["message"])
 107                 else:
 108                     raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
 109                         config["message"]["driver"]))
 110             if not self.auth:
 111                 if config["authentication"]["backend"] == "keystone":
 112                     self.auth = AuthconnKeystone(config["authentication"])
 113             if not self.operations:
 114                 if "resources_to_operations" in config["rbac"]:
 115                     resources_to_operations_file = config["rbac"]["resources_to_operations"]
 116                 else:
 117                     possible_paths = (
 118                         __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
 119                         "./resources_to_operations.yml"
 120                     )
 121                     for config_file in possible_paths:
 122                         if path.isfile(config_file):
 123                             resources_to_operations_file = config_file
 124                             break
 125                     if not resources_to_operations_file:
 126                         raise EngineException("Invalid permission configuration: resources_to_operations file missing")
 127
 128                 with open(resources_to_operations_file, 'r') as f:
 129                     resources_to_operations = yaml.load(f)
 130
 131                 self.operations = []
 132
 133                 for _, value in resources_to_operations["resources_to_operations"].items():
 134                     if value not in self.operations:
 135                         self.operations += value
 136
 137             if config["authentication"]["backend"] == "keystone":
 138                 self.map_from_topic_to_class["users"] = UserTopicAuth
 139                 self.map_from_topic_to_class["projects"] = ProjectTopicAuth
 140                 self.map_from_topic_to_class["roles"] = RoleTopicAuth
 141
 142             self.write_lock = Lock()
 143             # create one class per topic
 144             for topic, topic_class in self.map_from_topic_to_class.items():
 145                 if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
 146                     self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
 147                 elif self.auth and topic_class == RoleTopicAuth:
 148                     self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth,
 149                                                         self.operations)
 150                 else:
 151                     self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)
 152                 self.map_topic[topic] = topic_class(self.db, self.fs, self.msg)
 153             self.map_topic["pm_jobs"] = PmJobsTopic(config["prometheus"].get("host"), config["prometheus"].get("port"))
 154         except (DbException, FsException, MsgException) as e:
 155             raise EngineException(str(e), http_code=e.http_code)
 156
 157     def stop(self):
 158         try:
 159             if self.db:
 160                 self.db.db_disconnect()
 161             if self.fs:
 162                 self.fs.fs_disconnect()
 163             if self.msg:
 164                 self.msg.disconnect()
 165             self.write_lock = None
 166         except (DbException, FsException, MsgException) as e:
 167             raise EngineException(str(e), http_code=e.http_code)
 168
 169     def new_item(self, rollback, session, topic, indata=None, kwargs=None, headers=None):
 170         """
 171         Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED  entry,
 172         that must be completed with a call to method upload_content
 173         :param rollback: list to append created items at database in case a rollback must to be done
 174         :param session: contains the used login username and working project, force to avoid checkins, public
 175         :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
 176         :param indata: data to be inserted
 177         :param kwargs: used to override the indata descriptor
 178         :param headers: http request headers
 179         :return: _id: identity of the inserted data.
 180         """
 181         if topic not in self.map_topic:
 182             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 183         with self.write_lock:
 184             return self.map_topic[topic].new(rollback, session, indata, kwargs, headers)
 185
 186     def upload_content(self, session, topic, _id, indata, kwargs, headers):
 187         """
 188         Upload content for an already created entry (_id)
 189         :param session: contains the used login username and working project
 190         :param topic: it can be: users, projects, vnfds, nsds,
 191         :param _id: server id of the item
 192         :param indata: data to be inserted
 193         :param kwargs: used to override the indata descriptor
 194         :param headers: http request headers
 195         :return: _id: identity of the inserted data.
 196         """
 197         if topic not in self.map_topic:
 198             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 199         with self.write_lock:
 200             return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers)
 201
 202     def get_item_list(self, session, topic, filter_q=None):
 203         """
 204         Get a list of items
 205         :param session: contains the used login username and working project
 206         :param topic: it can be: users, projects, vnfds, nsds, ...
 207         :param filter_q: filter of data to be applied
 208         :return: The list, it can be empty if no one match the filter_q.
 209         """
 210         if topic not in self.map_topic:
 211             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 212         return self.map_topic[topic].list(session, filter_q)
 213
 214     def get_item(self, session, topic, _id):
 215         """
 216         Get complete information on an item
 217         :param session: contains the used login username and working project
 218         :param topic: it can be: users, projects, vnfds, nsds,
 219         :param _id: server id of the item
 220         :return: dictionary, raise exception if not found.
 221         """
 222         if topic not in self.map_topic:
 223             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 224         return self.map_topic[topic].show(session, _id)
 225
 226     def get_file(self, session, topic, _id, path=None, accept_header=None):
 227         """
 228         Get descriptor package or artifact file content
 229         :param session: contains the used login username and working project
 230         :param topic: it can be: users, projects, vnfds, nsds,
 231         :param _id: server id of the item
 232         :param path: artifact path or "$DESCRIPTOR" or None
 233         :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
 234         :return: opened file plus Accept format or raises an exception
 235         """
 236         if topic not in self.map_topic:
 237             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 238         return self.map_topic[topic].get_file(session, _id, path, accept_header)
 239
 240     def del_item_list(self, session, topic, _filter=None):
 241         """
 242         Delete a list of items
 243         :param session: contains the used login username and working project
 244         :param topic: it can be: users, projects, vnfds, nsds, ...
 245         :param _filter: filter of data to be applied
 246         :return: The deleted list, it can be empty if no one match the _filter.
 247         """
 248         if topic not in self.map_topic:
 249             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 250         with self.write_lock:
 251             return self.map_topic[topic].delete_list(session, _filter)
 252
 253     def del_item(self, session, topic, _id):
 254         """
 255         Delete item by its internal id
 256         :param session: contains the used login username and working project
 257         :param topic: it can be: users, projects, vnfds, nsds, ...
 258         :param _id: server id of the item
 259         :return: dictionary with deleted item _id. It raises exception if not found.
 260         """
 261         if topic not in self.map_topic:
 262             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 263         with self.write_lock:
 264             return self.map_topic[topic].delete(session, _id)
 265
 266     def edit_item(self, session, topic, _id, indata=None, kwargs=None):
 267         """
 268         Update an existing entry at database
 269         :param session: contains the used login username and working project
 270         :param topic: it can be: users, projects, vnfds, nsds, ...
 271         :param _id: identifier to be updated
 272         :param indata: data to be inserted
 273         :param kwargs: used to override the indata descriptor
 274         :return: dictionary, raise exception if not found.
 275         """
 276         if topic not in self.map_topic:
 277             raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
 278         with self.write_lock:
 279             return self.map_topic[topic].edit(session, _id, indata, kwargs)
 280
 281     def create_admin_project(self):
 282         """
 283         Creates a new project 'admin' into database if database is empty. Useful for initialization.
 284         :return: _id identity of the inserted data, or None
 285         """
 286
 287         projects = self.db.get_one("projects", fail_on_empty=False, fail_on_more=False)
 288         if projects:
 289             return None
 290         project_desc = {"name": "admin"}
 291         fake_session = {"project_id": "admin", "username": "admin", "admin": True, "force": True, "public": None}
 292         rollback_list = []
 293         _id = self.map_topic["projects"].new(rollback_list, fake_session, project_desc)
 294         return _id
 295
 296     def create_admin_user(self):
 297         """
 298         Creates a new user admin/admin into database if database is empty. Useful for initialization
 299         :return: _id identity of the inserted data, or None
 300         """
 301         users = self.db.get_one("users", fail_on_empty=False, fail_on_more=False)
 302         if users:
 303             return None
 304             # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
 305         user_desc = {"username": "admin", "password": "admin", "projects": ["admin"]}
 306         fake_session = {"project_id": "admin", "username": "admin", "admin": True, "force": True, "public": None}
 307         roolback_list = []
 308         _id = self.map_topic["users"].new(roolback_list, fake_session, user_desc)
 309         return _id
 310
 311     def create_admin(self):
 312         """
 313         Creates new 'admin' user and project into database if database is empty. Useful for initialization.
 314         :return: _id identity of the inserted data, or None
 315         """
 316         project_id = self.create_admin_project()
 317         user_id = self.create_admin_user()
 318         if not project_id and not user_id:
 319             return None
 320         else:
 321             return {'project_id': project_id, 'user_id': user_id}
 322
 323     def upgrade_db(self, current_version, target_version):
 324         if not target_version or current_version == target_version:
 325             return
 326         if target_version == '1.0':
 327             if not current_version:
 328                 # create database version
 329                 serial = urandom(32)
 330                 version_data = {
 331                     "_id": 'version',               # Always 'version'
 332                     "version_int": 1000,            # version number
 333                     "version": '1.0',               # version text
 334                     "date": "2018-10-25",           # version date
 335                     "description": "added serial",  # changes in this version
 336                     'status': 'ENABLED',            # ENABLED, DISABLED (migration in process), ERROR,
 337                     'serial': b64encode(serial)
 338                 }
 339                 self.db.create("admin", version_data)
 340                 self.db.set_secret_key(serial)
 341                 return
 342             # TODO add future migrations here
 343
 344         raise EngineException("Wrong database version '{}'. Expected '{}'"
 345                               ". It cannot be up/down-grade".format(current_version, target_version),
 346                               http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
 347
 348     def init_db(self, target_version='1.0'):
 349         """
 350         Init database if empty. If not empty it checks that database version and migrates if needed
 351         If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
 352         :param target_version: check desired database version. Migrate to it if possible or raises exception
 353         :return: None if ok, exception if error or if the version is different.
 354         """
 355
 356         version_data = self.db.get_one("admin", {"_id": "version"}, fail_on_empty=False, fail_on_more=True)
 357         # check database status is ok
 358         if version_data and version_data.get("status") != 'ENABLED':
 359             raise EngineException("Wrong database status '{}'".format(
 360                 version_data["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
 361
 362         # check version
 363         db_version = None if not version_data else version_data.get("version")
 364         if db_version != target_version:
 365             self.upgrade_db(db_version, target_version)
 366
 367         # create user admin if not exist
 368         self.create_admin()
 369         return