47296dc35de3f9bf960ab85ca475aba40fcff47e
2 # -*- coding: utf-8 -*-
5 # Copyright 2020 Telefonica Investigacion y Desarrollo, S.A.U.
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
22 from codecs
import getreader
24 from http
import HTTPStatus
27 import logging
.handlers
28 from os
import environ
, path
33 from osm_common
.dbbase
import DbException
34 from osm_common
.fsbase
import FsException
35 from osm_common
.msgbase
import MsgException
36 from osm_ng_ro
import version
as ro_version
, version_date
as ro_version_date
37 import osm_ng_ro
.html_out
as html
38 from osm_ng_ro
.ns
import Ns
, NsException
39 from osm_ng_ro
.validation
import ValidationError
40 from osm_ng_ro
.vim_admin
import VimAdminThread
44 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
45 __version__
= "0.1." # file version, not NBI version
46 version_date
= "May 2020"
48 database_version
= "1.2"
49 auth_database_version
= "1.0"
50 ro_server
= None # instance of Server class
51 vim_admin_thread
= None # instance of VimAdminThread class
53 # vim_threads = None # instance of VimThread class
56 RO North Bound Interface
57 URL: /ro GET POST PUT DELETE PATCH
65 valid_query_string
= ("ADMIN", "SET_PROJECT", "FORCE", "PUBLIC")
66 # ^ Contains possible administrative query string words:
67 # ADMIN=True(by default)|Project|Project-list: See all elements, or elements of a project
68 # (not owned by my session project).
69 # PUBLIC=True(by default)|False: See/hide public elements. Set/Unset a topic to be public
70 # FORCE=True(by default)|False: Force edition/deletion operations
71 # SET_PROJECT=Project|Project-list: Add/Delete the topic to the projects portfolio
74 # contains allowed URL and methods, and the role_permission name
79 "ROLE_PERMISSION": "tokens:",
80 "<ID>": {"METHODS": ("DELETE",), "ROLE_PERMISSION": "tokens:id:"},
88 "ROLE_PERMISSION": "rebuild:",
91 "ROLE_PERMISSION": "rebuild:id:",
96 "ROLE_PERMISSION": "start:",
99 "ROLE_PERMISSION": "start:id:",
103 "METHODS": ("POST",),
104 "ROLE_PERMISSION": "stop:",
106 "METHODS": ("POST",),
107 "ROLE_PERMISSION": "stop:id:",
112 "ROLE_PERMISSION": "deploy:",
114 "METHODS": ("GET", "POST", "DELETE"),
115 "ROLE_PERMISSION": "deploy:id:",
118 "ROLE_PERMISSION": "deploy:id:id:",
120 "METHODS": ("POST",),
121 "ROLE_PERMISSION": "deploy:id:id:cancel",
129 "ROLE_PERMISSION": "recreate:id:",
132 "ROLE_PERMISSION": "recreate:id:id:",
139 "ROLE_PERMISSION": "migrate:id:",
142 "ROLE_PERMISSION": "migrate:id:id:",
149 "ROLE_PERMISSION": "verticalscale:id:",
152 "ROLE_PERMISSION": "verticalscale:id:id:",
161 class RoException(Exception):
162 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
163 Exception.__init
__(self
, message
)
164 self
.http_code
= http_code
167 class AuthException(RoException
):
172 def __init__(self
, valid_url_methods
, valid_query_string
):
173 self
.valid_url_methods
= valid_url_methods
174 self
.valid_query_string
= valid_query_string
176 def authorize(self
, *args
, **kwargs
):
177 return {"token": "ok", "id": "ok"}
179 def new_token(self
, token_info
, indata
, remote
):
180 return {"token": "ok", "id": "ok", "remote": remote
}
182 def del_token(self
, token_id
):
185 def start(self
, engine_config
):
189 class Server(object):
191 # to decode bytes to str
192 reader
= getreader("utf-8")
196 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
198 self
.map_operation
= {
199 "token:post": self
.new_token
,
200 "token:id:delete": self
.del_token
,
201 "deploy:get": self
.ns
.get_deploy
,
202 "deploy:id:get": self
.ns
.get_actions
,
203 "deploy:id:post": self
.ns
.deploy
,
204 "deploy:id:delete": self
.ns
.delete
,
205 "deploy:id:id:get": self
.ns
.status
,
206 "deploy:id:id:cancel:post": self
.ns
.cancel
,
207 "rebuild:id:post": self
.ns
.rebuild_start_stop
,
208 "start:id:post": self
.ns
.rebuild_start_stop
,
209 "stop:id:post": self
.ns
.rebuild_start_stop
,
210 "recreate:id:post": self
.ns
.recreate
,
211 "recreate:id:id:get": self
.ns
.recreate_status
,
212 "migrate:id:post": self
.ns
.migrate
,
213 "verticalscale:id:post": self
.ns
.verticalscale
,
216 def _format_in(self
, kwargs
):
221 if cherrypy
.request
.body
.length
:
222 error_text
= "Invalid input format "
224 if "Content-Type" in cherrypy
.request
.headers
:
225 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
226 error_text
= "Invalid json format "
227 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
228 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
229 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
230 error_text
= "Invalid yaml format "
231 indata
= yaml
.safe_load(cherrypy
.request
.body
)
232 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
234 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
235 or "application/gzip"
236 in cherrypy
.request
.headers
["Content-Type"]
237 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
238 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
240 indata
= cherrypy
.request
.body
# .read()
242 "multipart/form-data"
243 in cherrypy
.request
.headers
["Content-Type"]
245 if "descriptor_file" in kwargs
:
246 filecontent
= kwargs
.pop("descriptor_file")
248 if not filecontent
.file:
250 "empty file or content", HTTPStatus
.BAD_REQUEST
253 indata
= filecontent
.file # .read()
255 if filecontent
.content_type
.value
:
256 cherrypy
.request
.headers
[
258 ] = filecontent
.content_type
.value
260 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
261 # "Only 'Content-Type' of type 'application/json' or
262 # 'application/yaml' for input format are available")
263 error_text
= "Invalid yaml format "
264 indata
= yaml
.safe_load(cherrypy
.request
.body
)
265 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
267 error_text
= "Invalid yaml format "
268 indata
= yaml
.safe_load(cherrypy
.request
.body
)
269 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
275 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
278 for k
, v
in kwargs
.items():
279 if isinstance(v
, str):
284 kwargs
[k
] = yaml
.safe_load(v
)
285 except Exception as yaml_error
:
287 f
"{yaml_error} occured while parsing the yaml"
292 or k
.endswith(".gte")
293 or k
.endswith(".lte")
300 except Exception as keyword_error
:
302 f
"{keyword_error} occured while getting the keyword arguments"
304 elif v
.find(",") > 0:
305 kwargs
[k
] = v
.split(",")
306 elif isinstance(v
, (list, tuple)):
307 for index
in range(0, len(v
)):
312 v
[index
] = yaml
.safe_load(v
[index
])
313 except Exception as error
:
315 f
"{error} occured while parsing the yaml"
319 except (ValueError, yaml
.YAMLError
) as exc
:
320 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
321 except KeyError as exc
:
322 raise RoException("Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
)
323 except Exception as exc
:
324 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
327 def _format_out(data
, token_info
=None, _format
=None):
329 return string of dictionary data according to requested json, yaml, xml. By default json
330 :param data: response to be sent. Can be a dict, text or file
331 :param token_info: Contains among other username and project
332 :param _format: The format to be set as Content-Type if data is a file
335 accept
= cherrypy
.request
.headers
.get("Accept")
338 if accept
and "text/html" in accept
:
340 data
, cherrypy
.request
, cherrypy
.response
, token_info
343 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
345 elif hasattr(data
, "read"): # file object
347 cherrypy
.response
.headers
["Content-Type"] = _format
348 elif "b" in data
.mode
: # binariy asssumig zip
349 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
351 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
353 # TODO check that cherrypy close file. If not implement pending things to close per thread next
357 if "application/json" in accept
:
358 cherrypy
.response
.headers
[
360 ] = "application/json; charset=utf-8"
361 a
= json
.dumps(data
, indent
=4) + "\n"
363 return a
.encode("utf8")
364 elif "text/html" in accept
:
366 data
, cherrypy
.request
, cherrypy
.response
, token_info
369 "application/yaml" in accept
371 or "text/plain" in accept
374 # if there is not any valid accept, raise an error. But if response is already an error, format in yaml
375 elif cherrypy
.response
.status
>= 400:
376 raise cherrypy
.HTTPError(
377 HTTPStatus
.NOT_ACCEPTABLE
.value
,
378 "Only 'Accept' of type 'application/json' or 'application/yaml' "
379 "for output format are available",
382 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
384 return yaml
.safe_dump(
388 default_flow_style
=False,
392 ) # , canonical=True, default_style='"'
395 def index(self
, *args
, **kwargs
):
399 if cherrypy
.request
.method
== "GET":
400 token_info
= self
.authenticator
.authorize()
401 outdata
= token_info
# Home page
403 raise cherrypy
.HTTPError(
404 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
405 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
408 return self
._format
_out
(outdata
, token_info
)
409 except (NsException
, AuthException
) as e
:
410 # cherrypy.log("index Exception {}".format(e))
411 cherrypy
.response
.status
= e
.http_code
.value
413 return self
._format
_out
("Welcome to OSM!", token_info
)
416 def version(self
, *args
, **kwargs
):
417 # TODO consider to remove and provide version using the static version file
419 if cherrypy
.request
.method
!= "GET":
421 "Only method GET is allowed",
422 HTTPStatus
.METHOD_NOT_ALLOWED
,
426 "Invalid URL or query string for version",
427 HTTPStatus
.METHOD_NOT_ALLOWED
,
430 # TODO include version of other modules, pick up from some kafka admin message
431 osm_ng_ro_version
= {"version": ro_version
, "date": ro_version_date
}
433 return self
._format
_out
(osm_ng_ro_version
)
434 except RoException
as e
:
435 cherrypy
.response
.status
= e
.http_code
.value
437 "code": e
.http_code
.name
,
438 "status": e
.http_code
.value
,
442 return self
._format
_out
(problem_details
, None)
444 def new_token(self
, engine_session
, indata
, *args
, **kwargs
):
448 token_info
= self
.authenticator
.authorize()
453 indata
.update(kwargs
)
455 # This is needed to log the user when authentication fails
456 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
457 token_info
= self
.authenticator
.new_token(
458 token_info
, indata
, cherrypy
.request
.remote
460 cherrypy
.session
["Authorization"] = token_info
["id"]
461 self
._set
_location
_header
("admin", "v1", "tokens", token_info
["id"])
464 # cherrypy.response.cookie["Authorization"] = outdata["id"]
465 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
467 return token_info
, token_info
["id"], True
469 def del_token(self
, engine_session
, indata
, version
, _id
, *args
, **kwargs
):
472 if not token_id
and "id" in kwargs
:
473 token_id
= kwargs
["id"]
475 token_info
= self
.authenticator
.authorize()
477 token_id
= token_info
["id"]
479 self
.authenticator
.del_token(token_id
)
481 cherrypy
.session
["Authorization"] = "logout"
482 # cherrypy.response.cookie["Authorization"] = token_id
483 # cherrypy.response.cookie["Authorization"]['expires'] = 0
485 return None, None, True
488 def test(self
, *args
, **kwargs
):
489 if not cherrypy
.config
.get("server.enable_test") or (
490 isinstance(cherrypy
.config
["server.enable_test"], str)
491 and cherrypy
.config
["server.enable_test"].lower() == "false"
493 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
495 return "test URL is disabled"
499 if args
and args
[0] == "help":
501 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
502 "sleep/<time>\nmessage/topic\n</pre></html>"
504 elif args
and args
[0] == "init":
506 # self.ns.load_dbase(cherrypy.request.app.config)
507 self
.ns
.create_admin()
509 return "Done. User 'admin', password 'admin' created"
511 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
513 return self
._format
_out
("Database already initialized")
514 elif args
and args
[0] == "file":
515 return cherrypy
.lib
.static
.serve_file(
516 cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1],
520 elif args
and args
[0] == "file2":
521 f_path
= cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1]
522 f
= open(f_path
, "r")
523 cherrypy
.response
.headers
["Content-type"] = "text/plain"
526 elif len(args
) == 2 and args
[0] == "db-clear":
527 deleted_info
= self
.ns
.db
.del_list(args
[1], kwargs
)
528 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
529 elif len(args
) and args
[0] == "fs-clear":
533 folders
= self
.ns
.fs
.dir_ls(".")
535 for folder
in folders
:
536 self
.ns
.fs
.file_delete(folder
)
538 return ",".join(folders
) + " folders deleted\n"
539 elif args
and args
[0] == "login":
540 if not cherrypy
.request
.headers
.get("Authorization"):
541 cherrypy
.response
.headers
[
543 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
544 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
545 elif args
and args
[0] == "login2":
546 if not cherrypy
.request
.headers
.get("Authorization"):
547 cherrypy
.response
.headers
[
549 ] = 'Bearer realm="Access to OSM site"'
550 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
551 elif args
and args
[0] == "sleep":
555 sleep_time
= int(args
[1])
557 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
558 return self
._format
_out
("Database already initialized")
560 thread_info
= cherrypy
.thread_data
562 time
.sleep(sleep_time
)
564 elif len(args
) >= 2 and args
[0] == "message":
566 return_text
= "<html><pre>{} ->\n".format(main_topic
)
569 if cherrypy
.request
.method
== "POST":
570 to_send
= yaml
.safe_load(cherrypy
.request
.body
)
571 for k
, v
in to_send
.items():
572 self
.ns
.msg
.write(main_topic
, k
, v
)
573 return_text
+= " {}: {}\n".format(k
, v
)
574 elif cherrypy
.request
.method
== "GET":
575 for k
, v
in kwargs
.items():
576 self
.ns
.msg
.write(main_topic
, k
, yaml
.safe_load(v
))
577 return_text
+= " {}: {}\n".format(k
, yaml
.safe_load(v
))
578 except Exception as e
:
579 return_text
+= "Error: " + str(e
)
581 return_text
+= "</pre></html>\n"
586 "<html><pre>\nheaders:\n args: {}\n".format(args
)
587 + " kwargs: {}\n".format(kwargs
)
588 + " headers: {}\n".format(cherrypy
.request
.headers
)
589 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
590 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
591 + " session: {}\n".format(cherrypy
.session
)
592 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
593 + " method: {}\n".format(cherrypy
.request
.method
)
594 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
597 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
599 if cherrypy
.request
.body
.length
:
600 return_text
+= " content: {}\n".format(
602 cherrypy
.request
.body
.read(
603 int(cherrypy
.request
.headers
.get("Content-Length", 0))
609 return_text
+= "thread: {}\n".format(thread_info
)
611 return_text
+= "</pre></html>"
616 def _check_valid_url_method(method
, *args
):
619 "URL must contain at least 'main_topic/version/topic'",
620 HTTPStatus
.METHOD_NOT_ALLOWED
,
623 reference
= valid_url_methods
628 if not isinstance(reference
, dict):
630 "URL contains unexpected extra items '{}'".format(arg
),
631 HTTPStatus
.METHOD_NOT_ALLOWED
,
635 reference
= reference
[arg
]
636 elif "<ID>" in reference
:
637 reference
= reference
["<ID>"]
638 elif "*" in reference
:
639 # reference = reference["*"]
643 "Unexpected URL item {}".format(arg
),
644 HTTPStatus
.METHOD_NOT_ALLOWED
,
647 if "TODO" in reference
and method
in reference
["TODO"]:
649 "Method {} not supported yet for this URL".format(method
),
650 HTTPStatus
.NOT_IMPLEMENTED
,
652 elif "METHODS" not in reference
or method
not in reference
["METHODS"]:
654 "Method {} not supported for this URL".format(method
),
655 HTTPStatus
.METHOD_NOT_ALLOWED
,
658 return reference
["ROLE_PERMISSION"] + method
.lower()
661 def _set_location_header(main_topic
, version
, topic
, id):
663 Insert response header Location with the URL of created item base on URL params
670 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
671 cherrypy
.response
.headers
["Location"] = "/ro/{}/{}/{}/{}".format(
672 main_topic
, version
, topic
, id
693 engine_session
= None
696 if not main_topic
or not version
or not topic
:
698 "URL must contain at least 'main_topic/version/topic'",
699 HTTPStatus
.METHOD_NOT_ALLOWED
,
702 if main_topic
not in (
707 "URL main_topic '{}' not supported".format(main_topic
),
708 HTTPStatus
.METHOD_NOT_ALLOWED
,
713 "URL version '{}' not supported".format(version
),
714 HTTPStatus
.METHOD_NOT_ALLOWED
,
719 and "METHOD" in kwargs
720 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
722 method
= kwargs
.pop("METHOD")
724 method
= cherrypy
.request
.method
726 role_permission
= self
._check
_valid
_url
_method
(
727 method
, main_topic
, version
, topic
, _id
, _id2
, *args
, **kwargs
729 # skip token validation if requesting a token
730 indata
= self
._format
_in
(kwargs
)
732 if main_topic
!= "admin" or topic
!= "tokens":
733 token_info
= self
.authenticator
.authorize(role_permission
, _id
)
735 outdata
, created_id
, done
= self
.map_operation
[role_permission
](
736 engine_session
, indata
, version
, _id
, _id2
, *args
, *kwargs
740 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
742 cherrypy
.response
.status
= (
743 HTTPStatus
.ACCEPTED
.value
745 else HTTPStatus
.OK
.value
746 if outdata
is not None
747 else HTTPStatus
.NO_CONTENT
.value
750 return self
._format
_out
(outdata
, token_info
, _format
)
751 except Exception as e
:
764 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
765 http_code_name
= e
.http_code
.name
766 cherrypy
.log("Exception {}".format(e
))
769 cherrypy
.response
.status
770 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
771 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
772 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
774 if hasattr(outdata
, "close"): # is an open file
780 for rollback_item
in rollback
:
782 if rollback_item
.get("operation") == "set":
784 rollback_item
["topic"],
785 {"_id": rollback_item
["_id"]},
786 rollback_item
["content"],
791 rollback_item
["topic"],
792 {"_id": rollback_item
["_id"]},
795 except Exception as e2
:
796 rollback_error_text
= "Rollback Exception {}: {}".format(
799 cherrypy
.log(rollback_error_text
)
800 error_text
+= ". " + rollback_error_text
802 # if isinstance(e, MsgException):
803 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
804 # engine_topic[:-1], method, error_text)
806 "code": http_code_name
,
807 "status": http_code_value
,
808 "detail": error_text
,
811 return self
._format
_out
(problem_details
, token_info
)
812 # raise cherrypy.HTTPError(e.http_code.value, str(e))
815 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
816 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
817 if outdata
.get(logging_id
):
818 cherrypy
.request
.login
+= ";{}={}".format(
819 logging_id
, outdata
[logging_id
][:36]
823 def _start_service():
825 Callback function called when cherrypy.engine starts
826 Override configuration with env variables
827 Set database, storage, message configuration
828 Init database with admin/admin user password
830 global ro_server
, vim_admin_thread
832 cherrypy
.log
.error("Starting osm_ng_ro")
833 # update general cherrypy configuration
835 engine_config
= cherrypy
.tree
.apps
["/ro"].config
837 for k
, v
in environ
.items():
838 if not k
.startswith("OSMRO_"):
841 k1
, _
, k2
= k
[6:].lower().partition("_")
847 if k1
in ("server", "test", "auth", "log"):
848 # update [global] configuration
849 update_dict
[k1
+ "." + k2
] = yaml
.safe_load(v
)
851 # update [/static] configuration
852 engine_config
["/static"]["tools.staticdir." + k2
] = yaml
.safe_load(v
)
854 # update [/] configuration
855 engine_config
["/"]["tools." + k2
.replace("_", ".")] = yaml
.safe_load(v
)
856 elif k1
in ("message", "database", "storage", "authentication", "period"):
857 engine_config
[k1
][k2
] = yaml
.safe_load(v
)
859 except Exception as e
:
860 raise RoException("Cannot load env '{}': {}".format(k
, e
))
863 cherrypy
.config
.update(update_dict
)
864 engine_config
["global"].update(update_dict
)
867 log_format_simple
= (
868 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
870 log_formatter_simple
= logging
.Formatter(
871 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
873 logger_server
= logging
.getLogger("cherrypy.error")
874 logger_access
= logging
.getLogger("cherrypy.access")
875 logger_cherry
= logging
.getLogger("cherrypy")
876 logger
= logging
.getLogger("ro")
878 if "log.file" in engine_config
["global"]:
879 file_handler
= logging
.handlers
.RotatingFileHandler(
880 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
882 file_handler
.setFormatter(log_formatter_simple
)
883 logger_cherry
.addHandler(file_handler
)
884 logger
.addHandler(file_handler
)
886 # log always to standard output
887 for format_
, logger
in {
888 "ro.server %(filename)s:%(lineno)s": logger_server
,
889 "ro.access %(filename)s:%(lineno)s": logger_access
,
890 "%(name)s %(filename)s:%(lineno)s": logger
,
892 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
893 log_formatter_cherry
= logging
.Formatter(
894 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
896 str_handler
= logging
.StreamHandler()
897 str_handler
.setFormatter(log_formatter_cherry
)
898 logger
.addHandler(str_handler
)
900 if engine_config
["global"].get("log.level"):
901 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
902 logger
.setLevel(engine_config
["global"]["log.level"])
904 # logging other modules
910 engine_config
[k1
]["logger_name"] = logname
911 logger_module
= logging
.getLogger(logname
)
913 if "logfile" in engine_config
[k1
]:
914 file_handler
= logging
.handlers
.RotatingFileHandler(
915 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
917 file_handler
.setFormatter(log_formatter_simple
)
918 logger_module
.addHandler(file_handler
)
920 if "loglevel" in engine_config
[k1
]:
921 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
922 # TODO add more entries, e.g.: storage
924 engine_config
["assignment"] = {}
925 # ^ each VIM, SDNc will be assigned one worker id. Ns class will add items and VimThread will auto-assign
926 cherrypy
.tree
.apps
["/ro"].root
.ns
.start(engine_config
)
927 cherrypy
.tree
.apps
["/ro"].root
.authenticator
.start(engine_config
)
928 cherrypy
.tree
.apps
["/ro"].root
.ns
.init_db(target_version
=database_version
)
930 # # start subscriptions thread:
931 vim_admin_thread
= VimAdminThread(config
=engine_config
, engine
=ro_server
.ns
)
932 vim_admin_thread
.start()
933 # # Do not capture except SubscriptionException
935 # backend = engine_config["authentication"]["backend"]
936 # cherrypy.log.error("Starting OSM NBI Version '{} {}' with '{}' authentication backend"
937 # .format(ro_version, ro_version_date, backend))
942 Callback function called when cherrypy.engine stops
943 TODO: Ending database connections.
945 global vim_admin_thread
947 # terminate vim_admin_thread
949 vim_admin_thread
.terminate()
951 vim_admin_thread
= None
952 cherrypy
.tree
.apps
["/ro"].root
.ns
.stop()
953 cherrypy
.log
.error("Stopping osm_ng_ro")
956 def ro_main(config_file
):
960 cherrypy
.engine
.subscribe("start", _start_service
)
961 cherrypy
.engine
.subscribe("stop", _stop_service
)
962 cherrypy
.quickstart(ro_server
, "/ro", config_file
)
967 """Usage: {} [options]
968 -c|--config [configuration_file]: loads the configuration file (default: ./ro.cfg)
969 -h|--help: shows this help
974 # --log-socket-host HOST: send logs to this host")
975 # --log-socket-port PORT: send logs using this port (default: 9022)")
978 if __name__
== "__main__":
980 # load parameters and configuration
981 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
982 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
986 if o
in ("-h", "--help"):
989 elif o
in ("-c", "--config"):
992 raise ValueError("Unhandled option")
995 if not path
.isfile(config_file
):
997 "configuration file '{}' that not exist".format(config_file
),
1002 for config_file
in (
1003 path
.dirname(__file__
) + "/ro.cfg",
1007 if path
.isfile(config_file
):
1011 "No configuration file 'ro.cfg' found neither at local folder nor at /etc/osm/",
1016 ro_main(config_file
)
1017 except KeyboardInterrupt:
1018 print("KeyboardInterrupt. Finishing", file=sys
.stderr
)
1019 except getopt
.GetoptError
as e
:
1020 print(str(e
), file=sys
.stderr
)