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
, WimAccountTopic
, 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
,
43 "wim_accounts": WimAccountTopic
,
46 "projects": ProjectTopic
,
48 "nsilcmops": NsiLcmOpTopic
49 # [NEW_TOPIC]: add an entry here
57 self
.logger
= logging
.getLogger("nbi.engine")
60 def start(self
, config
):
62 Connect to database, filesystem storage, and messaging
63 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
67 # check right version of common
68 if versiontuple(common_version
) < versiontuple(min_common_version
):
69 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
70 common_version
, min_common_version
))
74 if config
["database"]["driver"] == "mongo":
75 self
.db
= dbmongo
.DbMongo()
76 self
.db
.db_connect(config
["database"])
77 elif config
["database"]["driver"] == "memory":
78 self
.db
= dbmemory
.DbMemory()
79 self
.db
.db_connect(config
["database"])
81 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
82 config
["database"]["driver"]))
84 if config
["storage"]["driver"] == "local":
85 self
.fs
= fslocal
.FsLocal()
86 self
.fs
.fs_connect(config
["storage"])
88 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
89 config
["storage"]["driver"]))
91 if config
["message"]["driver"] == "local":
92 self
.msg
= msglocal
.MsgLocal()
93 self
.msg
.connect(config
["message"])
94 elif config
["message"]["driver"] == "kafka":
95 self
.msg
= msgkafka
.MsgKafka()
96 self
.msg
.connect(config
["message"])
98 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
99 config
["storage"]["driver"]))
101 # create one class per topic
102 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
103 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
)
104 except (DbException
, FsException
, MsgException
) as e
:
105 raise EngineException(str(e
), http_code
=e
.http_code
)
110 self
.db
.db_disconnect()
112 self
.fs
.fs_disconnect()
114 self
.fs
.fs_disconnect()
115 except (DbException
, FsException
, MsgException
) as e
:
116 raise EngineException(str(e
), http_code
=e
.http_code
)
118 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None, force
=False):
120 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
121 that must be completed with a call to method upload_content
122 :param rollback: list to append created items at database in case a rollback must to be done
123 :param session: contains the used login username and working project
124 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
125 :param indata: data to be inserted
126 :param kwargs: used to override the indata descriptor
127 :param headers: http request headers
128 :param force: If True avoid some dependence checks
129 :return: _id: identity of the inserted data.
131 if topic
not in self
.map_topic
:
132 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
133 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
, force
)
135 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
, force
=False):
137 Upload content for an already created entry (_id)
138 :param session: contains the used login username and working project
139 :param topic: it can be: users, projects, vnfds, nsds,
140 :param _id: server id of the item
141 :param indata: data to be inserted
142 :param kwargs: used to override the indata descriptor
143 :param headers: http request headers
144 :param force: If True avoid some dependence checks
145 :return: _id: identity of the inserted data.
147 if topic
not in self
.map_topic
:
148 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
149 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
, force
)
151 def get_item_list(self
, session
, topic
, filter_q
=None):
154 :param session: contains the used login username and working project
155 :param topic: it can be: users, projects, vnfds, nsds, ...
156 :param filter_q: filter of data to be applied
157 :return: The list, it can be empty if no one match the filter_q.
159 if topic
not in self
.map_topic
:
160 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
161 return self
.map_topic
[topic
].list(session
, filter_q
)
163 def get_item(self
, session
, topic
, _id
):
165 Get complete information on an item
166 :param session: contains the used login username and working project
167 :param topic: it can be: users, projects, vnfds, nsds,
168 :param _id: server id of the item
169 :return: dictionary, raise exception if not found.
171 if topic
not in self
.map_topic
:
172 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
173 return self
.map_topic
[topic
].show(session
, _id
)
175 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
177 Get descriptor package or artifact file content
178 :param session: contains the used login username and working project
179 :param topic: it can be: users, projects, vnfds, nsds,
180 :param _id: server id of the item
181 :param path: artifact path or "$DESCRIPTOR" or None
182 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
183 :return: opened file plus Accept format or raises an exception
185 if topic
not in self
.map_topic
:
186 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
187 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
189 def del_item_list(self
, session
, topic
, _filter
=None):
191 Delete a list of items
192 :param session: contains the used login username and working project
193 :param topic: it can be: users, projects, vnfds, nsds, ...
194 :param _filter: filter of data to be applied
195 :return: The deleted list, it can be empty if no one match the _filter.
197 if topic
not in self
.map_topic
:
198 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
199 return self
.map_topic
[topic
].delete_list(session
, _filter
)
201 def del_item(self
, session
, topic
, _id
, force
=False):
203 Delete item by its internal id
204 :param session: contains the used login username and working project
205 :param topic: it can be: users, projects, vnfds, nsds, ...
206 :param _id: server id of the item
207 :param force: indicates if deletion must be forced in case of conflict
208 :return: dictionary with deleted item _id. It raises exception if not found.
210 if topic
not in self
.map_topic
:
211 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
212 return self
.map_topic
[topic
].delete(session
, _id
, force
)
214 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None, force
=False):
216 Update an existing entry at database
217 :param session: contains the used login username and working project
218 :param topic: it can be: users, projects, vnfds, nsds, ...
219 :param _id: identifier to be updated
220 :param indata: data to be inserted
221 :param kwargs: used to override the indata descriptor
222 :param force: If True avoid some dependence checks
223 :return: dictionary, raise exception if not found.
225 if topic
not in self
.map_topic
:
226 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
227 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
, force
)
229 def create_admin(self
):
231 Creates a new user admin/admin into database if database is empty. Useful for initialization
232 :return: _id identity of the inserted data, or None
234 users
= self
.db
.get_one("users", fail_on_empty
=False, fail_on_more
=False)
237 # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
238 user_desc
= {"username": "admin", "password": "admin", "projects": ["admin"]}
239 fake_session
= {"project_id": "admin", "username": "admin", "admin": True}
241 _id
= self
.map_topic
["users"].new(roolback_list
, fake_session
, user_desc
, force
=True)
244 def upgrade_db(self
, current_version
, target_version
):
245 if not target_version
or current_version
== target_version
:
247 if target_version
== '1.0':
248 if not current_version
:
249 # create database version
252 "_id": 'version', # Always 'version'
253 "version_int": 1000, # version number
254 "version": '1.0', # version text
255 "date": "2018-10-25", # version date
256 "description": "added serial", # changes in this version
257 'status': 'ENABLED', # ENABLED, DISABLED (migration in process), ERROR,
258 'serial': b64encode(serial
)
260 self
.db
.create("admin", version_data
)
261 self
.db
.set_secret_key(serial
)
262 # TODO add future migrations here
264 raise EngineException("Wrong database version '{}'. Expected '{}'"
265 ". It cannot be up/down-grade".format(current_version
, target_version
),
266 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
268 def init_db(self
, target_version
='1.0'):
270 Init database if empty. If not empty it checks that database version and migrates if needed
271 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
272 :param target_version: check desired database version. Migrate to it if possible or raises exception
273 :return: None if ok, exception if error or if the version is different.
276 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
277 # check database status is ok
278 if version_data
and version_data
.get("status") != 'ENABLED':
279 raise EngineException("Wrong database status '{}'".format(
280 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
283 db_version
= None if not version_data
else version_data
.get("version")
284 if db_version
!= target_version
:
285 self
.upgrade_db(db_version
, target_version
)
287 # create user admin if not exist