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