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 "vnf_instances": {"METHODS": ("GET", "POST"),
483 "ROLE_PERMISSION": "vnflcm_instances:",
484 "<ID>": {"METHODS": ("GET", "DELETE"),
485 "ROLE_PERMISSION": "vnflcm_instances:id:",
486 "scale": {"METHODS": ("POST",),
487 "ROLE_PERMISSION": "vnflcm_instances:id:scale:"
489 "terminate": {"METHODS": ("POST",),
490 "ROLE_PERMISSION": "vnflcm_instances:id:terminate:"
492 "instantiate": {"METHODS": ("POST",),
493 "ROLE_PERMISSION": "vnflcm_instances:id:instantiate:"
497 "vnf_lcm_op_occs": {"METHODS": ("GET",),
498 "ROLE_PERMISSION": "vnf_instances:opps:",
499 "<ID>": {"METHODS": ("GET",),
500 "ROLE_PERMISSION": "vnf_instances:opps:id:"
507 "netslice_templates_content": {
508 "METHODS": ("GET", "POST"),
509 "ROLE_PERMISSION": "slice_templates:",
511 "METHODS": ("GET", "PUT", "DELETE"),
512 "ROLE_PERMISSION": "slice_templates:id:",
515 "netslice_templates": {
516 "METHODS": ("GET", "POST"),
517 "ROLE_PERMISSION": "slice_templates:",
519 "METHODS": ("GET", "DELETE"),
521 "ROLE_PERMISSION": "slice_templates:id:",
523 "METHODS": ("GET", "PUT"),
524 "ROLE_PERMISSION": "slice_templates:id:content:",
527 "METHODS": ("GET",), # descriptor inside package
528 "ROLE_PERMISSION": "slice_templates:id:content:",
532 "ROLE_PERMISSION": "slice_templates:id:content:",
538 "TODO": ("GET", "POST"),
539 "<ID>": {"TODO": ("GET", "DELETE")},
545 "netslice_instances_content": {
546 "METHODS": ("GET", "POST"),
547 "ROLE_PERMISSION": "slice_instances:",
549 "METHODS": ("GET", "DELETE"),
550 "ROLE_PERMISSION": "slice_instances:id:",
553 "netslice_instances": {
554 "METHODS": ("GET", "POST"),
555 "ROLE_PERMISSION": "slice_instances:",
557 "METHODS": ("GET", "DELETE"),
558 "ROLE_PERMISSION": "slice_instances:id:",
560 "METHODS": ("POST",),
561 "ROLE_PERMISSION": "slice_instances:id:terminate:",
564 "METHODS": ("POST",),
565 "ROLE_PERMISSION": "slice_instances:id:instantiate:",
568 "METHODS": ("POST",),
569 "ROLE_PERMISSION": "slice_instances:id:action:",
575 "ROLE_PERMISSION": "slice_instances:opps:",
578 "ROLE_PERMISSION": "slice_instances:opps:id:",
590 "ROLE_PERMISSION": "reports:id:",
599 "alarms": {"METHODS": ("GET", "PATCH"),
600 "ROLE_PERMISSION": "alarms:",
601 "<ID>": {"METHODS": ("GET", "PATCH"),
602 "ROLE_PERMISSION": "alarms:id:",
610 class NbiException(Exception):
611 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
612 Exception.__init
__(self
, message
)
613 self
.http_code
= http_code
616 class Server(object):
618 # to decode bytes to str
619 reader
= getreader("utf-8")
623 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
624 self
.engine
= Engine(self
.authenticator
)
626 def _format_in(self
, kwargs
):
629 if cherrypy
.request
.body
.length
:
630 error_text
= "Invalid input format "
632 if "Content-Type" in cherrypy
.request
.headers
:
633 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
634 error_text
= "Invalid json format "
635 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
636 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
637 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
638 error_text
= "Invalid yaml format "
640 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
642 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
644 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
645 or "application/gzip"
646 in cherrypy
.request
.headers
["Content-Type"]
647 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
648 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
650 indata
= cherrypy
.request
.body
# .read()
652 "multipart/form-data"
653 in cherrypy
.request
.headers
["Content-Type"]
655 if "descriptor_file" in kwargs
:
656 filecontent
= kwargs
.pop("descriptor_file")
657 if not filecontent
.file:
659 "empty file or content", HTTPStatus
.BAD_REQUEST
661 indata
= filecontent
.file # .read()
662 if filecontent
.content_type
.value
:
663 cherrypy
.request
.headers
[
665 ] = filecontent
.content_type
.value
667 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
668 # "Only 'Content-Type' of type 'application/json' or
669 # 'application/yaml' for input format are available")
670 error_text
= "Invalid yaml format "
672 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
674 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
676 error_text
= "Invalid yaml format "
677 indata
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
678 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
683 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
686 for k
, v
in kwargs
.items():
687 if isinstance(v
, str):
692 kwargs
[k
] = yaml
.load(v
, Loader
=yaml
.SafeLoader
)
698 or k
.endswith(".gte")
699 or k
.endswith(".lte")
708 elif v
.find(",") > 0:
709 kwargs
[k
] = v
.split(",")
710 elif isinstance(v
, (list, tuple)):
711 for index
in range(0, len(v
)):
716 v
[index
] = yaml
.load(v
[index
], Loader
=yaml
.SafeLoader
)
721 except (ValueError, yaml
.YAMLError
) as exc
:
722 raise NbiException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
723 except KeyError as exc
:
725 "Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
727 except Exception as exc
:
728 raise NbiException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
731 def _format_out(data
, token_info
=None, _format
=None):
733 return string of dictionary data according to requested json, yaml, xml. By default json
734 :param data: response to be sent. Can be a dict, text or file
735 :param token_info: Contains among other username and project
736 :param _format: The format to be set as Content-Type if data is a file
739 accept
= cherrypy
.request
.headers
.get("Accept")
741 if accept
and "text/html" in accept
:
743 data
, cherrypy
.request
, cherrypy
.response
, token_info
745 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
747 elif hasattr(data
, "read"): # file object
749 cherrypy
.response
.headers
["Content-Type"] = _format
750 elif "b" in data
.mode
: # binariy asssumig zip
751 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
753 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
754 # TODO check that cherrypy close file. If not implement pending things to close per thread next
757 if "text/html" in accept
:
759 data
, cherrypy
.request
, cherrypy
.response
, token_info
761 elif "application/yaml" in accept
or "*/*" in accept
:
763 elif "application/json" in accept
or (
764 cherrypy
.response
.status
and cherrypy
.response
.status
>= 300
766 cherrypy
.response
.headers
[
768 ] = "application/json; charset=utf-8"
769 a
= json
.dumps(data
, indent
=4) + "\n"
770 return a
.encode("utf8")
771 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
772 return yaml
.safe_dump(
776 default_flow_style
=False,
780 ) # , canonical=True, default_style='"'
783 def index(self
, *args
, **kwargs
):
786 if cherrypy
.request
.method
== "GET":
787 token_info
= self
.authenticator
.authorize()
788 outdata
= token_info
# Home page
790 raise cherrypy
.HTTPError(
791 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
792 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
795 return self
._format
_out
(outdata
, token_info
)
797 except (EngineException
, AuthException
) as e
:
798 # cherrypy.log("index Exception {}".format(e))
799 cherrypy
.response
.status
= e
.http_code
.value
800 return self
._format
_out
("Welcome to OSM!", token_info
)
803 def version(self
, *args
, **kwargs
):
804 # TODO consider to remove and provide version using the static version file
806 if cherrypy
.request
.method
!= "GET":
808 "Only method GET is allowed", HTTPStatus
.METHOD_NOT_ALLOWED
812 "Invalid URL or query string for version",
813 HTTPStatus
.METHOD_NOT_ALLOWED
,
815 # TODO include version of other modules, pick up from some kafka admin message
816 osm_nbi_version
= {"version": nbi_version
, "date": nbi_version_date
}
817 return self
._format
_out
(osm_nbi_version
)
818 except NbiException
as e
:
819 cherrypy
.response
.status
= e
.http_code
.value
821 "code": e
.http_code
.name
,
822 "status": e
.http_code
.value
,
825 return self
._format
_out
(problem_details
, None)
830 "user_domain_name": cherrypy
.tree
.apps
["/osm"]
831 .config
["authentication"]
832 .get("user_domain_name"),
833 "project_domain_name": cherrypy
.tree
.apps
["/osm"]
834 .config
["authentication"]
835 .get("project_domain_name"),
837 return self
._format
_out
(domains
)
838 except NbiException
as e
:
839 cherrypy
.response
.status
= e
.http_code
.value
841 "code": e
.http_code
.name
,
842 "status": e
.http_code
.value
,
845 return self
._format
_out
(problem_details
, None)
848 def _format_login(token_info
):
850 Changes cherrypy.request.login to include username/project_name;session so that cherrypy access log will
852 :param token_info: Dictionary with token content
855 cherrypy
.request
.login
= token_info
.get("username", "-")
856 if token_info
.get("project_name"):
857 cherrypy
.request
.login
+= "/" + token_info
["project_name"]
858 if token_info
.get("id"):
859 cherrypy
.request
.login
+= ";session=" + token_info
["id"][0:12]
861 # NS Fault Management
863 def nsfm(self
, version
=None, topic
=None, uuid
=None, project_name
=None, ns_id
=None, *args
, **kwargs
):
864 if topic
== 'alarms':
866 method
= cherrypy
.request
.method
867 role_permission
= self
._check
_valid
_url
_method
(method
, "nsfm", version
, topic
, None, None, *args
)
868 query_string_operations
= self
._extract
_query
_string
_operations
(kwargs
, method
)
870 self
.authenticator
.authorize(role_permission
, query_string_operations
, None)
872 # to handle get request
873 if cherrypy
.request
.method
== 'GET':
874 # if request is on basis of uuid
875 if uuid
and uuid
!= 'None':
877 alarm
= self
.engine
.db
.get_one("alarms", {"uuid": uuid
})
878 alarm_action
= self
.engine
.db
.get_one("alarms_action", {"uuid": uuid
})
879 alarm
.update(alarm_action
)
880 vnf
= self
.engine
.db
.get_one("vnfrs", {"nsr-id-ref": alarm
["tags"]["ns_id"]})
881 alarm
["vnf-id"] = vnf
["_id"]
882 return self
._format
_out
(str(alarm
))
884 return self
._format
_out
("Please provide valid alarm uuid")
885 elif ns_id
and ns_id
!= 'None':
886 # if request is on basis of ns_id
888 alarms
= self
.engine
.db
.get_list("alarms", {"tags.ns_id": ns_id
})
890 alarm_action
= self
.engine
.db
.get_one("alarms_action", {"uuid": alarm
['uuid']})
891 alarm
.update(alarm_action
)
892 return self
._format
_out
(str(alarms
))
894 return self
._format
_out
("Please provide valid ns id")
896 # to return only alarm which are related to given project
897 project
= self
.engine
.db
.get_one("projects", {"name": project_name
})
898 project_id
= project
.get('_id')
899 ns_list
= self
.engine
.db
.get_list("nsrs", {"_admin.projects_read": project_id
})
902 ns_ids
.append(ns
.get("_id"))
903 alarms
= self
.engine
.db
.get_list("alarms")
904 alarm_list
= [alarm
for alarm
in alarms
if alarm
["tags"]["ns_id"] in ns_ids
]
905 for alrm
in alarm_list
:
906 action
= self
.engine
.db
.get_one("alarms_action", {"uuid": alrm
.get("uuid")})
908 return self
._format
_out
(str(alarm_list
))
909 # to handle patch request for alarm update
910 elif cherrypy
.request
.method
== 'PATCH':
911 data
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
913 # check if uuid is valid
914 self
.engine
.db
.get_one("alarms", {"uuid": data
.get("uuid")})
916 return self
._format
_out
("Please provide valid alarm uuid.")
917 if data
.get("is_enable") is not None:
918 if data
.get("is_enable"):
921 alarm_status
= 'disabled'
922 self
.engine
.db
.set_one("alarms", {"uuid": data
.get("uuid")},
923 {"alarm_status": alarm_status
})
925 self
.engine
.db
.set_one("alarms", {"uuid": data
.get("uuid")},
926 {"threshold": data
.get("threshold")})
927 return self
._format
_out
("Alarm updated")
928 except Exception as e
:
929 cherrypy
.response
.status
= e
.http_code
.value
930 if isinstance(e
, (NbiException
, EngineException
, DbException
, FsException
, MsgException
, AuthException
,
931 ValidationError
, AuthconnException
)):
932 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
933 http_code_name
= e
.http_code
.name
934 cherrypy
.log("Exception {}".format(e
))
936 http_code_value
= cherrypy
.response
.status
= HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
937 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
938 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
940 "code": http_code_name
,
941 "status": http_code_value
,
944 return self
._format
_out
(problem_details
)
947 def token(self
, method
, token_id
=None, kwargs
=None):
949 # self.engine.load_dbase(cherrypy.request.app.config)
950 indata
= self
._format
_in
(kwargs
)
951 if not isinstance(indata
, dict):
953 "Expected application/yaml or application/json Content-Type",
954 HTTPStatus
.BAD_REQUEST
,
958 token_info
= self
.authenticator
.authorize()
960 self
._format
_login
(token_info
)
962 outdata
= self
.authenticator
.get_token(token_info
, token_id
)
964 outdata
= self
.authenticator
.get_token_list(token_info
)
965 elif method
== "POST":
967 token_info
= self
.authenticator
.authorize()
971 indata
.update(kwargs
)
972 # This is needed to log the user when authentication fails
973 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
974 outdata
= token_info
= self
.authenticator
.new_token(
975 token_info
, indata
, cherrypy
.request
.remote
977 cherrypy
.session
["Authorization"] = outdata
["_id"]
978 self
._set
_location
_header
("admin", "v1", "tokens", outdata
["_id"])
980 self
._format
_login
(token_info
)
981 # password expiry check
982 if self
.authenticator
.check_password_expiry(outdata
):
983 outdata
= {"id": outdata
["id"],
984 "message": "change_password",
985 "user_id": outdata
["user_id"]
987 # cherrypy.response.cookie["Authorization"] = outdata["id"]
988 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
989 elif method
== "DELETE":
990 if not token_id
and "id" in kwargs
:
991 token_id
= kwargs
["id"]
993 token_info
= self
.authenticator
.authorize()
995 self
._format
_login
(token_info
)
996 token_id
= token_info
["_id"]
997 outdata
= self
.authenticator
.del_token(token_id
)
999 cherrypy
.session
["Authorization"] = "logout"
1000 # cherrypy.response.cookie["Authorization"] = token_id
1001 # cherrypy.response.cookie["Authorization"]['expires'] = 0
1004 "Method {} not allowed for token".format(method
),
1005 HTTPStatus
.METHOD_NOT_ALLOWED
,
1007 return self
._format
_out
(outdata
, token_info
)
1010 def test(self
, *args
, **kwargs
):
1011 if not cherrypy
.config
.get("server.enable_test") or (
1012 isinstance(cherrypy
.config
["server.enable_test"], str)
1013 and cherrypy
.config
["server.enable_test"].lower() == "false"
1015 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
1016 return "test URL is disabled"
1018 if args
and args
[0] == "help":
1020 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
1021 "sleep/<time>\nmessage/topic\n</pre></html>"
1024 elif args
and args
[0] == "init":
1026 # self.engine.load_dbase(cherrypy.request.app.config)
1027 self
.engine
.create_admin()
1028 return "Done. User 'admin', password 'admin' created"
1030 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
1031 return self
._format
_out
("Database already initialized")
1032 elif args
and args
[0] == "file":
1033 return cherrypy
.lib
.static
.serve_file(
1034 cherrypy
.tree
.apps
["/osm"].config
["storage"]["path"] + "/" + args
[1],
1038 elif args
and args
[0] == "file2":
1040 cherrypy
.tree
.apps
["/osm"].config
["storage"]["path"] + "/" + args
[1]
1042 f
= open(f_path
, "r")
1043 cherrypy
.response
.headers
["Content-type"] = "text/plain"
1046 elif len(args
) == 2 and args
[0] == "db-clear":
1047 deleted_info
= self
.engine
.db
.del_list(args
[1], kwargs
)
1048 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
1049 elif len(args
) and args
[0] == "fs-clear":
1051 folders
= (args
[1],)
1053 folders
= self
.engine
.fs
.dir_ls(".")
1054 for folder
in folders
:
1055 self
.engine
.fs
.file_delete(folder
)
1056 return ",".join(folders
) + " folders deleted\n"
1057 elif args
and args
[0] == "login":
1058 if not cherrypy
.request
.headers
.get("Authorization"):
1059 cherrypy
.response
.headers
[
1061 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
1062 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
1063 elif args
and args
[0] == "login2":
1064 if not cherrypy
.request
.headers
.get("Authorization"):
1065 cherrypy
.response
.headers
[
1067 ] = 'Bearer realm="Access to OSM site"'
1068 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
1069 elif args
and args
[0] == "sleep":
1072 sleep_time
= int(args
[1])
1074 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
1075 return self
._format
_out
("Database already initialized")
1076 thread_info
= cherrypy
.thread_data
1078 time
.sleep(sleep_time
)
1080 elif len(args
) >= 2 and args
[0] == "message":
1081 main_topic
= args
[1]
1082 return_text
= "<html><pre>{} ->\n".format(main_topic
)
1084 if cherrypy
.request
.method
== "POST":
1085 to_send
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
1086 for k
, v
in to_send
.items():
1087 self
.engine
.msg
.write(main_topic
, k
, v
)
1088 return_text
+= " {}: {}\n".format(k
, v
)
1089 elif cherrypy
.request
.method
== "GET":
1090 for k
, v
in kwargs
.items():
1091 v_dict
= yaml
.load(v
, Loader
=yaml
.SafeLoader
)
1092 self
.engine
.msg
.write(main_topic
, k
, v_dict
)
1093 return_text
+= " {}: {}\n".format(k
, v_dict
)
1094 except Exception as e
:
1095 return_text
+= "Error: " + str(e
)
1096 return_text
+= "</pre></html>\n"
1100 "<html><pre>\nheaders:\n args: {}\n".format(args
)
1101 + " kwargs: {}\n".format(kwargs
)
1102 + " headers: {}\n".format(cherrypy
.request
.headers
)
1103 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
1104 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
1105 + " session: {}\n".format(cherrypy
.session
)
1106 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
1107 + " method: {}\n".format(cherrypy
.request
.method
)
1108 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
1111 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
1112 if cherrypy
.request
.body
.length
:
1113 return_text
+= " content: {}\n".format(
1115 cherrypy
.request
.body
.read(
1116 int(cherrypy
.request
.headers
.get("Content-Length", 0))
1121 return_text
+= "thread: {}\n".format(thread_info
)
1122 return_text
+= "</pre></html>"
1126 def _check_valid_url_method(method
, *args
):
1129 "URL must contain at least 'main_topic/version/topic'",
1130 HTTPStatus
.METHOD_NOT_ALLOWED
,
1133 reference
= valid_url_methods
1137 if not isinstance(reference
, dict):
1139 "URL contains unexpected extra items '{}'".format(arg
),
1140 HTTPStatus
.METHOD_NOT_ALLOWED
,
1143 if arg
in reference
:
1144 reference
= reference
[arg
]
1145 elif "<ID>" in reference
:
1146 reference
= reference
["<ID>"]
1147 elif "*" in reference
:
1148 # if there is content
1150 reference
= reference
["*"]
1154 "Unexpected URL item {}".format(arg
), HTTPStatus
.METHOD_NOT_ALLOWED
1156 if "TODO" in reference
and method
in reference
["TODO"]:
1158 "Method {} not supported yet for this URL".format(method
),
1159 HTTPStatus
.NOT_IMPLEMENTED
,
1161 elif "METHODS" in reference
and method
not in reference
["METHODS"]:
1163 "Method {} not supported for this URL".format(method
),
1164 HTTPStatus
.METHOD_NOT_ALLOWED
,
1166 return reference
["ROLE_PERMISSION"] + method
.lower()
1169 def _set_location_header(main_topic
, version
, topic
, id):
1171 Insert response header Location with the URL of created item base on URL params
1178 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
1179 cherrypy
.response
.headers
["Location"] = "/osm/{}/{}/{}/{}".format(
1180 main_topic
, version
, topic
, id
1185 def _extract_query_string_operations(kwargs
, method
):
1191 query_string_operations
= []
1193 for qs
in ("FORCE", "PUBLIC", "ADMIN", "SET_PROJECT"):
1194 if qs
in kwargs
and kwargs
[qs
].lower() != "false":
1195 query_string_operations
.append(qs
.lower() + ":" + method
.lower())
1196 return query_string_operations
1199 def _manage_admin_query(token_info
, kwargs
, method
, _id
):
1201 Processes the administrator query inputs (if any) of FORCE, ADMIN, PUBLIC, SET_PROJECT
1202 Check that users has rights to use them and returs the admin_query
1203 :param token_info: token_info rights obtained by token
1204 :param kwargs: query string input.
1205 :param method: http method: GET, POSST, PUT, ...
1207 :return: admin_query dictionary with keys:
1208 public: True, False or None
1209 force: True or False
1210 project_id: tuple with projects used for accessing an element
1211 set_project: tuple with projects that a created element will belong to
1212 method: show, list, delete, write
1216 "project_id": (token_info
["project_id"],),
1217 "username": token_info
["username"],
1218 "admin": token_info
["admin"],
1220 "allow_show_user_project_role": token_info
["allow_show_user_project_role"],
1224 if "FORCE" in kwargs
:
1226 kwargs
["FORCE"].lower() != "false"
1227 ): # if None or True set force to True
1228 admin_query
["force"] = True
1231 if "PUBLIC" in kwargs
:
1233 kwargs
["PUBLIC"].lower() != "false"
1234 ): # if None or True set public to True
1235 admin_query
["public"] = True
1237 admin_query
["public"] = False
1238 del kwargs
["PUBLIC"]
1240 if "ADMIN" in kwargs
:
1241 behave_as
= kwargs
.pop("ADMIN")
1242 if behave_as
.lower() != "false":
1243 if not token_info
["admin"]:
1245 "Only admin projects can use 'ADMIN' query string",
1246 HTTPStatus
.UNAUTHORIZED
,
1249 not behave_as
or behave_as
.lower() == "true"
1250 ): # convert True, None to empty list
1251 admin_query
["project_id"] = ()
1252 elif isinstance(behave_as
, (list, tuple)):
1253 admin_query
["project_id"] = behave_as
1254 else: # isinstance(behave_as, str)
1255 admin_query
["project_id"] = (behave_as
,)
1256 if "SET_PROJECT" in kwargs
:
1257 set_project
= kwargs
.pop("SET_PROJECT")
1259 admin_query
["set_project"] = list(admin_query
["project_id"])
1261 if isinstance(set_project
, str):
1262 set_project
= (set_project
,)
1263 if admin_query
["project_id"]:
1264 for p
in set_project
:
1265 if p
not in admin_query
["project_id"]:
1267 "Unauthorized for 'SET_PROJECT={p}'. Try with 'ADMIN=True' or "
1268 "'ADMIN='{p}'".format(p
=p
),
1269 HTTPStatus
.UNAUTHORIZED
,
1271 admin_query
["set_project"] = set_project
1274 # if "PROJECT_READ" in kwargs:
1275 # admin_query["project"] = kwargs.pop("project")
1276 # if admin_query["project"] == token_info["project_id"]:
1279 admin_query
["method"] = "show"
1281 admin_query
["method"] = "list"
1282 elif method
== "DELETE":
1283 admin_query
["method"] = "delete"
1285 admin_query
["method"] = "write"
1305 engine_session
= None
1307 if not main_topic
or not version
or not topic
:
1309 "URL must contain at least 'main_topic/version/topic'",
1310 HTTPStatus
.METHOD_NOT_ALLOWED
,
1312 if main_topic
not in (
1324 "URL main_topic '{}' not supported".format(main_topic
),
1325 HTTPStatus
.METHOD_NOT_ALLOWED
,
1329 "URL version '{}' not supported".format(version
),
1330 HTTPStatus
.METHOD_NOT_ALLOWED
,
1335 and "METHOD" in kwargs
1336 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
1338 method
= kwargs
.pop("METHOD")
1340 method
= cherrypy
.request
.method
1342 role_permission
= self
._check
_valid
_url
_method
(
1343 method
, main_topic
, version
, topic
, _id
, item
, *args
1345 query_string_operations
= self
._extract
_query
_string
_operations
(
1348 if main_topic
== "admin" and topic
== "tokens":
1349 return self
.token(method
, _id
, kwargs
)
1350 token_info
= self
.authenticator
.authorize(
1351 role_permission
, query_string_operations
, _id
1353 if main_topic
== "admin" and topic
== "domains":
1354 return self
.domain()
1355 engine_session
= self
._manage
_admin
_query
(token_info
, kwargs
, method
, _id
)
1356 indata
= self
._format
_in
(kwargs
)
1357 engine_topic
= topic
1359 if item
and topic
!= "pm_jobs":
1362 if main_topic
== "nsd":
1363 engine_topic
= "nsds"
1364 elif main_topic
== "vnfpkgm":
1365 engine_topic
= "vnfds"
1366 if topic
== "vnfpkg_op_occs":
1367 engine_topic
= "vnfpkgops"
1368 if topic
== "vnf_packages" and item
== "action":
1369 engine_topic
= "vnfpkgops"
1370 elif main_topic
== "nslcm":
1371 engine_topic
= "nsrs"
1372 if topic
== "ns_lcm_op_occs":
1373 engine_topic
= "nslcmops"
1374 if topic
== "vnfrs" or topic
== "vnf_instances":
1375 engine_topic
= "vnfrs"
1376 elif main_topic
== "vnflcm":
1377 if topic
== "vnf_lcm_op_occs":
1378 engine_topic
= "vnflcmops"
1379 elif main_topic
== "nst":
1380 engine_topic
= "nsts"
1381 elif main_topic
== "nsilcm":
1382 engine_topic
= "nsis"
1383 if topic
== "nsi_lcm_op_occs":
1384 engine_topic
= "nsilcmops"
1385 elif main_topic
== "pdu":
1386 engine_topic
= "pdus"
1388 engine_topic
== "vims"
1389 ): # TODO this is for backward compatibility, it will be removed in the future
1390 engine_topic
= "vim_accounts"
1392 if topic
== "subscriptions":
1393 engine_topic
= main_topic
+ "_" + topic
1405 if item
in ("vnfd", "nsd", "nst"):
1406 path
= "$DESCRIPTOR"
1409 elif item
== "artifacts":
1413 file, _format
= self
.engine
.get_file(
1418 cherrypy
.request
.headers
.get("Accept"),
1422 outdata
= self
.engine
.get_item_list(
1423 engine_session
, engine_topic
, kwargs
, api_req
=True
1426 if item
== "reports":
1427 # TODO check that project_id (_id in this context) has permissions
1430 if "vcaStatusRefresh" in kwargs
:
1431 filter_q
= {"vcaStatusRefresh": kwargs
["vcaStatusRefresh"]}
1432 outdata
= self
.engine
.get_item(engine_session
, engine_topic
, _id
, filter_q
, True)
1434 elif method
== "POST":
1435 cherrypy
.response
.status
= HTTPStatus
.CREATED
.value
1437 "ns_descriptors_content",
1438 "vnf_packages_content",
1439 "netslice_templates_content",
1441 _id
= cherrypy
.request
.headers
.get("Transaction-Id")
1443 _id
, _
= self
.engine
.new_item(
1449 cherrypy
.request
.headers
,
1451 completed
= self
.engine
.upload_content(
1457 cherrypy
.request
.headers
,
1460 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1462 cherrypy
.response
.headers
["Transaction-Id"] = _id
1463 outdata
= {"id": _id
}
1464 elif topic
== "ns_instances_content":
1466 _id
, _
= self
.engine
.new_item(
1467 rollback
, engine_session
, engine_topic
, indata
, kwargs
1470 indata
["lcmOperationType"] = "instantiate"
1471 indata
["nsInstanceId"] = _id
1472 nslcmop_id
, _
= self
.engine
.new_item(
1473 rollback
, engine_session
, "nslcmops", indata
, None
1475 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1476 outdata
= {"id": _id
, "nslcmop_id": nslcmop_id
}
1477 elif topic
== "ns_instances" and item
:
1478 indata
["lcmOperationType"] = item
1479 indata
["nsInstanceId"] = _id
1480 _id
, _
= self
.engine
.new_item(
1481 rollback
, engine_session
, "nslcmops", indata
, kwargs
1483 self
._set
_location
_header
(
1484 main_topic
, version
, "ns_lcm_op_occs", _id
1486 outdata
= {"id": _id
}
1487 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1488 elif topic
== "netslice_instances_content":
1489 # creates NetSlice_Instance_record (NSIR)
1490 _id
, _
= self
.engine
.new_item(
1491 rollback
, engine_session
, engine_topic
, indata
, kwargs
1493 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1494 indata
["lcmOperationType"] = "instantiate"
1495 indata
["netsliceInstanceId"] = _id
1496 nsilcmop_id
, _
= self
.engine
.new_item(
1497 rollback
, engine_session
, "nsilcmops", indata
, kwargs
1499 outdata
= {"id": _id
, "nsilcmop_id": nsilcmop_id
}
1500 elif topic
== "netslice_instances" and item
:
1501 indata
["lcmOperationType"] = item
1502 indata
["netsliceInstanceId"] = _id
1503 _id
, _
= self
.engine
.new_item(
1504 rollback
, engine_session
, "nsilcmops", indata
, kwargs
1506 self
._set
_location
_header
(
1507 main_topic
, version
, "nsi_lcm_op_occs", _id
1509 outdata
= {"id": _id
}
1510 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1511 elif topic
== "vnf_packages" and item
== "action":
1512 indata
["lcmOperationType"] = item
1513 indata
["vnfPkgId"] = _id
1514 _id
, _
= self
.engine
.new_item(
1515 rollback
, engine_session
, "vnfpkgops", indata
, kwargs
1517 self
._set
_location
_header
(
1518 main_topic
, version
, "vnfpkg_op_occs", _id
1520 outdata
= {"id": _id
}
1521 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1522 elif topic
== "subscriptions":
1523 _id
, _
= self
.engine
.new_item(
1524 rollback
, engine_session
, engine_topic
, indata
, kwargs
1526 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1528 link
["self"] = cherrypy
.response
.headers
["Location"]
1531 "filter": indata
["filter"],
1532 "callbackUri": indata
["CallbackUri"],
1535 cherrypy
.response
.status
= HTTPStatus
.CREATED
.value
1536 elif topic
== "vnf_instances" and item
:
1537 indata
["lcmOperationType"] = item
1538 indata
["vnfInstanceId"] = _id
1539 _id
, _
= self
.engine
.new_item(rollback
, engine_session
, "vnflcmops", indata
, kwargs
)
1540 self
._set
_location
_header
(main_topic
, version
, "vnf_lcm_op_occs", _id
)
1541 outdata
= {"id": _id
}
1542 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1544 _id
, op_id
= self
.engine
.new_item(
1550 cherrypy
.request
.headers
,
1552 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
1553 outdata
= {"id": _id
}
1555 outdata
["op_id"] = op_id
1556 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1557 # TODO form NsdInfo when topic in ("ns_descriptors", "vnf_packages")
1559 elif method
== "DELETE":
1561 outdata
= self
.engine
.del_item_list(
1562 engine_session
, engine_topic
, kwargs
1564 cherrypy
.response
.status
= HTTPStatus
.OK
.value
1565 else: # len(args) > 1
1566 # for NS NSI generate an operation
1568 if topic
== "ns_instances_content" and not engine_session
["force"]:
1570 "lcmOperationType": "terminate",
1571 "nsInstanceId": _id
,
1574 op_id
, _
= self
.engine
.new_item(
1575 rollback
, engine_session
, "nslcmops", nslcmop_desc
, kwargs
1578 outdata
= {"_id": op_id
}
1580 topic
== "netslice_instances_content"
1581 and not engine_session
["force"]
1584 "lcmOperationType": "terminate",
1585 "netsliceInstanceId": _id
,
1588 op_id
, _
= self
.engine
.new_item(
1589 rollback
, engine_session
, "nsilcmops", nsilcmop_desc
, None
1592 outdata
= {"_id": op_id
}
1593 # if there is not any deletion in process, delete
1595 op_id
= self
.engine
.del_item(engine_session
, engine_topic
, _id
)
1597 outdata
= {"op_id": op_id
}
1598 cherrypy
.response
.status
= (
1599 HTTPStatus
.ACCEPTED
.value
1601 else HTTPStatus
.NO_CONTENT
.value
1604 elif method
in ("PUT", "PATCH"):
1606 if not indata
and not kwargs
and not engine_session
.get("set_project"):
1608 "Nothing to update. Provide payload and/or query string",
1609 HTTPStatus
.BAD_REQUEST
,
1612 item
in ("nsd_content", "package_content", "nst_content")
1615 completed
= self
.engine
.upload_content(
1621 cherrypy
.request
.headers
,
1624 cherrypy
.response
.headers
["Transaction-Id"] = id
1626 op_id
= self
.engine
.edit_item(
1627 engine_session
, engine_topic
, _id
, indata
, kwargs
1631 cherrypy
.response
.status
= HTTPStatus
.ACCEPTED
.value
1632 outdata
= {"op_id": op_id
}
1634 cherrypy
.response
.status
= HTTPStatus
.NO_CONTENT
.value
1638 "Method {} not allowed".format(method
),
1639 HTTPStatus
.METHOD_NOT_ALLOWED
,
1642 # if Role information changes, it is needed to reload the information of roles
1643 if topic
== "roles" and method
!= "GET":
1644 self
.authenticator
.load_operation_to_allowed_roles()
1648 and method
== "DELETE"
1649 or topic
in ["users", "roles"]
1650 and method
in ["PUT", "PATCH", "DELETE"]
1652 self
.authenticator
.remove_token_from_cache()
1654 return self
._format
_out
(outdata
, token_info
, _format
)
1655 except Exception as e
:
1669 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
1670 http_code_name
= e
.http_code
.name
1671 cherrypy
.log("Exception {}".format(e
))
1674 cherrypy
.response
.status
1675 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
1676 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
1677 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
1678 if hasattr(outdata
, "close"): # is an open file
1682 for rollback_item
in rollback
:
1684 if rollback_item
.get("operation") == "set":
1685 self
.engine
.db
.set_one(
1686 rollback_item
["topic"],
1687 {"_id": rollback_item
["_id"]},
1688 rollback_item
["content"],
1689 fail_on_empty
=False,
1691 elif rollback_item
.get("operation") == "del_list":
1692 self
.engine
.db
.del_list(
1693 rollback_item
["topic"],
1694 rollback_item
["filter"],
1695 fail_on_empty
=False,
1698 self
.engine
.db
.del_one(
1699 rollback_item
["topic"],
1700 {"_id": rollback_item
["_id"]},
1701 fail_on_empty
=False,
1703 except Exception as e2
:
1704 rollback_error_text
= "Rollback Exception {}: {}".format(
1707 cherrypy
.log(rollback_error_text
)
1708 error_text
+= ". " + rollback_error_text
1709 # if isinstance(e, MsgException):
1710 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
1711 # engine_topic[:-1], method, error_text)
1713 "code": http_code_name
,
1714 "status": http_code_value
,
1715 "detail": error_text
,
1717 return self
._format
_out
(problem_details
, token_info
)
1718 # raise cherrypy.HTTPError(e.http_code.value, str(e))
1721 self
._format
_login
(token_info
)
1722 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
1723 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
1724 if outdata
.get(logging_id
):
1725 cherrypy
.request
.login
+= ";{}={}".format(
1726 logging_id
, outdata
[logging_id
][:36]
1730 def _start_service():
1732 Callback function called when cherrypy.engine starts
1733 Override configuration with env variables
1734 Set database, storage, message configuration
1735 Init database with admin/admin user password
1738 global subscription_thread
1739 cherrypy
.log
.error("Starting osm_nbi")
1740 # update general cherrypy configuration
1743 engine_config
= cherrypy
.tree
.apps
["/osm"].config
1744 for k
, v
in environ
.items():
1745 if not k
.startswith("OSMNBI_"):
1747 k1
, _
, k2
= k
[7:].lower().partition("_")
1751 # update static configuration
1752 if k
== "OSMNBI_STATIC_DIR":
1753 engine_config
["/static"]["tools.staticdir.dir"] = v
1754 engine_config
["/static"]["tools.staticdir.on"] = True
1755 elif k
== "OSMNBI_SOCKET_PORT" or k
== "OSMNBI_SERVER_PORT":
1756 update_dict
["server.socket_port"] = int(v
)
1757 elif k
== "OSMNBI_SOCKET_HOST" or k
== "OSMNBI_SERVER_HOST":
1758 update_dict
["server.socket_host"] = v
1759 elif k1
in ("server", "test", "auth", "log"):
1760 update_dict
[k1
+ "." + k2
] = v
1761 elif k1
in ("message", "database", "storage", "authentication"):
1762 # k2 = k2.replace('_', '.')
1763 if k2
in ("port", "db_port"):
1764 engine_config
[k1
][k2
] = int(v
)
1766 engine_config
[k1
][k2
] = v
1768 except ValueError as e
:
1769 cherrypy
.log
.error("Ignoring environ '{}': " + str(e
))
1770 except Exception as e
:
1771 cherrypy
.log
.warn("skipping environ '{}' on exception '{}'".format(k
, e
))
1774 cherrypy
.config
.update(update_dict
)
1775 engine_config
["global"].update(update_dict
)
1778 log_format_simple
= (
1779 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
1781 log_formatter_simple
= logging
.Formatter(
1782 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
1784 logger_server
= logging
.getLogger("cherrypy.error")
1785 logger_access
= logging
.getLogger("cherrypy.access")
1786 logger_cherry
= logging
.getLogger("cherrypy")
1787 logger_nbi
= logging
.getLogger("nbi")
1789 if "log.file" in engine_config
["global"]:
1790 file_handler
= logging
.handlers
.RotatingFileHandler(
1791 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
1793 file_handler
.setFormatter(log_formatter_simple
)
1794 logger_cherry
.addHandler(file_handler
)
1795 logger_nbi
.addHandler(file_handler
)
1796 # log always to standard output
1797 for format_
, logger
in {
1798 "nbi.server %(filename)s:%(lineno)s": logger_server
,
1799 "nbi.access %(filename)s:%(lineno)s": logger_access
,
1800 "%(name)s %(filename)s:%(lineno)s": logger_nbi
,
1802 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
1803 log_formatter_cherry
= logging
.Formatter(
1804 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
1806 str_handler
= logging
.StreamHandler()
1807 str_handler
.setFormatter(log_formatter_cherry
)
1808 logger
.addHandler(str_handler
)
1810 if engine_config
["global"].get("log.level"):
1811 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
1812 logger_nbi
.setLevel(engine_config
["global"]["log.level"])
1814 # logging other modules
1815 for k1
, logname
in {
1816 "message": "nbi.msg",
1817 "database": "nbi.db",
1818 "storage": "nbi.fs",
1820 engine_config
[k1
]["logger_name"] = logname
1821 logger_module
= logging
.getLogger(logname
)
1822 if "logfile" in engine_config
[k1
]:
1823 file_handler
= logging
.handlers
.RotatingFileHandler(
1824 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
1826 file_handler
.setFormatter(log_formatter_simple
)
1827 logger_module
.addHandler(file_handler
)
1828 if "loglevel" in engine_config
[k1
]:
1829 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
1830 # TODO add more entries, e.g.: storage
1831 cherrypy
.tree
.apps
["/osm"].root
.engine
.start(engine_config
)
1832 cherrypy
.tree
.apps
["/osm"].root
.authenticator
.start(engine_config
)
1833 cherrypy
.tree
.apps
["/osm"].root
.engine
.init_db(target_version
=database_version
)
1834 cherrypy
.tree
.apps
["/osm"].root
.authenticator
.init_db(
1835 target_version
=auth_database_version
1838 # start subscriptions thread:
1839 subscription_thread
= SubscriptionThread(
1840 config
=engine_config
, engine
=nbi_server
.engine
1842 subscription_thread
.start()
1843 # Do not capture except SubscriptionException
1845 backend
= engine_config
["authentication"]["backend"]
1847 "Starting OSM NBI Version '{} {}' with '{}' authentication backend".format(
1848 nbi_version
, nbi_version_date
, backend
1853 def _stop_service():
1855 Callback function called when cherrypy.engine stops
1856 TODO: Ending database connections.
1858 global subscription_thread
1859 if subscription_thread
:
1860 subscription_thread
.terminate()
1861 subscription_thread
= None
1862 cherrypy
.tree
.apps
["/osm"].root
.engine
.stop()
1863 cherrypy
.log
.error("Stopping osm_nbi")
1866 def nbi(config_file
):
1870 # #'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
1871 # 'tools.sessions.on': True,
1872 # 'tools.response_headers.on': True,
1873 # # 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
1876 # cherrypy.Server.ssl_module = 'builtin'
1877 # cherrypy.Server.ssl_certificate = "http/cert.pem"
1878 # cherrypy.Server.ssl_private_key = "http/privkey.pem"
1879 # cherrypy.Server.thread_pool = 10
1880 # cherrypy.config.update({'Server.socket_port': config["port"], 'Server.socket_host': config["host"]})
1882 # cherrypy.config.update({'tools.auth_basic.on': True,
1883 # 'tools.auth_basic.realm': 'localhost',
1884 # 'tools.auth_basic.checkpassword': validate_password})
1885 nbi_server
= Server()
1886 cherrypy
.engine
.subscribe("start", _start_service
)
1887 cherrypy
.engine
.subscribe("stop", _stop_service
)
1888 cherrypy
.quickstart(nbi_server
, "/osm", config_file
)
1893 """Usage: {} [options]
1894 -c|--config [configuration_file]: loads the configuration file (default: ./nbi.cfg)
1895 -h|--help: shows this help
1900 # --log-socket-host HOST: send logs to this host")
1901 # --log-socket-port PORT: send logs using this port (default: 9022)")
1904 if __name__
== "__main__":
1906 # load parameters and configuration
1907 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
1908 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
1911 if o
in ("-h", "--help"):
1914 elif o
in ("-c", "--config"):
1916 # elif o == "--log-socket-port":
1917 # log_socket_port = a
1918 # elif o == "--log-socket-host":
1919 # log_socket_host = a
1920 # elif o == "--log-file":
1923 assert False, "Unhandled option"
1925 if not path
.isfile(config_file
):
1927 "configuration file '{}' that not exist".format(config_file
),
1932 for config_file
in (
1933 __file__
[: __file__
.rfind(".")] + ".cfg",
1937 if path
.isfile(config_file
):
1941 "No configuration file 'nbi.cfg' found neither at local folder nor at /etc/osm/",
1946 except getopt
.GetoptError
as e
:
1947 print(str(e
), file=sys
.stderr
)