2 # -*- coding: utf-8 -*-
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
21 import osm_nbi
.html_out
as html
23 import logging
.handlers
27 from osm_nbi
.authconn
import AuthException
, AuthconnException
28 from osm_nbi
.auth
import Authenticator
29 from osm_nbi
.engine
import Engine
, EngineException
30 from osm_nbi
.subscriptions
import SubscriptionThread
31 from osm_nbi
.validation
import ValidationError
32 from osm_common
.dbbase
import DbException
33 from osm_common
.fsbase
import FsException
34 from osm_common
.msgbase
import MsgException
35 from http
import HTTPStatus
36 from codecs
import getreader
37 from os
import environ
, path
38 from osm_nbi
import version
as nbi_version
, version_date
as nbi_version_date
40 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
42 __version__
= "0.1.3" # file version, not NBI version
43 version_date
= "Aug 2019"
45 database_version
= "1.2"
46 auth_database_version
= "1.0"
47 nbi_server
= None # instance of Server class
48 subscription_thread
= None # instance of SubscriptionThread class
51 North Bound Interface (O: OSM specific; 5,X: SOL005 not implemented yet; O5: SOL005 implemented)
52 URL: /osm GET POST PUT DELETE PATCH
54 /ns_descriptors_content O O
60 /artifacts[/<artifactPath>] O
68 /vnf_packages_content O O
72 /package_content O5 O5
75 /artifacts[/<artifactPath>] O5
80 /ns_instances_content O O
92 /vnf_instances (also vnfrs for compatibility) O
108 /vim_accounts (also vims for compatibility) O O
122 /netslice_templates_content O O
124 /netslice_templates O O
128 /artifacts[/<artifactPath>] O
130 /<subscriptionId> X X
133 /netslice_instances_content O O
134 /<SliceInstanceId> O O
135 /netslice_instances O O
136 /<SliceInstanceId> O O
141 /<nsiLcmOpOccId> O O O
143 /<subscriptionId> X X
146 Follows SOL005 section 4.3.2 It contains extra METHOD to override http method, FORCE to force.
147 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
148 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
149 op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
151 For filtering inside array, it must select the element of the array, or add ANYINDEX to apply the filtering over any
152 item of the array, that is, pass if any item of the array pass the filter.
153 It allows both ne and neq for not equal
154 TODO: 4.3.3 Attribute selectors
155 all_fields, fields=x,y,.., exclude_default, exclude_fields=x,y,...
156 (none) … same as “exclude_default”
157 all_fields … all attributes.
158 fields=<list> … all attributes except all complex attributes with minimum cardinality of zero that are not
159 conditionally mandatory, and that are not provided in <list>.
160 exclude_fields=<list> … all attributes except those complex attributes with a minimum cardinality of zero that
161 are not conditionally mandatory, and that are provided in <list>.
162 exclude_default … all attributes except those complex attributes with a minimum cardinality of zero that are not
163 conditionally mandatory, and that are part of the "default exclude set" defined in the present specification for
164 the particular resource
165 exclude_default and include=<list> … all attributes except those complex attributes with a minimum cardinality
166 of zero that are not conditionally mandatory and that are part of the "default exclude set" defined in the
167 present specification for the particular resource, but that are not part of <list>
168 Additionally it admits some administrator values:
169 FORCE: To force operations skipping dependency checkings
170 ADMIN: To act as an administrator or a different project
171 PUBLIC: To get public descriptors or set a descriptor as public
172 SET_PROJECT: To make a descriptor available for other project
174 Header field name Reference Example Descriptions
175 Accept IETF RFC 7231 [19] application/json Content-Types that are acceptable for the response.
176 This header field shall be present if the response is expected to have a non-empty message body.
177 Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the request.
178 This header field shall be present if the request has a non-empty message body.
179 Authorization IETF RFC 7235 [22] Bearer mF_9.B5f-4.1JqM The authorization token for the request.
180 Details are specified in clause 4.5.3.
181 Range IETF RFC 7233 [21] 1000-2000 Requested range of bytes from a file
182 Header field name Reference Example Descriptions
183 Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the response.
184 This header field shall be present if the response has a non-empty message body.
185 Location IETF RFC 7231 [19] http://www.example.com/vnflcm/v1/vnf_instances/123 Used in redirection, or when a
186 new resource has been created.
187 This header field shall be present if the response status code is 201 or 3xx.
188 In the present document this header field is also used if the response status code is 202 and a new resource was
190 WWW-Authenticate IETF RFC 7235 [22] Bearer realm="example" Challenge if the corresponding HTTP request has not
191 provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization
193 Accept-Ranges IETF RFC 7233 [21] bytes Used by the Server to signal whether or not it supports ranges for
195 Content-Range IETF RFC 7233 [21] bytes 21010-47021/ 47022 Signals the byte range that is contained in the
196 response, and the total length of the file.
197 Retry-After IETF RFC 7231 [19] Fri, 31 Dec 1999 23:59:59 GMT
200 valid_query_string
= ("ADMIN", "SET_PROJECT", "FORCE", "PUBLIC")
201 # ^ Contains possible administrative query string words:
202 # ADMIN=True(by default)|Project|Project-list: See all elements, or elements of a project
203 # (not owned by my session project).
204 # PUBLIC=True(by default)|False: See/hide public elements. Set/Unset a topic to be public
205 # FORCE=True(by default)|False: Force edition/deletion operations
206 # SET_PROJECT=Project|Project-list: Add/Delete the topic to the projects portfolio
208 valid_url_methods
= {
209 # contains allowed URL and methods, and the role_permission name
213 "METHODS": ("GET", "POST", "DELETE"),
214 "ROLE_PERMISSION": "tokens:",
215 "<ID>": {"METHODS": ("GET", "DELETE"), "ROLE_PERMISSION": "tokens:id:"},
218 "METHODS": ("GET", "POST"),
219 "ROLE_PERMISSION": "users:",
221 "METHODS": ("GET", "DELETE", "PATCH"),
222 "ROLE_PERMISSION": "users:id:",
226 "METHODS": ("GET", "POST"),
227 "ROLE_PERMISSION": "projects:",
229 "METHODS": ("GET", "DELETE", "PATCH"),
230 "ROLE_PERMISSION": "projects:id:",
234 "METHODS": ("GET", "POST"),
235 "ROLE_PERMISSION": "roles:",
237 "METHODS": ("GET", "DELETE", "PATCH"),
238 "ROLE_PERMISSION": "roles:id:",
242 "METHODS": ("GET", "POST"),
243 "ROLE_PERMISSION": "vims:",
245 "METHODS": ("GET", "DELETE", "PATCH"),
246 "ROLE_PERMISSION": "vims:id:",
250 "METHODS": ("GET", "POST"),
251 "ROLE_PERMISSION": "vim_accounts:",
253 "METHODS": ("GET", "DELETE", "PATCH"),
254 "ROLE_PERMISSION": "vim_accounts:id:",
258 "METHODS": ("GET", "POST"),
259 "ROLE_PERMISSION": "wim_accounts:",
261 "METHODS": ("GET", "DELETE", "PATCH"),
262 "ROLE_PERMISSION": "wim_accounts:id:",
266 "METHODS": ("GET", "POST"),
267 "ROLE_PERMISSION": "sdn_controllers:",
269 "METHODS": ("GET", "DELETE", "PATCH"),
270 "ROLE_PERMISSION": "sdn_controllers:id:",
274 "METHODS": ("GET", "POST"),
275 "ROLE_PERMISSION": "k8sclusters:",
277 "METHODS": ("GET", "DELETE", "PATCH"),
278 "ROLE_PERMISSION": "k8sclusters:id:",
282 "METHODS": ("GET", "POST"),
283 "ROLE_PERMISSION": "vca:",
285 "METHODS": ("GET", "DELETE", "PATCH"),
286 "ROLE_PERMISSION": "vca:id:",
290 "METHODS": ("GET", "POST"),
291 "ROLE_PERMISSION": "k8srepos:",
293 "METHODS": ("GET", "DELETE"),
294 "ROLE_PERMISSION": "k8srepos:id:",
298 "METHODS": ("GET", "POST"),
299 "ROLE_PERMISSION": "osmrepos:",
301 "METHODS": ("GET", "DELETE", "PATCH"),
302 "ROLE_PERMISSION": "osmrepos:id:",
307 "ROLE_PERMISSION": "domains:",
314 "METHODS": ("GET", "POST"),
315 "ROLE_PERMISSION": "pduds:",
317 "METHODS": ("GET", "POST", "DELETE", "PATCH", "PUT"),
318 "ROLE_PERMISSION": "pduds:id:",
325 "ns_descriptors_content": {
326 "METHODS": ("GET", "POST"),
327 "ROLE_PERMISSION": "nsds:",
329 "METHODS": ("GET", "PUT", "DELETE"),
330 "ROLE_PERMISSION": "nsds:id:",
334 "METHODS": ("GET", "POST"),
335 "ROLE_PERMISSION": "nsds:",
337 "METHODS": ("GET", "DELETE", "PATCH"),
338 "ROLE_PERMISSION": "nsds:id:",
340 "METHODS": ("GET", "PUT"),
341 "ROLE_PERMISSION": "nsds:id:content:",
344 "METHODS": ("GET",), # descriptor inside package
345 "ROLE_PERMISSION": "nsds:id:content:",
349 "ROLE_PERMISSION": "nsds:id:nsd_artifact:",
355 "TODO": ("GET", "POST"),
357 "TODO": ("GET", "DELETE", "PATCH"),
358 "pnfd_content": {"TODO": ("GET", "PUT")},
362 "TODO": ("GET", "POST"),
363 "<ID>": {"TODO": ("GET", "DELETE")},
369 "vnf_packages_content": {
370 "METHODS": ("GET", "POST"),
371 "ROLE_PERMISSION": "vnfds:",
373 "METHODS": ("GET", "PUT", "DELETE"),
374 "ROLE_PERMISSION": "vnfds:id:",
378 "METHODS": ("GET", "POST"),
379 "ROLE_PERMISSION": "vnfds:",
381 "METHODS": ("GET", "DELETE", "PATCH"), # GET: vnfPkgInfo
382 "ROLE_PERMISSION": "vnfds:id:",
384 "METHODS": ("GET", "PUT"), # package
385 "ROLE_PERMISSION": "vnfds:id:",
389 "ROLE_PERMISSION": "vnfds:id:upload:",
393 "METHODS": ("GET",), # descriptor inside package
394 "ROLE_PERMISSION": "vnfds:id:content:",
398 "ROLE_PERMISSION": "vnfds:id:vnfd_artifact:",
402 "METHODS": ("POST",),
403 "ROLE_PERMISSION": "vnfds:id:action:",
408 "TODO": ("GET", "POST"),
409 "<ID>": {"TODO": ("GET", "DELETE")},
413 "ROLE_PERMISSION": "vnfds:vnfpkgops:",
414 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnfds:vnfpkgops:id:"},
420 "ns_instances_content": {
421 "METHODS": ("GET", "POST"),
422 "ROLE_PERMISSION": "ns_instances:",
424 "METHODS": ("GET", "DELETE"),
425 "ROLE_PERMISSION": "ns_instances:id:",
429 "METHODS": ("GET", "POST"),
430 "ROLE_PERMISSION": "ns_instances:",
432 "METHODS": ("GET", "DELETE"),
433 "ROLE_PERMISSION": "ns_instances:id:",
435 "METHODS": ("POST",),
436 "ROLE_PERMISSION": "ns_instances:id:scale:",
439 "METHODS": ("POST",),
440 "ROLE_PERMISSION": "ns_instances:id:terminate:",
443 "METHODS": ("POST",),
444 "ROLE_PERMISSION": "ns_instances:id:instantiate:",
447 "METHODS": ("POST",),
448 "ROLE_PERMISSION": "ns_instances:id:action:",
454 "ROLE_PERMISSION": "ns_instances:opps:",
457 "ROLE_PERMISSION": "ns_instances:opps:id:",
462 "ROLE_PERMISSION": "vnf_instances:",
463 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnf_instances:id:"},
467 "ROLE_PERMISSION": "vnf_instances:",
468 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnf_instances:id:"},
471 "METHODS": ("GET", "POST"),
472 "ROLE_PERMISSION": "ns_subscriptions:",
474 "METHODS": ("GET", "DELETE"),
475 "ROLE_PERMISSION": "ns_subscriptions:id:",
482 "netslice_templates_content": {
483 "METHODS": ("GET", "POST"),
484 "ROLE_PERMISSION": "slice_templates:",
486 "METHODS": ("GET", "PUT", "DELETE"),
487 "ROLE_PERMISSION": "slice_templates:id:",
490 "netslice_templates": {
491 "METHODS": ("GET", "POST"),
492 "ROLE_PERMISSION": "slice_templates:",
494 "METHODS": ("GET", "DELETE"),
496 "ROLE_PERMISSION": "slice_templates:id:",
498 "METHODS": ("GET", "PUT"),
499 "ROLE_PERMISSION": "slice_templates:id:content:",
502 "METHODS": ("GET",), # descriptor inside package
503 "ROLE_PERMISSION": "slice_templates:id:content:",
507 "ROLE_PERMISSION": "slice_templates:id:content:",
513 "TODO": ("GET", "POST"),
514 "<ID>": {"TODO": ("GET", "DELETE")},
520 "netslice_instances_content": {
521 "METHODS": ("GET", "POST"),
522 "ROLE_PERMISSION": "slice_instances:",
524 "METHODS": ("GET", "DELETE"),
525 "ROLE_PERMISSION": "slice_instances:id:",
528 "netslice_instances": {
529 "METHODS": ("GET", "POST"),
530 "ROLE_PERMISSION": "slice_instances:",
532 "METHODS": ("GET", "DELETE"),
533 "ROLE_PERMISSION": "slice_instances:id:",
535 "METHODS": ("POST",),
536 "ROLE_PERMISSION": "slice_instances:id:terminate:",
539 "METHODS": ("POST",),
540 "ROLE_PERMISSION": "slice_instances:id:instantiate:",
543 "METHODS": ("POST",),
544 "ROLE_PERMISSION": "slice_instances:id:action:",
550 "ROLE_PERMISSION": "slice_instances:opps:",
553 "ROLE_PERMISSION": "slice_instances:opps:id:",
565 "ROLE_PERMISSION": "reports:id:",
574 "alarms": {"METHODS": ("GET", "PATCH"),
575 "ROLE_PERMISSION": "alarms:",
576 "<ID>": {"METHODS": ("GET", "PATCH"),
577 "ROLE_PERMISSION": "alarms:id:",
585 class NbiException(Exception):
586 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
587 Exception.__init
__(self
, message
)
588 self
.http_code
= http_code
591 class Server(object):
593 # to decode bytes to str
594 reader
= getreader("utf-8")
598 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
599 self
.engine
= Engine(self
.authenticator
)
601 def _format_in(self
, kwargs
):
604 if cherrypy
.request
.body
.length
:
605 error_text
= "Invalid input format "
607 if "Content-Type" in cherrypy
.request
.headers
:
608 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
609 error_text
= "Invalid json format "
610 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
611 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
612 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
613 error_text
= "Invalid yaml format "
615 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
617 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
619 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
620 or "application/gzip"
621 in cherrypy
.request
.headers
["Content-Type"]
622 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
623 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
625 indata
= cherrypy
.request
.body
# .read()
627 "multipart/form-data"
628 in cherrypy
.request
.headers
["Content-Type"]
630 if "descriptor_file" in kwargs
:
631 filecontent
= kwargs
.pop("descriptor_file")
632 if not filecontent
.file:
634 "empty file or content", HTTPStatus
.BAD_REQUEST
636 indata
= filecontent
.file # .read()
637 if filecontent
.content_type
.value
:
638 cherrypy
.request
.headers
[
640 ] = filecontent
.content_type
.value
642 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
643 # "Only 'Content-Type' of type 'application/json' or
644 # 'application/yaml' for input format are available")
645 error_text
= "Invalid yaml format "
647 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
649 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
651 error_text
= "Invalid yaml format "
652 indata
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
653 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
658 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
661 for k
, v
in kwargs
.items():
662 if isinstance(v
, str):
667 kwargs
[k
] = yaml
.load(v
, Loader
=yaml
.SafeLoader
)
673 or k
.endswith(".gte")
674 or k
.endswith(".lte")
683 elif v
.find(",") > 0:
684 kwargs
[k
] = v
.split(",")
685 elif isinstance(v
, (list, tuple)):
686 for index
in range(0, len(v
)):
691 v
[index
] = yaml
.load(v
[index
], Loader
=yaml
.SafeLoader
)
696 except (ValueError, yaml
.YAMLError
) as exc
:
697 raise NbiException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
698 except KeyError as exc
:
700 "Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
702 except Exception as exc
:
703 raise NbiException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
706 def _format_out(data
, token_info
=None, _format
=None):
708 return string of dictionary data according to requested json, yaml, xml. By default json
709 :param data: response to be sent. Can be a dict, text or file
710 :param token_info: Contains among other username and project
711 :param _format: The format to be set as Content-Type if data is a file
714 accept
= cherrypy
.request
.headers
.get("Accept")
716 if accept
and "text/html" in accept
:
718 data
, cherrypy
.request
, cherrypy
.response
, token_info
720 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
722 elif hasattr(data
, "read"): # file object
724 cherrypy
.response
.headers
["Content-Type"] = _format
725 elif "b" in data
.mode
: # binariy asssumig zip
726 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
728 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
729 # TODO check that cherrypy close file. If not implement pending things to close per thread next
732 if "text/html" in accept
:
734 data
, cherrypy
.request
, cherrypy
.response
, token_info
736 elif "application/yaml" in accept
or "*/*" in accept
:
738 elif "application/json" in accept
or (
739 cherrypy
.response
.status
and cherrypy
.response
.status
>= 300
741 cherrypy
.response
.headers
[
743 ] = "application/json; charset=utf-8"
744 a
= json
.dumps(data
, indent
=4) + "\n"
745 return a
.encode("utf8")
746 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
747 return yaml
.safe_dump(
751 default_flow_style
=False,
755 ) # , canonical=True, default_style='"'
758 def index(self
, *args
, **kwargs
):
761 if cherrypy
.request
.method
== "GET":
762 token_info
= self
.authenticator
.authorize()
763 outdata
= token_info
# Home page
765 raise cherrypy
.HTTPError(
766 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
767 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
770 return self
._format
_out
(outdata
, token_info
)
772 except (EngineException
, AuthException
) as e
:
773 # cherrypy.log("index Exception {}".format(e))
774 cherrypy
.response
.status
= e
.http_code
.value
775 return self
._format
_out
("Welcome to OSM!", token_info
)
778 def version(self
, *args
, **kwargs
):
779 # TODO consider to remove and provide version using the static version file
781 if cherrypy
.request
.method
!= "GET":
783 "Only method GET is allowed", HTTPStatus
.METHOD_NOT_ALLOWED
787 "Invalid URL or query string for version",
788 HTTPStatus
.METHOD_NOT_ALLOWED
,
790 # TODO include version of other modules, pick up from some kafka admin message
791 osm_nbi_version
= {"version": nbi_version
, "date": nbi_version_date
}
792 return self
._format
_out
(osm_nbi_version
)
793 except NbiException
as e
:
794 cherrypy
.response
.status
= e
.http_code
.value
796 "code": e
.http_code
.name
,
797 "status": e
.http_code
.value
,
800 return self
._format
_out
(problem_details
, None)
805 "user_domain_name": cherrypy
.tree
.apps
["/osm"]
806 .config
["authentication"]
807 .get("user_domain_name"),
808 "project_domain_name": cherrypy
.tree
.apps
["/osm"]
809 .config
["authentication"]
810 .get("project_domain_name"),
812 return self
._format
_out
(domains
)
813 except NbiException
as e
:
814 cherrypy
.response
.status
= e
.http_code
.value
816 "code": e
.http_code
.name
,
817 "status": e
.http_code
.value
,
820 return self
._format
_out
(problem_details
, None)
823 def _format_login(token_info
):
825 Changes cherrypy.request.login to include username/project_name;session so that cherrypy access log will
827 :param token_info: Dictionary with token content
830 cherrypy
.request
.login
= token_info
.get("username", "-")
831 if token_info
.get("project_name"):
832 cherrypy
.request
.login
+= "/" + token_info
["project_name"]
833 if token_info
.get("id"):
834 cherrypy
.request
.login
+= ";session=" + token_info
["id"][0:12]
836 # NS Fault Management
838 def nsfm(self
, version
=None, topic
=None, uuid
=None, project_name
=None, ns_id
=None, *args
, **kwargs
):
839 if topic
== 'alarms':
841 method
= cherrypy
.request
.method
842 role_permission
= self
._check
_valid
_url
_method
(method
, "nsfm", version
, topic
, None, None, *args
)
843 query_string_operations
= self
._extract
_query
_string
_operations
(kwargs
, method
)
845 self
.authenticator
.authorize(role_permission
, query_string_operations
, None)
847 # to handle get request
848 if cherrypy
.request
.method
== 'GET':
849 # if request is on basis of uuid
850 if uuid
and uuid
!= 'None':
852 alarm
= self
.engine
.db
.get_one("alarms", {"uuid": uuid
})
853 alarm_action
= self
.engine
.db
.get_one("alarms_action", {"uuid": uuid
})
854 alarm
.update(alarm_action
)
855 vnf
= self
.engine
.db
.get_one("vnfrs", {"nsr-id-ref": alarm
["tags"]["ns_id"]})
856 alarm
["vnf-id"] = vnf
["_id"]
857 return self
._format
_out
(str(alarm
))
859 return self
._format
_out
("Please provide valid alarm uuid")
860 elif ns_id
and ns_id
!= 'None':
861 # if request is on basis of ns_id
863 alarms
= self
.engine
.db
.get_list("alarms", {"tags.ns_id": ns_id
})
865 alarm_action
= self
.engine
.db
.get_one("alarms_action", {"uuid": alarm
['uuid']})
866 alarm
.update(alarm_action
)
867 return self
._format
_out
(str(alarms
))
869 return self
._format
_out
("Please provide valid ns id")
871 # to return only alarm which are related to given project
872 project
= self
.engine
.db
.get_one("projects", {"name": project_name
})
873 project_id
= project
.get('_id')
874 ns_list
= self
.engine
.db
.get_list("nsrs", {"_admin.projects_read": project_id
})
877 ns_ids
.append(ns
.get("_id"))
878 alarms
= self
.engine
.db
.get_list("alarms")
879 alarm_list
= [alarm
for alarm
in alarms
if alarm
["tags"]["ns_id"] in ns_ids
]
880 for alrm
in alarm_list
:
881 action
= self
.engine
.db
.get_one("alarms_action", {"uuid": alrm
.get("uuid")})
883 return self
._format
_out
(str(alarm_list
))
884 # to handle patch request for alarm update
885 elif cherrypy
.request
.method
== 'PATCH':
886 data
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
888 # check if uuid is valid
889 self
.engine
.db
.get_one("alarms", {"uuid": data
.get("uuid")})
891 return self
._format
_out
("Please provide valid alarm uuid.")
892 if data
.get("is_enable") is not None:
893 if data
.get("is_enable"):
896 alarm_status
= 'disabled'
897 self
.engine
.db
.set_one("alarms", {"uuid": data
.get("uuid")},
898 {"alarm_status": alarm_status
})
900 self
.engine
.db
.set_one("alarms", {"uuid": data
.get("uuid")},
901 {"threshold": data
.get("threshold")})
902 return self
._format
_out
("Alarm updated")
903 except Exception as e
:
904 cherrypy
.response
.status
= e
.http_code
.value
905 if isinstance(e
, (NbiException
, EngineException
, DbException
, FsException
, MsgException
, AuthException
,
906 ValidationError
, AuthconnException
)):
907 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
908 http_code_name
= e
.http_code
.name
909 cherrypy
.log("Exception {}".format(e
))
911 http_code_value
= cherrypy
.response
.status
= HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
912 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
913 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
915 "code": http_code_name
,
916 "status": http_code_value
,
919 return self
._format
_out
(problem_details
)
922 def token(self
, method
, token_id
=None, kwargs
=None):
924 # self.engine.load_dbase(cherrypy.request.app.config)
925 indata
= self
._format
_in
(kwargs
)
926 if not isinstance(indata
, dict):
928 "Expected application/yaml or application/json Content-Type",
929 HTTPStatus
.BAD_REQUEST
,
933 token_info
= self
.authenticator
.authorize()
935 self
._format
_login
(token_info
)
937 outdata
= self
.authenticator
.get_token(token_info
, token_id
)
939 outdata
= self
.authenticator
.get_token_list(token_info
)
940 elif method
== "POST":
942 token_info
= self
.authenticator
.authorize()
946 indata
.update(kwargs
)
947 # This is needed to log the user when authentication fails
948 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
949 outdata
= token_info
= self
.authenticator
.new_token(
950 token_info
, indata
, cherrypy
.request
.remote
952 cherrypy
.session
["Authorization"] = outdata
["_id"]
953 self
._set
_location
_header
("admin", "v1", "tokens", outdata
["_id"])
955 self
._format
_login
(token_info
)
957 # cherrypy.response.cookie["Authorization"] = outdata["id"]
958 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
959 elif method
== "DELETE":
960 if not token_id
and "id" in kwargs
:
961 token_id
= kwargs
["id"]
963 token_info
= self
.authenticator
.authorize()
965 self
._format
_login
(token_info
)
966 token_id
= token_info
["_id"]
967 outdata
= self
.authenticator
.del_token(token_id
)
969 cherrypy
.session
["Authorization"] = "logout"
970 # cherrypy.response.cookie["Authorization"] = token_id
971 # cherrypy.response.cookie["Authorization"]['expires'] = 0
974 "Method {} not allowed for token".format(method
),
975 HTTPStatus
.METHOD_NOT_ALLOWED
,
977 return self
._format
_out
(outdata
, token_info
)
980 def test(self
, *args
, **kwargs
):
981 if not cherrypy
.config
.get("server.enable_test") or (
982 isinstance(cherrypy
.config
["server.enable_test"], str)
983 and cherrypy
.config
["server.enable_test"].lower() == "false"
985 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
986 return "test URL is disabled"
988 if args
and args
[0] == "help":
990 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
991 "sleep/<time>\nmessage/topic\n</pre></html>"
994 elif args
and args
[0] == "init":
996 # self.engine.load_dbase(cherrypy.request.app.config)
997 self
.engine
.create_admin()
998 return "Done. User 'admin', password 'admin' created"
1000 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
1001 return self
._format
_out
("Database already initialized")
1002 elif args
and args
[0] == "file":
1003 return cherrypy
.lib
.static
.serve_file(
1004 cherrypy
.tree
.apps
["/osm"].config
["storage"]["path"] + "/" + args
[1],
1008 elif args
and args
[0] == "file2":
1010 cherrypy
.tree
.apps
["/osm"].config
["storage"]["path"] + "/" + args
[1]
1012 f
= open(f_path
, "r")
1013 cherrypy
.response
.headers
["Content-type"] = "text/plain"
1016 elif len(args
) == 2 and args
[0] == "db-clear":
1017 deleted_info
= self
.engine
.db
.del_list(args
[1], kwargs
)
1018 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
1019 elif len(args
) and args
[0] == "fs-clear":
1021 folders
= (args
[1],)
1023 folders
= self
.engine
.fs
.dir_ls(".")
1024 for folder
in folders
:
1025 self
.engine
.fs
.file_delete(folder
)
1026 return ",".join(folders
) + " folders deleted\n"
1027 elif args
and args
[0] == "login":
1028 if not cherrypy
.request
.headers
.get("Authorization"):
1029 cherrypy
.response
.headers
[
1031 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
1032 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
1033 elif args
and args
[0] == "login2":
1034 if not cherrypy
.request
.headers
.get("Authorization"):
1035 cherrypy
.response
.headers
[
1037 ] = 'Bearer realm="Access to OSM site"'
1038 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
1039 elif args
and args
[0] == "sleep":
1042 sleep_time
= int(args
[1])
1044 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
1045 return self
._format
_out
("Database already initialized")
1046 thread_info
= cherrypy
.thread_data
1048 time
.sleep(sleep_time
)
1050 elif len(args
) >= 2 and args
[0] == "message":
1051 main_topic
= args
[1]
1052 return_text
= "<html><pre>{} ->\n".format(main_topic
)
1054 if cherrypy
.request
.method
== "POST":
1055 to_send
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
1056 for k
, v
in to_send
.items():
1057 self
.engine
.msg
.write(main_topic
, k
, v
)
1058 return_text
+= " {}: {}\n".format(k
, v
)
1059 elif cherrypy
.request
.method
== "GET":
1060 for k
, v
in kwargs
.items():
1061 v_dict
= yaml
.load(v
, Loader
=yaml
.SafeLoader
)
1062 self
.engine
.msg
.write(main_topic
, k
, v_dict
)
1063 return_text
+= " {}: {}\n".format(k
, v_dict
)
1064 except Exception as e
:
1065 return_text
+= "Error: " + str(e
)
1066 return_text
+= "</pre></html>\n"
1070 "<html><pre>\nheaders:\n args: {}\n".format(args
)
1071 + " kwargs: {}\n".format(kwargs
)
1072 + " headers: {}\n".format(cherrypy
.request
.headers
)
1073 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
1074 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
1075 + " session: {}\n".format(cherrypy
.session
)
1076 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
1077 + " method: {}\n".format(cherrypy
.request
.method
)
1078 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
1081 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
1082 if cherrypy
.request
.body
.length
:
1083 return_text
+= " content: {}\n".format(
1085 cherrypy
.request
.body
.read(
1086 int(cherrypy
.request
.headers
.get("Content-Length", 0))
1091 return_text
+= "thread: {}\n".format(thread_info
)
1092 return_text
+= "</pre></html>"
1096 def _check_valid_url_method(method
, *args
):
1099 "URL must contain at least 'main_topic/version/topic'",
1100 HTTPStatus
.METHOD_NOT_ALLOWED
,
1103 reference
= valid_url_methods
1107 if not isinstance(reference
, dict):
1109 "URL contains unexpected extra items '{}'".format(arg
),
1110 HTTPStatus
.METHOD_NOT_ALLOWED
,
1113 if arg
in reference
:
1114 reference
= reference
[arg
]
1115 elif "<ID>" in reference
:
1116 reference
= reference
["<ID>"]
1117 elif "*" in reference
:
1118 # if there is content
1120 reference
= reference
["*"]
1124 "Unexpected URL item {}".format(arg
), HTTPStatus
.METHOD_NOT_ALLOWED
1126 if "TODO" in reference
and method
in reference
["TODO"]:
1128 "Method {} not supported yet for this URL".format(method
),
1129 HTTPStatus
.NOT_IMPLEMENTED
,
1131 elif "METHODS" in reference
and method
not in reference
["METHODS"]:
1133 "Method {} not supported for this URL".format(method
),
1134 HTTPStatus
.METHOD_NOT_ALLOWED
,
1136 return reference
["ROLE_PERMISSION"] + method
.lower()
1139 def _set_location_header(main_topic
, version
, topic
, id):
1141 Insert response header Location with the URL of created item base on URL params
1148 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
1149 cherrypy
.response
.headers
["Location"] = "/osm/{}/{}/{}/{}".format(
1150 main_topic
, version
, topic
, id
1155 def _extract_query_string_operations(kwargs
, method
):
1161 query_string_operations
= []
1163 for qs
in ("FORCE", "PUBLIC", "ADMIN", "SET_PROJECT"):
1164 if qs
in kwargs
and kwargs
[qs
].lower() != "false":
1165 query_string_operations
.append(qs
.lower() + ":" + method
.lower())
1166 return query_string_operations
1169 def _manage_admin_query(token_info
, kwargs
, method
, _id
):
1171 Processes the administrator query inputs (if any) of FORCE, ADMIN, PUBLIC, SET_PROJECT
1172 Check that users has rights to use them and returs the admin_query
1173 :param token_info: token_info rights obtained by token
1174 :param kwargs: query string input.
1175 :param method: http method: GET, POSST, PUT, ...
1177 :return: admin_query dictionary with keys:
1178 public: True, False or None
1179 force: True or False
1180 project_id: tuple with projects used for accessing an element
1181 set_project: tuple with projects that a created element will belong to
1182 method: show, list, delete, write
1186 "project_id": (token_info
["project_id"],),
1187 "username": token_info
["username"],
1188 "admin": token_info
["admin"],
1190 "allow_show_user_project_role": token_info
["allow_show_user_project_role"],
1194 if "FORCE" in kwargs
:
1196 kwargs
["FORCE"].lower() != "false"
1197 ): # if None or True set force to True
1198 admin_query
["force"] = True
1201 if "PUBLIC" in kwargs
:
1203 kwargs
["PUBLIC"].lower() != "false"
1204 ): # if None or True set public to True
1205 admin_query
["public"] = True
1207 admin_query
["public"] = False
1208 del kwargs
["PUBLIC"]
1210 if "ADMIN" in kwargs
:
1211 behave_as
= kwargs
.pop("ADMIN")
1212 if behave_as
.lower() != "false":
1213 if not token_info
["admin"]:
1215 "Only admin projects can use 'ADMIN' query string",
1216 HTTPStatus
.UNAUTHORIZED
,
1219 not behave_as
or behave_as
.lower() == "true"
1220 ): # convert True, None to empty list
1221 admin_query
["project_id"] = ()
1222 elif isinstance(behave_as
, (list, tuple)):
1223 admin_query
["project_id"] = behave_as
1224 else: # isinstance(behave_as, str)
1225 admin_query
["project_id"] = (behave_as
,)
1226 if "SET_PROJECT" in kwargs
:
1227 set_project
= kwargs
.pop("SET_PROJECT")
1229 admin_query
["set_project"] = list(admin_query
["project_id"])
1231 if isinstance(set_project
, str):
1232 set_project
= (set_project
,)
1233 if admin_query
["project_id"]:
1234 for p
in set_project
:
1235 if p
not in admin_query
["project_id"]:
1237 "Unauthorized for 'SET_PROJECT={p}'. Try with 'ADMIN=True' or "
1238 "'ADMIN='{p}'".format(p
=p
),
1239 HTTPStatus
.UNAUTHORIZED
,
1241 admin_query
["set_project"] = set_project
1244 # if "PROJECT_READ" in kwargs:
1245 # admin_query["project"] = kwargs.pop("project")
1246 # if admin_query["project"] == token_info["project_id"]:
1249 admin_query
["method"] = "show"
1251 admin_query
["method"] = "list"
1252 elif method
== "DELETE":
1253 admin_query
["method"] = "delete"
1255 admin_query
["method"] = "write"
1275 engine_session
= None
1277 if not main_topic
or not version
or not topic
:
1279 "URL must contain at least 'main_topic/version/topic'",
1280 HTTPStatus
.METHOD_NOT_ALLOWED
,
1282 if main_topic
not in (
1293 "URL main_topic '{}' not supported".format(main_topic
),
1294 HTTPStatus
.METHOD_NOT_ALLOWED
,
1298 "URL version '{}' not supported".format(version
),
1299 HTTPStatus
.METHOD_NOT_ALLOWED
,
1304 and "METHOD" in kwargs
1305 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
1307 method
= kwargs
.pop("METHOD")
1309 method
= cherrypy
.request
.method
1311 role_permission
= self
._check
_valid
_url
_method
(
1312 method
, main_topic
, version
, topic
, _id
, item
, *args
1314 query_string_operations
= self
._extract
_query
_string
_operations
(
1317 if main_topic
== "admin" and topic
== "tokens":
1318 return self
.token(method
, _id
, kwargs
)
1319 token_info
= self
.authenticator
.authorize(
1320 role_permission
, query_string_operations
, _id
1322 if main_topic
== "admin" and topic
== "domains":
1323 return self
.domain()
1324 engine_session
= self
._manage
_admin
_query
(token_info
, kwargs
, method
, _id
)
1325 indata
= self
._format
_in
(kwargs
)
1326 engine_topic
= topic
1328 if item
and topic
!= "pm_jobs":
1331 if main_topic
== "nsd":
1332 engine_topic
= "nsds"
1333 elif main_topic
== "vnfpkgm":
1334 engine_topic
= "vnfds"
1335 if topic
== "vnfpkg_op_occs":
1336 engine_topic
= "vnfpkgops"
1337 if topic
== "vnf_packages" and item
== "action":
1338 engine_topic
= "vnfpkgops"
1339 elif main_topic
== "nslcm":
1340 engine_topic
= "nsrs"
1341 if topic
== "ns_lcm_op_occs":
1342 engine_topic
= "nslcmops"
1343 if topic
== "vnfrs" or topic
== "vnf_instances":
1344 engine_topic
= "vnfrs"
1345 elif main_topic
== "nst":
1346 engine_topic
= "nsts"
1347 elif main_topic
== "nsilcm":
1348 engine_topic
= "nsis"
1349 if topic
== "nsi_lcm_op_occs":
1350 engine_topic
= "nsilcmops"
1351 elif main_topic
== "pdu":
1352 engine_topic
= "pdus"
1354 engine_topic
== "vims"
1355 ): # TODO this is for backward compatibility, it will be removed in the future
1356 engine_topic
= "vim_accounts"
1358 if topic
== "subscriptions":
1359 engine_topic
= main_topic
+ "_" + topic
1371 if item
in ("vnfd", "nsd", "nst"):
1372 path
= "$DESCRIPTOR"
1375 elif item
== "artifacts":
1379 file, _format
= self
.engine
.get_file(
1384 cherrypy
.request
.headers
.get("Accept"),
1388 outdata
= self
.engine
.get_item_list(
1389 engine_session
, engine_topic
, kwargs
, api_req
=True
1392 if item
== "reports":
1393 # TODO check that project_id (_id in this context) has permissions
1396 if "vcaStatusRefresh" in kwargs
:
1397 filter_q
= {"vcaStatusRefresh": kwargs
["vcaStatusRefresh"]}
1398 outdata
= self
.engine
.get_item(engine_session
, engine_topic
, _id
, filter_q
, True)
1400 elif method
== "POST":
1401 cherrypy
.response
.status
= HTTPStatus
.CREATED
.value
1403 "ns_descriptors_content",
1404 "vnf_packages_content",
1405 "netslice_templates_content",
1407 _id
= cherrypy
.request
.headers
.get("Transaction-Id")
1409 _id
, _
= self
.engine
.new_item(
1415 cherrypy
.request
.headers
,
1417 completed
= self
.engine
.upload_content(
1423 cherrypy
.request
.headers
,
1426 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1428 cherrypy
.response
.headers
["Transaction-Id"] = _id
1429 outdata
= {"id": _id
}
1430 elif topic
== "ns_instances_content":
1432 _id
, _
= self
.engine
.new_item(
1433 rollback
, engine_session
, engine_topic
, indata
, kwargs
1436 indata
["lcmOperationType"] = "instantiate"
1437 indata
["nsInstanceId"] = _id
1438 nslcmop_id
, _
= self
.engine
.new_item(
1439 rollback
, engine_session
, "nslcmops", indata
, None
1441 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1442 outdata
= {"id": _id
, "nslcmop_id": nslcmop_id
}
1443 elif topic
== "ns_instances" and item
:
1444 indata
["lcmOperationType"] = item
1445 indata
["nsInstanceId"] = _id
1446 _id
, _
= self
.engine
.new_item(
1447 rollback
, engine_session
, "nslcmops", indata
, kwargs
1449 self
._set
_location
_header
(
1450 main_topic
, version
, "ns_lcm_op_occs", _id
1452 outdata
= {"id": _id
}
1453 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1454 elif topic
== "netslice_instances_content":
1455 # creates NetSlice_Instance_record (NSIR)
1456 _id
, _
= self
.engine
.new_item(
1457 rollback
, engine_session
, engine_topic
, indata
, kwargs
1459 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1460 indata
["lcmOperationType"] = "instantiate"
1461 indata
["netsliceInstanceId"] = _id
1462 nsilcmop_id
, _
= self
.engine
.new_item(
1463 rollback
, engine_session
, "nsilcmops", indata
, kwargs
1465 outdata
= {"id": _id
, "nsilcmop_id": nsilcmop_id
}
1466 elif topic
== "netslice_instances" and item
:
1467 indata
["lcmOperationType"] = item
1468 indata
["netsliceInstanceId"] = _id
1469 _id
, _
= self
.engine
.new_item(
1470 rollback
, engine_session
, "nsilcmops", indata
, kwargs
1472 self
._set
_location
_header
(
1473 main_topic
, version
, "nsi_lcm_op_occs", _id
1475 outdata
= {"id": _id
}
1476 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1477 elif topic
== "vnf_packages" and item
== "action":
1478 indata
["lcmOperationType"] = item
1479 indata
["vnfPkgId"] = _id
1480 _id
, _
= self
.engine
.new_item(
1481 rollback
, engine_session
, "vnfpkgops", indata
, kwargs
1483 self
._set
_location
_header
(
1484 main_topic
, version
, "vnfpkg_op_occs", _id
1486 outdata
= {"id": _id
}
1487 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1488 elif topic
== "subscriptions":
1489 _id
, _
= self
.engine
.new_item(
1490 rollback
, engine_session
, engine_topic
, indata
, kwargs
1492 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1494 link
["self"] = cherrypy
.response
.headers
["Location"]
1497 "filter": indata
["filter"],
1498 "callbackUri": indata
["CallbackUri"],
1501 cherrypy
.response
.status
= HTTPStatus
.CREATED
.value
1503 _id
, op_id
= self
.engine
.new_item(
1509 cherrypy
.request
.headers
,
1511 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1512 outdata
= {"id": _id
}
1514 outdata
["op_id"] = op_id
1515 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1516 # TODO form NsdInfo when topic in ("ns_descriptors", "vnf_packages")
1518 elif method
== "DELETE":
1520 outdata
= self
.engine
.del_item_list(
1521 engine_session
, engine_topic
, kwargs
1523 cherrypy
.response
.status
= HTTPStatus
.OK
.value
1524 else: # len(args) > 1
1525 # for NS NSI generate an operation
1527 if topic
== "ns_instances_content" and not engine_session
["force"]:
1529 "lcmOperationType": "terminate",
1530 "nsInstanceId": _id
,
1533 op_id
, _
= self
.engine
.new_item(
1534 rollback
, engine_session
, "nslcmops", nslcmop_desc
, kwargs
1537 outdata
= {"_id": op_id
}
1539 topic
== "netslice_instances_content"
1540 and not engine_session
["force"]
1543 "lcmOperationType": "terminate",
1544 "netsliceInstanceId": _id
,
1547 op_id
, _
= self
.engine
.new_item(
1548 rollback
, engine_session
, "nsilcmops", nsilcmop_desc
, None
1551 outdata
= {"_id": op_id
}
1552 # if there is not any deletion in process, delete
1554 op_id
= self
.engine
.del_item(engine_session
, engine_topic
, _id
)
1556 outdata
= {"op_id": op_id
}
1557 cherrypy
.response
.status
= (
1558 HTTPStatus
.ACCEPTED
.value
1560 else HTTPStatus
.NO_CONTENT
.value
1563 elif method
in ("PUT", "PATCH"):
1565 if not indata
and not kwargs
and not engine_session
.get("set_project"):
1567 "Nothing to update. Provide payload and/or query string",
1568 HTTPStatus
.BAD_REQUEST
,
1571 item
in ("nsd_content", "package_content", "nst_content")
1574 completed
= self
.engine
.upload_content(
1580 cherrypy
.request
.headers
,
1583 cherrypy
.response
.headers
["Transaction-Id"] = id
1585 op_id
= self
.engine
.edit_item(
1586 engine_session
, engine_topic
, _id
, indata
, kwargs
1590 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1591 outdata
= {"op_id": op_id
}
1593 cherrypy
.response
.status
= HTTPStatus
.NO_CONTENT
.value
1597 "Method {} not allowed".format(method
),
1598 HTTPStatus
.METHOD_NOT_ALLOWED
,
1601 # if Role information changes, it is needed to reload the information of roles
1602 if topic
== "roles" and method
!= "GET":
1603 self
.authenticator
.load_operation_to_allowed_roles()
1607 and method
== "DELETE"
1608 or topic
in ["users", "roles"]
1609 and method
in ["PUT", "PATCH", "DELETE"]
1611 self
.authenticator
.remove_token_from_cache()
1613 return self
._format
_out
(outdata
, token_info
, _format
)
1614 except Exception as e
:
1628 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
1629 http_code_name
= e
.http_code
.name
1630 cherrypy
.log("Exception {}".format(e
))
1633 cherrypy
.response
.status
1634 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
1635 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
1636 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
1637 if hasattr(outdata
, "close"): # is an open file
1641 for rollback_item
in rollback
:
1643 if rollback_item
.get("operation") == "set":
1644 self
.engine
.db
.set_one(
1645 rollback_item
["topic"],
1646 {"_id": rollback_item
["_id"]},
1647 rollback_item
["content"],
1648 fail_on_empty
=False,
1650 elif rollback_item
.get("operation") == "del_list":
1651 self
.engine
.db
.del_list(
1652 rollback_item
["topic"],
1653 rollback_item
["filter"],
1654 fail_on_empty
=False,
1657 self
.engine
.db
.del_one(
1658 rollback_item
["topic"],
1659 {"_id": rollback_item
["_id"]},
1660 fail_on_empty
=False,
1662 except Exception as e2
:
1663 rollback_error_text
= "Rollback Exception {}: {}".format(
1666 cherrypy
.log(rollback_error_text
)
1667 error_text
+= ". " + rollback_error_text
1668 # if isinstance(e, MsgException):
1669 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
1670 # engine_topic[:-1], method, error_text)
1672 "code": http_code_name
,
1673 "status": http_code_value
,
1674 "detail": error_text
,
1676 return self
._format
_out
(problem_details
, token_info
)
1677 # raise cherrypy.HTTPError(e.http_code.value, str(e))
1680 self
._format
_login
(token_info
)
1681 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
1682 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
1683 if outdata
.get(logging_id
):
1684 cherrypy
.request
.login
+= ";{}={}".format(
1685 logging_id
, outdata
[logging_id
][:36]
1689 def _start_service():
1691 Callback function called when cherrypy.engine starts
1692 Override configuration with env variables
1693 Set database, storage, message configuration
1694 Init database with admin/admin user password
1697 global subscription_thread
1698 cherrypy
.log
.error("Starting osm_nbi")
1699 # update general cherrypy configuration
1702 engine_config
= cherrypy
.tree
.apps
["/osm"].config
1703 for k
, v
in environ
.items():
1704 if not k
.startswith("OSMNBI_"):
1706 k1
, _
, k2
= k
[7:].lower().partition("_")
1710 # update static configuration
1711 if k
== "OSMNBI_STATIC_DIR":
1712 engine_config
["/static"]["tools.staticdir.dir"] = v
1713 engine_config
["/static"]["tools.staticdir.on"] = True
1714 elif k
== "OSMNBI_SOCKET_PORT" or k
== "OSMNBI_SERVER_PORT":
1715 update_dict
["server.socket_port"] = int(v
)
1716 elif k
== "OSMNBI_SOCKET_HOST" or k
== "OSMNBI_SERVER_HOST":
1717 update_dict
["server.socket_host"] = v
1718 elif k1
in ("server", "test", "auth", "log"):
1719 update_dict
[k1
+ "." + k2
] = v
1720 elif k1
in ("message", "database", "storage", "authentication"):
1721 # k2 = k2.replace('_', '.')
1722 if k2
in ("port", "db_port"):
1723 engine_config
[k1
][k2
] = int(v
)
1725 engine_config
[k1
][k2
] = v
1727 except ValueError as e
:
1728 cherrypy
.log
.error("Ignoring environ '{}': " + str(e
))
1729 except Exception as e
:
1730 cherrypy
.log
.warn("skipping environ '{}' on exception '{}'".format(k
, e
))
1733 cherrypy
.config
.update(update_dict
)
1734 engine_config
["global"].update(update_dict
)
1737 log_format_simple
= (
1738 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
1740 log_formatter_simple
= logging
.Formatter(
1741 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
1743 logger_server
= logging
.getLogger("cherrypy.error")
1744 logger_access
= logging
.getLogger("cherrypy.access")
1745 logger_cherry
= logging
.getLogger("cherrypy")
1746 logger_nbi
= logging
.getLogger("nbi")
1748 if "log.file" in engine_config
["global"]:
1749 file_handler
= logging
.handlers
.RotatingFileHandler(
1750 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
1752 file_handler
.setFormatter(log_formatter_simple
)
1753 logger_cherry
.addHandler(file_handler
)
1754 logger_nbi
.addHandler(file_handler
)
1755 # log always to standard output
1756 for format_
, logger
in {
1757 "nbi.server %(filename)s:%(lineno)s": logger_server
,
1758 "nbi.access %(filename)s:%(lineno)s": logger_access
,
1759 "%(name)s %(filename)s:%(lineno)s": logger_nbi
,
1761 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
1762 log_formatter_cherry
= logging
.Formatter(
1763 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
1765 str_handler
= logging
.StreamHandler()
1766 str_handler
.setFormatter(log_formatter_cherry
)
1767 logger
.addHandler(str_handler
)
1769 if engine_config
["global"].get("log.level"):
1770 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
1771 logger_nbi
.setLevel(engine_config
["global"]["log.level"])
1773 # logging other modules
1774 for k1
, logname
in {
1775 "message": "nbi.msg",
1776 "database": "nbi.db",
1777 "storage": "nbi.fs",
1779 engine_config
[k1
]["logger_name"] = logname
1780 logger_module
= logging
.getLogger(logname
)
1781 if "logfile" in engine_config
[k1
]:
1782 file_handler
= logging
.handlers
.RotatingFileHandler(
1783 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
1785 file_handler
.setFormatter(log_formatter_simple
)
1786 logger_module
.addHandler(file_handler
)
1787 if "loglevel" in engine_config
[k1
]:
1788 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
1789 # TODO add more entries, e.g.: storage
1790 cherrypy
.tree
.apps
["/osm"].root
.engine
.start(engine_config
)
1791 cherrypy
.tree
.apps
["/osm"].root
.authenticator
.start(engine_config
)
1792 cherrypy
.tree
.apps
["/osm"].root
.engine
.init_db(target_version
=database_version
)
1793 cherrypy
.tree
.apps
["/osm"].root
.authenticator
.init_db(
1794 target_version
=auth_database_version
1797 # start subscriptions thread:
1798 subscription_thread
= SubscriptionThread(
1799 config
=engine_config
, engine
=nbi_server
.engine
1801 subscription_thread
.start()
1802 # Do not capture except SubscriptionException
1804 backend
= engine_config
["authentication"]["backend"]
1806 "Starting OSM NBI Version '{} {}' with '{}' authentication backend".format(
1807 nbi_version
, nbi_version_date
, backend
1812 def _stop_service():
1814 Callback function called when cherrypy.engine stops
1815 TODO: Ending database connections.
1817 global subscription_thread
1818 if subscription_thread
:
1819 subscription_thread
.terminate()
1820 subscription_thread
= None
1821 cherrypy
.tree
.apps
["/osm"].root
.engine
.stop()
1822 cherrypy
.log
.error("Stopping osm_nbi")
1825 def nbi(config_file
):
1829 # #'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
1830 # 'tools.sessions.on': True,
1831 # 'tools.response_headers.on': True,
1832 # # 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
1835 # cherrypy.Server.ssl_module = 'builtin'
1836 # cherrypy.Server.ssl_certificate = "http/cert.pem"
1837 # cherrypy.Server.ssl_private_key = "http/privkey.pem"
1838 # cherrypy.Server.thread_pool = 10
1839 # cherrypy.config.update({'Server.socket_port': config["port"], 'Server.socket_host': config["host"]})
1841 # cherrypy.config.update({'tools.auth_basic.on': True,
1842 # 'tools.auth_basic.realm': 'localhost',
1843 # 'tools.auth_basic.checkpassword': validate_password})
1844 nbi_server
= Server()
1845 cherrypy
.engine
.subscribe("start", _start_service
)
1846 cherrypy
.engine
.subscribe("stop", _stop_service
)
1847 cherrypy
.quickstart(nbi_server
, "/osm", config_file
)
1852 """Usage: {} [options]
1853 -c|--config [configuration_file]: loads the configuration file (default: ./nbi.cfg)
1854 -h|--help: shows this help
1859 # --log-socket-host HOST: send logs to this host")
1860 # --log-socket-port PORT: send logs using this port (default: 9022)")
1863 if __name__
== "__main__":
1865 # load parameters and configuration
1866 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
1867 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
1870 if o
in ("-h", "--help"):
1873 elif o
in ("-c", "--config"):
1875 # elif o == "--log-socket-port":
1876 # log_socket_port = a
1877 # elif o == "--log-socket-host":
1878 # log_socket_host = a
1879 # elif o == "--log-file":
1882 assert False, "Unhandled option"
1884 if not path
.isfile(config_file
):
1886 "configuration file '{}' that not exist".format(config_file
),
1891 for config_file
in (
1892 __file__
[: __file__
.rfind(".")] + ".cfg",
1896 if path
.isfile(config_file
):
1900 "No configuration file 'nbi.cfg' found neither at local folder nor at /etc/osm/",
1905 except getopt
.GetoptError
as e
:
1906 print(str(e
), file=sys
.stderr
)