1 # -*- coding: utf-8 -*-
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
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
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 UserTopicAuth
, ProjectTopicAuth
, RoleTopicAuth
29 from osm_nbi
.descriptor_topics
import VnfdTopic
, NsdTopic
, PduTopic
, NstTopic
30 from osm_nbi
.instance_topics
import NsrTopic
, VnfrTopic
, NsLcmOpTopic
, NsiTopic
, NsiLcmOpTopic
31 from osm_nbi
.pmjobs_topics
import PmJobsTopic
32 from base64
import b64encode
33 from os
import urandom
, path
34 from threading
import Lock
36 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
37 min_common_version
= "0.1.16"
41 map_from_topic_to_class
= {
48 "nslcmops": NsLcmOpTopic
,
49 "vim_accounts": VimAccountTopic
,
50 "wim_accounts": WimAccountTopic
,
52 "users": UserTopicAuth
, # Valid for both internal and keystone authentication backends
53 "projects": ProjectTopicAuth
, # Valid for both internal and keystone authentication backends
54 "roles": RoleTopicAuth
, # Valid for both internal and keystone authentication backends
56 "nsilcmops": NsiLcmOpTopic
57 # [NEW_TOPIC]: add an entry here
58 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
61 map_target_version_to_int
= {
65 # Add new versions here
74 self
.operations
= None
75 self
.logger
= logging
.getLogger("nbi.engine")
77 self
.write_lock
= None
79 def start(self
, config
):
81 Connect to database, filesystem storage, and messaging
82 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
86 # check right version of common
87 if versiontuple(common_version
) < versiontuple(min_common_version
):
88 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
89 common_version
, min_common_version
))
93 if config
["database"]["driver"] == "mongo":
94 self
.db
= dbmongo
.DbMongo()
95 self
.db
.db_connect(config
["database"])
96 elif config
["database"]["driver"] == "memory":
97 self
.db
= dbmemory
.DbMemory()
98 self
.db
.db_connect(config
["database"])
100 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
101 config
["database"]["driver"]))
103 if config
["storage"]["driver"] == "local":
104 self
.fs
= fslocal
.FsLocal()
105 self
.fs
.fs_connect(config
["storage"])
107 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
108 config
["storage"]["driver"]))
110 if config
["message"]["driver"] == "local":
111 self
.msg
= msglocal
.MsgLocal()
112 self
.msg
.connect(config
["message"])
113 elif config
["message"]["driver"] == "kafka":
114 self
.msg
= msgkafka
.MsgKafka()
115 self
.msg
.connect(config
["message"])
117 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
118 config
["message"]["driver"]))
120 if config
["authentication"]["backend"] == "keystone":
121 self
.auth
= AuthconnKeystone(config
["authentication"], self
.db
, None)
123 self
.auth
= AuthconnInternal(config
["authentication"], self
.db
, dict())
124 if not self
.operations
:
125 if "resources_to_operations" in config
["rbac"]:
126 resources_to_operations_file
= config
["rbac"]["resources_to_operations"]
129 __file__
[:__file__
.rfind("engine.py")] + "resources_to_operations.yml",
130 "./resources_to_operations.yml"
132 for config_file
in possible_paths
:
133 if path
.isfile(config_file
):
134 resources_to_operations_file
= config_file
136 if not resources_to_operations_file
:
137 raise EngineException("Invalid permission configuration: resources_to_operations file missing")
139 with
open(resources_to_operations_file
, 'r') as f
:
140 resources_to_operations
= yaml
.load(f
, Loader
=yaml
.Loader
)
144 for _
, value
in resources_to_operations
["resources_to_operations"].items():
145 if value
not in self
.operations
:
146 self
.operations
+= [value
]
148 self
.write_lock
= Lock()
149 # create one class per topic
150 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
151 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
152 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
153 if self
.auth
and topic_class
== RoleTopicAuth
:
154 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
,
157 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
)
159 self
.map_topic
["pm_jobs"] = PmJobsTopic(config
["prometheus"].get("host"), config
["prometheus"].get("port"))
160 except (DbException
, FsException
, MsgException
) as e
:
161 raise EngineException(str(e
), http_code
=e
.http_code
)
166 self
.db
.db_disconnect()
168 self
.fs
.fs_disconnect()
170 self
.msg
.disconnect()
171 self
.write_lock
= None
172 except (DbException
, FsException
, MsgException
) as e
:
173 raise EngineException(str(e
), http_code
=e
.http_code
)
175 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None):
177 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
178 that must be completed with a call to method upload_content
179 :param rollback: list to append created items at database in case a rollback must to be done
180 :param session: contains the used login username and working project, force to avoid checkins, public
181 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
182 :param indata: data to be inserted
183 :param kwargs: used to override the indata descriptor
184 :param headers: http request headers
185 :return: _id: identity of the inserted data.
187 if topic
not in self
.map_topic
:
188 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
189 with self
.write_lock
:
190 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
)
192 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
):
194 Upload content for an already created entry (_id)
195 :param session: contains the used login username and working project
196 :param topic: it can be: users, projects, vnfds, nsds,
197 :param _id: server id of the item
198 :param indata: data to be inserted
199 :param kwargs: used to override the indata descriptor
200 :param headers: http request headers
201 :return: _id: identity of the inserted data.
203 if topic
not in self
.map_topic
:
204 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
205 with self
.write_lock
:
206 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
)
208 def get_item_list(self
, session
, topic
, filter_q
=None):
211 :param session: contains the used login username and working project
212 :param topic: it can be: users, projects, vnfds, nsds, ...
213 :param filter_q: filter of data to be applied
214 :return: The list, it can be empty if no one match the filter_q.
216 if topic
not in self
.map_topic
:
217 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
218 return self
.map_topic
[topic
].list(session
, filter_q
)
220 def get_item(self
, session
, topic
, _id
):
222 Get complete information on an item
223 :param session: contains the used login username and working project
224 :param topic: it can be: users, projects, vnfds, nsds,
225 :param _id: server id of the item
226 :return: dictionary, raise exception if not found.
228 if topic
not in self
.map_topic
:
229 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
230 return self
.map_topic
[topic
].show(session
, _id
)
232 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
234 Get descriptor package or artifact file content
235 :param session: contains the used login username and working project
236 :param topic: it can be: users, projects, vnfds, nsds,
237 :param _id: server id of the item
238 :param path: artifact path or "$DESCRIPTOR" or None
239 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
240 :return: opened file plus Accept format or raises an exception
242 if topic
not in self
.map_topic
:
243 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
244 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
246 def del_item_list(self
, session
, topic
, _filter
=None):
248 Delete a list of items
249 :param session: contains the used login username and working project
250 :param topic: it can be: users, projects, vnfds, nsds, ...
251 :param _filter: filter of data to be applied
252 :return: The deleted list, it can be empty if no one match the _filter.
254 if topic
not in self
.map_topic
:
255 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
256 with self
.write_lock
:
257 return self
.map_topic
[topic
].delete_list(session
, _filter
)
259 def del_item(self
, session
, topic
, _id
):
261 Delete item by its internal id
262 :param session: contains the used login username and working project
263 :param topic: it can be: users, projects, vnfds, nsds, ...
264 :param _id: server id of the item
265 :return: dictionary with deleted item _id. It raises exception if not found.
267 if topic
not in self
.map_topic
:
268 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
269 with self
.write_lock
:
270 return self
.map_topic
[topic
].delete(session
, _id
)
272 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None):
274 Update an existing entry at database
275 :param session: contains the used login username and working project
276 :param topic: it can be: users, projects, vnfds, nsds, ...
277 :param _id: identifier to be updated
278 :param indata: data to be inserted
279 :param kwargs: used to override the indata descriptor
280 :return: dictionary with edited item _id, raise exception if not found.
282 if topic
not in self
.map_topic
:
283 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
284 with self
.write_lock
:
285 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
)
287 def upgrade_db(self
, current_version
, target_version
):
288 if target_version
not in self
.map_target_version_to_int
.keys():
289 raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version
),
290 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
292 if current_version
== target_version
:
295 target_version_int
= self
.map_target_version_to_int
[target_version
]
297 if not current_version
:
298 # create database version
301 "_id": "version", # Always "version"
302 "version_int": 1000, # version number
303 "version": "1.0", # version text
304 "date": "2018-10-25", # version date
305 "description": "added serial", # changes in this version
306 'status': "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
307 'serial': b64encode(serial
)
309 self
.db
.create("admin", version_data
)
310 self
.db
.set_secret_key(serial
)
311 current_version
= "1.0"
313 if current_version
in ("1.0", "1.1") and target_version_int
>= self
.map_target_version_to_int
["1.2"]:
314 if self
.config
['authentication']['backend'] == "internal":
315 self
.db
.del_list("roles")
321 "date": "2019-06-11",
322 "description": "set new format for roles_operations"
325 self
.db
.set_one("admin", {"_id": "version"}, version_data
)
326 current_version
= "1.2"
327 # TODO add future migrations here
329 def init_db(self
, target_version
='1.0'):
331 Init database if empty. If not empty it checks that database version and migrates if needed
332 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
333 :param target_version: check desired database version. Migrate to it if possible or raises exception
334 :return: None if ok, exception if error or if the version is different.
337 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
338 # check database status is ok
339 if version_data
and version_data
.get("status") != 'ENABLED':
340 raise EngineException("Wrong database status '{}'".format(
341 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
344 db_version
= None if not version_data
else version_data
.get("version")
345 if db_version
!= target_version
:
346 self
.upgrade_db(db_version
, target_version
)