30acd2b6100132a56f7f4db542a828346a863591
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": "deploy:",
90 "METHODS": ("GET", "POST", "DELETE"),
91 "ROLE_PERMISSION": "deploy:id:",
94 "ROLE_PERMISSION": "deploy:id:id:",
97 "ROLE_PERMISSION": "deploy:id:id:cancel",
105 "ROLE_PERMISSION": "recreate:id:",
108 "ROLE_PERMISSION": "recreate:id:id:",
115 "ROLE_PERMISSION": "migrate:id:",
118 "ROLE_PERMISSION": "migrate:id:id:",
127 class RoException(Exception):
128 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
129 Exception.__init
__(self
, message
)
130 self
.http_code
= http_code
133 class AuthException(RoException
):
138 def __init__(self
, valid_url_methods
, valid_query_string
):
139 self
.valid_url_methods
= valid_url_methods
140 self
.valid_query_string
= valid_query_string
142 def authorize(self
, *args
, **kwargs
):
143 return {"token": "ok", "id": "ok"}
145 def new_token(self
, token_info
, indata
, remote
):
146 return {"token": "ok", "id": "ok", "remote": remote
}
148 def del_token(self
, token_id
):
151 def start(self
, engine_config
):
155 class Server(object):
157 # to decode bytes to str
158 reader
= getreader("utf-8")
162 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
164 self
.map_operation
= {
165 "token:post": self
.new_token
,
166 "token:id:delete": self
.del_token
,
167 "deploy:get": self
.ns
.get_deploy
,
168 "deploy:id:get": self
.ns
.get_actions
,
169 "deploy:id:post": self
.ns
.deploy
,
170 "deploy:id:delete": self
.ns
.delete
,
171 "deploy:id:id:get": self
.ns
.status
,
172 "deploy:id:id:cancel:post": self
.ns
.cancel
,
173 "recreate:id:post": self
.ns
.recreate
,
174 "recreate:id:id:get": self
.ns
.recreate_status
,
175 "migrate:id:post": self
.ns
.migrate
,
178 def _format_in(self
, kwargs
):
182 if cherrypy
.request
.body
.length
:
183 error_text
= "Invalid input format "
185 if "Content-Type" in cherrypy
.request
.headers
:
186 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
187 error_text
= "Invalid json format "
188 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
189 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
190 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
191 error_text
= "Invalid yaml format "
193 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
195 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
197 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
198 or "application/gzip"
199 in cherrypy
.request
.headers
["Content-Type"]
200 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
201 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
203 indata
= cherrypy
.request
.body
# .read()
205 "multipart/form-data"
206 in cherrypy
.request
.headers
["Content-Type"]
208 if "descriptor_file" in kwargs
:
209 filecontent
= kwargs
.pop("descriptor_file")
211 if not filecontent
.file:
213 "empty file or content", HTTPStatus
.BAD_REQUEST
216 indata
= filecontent
.file # .read()
218 if filecontent
.content_type
.value
:
219 cherrypy
.request
.headers
[
221 ] = filecontent
.content_type
.value
223 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
224 # "Only 'Content-Type' of type 'application/json' or
225 # 'application/yaml' for input format are available")
226 error_text
= "Invalid yaml format "
228 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
230 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
232 error_text
= "Invalid yaml format "
233 indata
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
234 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
240 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
243 for k
, v
in kwargs
.items():
244 if isinstance(v
, str):
249 kwargs
[k
] = yaml
.load(v
, Loader
=yaml
.SafeLoader
)
255 or k
.endswith(".gte")
256 or k
.endswith(".lte")
265 elif v
.find(",") > 0:
266 kwargs
[k
] = v
.split(",")
267 elif isinstance(v
, (list, tuple)):
268 for index
in range(0, len(v
)):
273 v
[index
] = yaml
.load(v
[index
], Loader
=yaml
.SafeLoader
)
278 except (ValueError, yaml
.YAMLError
) as exc
:
279 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
280 except KeyError as exc
:
281 raise RoException("Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
)
282 except Exception as exc
:
283 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
286 def _format_out(data
, token_info
=None, _format
=None):
288 return string of dictionary data according to requested json, yaml, xml. By default json
289 :param data: response to be sent. Can be a dict, text or file
290 :param token_info: Contains among other username and project
291 :param _format: The format to be set as Content-Type if data is a file
294 accept
= cherrypy
.request
.headers
.get("Accept")
297 if accept
and "text/html" in accept
:
299 data
, cherrypy
.request
, cherrypy
.response
, token_info
302 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
304 elif hasattr(data
, "read"): # file object
306 cherrypy
.response
.headers
["Content-Type"] = _format
307 elif "b" in data
.mode
: # binariy asssumig zip
308 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
310 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
312 # TODO check that cherrypy close file. If not implement pending things to close per thread next
316 if "application/json" in accept
:
317 cherrypy
.response
.headers
[
319 ] = "application/json; charset=utf-8"
320 a
= json
.dumps(data
, indent
=4) + "\n"
322 return a
.encode("utf8")
323 elif "text/html" in accept
:
325 data
, cherrypy
.request
, cherrypy
.response
, token_info
328 "application/yaml" in accept
330 or "text/plain" in accept
333 # if there is not any valid accept, raise an error. But if response is already an error, format in yaml
334 elif cherrypy
.response
.status
>= 400:
335 raise cherrypy
.HTTPError(
336 HTTPStatus
.NOT_ACCEPTABLE
.value
,
337 "Only 'Accept' of type 'application/json' or 'application/yaml' "
338 "for output format are available",
341 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
343 return yaml
.safe_dump(
347 default_flow_style
=False,
351 ) # , canonical=True, default_style='"'
354 def index(self
, *args
, **kwargs
):
358 if cherrypy
.request
.method
== "GET":
359 token_info
= self
.authenticator
.authorize()
360 outdata
= token_info
# Home page
362 raise cherrypy
.HTTPError(
363 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
364 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
367 return self
._format
_out
(outdata
, token_info
)
368 except (NsException
, AuthException
) as e
:
369 # cherrypy.log("index Exception {}".format(e))
370 cherrypy
.response
.status
= e
.http_code
.value
372 return self
._format
_out
("Welcome to OSM!", token_info
)
375 def version(self
, *args
, **kwargs
):
376 # TODO consider to remove and provide version using the static version file
378 if cherrypy
.request
.method
!= "GET":
380 "Only method GET is allowed",
381 HTTPStatus
.METHOD_NOT_ALLOWED
,
385 "Invalid URL or query string for version",
386 HTTPStatus
.METHOD_NOT_ALLOWED
,
389 # TODO include version of other modules, pick up from some kafka admin message
390 osm_ng_ro_version
= {"version": ro_version
, "date": ro_version_date
}
392 return self
._format
_out
(osm_ng_ro_version
)
393 except RoException
as e
:
394 cherrypy
.response
.status
= e
.http_code
.value
396 "code": e
.http_code
.name
,
397 "status": e
.http_code
.value
,
401 return self
._format
_out
(problem_details
, None)
403 def new_token(self
, engine_session
, indata
, *args
, **kwargs
):
407 token_info
= self
.authenticator
.authorize()
412 indata
.update(kwargs
)
414 # This is needed to log the user when authentication fails
415 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
416 token_info
= self
.authenticator
.new_token(
417 token_info
, indata
, cherrypy
.request
.remote
419 cherrypy
.session
["Authorization"] = token_info
["id"]
420 self
._set
_location
_header
("admin", "v1", "tokens", token_info
["id"])
423 # cherrypy.response.cookie["Authorization"] = outdata["id"]
424 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
426 return token_info
, token_info
["id"], True
428 def del_token(self
, engine_session
, indata
, version
, _id
, *args
, **kwargs
):
431 if not token_id
and "id" in kwargs
:
432 token_id
= kwargs
["id"]
434 token_info
= self
.authenticator
.authorize()
436 token_id
= token_info
["id"]
438 self
.authenticator
.del_token(token_id
)
440 cherrypy
.session
["Authorization"] = "logout"
441 # cherrypy.response.cookie["Authorization"] = token_id
442 # cherrypy.response.cookie["Authorization"]['expires'] = 0
444 return None, None, True
447 def test(self
, *args
, **kwargs
):
448 if not cherrypy
.config
.get("server.enable_test") or (
449 isinstance(cherrypy
.config
["server.enable_test"], str)
450 and cherrypy
.config
["server.enable_test"].lower() == "false"
452 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
454 return "test URL is disabled"
458 if args
and args
[0] == "help":
460 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
461 "sleep/<time>\nmessage/topic\n</pre></html>"
463 elif args
and args
[0] == "init":
465 # self.ns.load_dbase(cherrypy.request.app.config)
466 self
.ns
.create_admin()
468 return "Done. User 'admin', password 'admin' created"
470 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
472 return self
._format
_out
("Database already initialized")
473 elif args
and args
[0] == "file":
474 return cherrypy
.lib
.static
.serve_file(
475 cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1],
479 elif args
and args
[0] == "file2":
480 f_path
= cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1]
481 f
= open(f_path
, "r")
482 cherrypy
.response
.headers
["Content-type"] = "text/plain"
485 elif len(args
) == 2 and args
[0] == "db-clear":
486 deleted_info
= self
.ns
.db
.del_list(args
[1], kwargs
)
487 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
488 elif len(args
) and args
[0] == "fs-clear":
492 folders
= self
.ns
.fs
.dir_ls(".")
494 for folder
in folders
:
495 self
.ns
.fs
.file_delete(folder
)
497 return ",".join(folders
) + " folders deleted\n"
498 elif args
and args
[0] == "login":
499 if not cherrypy
.request
.headers
.get("Authorization"):
500 cherrypy
.response
.headers
[
502 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
503 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
504 elif args
and args
[0] == "login2":
505 if not cherrypy
.request
.headers
.get("Authorization"):
506 cherrypy
.response
.headers
[
508 ] = 'Bearer realm="Access to OSM site"'
509 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
510 elif args
and args
[0] == "sleep":
514 sleep_time
= int(args
[1])
516 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
517 return self
._format
_out
("Database already initialized")
519 thread_info
= cherrypy
.thread_data
521 time
.sleep(sleep_time
)
523 elif len(args
) >= 2 and args
[0] == "message":
525 return_text
= "<html><pre>{} ->\n".format(main_topic
)
528 if cherrypy
.request
.method
== "POST":
529 to_send
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
530 for k
, v
in to_send
.items():
531 self
.ns
.msg
.write(main_topic
, k
, v
)
532 return_text
+= " {}: {}\n".format(k
, v
)
533 elif cherrypy
.request
.method
== "GET":
534 for k
, v
in kwargs
.items():
536 main_topic
, k
, yaml
.load(v
, Loader
=yaml
.SafeLoader
)
538 return_text
+= " {}: {}\n".format(
539 k
, yaml
.load(v
, Loader
=yaml
.SafeLoader
)
541 except Exception as e
:
542 return_text
+= "Error: " + str(e
)
544 return_text
+= "</pre></html>\n"
549 "<html><pre>\nheaders:\n args: {}\n".format(args
)
550 + " kwargs: {}\n".format(kwargs
)
551 + " headers: {}\n".format(cherrypy
.request
.headers
)
552 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
553 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
554 + " session: {}\n".format(cherrypy
.session
)
555 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
556 + " method: {}\n".format(cherrypy
.request
.method
)
557 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
560 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
562 if cherrypy
.request
.body
.length
:
563 return_text
+= " content: {}\n".format(
565 cherrypy
.request
.body
.read(
566 int(cherrypy
.request
.headers
.get("Content-Length", 0))
572 return_text
+= "thread: {}\n".format(thread_info
)
574 return_text
+= "</pre></html>"
579 def _check_valid_url_method(method
, *args
):
582 "URL must contain at least 'main_topic/version/topic'",
583 HTTPStatus
.METHOD_NOT_ALLOWED
,
586 reference
= valid_url_methods
591 if not isinstance(reference
, dict):
593 "URL contains unexpected extra items '{}'".format(arg
),
594 HTTPStatus
.METHOD_NOT_ALLOWED
,
598 reference
= reference
[arg
]
599 elif "<ID>" in reference
:
600 reference
= reference
["<ID>"]
601 elif "*" in reference
:
602 # reference = reference["*"]
606 "Unexpected URL item {}".format(arg
),
607 HTTPStatus
.METHOD_NOT_ALLOWED
,
610 if "TODO" in reference
and method
in reference
["TODO"]:
612 "Method {} not supported yet for this URL".format(method
),
613 HTTPStatus
.NOT_IMPLEMENTED
,
615 elif "METHODS" not in reference
or method
not in reference
["METHODS"]:
617 "Method {} not supported for this URL".format(method
),
618 HTTPStatus
.METHOD_NOT_ALLOWED
,
621 return reference
["ROLE_PERMISSION"] + method
.lower()
624 def _set_location_header(main_topic
, version
, topic
, id):
626 Insert response header Location with the URL of created item base on URL params
633 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
634 cherrypy
.response
.headers
["Location"] = "/ro/{}/{}/{}/{}".format(
635 main_topic
, version
, topic
, id
656 engine_session
= None
659 if not main_topic
or not version
or not topic
:
661 "URL must contain at least 'main_topic/version/topic'",
662 HTTPStatus
.METHOD_NOT_ALLOWED
,
665 if main_topic
not in (
670 "URL main_topic '{}' not supported".format(main_topic
),
671 HTTPStatus
.METHOD_NOT_ALLOWED
,
676 "URL version '{}' not supported".format(version
),
677 HTTPStatus
.METHOD_NOT_ALLOWED
,
682 and "METHOD" in kwargs
683 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
685 method
= kwargs
.pop("METHOD")
687 method
= cherrypy
.request
.method
689 role_permission
= self
._check
_valid
_url
_method
(
690 method
, main_topic
, version
, topic
, _id
, _id2
, *args
, **kwargs
692 # skip token validation if requesting a token
693 indata
= self
._format
_in
(kwargs
)
695 if main_topic
!= "admin" or topic
!= "tokens":
696 token_info
= self
.authenticator
.authorize(role_permission
, _id
)
698 outdata
, created_id
, done
= self
.map_operation
[role_permission
](
699 engine_session
, indata
, version
, _id
, _id2
, *args
, *kwargs
703 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
705 cherrypy
.response
.status
= (
706 HTTPStatus
.ACCEPTED
.value
708 else HTTPStatus
.OK
.value
709 if outdata
is not None
710 else HTTPStatus
.NO_CONTENT
.value
713 return self
._format
_out
(outdata
, token_info
, _format
)
714 except Exception as e
:
727 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
728 http_code_name
= e
.http_code
.name
729 cherrypy
.log("Exception {}".format(e
))
732 cherrypy
.response
.status
733 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
734 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
735 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
737 if hasattr(outdata
, "close"): # is an open file
743 for rollback_item
in rollback
:
745 if rollback_item
.get("operation") == "set":
747 rollback_item
["topic"],
748 {"_id": rollback_item
["_id"]},
749 rollback_item
["content"],
754 rollback_item
["topic"],
755 {"_id": rollback_item
["_id"]},
758 except Exception as e2
:
759 rollback_error_text
= "Rollback Exception {}: {}".format(
762 cherrypy
.log(rollback_error_text
)
763 error_text
+= ". " + rollback_error_text
765 # if isinstance(e, MsgException):
766 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
767 # engine_topic[:-1], method, error_text)
769 "code": http_code_name
,
770 "status": http_code_value
,
771 "detail": error_text
,
774 return self
._format
_out
(problem_details
, token_info
)
775 # raise cherrypy.HTTPError(e.http_code.value, str(e))
778 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
779 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
780 if outdata
.get(logging_id
):
781 cherrypy
.request
.login
+= ";{}={}".format(
782 logging_id
, outdata
[logging_id
][:36]
786 def _start_service():
788 Callback function called when cherrypy.engine starts
789 Override configuration with env variables
790 Set database, storage, message configuration
791 Init database with admin/admin user password
793 global ro_server
, vim_admin_thread
795 cherrypy
.log
.error("Starting osm_ng_ro")
796 # update general cherrypy configuration
798 engine_config
= cherrypy
.tree
.apps
["/ro"].config
800 for k
, v
in environ
.items():
801 if not k
.startswith("OSMRO_"):
804 k1
, _
, k2
= k
[6:].lower().partition("_")
810 if k1
in ("server", "test", "auth", "log"):
811 # update [global] configuration
812 update_dict
[k1
+ "." + k2
] = yaml
.safe_load(v
)
814 # update [/static] configuration
815 engine_config
["/static"]["tools.staticdir." + k2
] = yaml
.safe_load(v
)
817 # update [/] configuration
818 engine_config
["/"]["tools." + k2
.replace("_", ".")] = yaml
.safe_load(v
)
819 elif k1
in ("message", "database", "storage", "authentication"):
820 engine_config
[k1
][k2
] = yaml
.safe_load(v
)
822 except Exception as e
:
823 raise RoException("Cannot load env '{}': {}".format(k
, e
))
826 cherrypy
.config
.update(update_dict
)
827 engine_config
["global"].update(update_dict
)
830 log_format_simple
= (
831 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
833 log_formatter_simple
= logging
.Formatter(
834 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
836 logger_server
= logging
.getLogger("cherrypy.error")
837 logger_access
= logging
.getLogger("cherrypy.access")
838 logger_cherry
= logging
.getLogger("cherrypy")
839 logger
= logging
.getLogger("ro")
841 if "log.file" in engine_config
["global"]:
842 file_handler
= logging
.handlers
.RotatingFileHandler(
843 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
845 file_handler
.setFormatter(log_formatter_simple
)
846 logger_cherry
.addHandler(file_handler
)
847 logger
.addHandler(file_handler
)
849 # log always to standard output
850 for format_
, logger
in {
851 "ro.server %(filename)s:%(lineno)s": logger_server
,
852 "ro.access %(filename)s:%(lineno)s": logger_access
,
853 "%(name)s %(filename)s:%(lineno)s": logger
,
855 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
856 log_formatter_cherry
= logging
.Formatter(
857 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
859 str_handler
= logging
.StreamHandler()
860 str_handler
.setFormatter(log_formatter_cherry
)
861 logger
.addHandler(str_handler
)
863 if engine_config
["global"].get("log.level"):
864 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
865 logger
.setLevel(engine_config
["global"]["log.level"])
867 # logging other modules
873 engine_config
[k1
]["logger_name"] = logname
874 logger_module
= logging
.getLogger(logname
)
876 if "logfile" in engine_config
[k1
]:
877 file_handler
= logging
.handlers
.RotatingFileHandler(
878 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
880 file_handler
.setFormatter(log_formatter_simple
)
881 logger_module
.addHandler(file_handler
)
883 if "loglevel" in engine_config
[k1
]:
884 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
885 # TODO add more entries, e.g.: storage
887 engine_config
["assignment"] = {}
888 # ^ each VIM, SDNc will be assigned one worker id. Ns class will add items and VimThread will auto-assign
889 cherrypy
.tree
.apps
["/ro"].root
.ns
.start(engine_config
)
890 cherrypy
.tree
.apps
["/ro"].root
.authenticator
.start(engine_config
)
891 cherrypy
.tree
.apps
["/ro"].root
.ns
.init_db(target_version
=database_version
)
893 # # start subscriptions thread:
894 vim_admin_thread
= VimAdminThread(config
=engine_config
, engine
=ro_server
.ns
)
895 vim_admin_thread
.start()
896 # # Do not capture except SubscriptionException
898 # backend = engine_config["authentication"]["backend"]
899 # cherrypy.log.error("Starting OSM NBI Version '{} {}' with '{}' authentication backend"
900 # .format(ro_version, ro_version_date, backend))
905 Callback function called when cherrypy.engine stops
906 TODO: Ending database connections.
908 global vim_admin_thread
910 # terminate vim_admin_thread
912 vim_admin_thread
.terminate()
914 vim_admin_thread
= None
915 cherrypy
.tree
.apps
["/ro"].root
.ns
.stop()
916 cherrypy
.log
.error("Stopping osm_ng_ro")
919 def ro_main(config_file
):
923 cherrypy
.engine
.subscribe("start", _start_service
)
924 cherrypy
.engine
.subscribe("stop", _stop_service
)
925 cherrypy
.quickstart(ro_server
, "/ro", config_file
)
930 """Usage: {} [options]
931 -c|--config [configuration_file]: loads the configuration file (default: ./ro.cfg)
932 -h|--help: shows this help
937 # --log-socket-host HOST: send logs to this host")
938 # --log-socket-port PORT: send logs using this port (default: 9022)")
941 if __name__
== "__main__":
943 # load parameters and configuration
944 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
945 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
949 if o
in ("-h", "--help"):
952 elif o
in ("-c", "--config"):
955 assert False, "Unhandled option"
958 if not path
.isfile(config_file
):
960 "configuration file '{}' that not exist".format(config_file
),
966 path
.dirname(__file__
) + "/ro.cfg",
970 if path
.isfile(config_file
):
974 "No configuration file 'ro.cfg' found neither at local folder nor at /etc/osm/",
980 except KeyboardInterrupt:
981 print("KeyboardInterrupt. Finishing", file=sys
.stderr
)
982 except getopt
.GetoptError
as e
:
983 print(str(e
), file=sys
.stderr
)