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