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.
17 from osm_common
import dbmongo
, dbmemory
, fslocal
, msglocal
, msgkafka
, version
as common_version
18 from osm_common
.dbbase
import DbException
19 from osm_common
.fsbase
import FsException
20 from osm_common
.msgbase
import MsgException
21 from http
import HTTPStatus
22 from base_topic
import EngineException
, versiontuple
23 from admin_topics
import UserTopic
, ProjectTopic
, VimAccountTopic
, SdnTopic
24 from descriptor_topics
import VnfdTopic
, NsdTopic
, PduTopic
, NstTopic
25 from instance_topics
import NsrTopic
, VnfrTopic
, NsLcmOpTopic
, NsiTopic
, NsiLcmOpTopic
26 from base64
import b64encode
27 from os
import urandom
29 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
30 min_common_version
= "0.1.8"
34 map_from_topic_to_class
= {
41 "nslcmops": NsLcmOpTopic
,
42 "vim_accounts": VimAccountTopic
,
45 "projects": ProjectTopic
,
47 "nsilcmops": NsiLcmOpTopic
48 # [NEW_TOPIC]: add an entry here
56 self
.logger
= logging
.getLogger("nbi.engine")
59 def start(self
, config
):
61 Connect to database, filesystem storage, and messaging
62 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
66 # check right version of common
67 if versiontuple(common_version
) < versiontuple(min_common_version
):
68 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
69 common_version
, min_common_version
))
73 if config
["database"]["driver"] == "mongo":
74 self
.db
= dbmongo
.DbMongo()
75 self
.db
.db_connect(config
["database"])
76 elif config
["database"]["driver"] == "memory":
77 self
.db
= dbmemory
.DbMemory()
78 self
.db
.db_connect(config
["database"])
80 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
81 config
["database"]["driver"]))
83 if config
["storage"]["driver"] == "local":
84 self
.fs
= fslocal
.FsLocal()
85 self
.fs
.fs_connect(config
["storage"])
87 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
88 config
["storage"]["driver"]))
90 if config
["message"]["driver"] == "local":
91 self
.msg
= msglocal
.MsgLocal()
92 self
.msg
.connect(config
["message"])
93 elif config
["message"]["driver"] == "kafka":
94 self
.msg
= msgkafka
.MsgKafka()
95 self
.msg
.connect(config
["message"])
97 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
98 config
["storage"]["driver"]))
100 # create one class per topic
101 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
102 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
)
103 except (DbException
, FsException
, MsgException
) as e
:
104 raise EngineException(str(e
), http_code
=e
.http_code
)
109 self
.db
.db_disconnect()
111 self
.fs
.fs_disconnect()
113 self
.fs
.fs_disconnect()
114 except (DbException
, FsException
, MsgException
) as e
:
115 raise EngineException(str(e
), http_code
=e
.http_code
)
117 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None, force
=False):
119 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
120 that must be completed with a call to method upload_content
121 :param rollback: list to append created items at database in case a rollback must to be done
122 :param session: contains the used login username and working project
123 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
124 :param indata: data to be inserted
125 :param kwargs: used to override the indata descriptor
126 :param headers: http request headers
127 :param force: If True avoid some dependence checks
128 :return: _id: identity of the inserted data.
130 if topic
not in self
.map_topic
:
131 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
132 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
, force
)
134 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
, force
=False):
136 Upload content for an already created entry (_id)
137 :param session: contains the used login username and working project
138 :param topic: it can be: users, projects, vnfds, nsds,
139 :param _id: server id of the item
140 :param indata: data to be inserted
141 :param kwargs: used to override the indata descriptor
142 :param headers: http request headers
143 :param force: If True avoid some dependence checks
144 :return: _id: identity of the inserted data.
146 if topic
not in self
.map_topic
:
147 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
148 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
, force
)
150 def get_item_list(self
, session
, topic
, filter_q
=None):
153 :param session: contains the used login username and working project
154 :param topic: it can be: users, projects, vnfds, nsds, ...
155 :param filter_q: filter of data to be applied
156 :return: The list, it can be empty if no one match the filter_q.
158 if topic
not in self
.map_topic
:
159 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
160 return self
.map_topic
[topic
].list(session
, filter_q
)
162 def get_item(self
, session
, topic
, _id
):
164 Get complete information on an item
165 :param session: contains the used login username and working project
166 :param topic: it can be: users, projects, vnfds, nsds,
167 :param _id: server id of the item
168 :return: dictionary, raise exception if not found.
170 if topic
not in self
.map_topic
:
171 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
172 return self
.map_topic
[topic
].show(session
, _id
)
174 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
176 Get descriptor package or artifact file content
177 :param session: contains the used login username and working project
178 :param topic: it can be: users, projects, vnfds, nsds,
179 :param _id: server id of the item
180 :param path: artifact path or "$DESCRIPTOR" or None
181 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
182 :return: opened file plus Accept format or raises an exception
184 if topic
not in self
.map_topic
:
185 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
186 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
188 def del_item_list(self
, session
, topic
, _filter
=None):
190 Delete a list of items
191 :param session: contains the used login username and working project
192 :param topic: it can be: users, projects, vnfds, nsds, ...
193 :param _filter: filter of data to be applied
194 :return: The deleted list, it can be empty if no one match the _filter.
196 if topic
not in self
.map_topic
:
197 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
198 return self
.map_topic
[topic
].delete_list(session
, _filter
)
200 def del_item(self
, session
, topic
, _id
, force
=False):
202 Delete item by its internal id
203 :param session: contains the used login username and working project
204 :param topic: it can be: users, projects, vnfds, nsds, ...
205 :param _id: server id of the item
206 :param force: indicates if deletion must be forced in case of conflict
207 :return: dictionary with deleted item _id. It raises exception if not found.
209 if topic
not in self
.map_topic
:
210 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
211 return self
.map_topic
[topic
].delete(session
, _id
, force
)
213 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None, force
=False):
215 Update an existing entry at database
216 :param session: contains the used login username and working project
217 :param topic: it can be: users, projects, vnfds, nsds, ...
218 :param _id: identifier to be updated
219 :param indata: data to be inserted
220 :param kwargs: used to override the indata descriptor
221 :param force: If True avoid some dependence checks
222 :return: dictionary, raise exception if not found.
224 if topic
not in self
.map_topic
:
225 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
226 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
, force
)
230 Prune database not needed content
233 return self
.db
.del_list("nsrs", {"_admin.to_delete": True})
235 def create_admin(self
):
237 Creates a new user admin/admin into database if database is empty. Useful for initialization
238 :return: _id identity of the inserted data, or None
240 users
= self
.db
.get_one("users", fail_on_empty
=False, fail_on_more
=False)
243 # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
244 user_desc
= {"username": "admin", "password": "admin", "projects": ["admin"]}
245 fake_session
= {"project_id": "admin", "username": "admin", "admin": True}
247 _id
= self
.map_topic
["users"].new(roolback_list
, fake_session
, user_desc
, force
=True)
250 def upgrade_db(self
, current_version
, target_version
):
251 if not target_version
or current_version
== target_version
:
253 if target_version
== '1.0':
254 if not current_version
:
255 # create database version
258 "_id": 'version', # Always 'version'
259 "version_int": 1000, # version number
260 "version": '1.0', # version text
261 "date": "2018-10-25", # version date
262 "description": "added serial", # changes in this version
263 'status': 'ENABLED', # ENABLED, DISABLED (migration in process), ERROR,
264 'serial': b64encode(serial
)
266 self
.db
.create("admin", version_data
)
267 self
.db
.set_secret_key(serial
)
268 # TODO add future migrations here
270 raise EngineException("Wrong database version '{}'. Expected '{}'"
271 ". It cannot be up/down-grade".format(current_version
, target_version
),
272 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
274 def init_db(self
, target_version
='1.0'):
276 Init database if empty. If not empty it checks that database version and migrates if needed
277 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
278 :param target_version: check desired database version. Migrate to it if possible or raises exception
279 :return: None if ok, exception if error or if the version is different.
282 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
283 # check database status is ok
284 if version_data
and version_data
.get("status") != 'ENABLED':
285 raise EngineException("Wrong database status '{}'".format(
286 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
289 db_version
= None if not version_data
else version_data
.get("version")
290 if db_version
!= target_version
:
291 self
.upgrade_db(db_version
, target_version
)
293 # create user admin if not exist