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