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.
21 from codecs
import getreader
23 from http
import HTTPStatus
26 import logging
.handlers
27 from os
import environ
, path
32 from osm_common
.dbbase
import DbException
33 from osm_common
.fsbase
import FsException
34 from osm_common
.msgbase
import MsgException
35 from osm_ng_ro
import version
as ro_version
, version_date
as ro_version_date
36 import osm_ng_ro
.html_out
as html
37 from osm_ng_ro
.ns
import Ns
, NsException
38 from osm_ng_ro
.validation
import ValidationError
39 from osm_ng_ro
.vim_admin
import VimAdminThread
42 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
44 __version__
= "0.1." # file version, not NBI version
45 version_date
= "May 2020"
47 database_version
= "1.2"
48 auth_database_version
= "1.0"
49 ro_server
= None # instance of Server class
50 vim_admin_thread
= None # instance of VimAdminThread class
52 # vim_threads = None # instance of VimThread class
55 RO North Bound Interface
56 URL: /ro GET POST PUT DELETE PATCH
64 valid_query_string
= ("ADMIN", "SET_PROJECT", "FORCE", "PUBLIC")
65 # ^ Contains possible administrative query string words:
66 # ADMIN=True(by default)|Project|Project-list: See all elements, or elements of a project
67 # (not owned by my session project).
68 # PUBLIC=True(by default)|False: See/hide public elements. Set/Unset a topic to be public
69 # FORCE=True(by default)|False: Force edition/deletion operations
70 # SET_PROJECT=Project|Project-list: Add/Delete the topic to the projects portfolio
73 # contains allowed URL and methods, and the role_permission name
78 "ROLE_PERMISSION": "tokens:",
79 "<ID>": {"METHODS": ("DELETE",), "ROLE_PERMISSION": "tokens:id:"},
87 "ROLE_PERMISSION": "deploy:",
89 "METHODS": ("GET", "POST", "DELETE"),
90 "ROLE_PERMISSION": "deploy:id:",
93 "ROLE_PERMISSION": "deploy:id:id:",
96 "ROLE_PERMISSION": "deploy:id:id:cancel",
106 class RoException(Exception):
107 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
108 Exception.__init
__(self
, message
)
109 self
.http_code
= http_code
112 class AuthException(RoException
):
117 def __init__(self
, valid_url_methods
, valid_query_string
):
118 self
.valid_url_methods
= valid_url_methods
119 self
.valid_query_string
= valid_query_string
121 def authorize(self
, *args
, **kwargs
):
122 return {"token": "ok", "id": "ok"}
124 def new_token(self
, token_info
, indata
, remote
):
125 return {"token": "ok", "id": "ok", "remote": remote
}
127 def del_token(self
, token_id
):
130 def start(self
, engine_config
):
134 class Server(object):
136 # to decode bytes to str
137 reader
= getreader("utf-8")
141 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
143 self
.map_operation
= {
144 "token:post": self
.new_token
,
145 "token:id:delete": self
.del_token
,
146 "deploy:get": self
.ns
.get_deploy
,
147 "deploy:id:get": self
.ns
.get_actions
,
148 "deploy:id:post": self
.ns
.deploy
,
149 "deploy:id:delete": self
.ns
.delete
,
150 "deploy:id:id:get": self
.ns
.status
,
151 "deploy:id:id:cancel:post": self
.ns
.cancel
,
154 def _format_in(self
, kwargs
):
158 if cherrypy
.request
.body
.length
:
159 error_text
= "Invalid input format "
161 if "Content-Type" in cherrypy
.request
.headers
:
162 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
163 error_text
= "Invalid json format "
164 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
165 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
166 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
167 error_text
= "Invalid yaml format "
169 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
171 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
173 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
174 or "application/gzip"
175 in cherrypy
.request
.headers
["Content-Type"]
176 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
177 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
179 indata
= cherrypy
.request
.body
# .read()
181 "multipart/form-data"
182 in cherrypy
.request
.headers
["Content-Type"]
184 if "descriptor_file" in kwargs
:
185 filecontent
= kwargs
.pop("descriptor_file")
187 if not filecontent
.file:
189 "empty file or content", HTTPStatus
.BAD_REQUEST
192 indata
= filecontent
.file # .read()
194 if filecontent
.content_type
.value
:
195 cherrypy
.request
.headers
[
197 ] = filecontent
.content_type
.value
199 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
200 # "Only 'Content-Type' of type 'application/json' or
201 # 'application/yaml' for input format are available")
202 error_text
= "Invalid yaml format "
204 cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
206 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
208 error_text
= "Invalid yaml format "
209 indata
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
210 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
216 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
219 for k
, v
in kwargs
.items():
220 if isinstance(v
, str):
225 kwargs
[k
] = yaml
.load(v
, Loader
=yaml
.SafeLoader
)
231 or k
.endswith(".gte")
232 or k
.endswith(".lte")
241 elif v
.find(",") > 0:
242 kwargs
[k
] = v
.split(",")
243 elif isinstance(v
, (list, tuple)):
244 for index
in range(0, len(v
)):
249 v
[index
] = yaml
.load(v
[index
], Loader
=yaml
.SafeLoader
)
254 except (ValueError, yaml
.YAMLError
) as exc
:
255 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
256 except KeyError as exc
:
257 raise RoException("Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
)
258 except Exception as exc
:
259 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
262 def _format_out(data
, token_info
=None, _format
=None):
264 return string of dictionary data according to requested json, yaml, xml. By default json
265 :param data: response to be sent. Can be a dict, text or file
266 :param token_info: Contains among other username and project
267 :param _format: The format to be set as Content-Type if data is a file
270 accept
= cherrypy
.request
.headers
.get("Accept")
273 if accept
and "text/html" in accept
:
275 data
, cherrypy
.request
, cherrypy
.response
, token_info
278 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
280 elif hasattr(data
, "read"): # file object
282 cherrypy
.response
.headers
["Content-Type"] = _format
283 elif "b" in data
.mode
: # binariy asssumig zip
284 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
286 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
288 # TODO check that cherrypy close file. If not implement pending things to close per thread next
292 if "application/json" in accept
:
293 cherrypy
.response
.headers
[
295 ] = "application/json; charset=utf-8"
296 a
= json
.dumps(data
, indent
=4) + "\n"
298 return a
.encode("utf8")
299 elif "text/html" in accept
:
301 data
, cherrypy
.request
, cherrypy
.response
, token_info
304 "application/yaml" in accept
306 or "text/plain" in accept
309 # if there is not any valid accept, raise an error. But if response is already an error, format in yaml
310 elif cherrypy
.response
.status
>= 400:
311 raise cherrypy
.HTTPError(
312 HTTPStatus
.NOT_ACCEPTABLE
.value
,
313 "Only 'Accept' of type 'application/json' or 'application/yaml' "
314 "for output format are available",
317 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
319 return yaml
.safe_dump(
323 default_flow_style
=False,
327 ) # , canonical=True, default_style='"'
330 def index(self
, *args
, **kwargs
):
334 if cherrypy
.request
.method
== "GET":
335 token_info
= self
.authenticator
.authorize()
336 outdata
= token_info
# Home page
338 raise cherrypy
.HTTPError(
339 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
340 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
343 return self
._format
_out
(outdata
, token_info
)
344 except (NsException
, AuthException
) as e
:
345 # cherrypy.log("index Exception {}".format(e))
346 cherrypy
.response
.status
= e
.http_code
.value
348 return self
._format
_out
("Welcome to OSM!", token_info
)
351 def version(self
, *args
, **kwargs
):
352 # TODO consider to remove and provide version using the static version file
354 if cherrypy
.request
.method
!= "GET":
356 "Only method GET is allowed",
357 HTTPStatus
.METHOD_NOT_ALLOWED
,
361 "Invalid URL or query string for version",
362 HTTPStatus
.METHOD_NOT_ALLOWED
,
365 # TODO include version of other modules, pick up from some kafka admin message
366 osm_ng_ro_version
= {"version": ro_version
, "date": ro_version_date
}
368 return self
._format
_out
(osm_ng_ro_version
)
369 except RoException
as e
:
370 cherrypy
.response
.status
= e
.http_code
.value
372 "code": e
.http_code
.name
,
373 "status": e
.http_code
.value
,
377 return self
._format
_out
(problem_details
, None)
379 def new_token(self
, engine_session
, indata
, *args
, **kwargs
):
383 token_info
= self
.authenticator
.authorize()
388 indata
.update(kwargs
)
390 # This is needed to log the user when authentication fails
391 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
392 token_info
= self
.authenticator
.new_token(
393 token_info
, indata
, cherrypy
.request
.remote
395 cherrypy
.session
["Authorization"] = token_info
["id"]
396 self
._set
_location
_header
("admin", "v1", "tokens", token_info
["id"])
399 # cherrypy.response.cookie["Authorization"] = outdata["id"]
400 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
402 return token_info
, token_info
["id"], True
404 def del_token(self
, engine_session
, indata
, version
, _id
, *args
, **kwargs
):
407 if not token_id
and "id" in kwargs
:
408 token_id
= kwargs
["id"]
410 token_info
= self
.authenticator
.authorize()
412 token_id
= token_info
["id"]
414 self
.authenticator
.del_token(token_id
)
416 cherrypy
.session
["Authorization"] = "logout"
417 # cherrypy.response.cookie["Authorization"] = token_id
418 # cherrypy.response.cookie["Authorization"]['expires'] = 0
420 return None, None, True
423 def test(self
, *args
, **kwargs
):
424 if not cherrypy
.config
.get("server.enable_test") or (
425 isinstance(cherrypy
.config
["server.enable_test"], str)
426 and cherrypy
.config
["server.enable_test"].lower() == "false"
428 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
430 return "test URL is disabled"
434 if args
and args
[0] == "help":
436 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
437 "sleep/<time>\nmessage/topic\n</pre></html>"
439 elif args
and args
[0] == "init":
441 # self.ns.load_dbase(cherrypy.request.app.config)
442 self
.ns
.create_admin()
444 return "Done. User 'admin', password 'admin' created"
446 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
448 return self
._format
_out
("Database already initialized")
449 elif args
and args
[0] == "file":
450 return cherrypy
.lib
.static
.serve_file(
451 cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1],
455 elif args
and args
[0] == "file2":
456 f_path
= cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1]
457 f
= open(f_path
, "r")
458 cherrypy
.response
.headers
["Content-type"] = "text/plain"
461 elif len(args
) == 2 and args
[0] == "db-clear":
462 deleted_info
= self
.ns
.db
.del_list(args
[1], kwargs
)
463 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
464 elif len(args
) and args
[0] == "fs-clear":
468 folders
= self
.ns
.fs
.dir_ls(".")
470 for folder
in folders
:
471 self
.ns
.fs
.file_delete(folder
)
473 return ",".join(folders
) + " folders deleted\n"
474 elif args
and args
[0] == "login":
475 if not cherrypy
.request
.headers
.get("Authorization"):
476 cherrypy
.response
.headers
[
478 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
479 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
480 elif args
and args
[0] == "login2":
481 if not cherrypy
.request
.headers
.get("Authorization"):
482 cherrypy
.response
.headers
[
484 ] = 'Bearer realm="Access to OSM site"'
485 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
486 elif args
and args
[0] == "sleep":
490 sleep_time
= int(args
[1])
492 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
493 return self
._format
_out
("Database already initialized")
495 thread_info
= cherrypy
.thread_data
497 time
.sleep(sleep_time
)
499 elif len(args
) >= 2 and args
[0] == "message":
501 return_text
= "<html><pre>{} ->\n".format(main_topic
)
504 if cherrypy
.request
.method
== "POST":
505 to_send
= yaml
.load(cherrypy
.request
.body
, Loader
=yaml
.SafeLoader
)
506 for k
, v
in to_send
.items():
507 self
.ns
.msg
.write(main_topic
, k
, v
)
508 return_text
+= " {}: {}\n".format(k
, v
)
509 elif cherrypy
.request
.method
== "GET":
510 for k
, v
in kwargs
.items():
512 main_topic
, k
, yaml
.load(v
, Loader
=yaml
.SafeLoader
)
514 return_text
+= " {}: {}\n".format(
515 k
, yaml
.load(v
, Loader
=yaml
.SafeLoader
)
517 except Exception as e
:
518 return_text
+= "Error: " + str(e
)
520 return_text
+= "</pre></html>\n"
525 "<html><pre>\nheaders:\n args: {}\n".format(args
)
526 + " kwargs: {}\n".format(kwargs
)
527 + " headers: {}\n".format(cherrypy
.request
.headers
)
528 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
529 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
530 + " session: {}\n".format(cherrypy
.session
)
531 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
532 + " method: {}\n".format(cherrypy
.request
.method
)
533 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
536 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
538 if cherrypy
.request
.body
.length
:
539 return_text
+= " content: {}\n".format(
541 cherrypy
.request
.body
.read(
542 int(cherrypy
.request
.headers
.get("Content-Length", 0))
548 return_text
+= "thread: {}\n".format(thread_info
)
550 return_text
+= "</pre></html>"
555 def _check_valid_url_method(method
, *args
):
558 "URL must contain at least 'main_topic/version/topic'",
559 HTTPStatus
.METHOD_NOT_ALLOWED
,
562 reference
= valid_url_methods
567 if not isinstance(reference
, dict):
569 "URL contains unexpected extra items '{}'".format(arg
),
570 HTTPStatus
.METHOD_NOT_ALLOWED
,
574 reference
= reference
[arg
]
575 elif "<ID>" in reference
:
576 reference
= reference
["<ID>"]
577 elif "*" in reference
:
578 # reference = reference["*"]
582 "Unexpected URL item {}".format(arg
),
583 HTTPStatus
.METHOD_NOT_ALLOWED
,
586 if "TODO" in reference
and method
in reference
["TODO"]:
588 "Method {} not supported yet for this URL".format(method
),
589 HTTPStatus
.NOT_IMPLEMENTED
,
591 elif "METHODS" not in reference
or method
not in reference
["METHODS"]:
593 "Method {} not supported for this URL".format(method
),
594 HTTPStatus
.METHOD_NOT_ALLOWED
,
597 return reference
["ROLE_PERMISSION"] + method
.lower()
600 def _set_location_header(main_topic
, version
, topic
, id):
602 Insert response header Location with the URL of created item base on URL params
609 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
610 cherrypy
.response
.headers
["Location"] = "/ro/{}/{}/{}/{}".format(
611 main_topic
, version
, topic
, id
632 engine_session
= None
635 if not main_topic
or not version
or not topic
:
637 "URL must contain at least 'main_topic/version/topic'",
638 HTTPStatus
.METHOD_NOT_ALLOWED
,
641 if main_topic
not in (
646 "URL main_topic '{}' not supported".format(main_topic
),
647 HTTPStatus
.METHOD_NOT_ALLOWED
,
652 "URL version '{}' not supported".format(version
),
653 HTTPStatus
.METHOD_NOT_ALLOWED
,
658 and "METHOD" in kwargs
659 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
661 method
= kwargs
.pop("METHOD")
663 method
= cherrypy
.request
.method
665 role_permission
= self
._check
_valid
_url
_method
(
666 method
, main_topic
, version
, topic
, _id
, _id2
, *args
, **kwargs
668 # skip token validation if requesting a token
669 indata
= self
._format
_in
(kwargs
)
671 if main_topic
!= "admin" or topic
!= "tokens":
672 token_info
= self
.authenticator
.authorize(role_permission
, _id
)
674 outdata
, created_id
, done
= self
.map_operation
[role_permission
](
675 engine_session
, indata
, version
, _id
, _id2
, *args
, *kwargs
679 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
681 cherrypy
.response
.status
= (
682 HTTPStatus
.ACCEPTED
.value
684 else HTTPStatus
.OK
.value
685 if outdata
is not None
686 else HTTPStatus
.NO_CONTENT
.value
689 return self
._format
_out
(outdata
, token_info
, _format
)
690 except Exception as e
:
703 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
704 http_code_name
= e
.http_code
.name
705 cherrypy
.log("Exception {}".format(e
))
708 cherrypy
.response
.status
709 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
710 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
711 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
713 if hasattr(outdata
, "close"): # is an open file
719 for rollback_item
in rollback
:
721 if rollback_item
.get("operation") == "set":
723 rollback_item
["topic"],
724 {"_id": rollback_item
["_id"]},
725 rollback_item
["content"],
730 rollback_item
["topic"],
731 {"_id": rollback_item
["_id"]},
734 except Exception as e2
:
735 rollback_error_text
= "Rollback Exception {}: {}".format(
738 cherrypy
.log(rollback_error_text
)
739 error_text
+= ". " + rollback_error_text
741 # if isinstance(e, MsgException):
742 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
743 # engine_topic[:-1], method, error_text)
745 "code": http_code_name
,
746 "status": http_code_value
,
747 "detail": error_text
,
750 return self
._format
_out
(problem_details
, token_info
)
751 # raise cherrypy.HTTPError(e.http_code.value, str(e))
754 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
755 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
756 if outdata
.get(logging_id
):
757 cherrypy
.request
.login
+= ";{}={}".format(
758 logging_id
, outdata
[logging_id
][:36]
762 def _start_service():
764 Callback function called when cherrypy.engine starts
765 Override configuration with env variables
766 Set database, storage, message configuration
767 Init database with admin/admin user password
769 global ro_server
, vim_admin_thread
771 cherrypy
.log
.error("Starting osm_ng_ro")
772 # update general cherrypy configuration
774 engine_config
= cherrypy
.tree
.apps
["/ro"].config
776 for k
, v
in environ
.items():
777 if not k
.startswith("OSMRO_"):
780 k1
, _
, k2
= k
[6:].lower().partition("_")
786 if k1
in ("server", "test", "auth", "log"):
787 # update [global] configuration
788 update_dict
[k1
+ "." + k2
] = yaml
.safe_load(v
)
790 # update [/static] configuration
791 engine_config
["/static"]["tools.staticdir." + k2
] = yaml
.safe_load(v
)
793 # update [/] configuration
794 engine_config
["/"]["tools." + k2
.replace("_", ".")] = yaml
.safe_load(v
)
795 elif k1
in ("message", "database", "storage", "authentication", "period"):
796 engine_config
[k1
][k2
] = yaml
.safe_load(v
)
798 except Exception as e
:
799 raise RoException("Cannot load env '{}': {}".format(k
, e
))
802 cherrypy
.config
.update(update_dict
)
803 engine_config
["global"].update(update_dict
)
806 log_format_simple
= (
807 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
809 log_formatter_simple
= logging
.Formatter(
810 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
812 logger_server
= logging
.getLogger("cherrypy.error")
813 logger_access
= logging
.getLogger("cherrypy.access")
814 logger_cherry
= logging
.getLogger("cherrypy")
815 logger
= logging
.getLogger("ro")
817 if "log.file" in engine_config
["global"]:
818 file_handler
= logging
.handlers
.RotatingFileHandler(
819 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
821 file_handler
.setFormatter(log_formatter_simple
)
822 logger_cherry
.addHandler(file_handler
)
823 logger
.addHandler(file_handler
)
825 # log always to standard output
826 for format_
, logger
in {
827 "ro.server %(filename)s:%(lineno)s": logger_server
,
828 "ro.access %(filename)s:%(lineno)s": logger_access
,
829 "%(name)s %(filename)s:%(lineno)s": logger
,
831 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
832 log_formatter_cherry
= logging
.Formatter(
833 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
835 str_handler
= logging
.StreamHandler()
836 str_handler
.setFormatter(log_formatter_cherry
)
837 logger
.addHandler(str_handler
)
839 if engine_config
["global"].get("log.level"):
840 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
841 logger
.setLevel(engine_config
["global"]["log.level"])
843 # logging other modules
849 engine_config
[k1
]["logger_name"] = logname
850 logger_module
= logging
.getLogger(logname
)
852 if "logfile" in engine_config
[k1
]:
853 file_handler
= logging
.handlers
.RotatingFileHandler(
854 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
856 file_handler
.setFormatter(log_formatter_simple
)
857 logger_module
.addHandler(file_handler
)
859 if "loglevel" in engine_config
[k1
]:
860 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
861 # TODO add more entries, e.g.: storage
863 engine_config
["assignment"] = {}
864 # ^ each VIM, SDNc will be assigned one worker id. Ns class will add items and VimThread will auto-assign
865 cherrypy
.tree
.apps
["/ro"].root
.ns
.start(engine_config
)
866 cherrypy
.tree
.apps
["/ro"].root
.authenticator
.start(engine_config
)
867 cherrypy
.tree
.apps
["/ro"].root
.ns
.init_db(target_version
=database_version
)
869 # # start subscriptions thread:
870 vim_admin_thread
= VimAdminThread(config
=engine_config
, engine
=ro_server
.ns
)
871 vim_admin_thread
.start()
872 # # Do not capture except SubscriptionException
874 # backend = engine_config["authentication"]["backend"]
875 # cherrypy.log.error("Starting OSM NBI Version '{} {}' with '{}' authentication backend"
876 # .format(ro_version, ro_version_date, backend))
881 Callback function called when cherrypy.engine stops
882 TODO: Ending database connections.
884 global vim_admin_thread
886 # terminate vim_admin_thread
888 vim_admin_thread
.terminate()
890 vim_admin_thread
= None
891 cherrypy
.tree
.apps
["/ro"].root
.ns
.stop()
892 cherrypy
.log
.error("Stopping osm_ng_ro")
895 def ro_main(config_file
):
899 cherrypy
.engine
.subscribe("start", _start_service
)
900 cherrypy
.engine
.subscribe("stop", _stop_service
)
901 cherrypy
.quickstart(ro_server
, "/ro", config_file
)
906 """Usage: {} [options]
907 -c|--config [configuration_file]: loads the configuration file (default: ./ro.cfg)
908 -h|--help: shows this help
913 # --log-socket-host HOST: send logs to this host")
914 # --log-socket-port PORT: send logs using this port (default: 9022)")
917 if __name__
== "__main__":
919 # load parameters and configuration
920 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
921 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
925 if o
in ("-h", "--help"):
928 elif o
in ("-c", "--config"):
931 assert False, "Unhandled option"
934 if not path
.isfile(config_file
):
936 "configuration file '{}' that not exist".format(config_file
),
942 path
.dirname(__file__
) + "/ro.cfg",
946 if path
.isfile(config_file
):
950 "No configuration file 'ro.cfg' found neither at local folder nor at /etc/osm/",
956 except KeyboardInterrupt:
957 print("KeyboardInterrupt. Finishing", file=sys
.stderr
)
958 except getopt
.GetoptError
as e
:
959 print(str(e
), file=sys
.stderr
)