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
.monitor
import start_monitoring
, stop_monitoring
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
43 __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",
107 class RoException(Exception):
108 def __init__(self
, message
, http_code
=HTTPStatus
.METHOD_NOT_ALLOWED
):
109 Exception.__init
__(self
, message
)
110 self
.http_code
= http_code
113 class AuthException(RoException
):
118 def __init__(self
, valid_url_methods
, valid_query_string
):
119 self
.valid_url_methods
= valid_url_methods
120 self
.valid_query_string
= valid_query_string
122 def authorize(self
, *args
, **kwargs
):
123 return {"token": "ok", "id": "ok"}
125 def new_token(self
, token_info
, indata
, remote
):
126 return {"token": "ok", "id": "ok", "remote": remote
}
128 def del_token(self
, token_id
):
131 def start(self
, engine_config
):
135 class Server(object):
137 # to decode bytes to str
138 reader
= getreader("utf-8")
142 self
.authenticator
= Authenticator(valid_url_methods
, valid_query_string
)
144 self
.map_operation
= {
145 "token:post": self
.new_token
,
146 "token:id:delete": self
.del_token
,
147 "deploy:get": self
.ns
.get_deploy
,
148 "deploy:id:get": self
.ns
.get_actions
,
149 "deploy:id:post": self
.ns
.deploy
,
150 "deploy:id:delete": self
.ns
.delete
,
151 "deploy:id:id:get": self
.ns
.status
,
152 "deploy:id:id:cancel:post": self
.ns
.cancel
,
155 def _format_in(self
, kwargs
):
159 if cherrypy
.request
.body
.length
:
160 error_text
= "Invalid input format "
162 if "Content-Type" in cherrypy
.request
.headers
:
163 if "application/json" in cherrypy
.request
.headers
["Content-Type"]:
164 error_text
= "Invalid json format "
165 indata
= json
.load(self
.reader(cherrypy
.request
.body
))
166 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
167 elif "application/yaml" in cherrypy
.request
.headers
["Content-Type"]:
168 error_text
= "Invalid yaml format "
169 indata
= yaml
.safe_load(cherrypy
.request
.body
)
170 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
172 "application/binary" in cherrypy
.request
.headers
["Content-Type"]
173 or "application/gzip"
174 in cherrypy
.request
.headers
["Content-Type"]
175 or "application/zip" in cherrypy
.request
.headers
["Content-Type"]
176 or "text/plain" in cherrypy
.request
.headers
["Content-Type"]
178 indata
= cherrypy
.request
.body
# .read()
180 "multipart/form-data"
181 in cherrypy
.request
.headers
["Content-Type"]
183 if "descriptor_file" in kwargs
:
184 filecontent
= kwargs
.pop("descriptor_file")
186 if not filecontent
.file:
188 "empty file or content", HTTPStatus
.BAD_REQUEST
191 indata
= filecontent
.file # .read()
193 if filecontent
.content_type
.value
:
194 cherrypy
.request
.headers
[
196 ] = filecontent
.content_type
.value
198 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
199 # "Only 'Content-Type' of type 'application/json' or
200 # 'application/yaml' for input format are available")
201 error_text
= "Invalid yaml format "
202 indata
= yaml
.safe_load(cherrypy
.request
.body
)
203 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
205 error_text
= "Invalid yaml format "
206 indata
= yaml
.safe_load(cherrypy
.request
.body
)
207 cherrypy
.request
.headers
.pop("Content-File-MD5", None)
213 if cherrypy
.request
.headers
.get("Query-String-Format") == "yaml":
216 for k
, v
in kwargs
.items():
217 if isinstance(v
, str):
222 kwargs
[k
] = yaml
.safe_load(v
)
223 except Exception as yaml_error
:
225 f
"{yaml_error} occured while parsing the yaml"
230 or k
.endswith(".gte")
231 or k
.endswith(".lte")
238 except Exception as keyword_error
:
240 f
"{keyword_error} occured while getting the keyword arguments"
242 elif v
.find(",") > 0:
243 kwargs
[k
] = v
.split(",")
244 elif isinstance(v
, (list, tuple)):
245 for index
in range(0, len(v
)):
250 v
[index
] = yaml
.safe_load(v
[index
])
251 except Exception as error
:
253 f
"{error} occured while parsing the yaml"
257 except (ValueError, yaml
.YAMLError
) as exc
:
258 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
259 except KeyError as exc
:
260 raise RoException("Query string error: " + str(exc
), HTTPStatus
.BAD_REQUEST
)
261 except Exception as exc
:
262 raise RoException(error_text
+ str(exc
), HTTPStatus
.BAD_REQUEST
)
265 def _format_out(data
, token_info
=None, _format
=None):
267 return string of dictionary data according to requested json, yaml, xml. By default json
268 :param data: response to be sent. Can be a dict, text or file
269 :param token_info: Contains among other username and project
270 :param _format: The format to be set as Content-Type if data is a file
273 accept
= cherrypy
.request
.headers
.get("Accept")
276 if accept
and "text/html" in accept
:
278 data
, cherrypy
.request
, cherrypy
.response
, token_info
281 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
283 elif hasattr(data
, "read"): # file object
285 cherrypy
.response
.headers
["Content-Type"] = _format
286 elif "b" in data
.mode
: # binariy asssumig zip
287 cherrypy
.response
.headers
["Content-Type"] = "application/zip"
289 cherrypy
.response
.headers
["Content-Type"] = "text/plain"
291 # TODO check that cherrypy close file. If not implement pending things to close per thread next
295 if "application/json" in accept
:
296 cherrypy
.response
.headers
[
298 ] = "application/json; charset=utf-8"
299 a
= json
.dumps(data
, indent
=4) + "\n"
301 return a
.encode("utf8")
302 elif "text/html" in accept
:
304 data
, cherrypy
.request
, cherrypy
.response
, token_info
307 "application/yaml" in accept
309 or "text/plain" in accept
312 # if there is not any valid accept, raise an error. But if response is already an error, format in yaml
313 elif cherrypy
.response
.status
>= 400:
314 raise cherrypy
.HTTPError(
315 HTTPStatus
.NOT_ACCEPTABLE
.value
,
316 "Only 'Accept' of type 'application/json' or 'application/yaml' "
317 "for output format are available",
320 cherrypy
.response
.headers
["Content-Type"] = "application/yaml"
322 return yaml
.safe_dump(
326 default_flow_style
=False,
330 ) # , canonical=True, default_style='"'
333 def index(self
, *args
, **kwargs
):
337 if cherrypy
.request
.method
== "GET":
338 token_info
= self
.authenticator
.authorize()
339 outdata
= token_info
# Home page
341 raise cherrypy
.HTTPError(
342 HTTPStatus
.METHOD_NOT_ALLOWED
.value
,
343 "Method {} not allowed for tokens".format(cherrypy
.request
.method
),
346 return self
._format
_out
(outdata
, token_info
)
347 except (NsException
, AuthException
) as e
:
348 # cherrypy.log("index Exception {}".format(e))
349 cherrypy
.response
.status
= e
.http_code
.value
351 return self
._format
_out
("Welcome to OSM!", token_info
)
354 def version(self
, *args
, **kwargs
):
355 # TODO consider to remove and provide version using the static version file
357 if cherrypy
.request
.method
!= "GET":
359 "Only method GET is allowed",
360 HTTPStatus
.METHOD_NOT_ALLOWED
,
364 "Invalid URL or query string for version",
365 HTTPStatus
.METHOD_NOT_ALLOWED
,
368 # TODO include version of other modules, pick up from some kafka admin message
369 osm_ng_ro_version
= {"version": ro_version
, "date": ro_version_date
}
371 return self
._format
_out
(osm_ng_ro_version
)
372 except RoException
as e
:
373 cherrypy
.response
.status
= e
.http_code
.value
375 "code": e
.http_code
.name
,
376 "status": e
.http_code
.value
,
380 return self
._format
_out
(problem_details
, None)
382 def new_token(self
, engine_session
, indata
, *args
, **kwargs
):
386 token_info
= self
.authenticator
.authorize()
391 indata
.update(kwargs
)
393 # This is needed to log the user when authentication fails
394 cherrypy
.request
.login
= "{}".format(indata
.get("username", "-"))
395 token_info
= self
.authenticator
.new_token(
396 token_info
, indata
, cherrypy
.request
.remote
398 cherrypy
.session
["Authorization"] = token_info
["id"]
399 self
._set
_location
_header
("admin", "v1", "tokens", token_info
["id"])
402 # cherrypy.response.cookie["Authorization"] = outdata["id"]
403 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
405 return token_info
, token_info
["id"], True
407 def del_token(self
, engine_session
, indata
, version
, _id
, *args
, **kwargs
):
410 if not token_id
and "id" in kwargs
:
411 token_id
= kwargs
["id"]
413 token_info
= self
.authenticator
.authorize()
415 token_id
= token_info
["id"]
417 self
.authenticator
.del_token(token_id
)
419 cherrypy
.session
["Authorization"] = "logout"
420 # cherrypy.response.cookie["Authorization"] = token_id
421 # cherrypy.response.cookie["Authorization"]['expires'] = 0
423 return None, None, True
426 def test(self
, *args
, **kwargs
):
427 if not cherrypy
.config
.get("server.enable_test") or (
428 isinstance(cherrypy
.config
["server.enable_test"], str)
429 and cherrypy
.config
["server.enable_test"].lower() == "false"
431 cherrypy
.response
.status
= HTTPStatus
.METHOD_NOT_ALLOWED
.value
433 return "test URL is disabled"
437 if args
and args
[0] == "help":
439 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
440 "sleep/<time>\nmessage/topic\n</pre></html>"
442 elif args
and args
[0] == "init":
444 # self.ns.load_dbase(cherrypy.request.app.config)
445 self
.ns
.create_admin()
447 return "Done. User 'admin', password 'admin' created"
449 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
451 return self
._format
_out
("Database already initialized")
452 elif args
and args
[0] == "file":
453 return cherrypy
.lib
.static
.serve_file(
454 cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1],
458 elif args
and args
[0] == "file2":
459 f_path
= cherrypy
.tree
.apps
["/ro"].config
["storage"]["path"] + "/" + args
[1]
460 f
= open(f_path
, "r")
461 cherrypy
.response
.headers
["Content-type"] = "text/plain"
464 elif len(args
) == 2 and args
[0] == "db-clear":
465 deleted_info
= self
.ns
.db
.del_list(args
[1], kwargs
)
466 return "{} {} deleted\n".format(deleted_info
["deleted"], args
[1])
467 elif len(args
) and args
[0] == "fs-clear":
471 folders
= self
.ns
.fs
.dir_ls(".")
473 for folder
in folders
:
474 self
.ns
.fs
.file_delete(folder
)
476 return ",".join(folders
) + " folders deleted\n"
477 elif args
and args
[0] == "login":
478 if not cherrypy
.request
.headers
.get("Authorization"):
479 cherrypy
.response
.headers
[
481 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
482 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
483 elif args
and args
[0] == "login2":
484 if not cherrypy
.request
.headers
.get("Authorization"):
485 cherrypy
.response
.headers
[
487 ] = 'Bearer realm="Access to OSM site"'
488 cherrypy
.response
.status
= HTTPStatus
.UNAUTHORIZED
.value
489 elif args
and args
[0] == "sleep":
493 sleep_time
= int(args
[1])
495 cherrypy
.response
.status
= HTTPStatus
.FORBIDDEN
.value
496 return self
._format
_out
("Database already initialized")
498 thread_info
= cherrypy
.thread_data
500 time
.sleep(sleep_time
)
502 elif len(args
) >= 2 and args
[0] == "message":
504 return_text
= "<html><pre>{} ->\n".format(main_topic
)
507 if cherrypy
.request
.method
== "POST":
508 to_send
= yaml
.safe_load(cherrypy
.request
.body
)
509 for k
, v
in to_send
.items():
510 self
.ns
.msg
.write(main_topic
, k
, v
)
511 return_text
+= " {}: {}\n".format(k
, v
)
512 elif cherrypy
.request
.method
== "GET":
513 for k
, v
in kwargs
.items():
514 self
.ns
.msg
.write(main_topic
, k
, yaml
.safe_load(v
))
515 return_text
+= " {}: {}\n".format(k
, yaml
.safe_load(v
))
516 except Exception as e
:
517 return_text
+= "Error: " + str(e
)
519 return_text
+= "</pre></html>\n"
524 "<html><pre>\nheaders:\n args: {}\n".format(args
)
525 + " kwargs: {}\n".format(kwargs
)
526 + " headers: {}\n".format(cherrypy
.request
.headers
)
527 + " path_info: {}\n".format(cherrypy
.request
.path_info
)
528 + " query_string: {}\n".format(cherrypy
.request
.query_string
)
529 + " session: {}\n".format(cherrypy
.session
)
530 + " cookie: {}\n".format(cherrypy
.request
.cookie
)
531 + " method: {}\n".format(cherrypy
.request
.method
)
532 + " session: {}\n".format(cherrypy
.session
.get("fieldname"))
535 return_text
+= " length: {}\n".format(cherrypy
.request
.body
.length
)
537 if cherrypy
.request
.body
.length
:
538 return_text
+= " content: {}\n".format(
540 cherrypy
.request
.body
.read(
541 int(cherrypy
.request
.headers
.get("Content-Length", 0))
547 return_text
+= "thread: {}\n".format(thread_info
)
549 return_text
+= "</pre></html>"
554 def _check_valid_url_method(method
, *args
):
557 "URL must contain at least 'main_topic/version/topic'",
558 HTTPStatus
.METHOD_NOT_ALLOWED
,
561 reference
= valid_url_methods
566 if not isinstance(reference
, dict):
568 "URL contains unexpected extra items '{}'".format(arg
),
569 HTTPStatus
.METHOD_NOT_ALLOWED
,
573 reference
= reference
[arg
]
574 elif "<ID>" in reference
:
575 reference
= reference
["<ID>"]
576 elif "*" in reference
:
577 # reference = reference["*"]
581 "Unexpected URL item {}".format(arg
),
582 HTTPStatus
.METHOD_NOT_ALLOWED
,
585 if "TODO" in reference
and method
in reference
["TODO"]:
587 "Method {} not supported yet for this URL".format(method
),
588 HTTPStatus
.NOT_IMPLEMENTED
,
590 elif "METHODS" not in reference
or method
not in reference
["METHODS"]:
592 "Method {} not supported for this URL".format(method
),
593 HTTPStatus
.METHOD_NOT_ALLOWED
,
596 return reference
["ROLE_PERMISSION"] + method
.lower()
599 def _set_location_header(main_topic
, version
, topic
, id):
601 Insert response header Location with the URL of created item base on URL params
608 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
609 cherrypy
.response
.headers
["Location"] = "/ro/{}/{}/{}/{}".format(
610 main_topic
, version
, topic
, id
631 engine_session
= None
634 if not main_topic
or not version
or not topic
:
636 "URL must contain at least 'main_topic/version/topic'",
637 HTTPStatus
.METHOD_NOT_ALLOWED
,
640 if main_topic
not in (
645 "URL main_topic '{}' not supported".format(main_topic
),
646 HTTPStatus
.METHOD_NOT_ALLOWED
,
651 "URL version '{}' not supported".format(version
),
652 HTTPStatus
.METHOD_NOT_ALLOWED
,
657 and "METHOD" in kwargs
658 and kwargs
["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
660 method
= kwargs
.pop("METHOD")
662 method
= cherrypy
.request
.method
664 role_permission
= self
._check
_valid
_url
_method
(
665 method
, main_topic
, version
, topic
, _id
, _id2
, *args
, **kwargs
667 # skip token validation if requesting a token
668 indata
= self
._format
_in
(kwargs
)
670 if main_topic
!= "admin" or topic
!= "tokens":
671 token_info
= self
.authenticator
.authorize(role_permission
, _id
)
673 outdata
, created_id
, done
= self
.map_operation
[role_permission
](
674 engine_session
, indata
, version
, _id
, _id2
, *args
, *kwargs
678 self
._set
_location
_header
(main_topic
, version
, topic
, _id
)
680 cherrypy
.response
.status
= (
681 HTTPStatus
.ACCEPTED
.value
683 else HTTPStatus
.OK
.value
684 if outdata
is not None
685 else HTTPStatus
.NO_CONTENT
.value
688 return self
._format
_out
(outdata
, token_info
, _format
)
689 except Exception as e
:
702 http_code_value
= cherrypy
.response
.status
= e
.http_code
.value
703 http_code_name
= e
.http_code
.name
704 cherrypy
.log("Exception {}".format(e
))
707 cherrypy
.response
.status
708 ) = HTTPStatus
.BAD_REQUEST
.value
# INTERNAL_SERVER_ERROR
709 cherrypy
.log("CRITICAL: Exception {}".format(e
), traceback
=True)
710 http_code_name
= HTTPStatus
.BAD_REQUEST
.name
712 if hasattr(outdata
, "close"): # is an open file
718 for rollback_item
in rollback
:
720 if rollback_item
.get("operation") == "set":
722 rollback_item
["topic"],
723 {"_id": rollback_item
["_id"]},
724 rollback_item
["content"],
729 rollback_item
["topic"],
730 {"_id": rollback_item
["_id"]},
733 except Exception as e2
:
734 rollback_error_text
= "Rollback Exception {}: {}".format(
737 cherrypy
.log(rollback_error_text
)
738 error_text
+= ". " + rollback_error_text
740 # if isinstance(e, MsgException):
741 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
742 # engine_topic[:-1], method, error_text)
744 "code": http_code_name
,
745 "status": http_code_value
,
746 "detail": error_text
,
749 return self
._format
_out
(problem_details
, token_info
)
750 # raise cherrypy.HTTPError(e.http_code.value, str(e))
753 if method
in ("PUT", "PATCH", "POST") and isinstance(outdata
, dict):
754 for logging_id
in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
755 if outdata
.get(logging_id
):
756 cherrypy
.request
.login
+= ";{}={}".format(
757 logging_id
, outdata
[logging_id
][:36]
761 def _start_service():
763 Callback function called when cherrypy.engine starts
764 Override configuration with env variables
765 Set database, storage, message configuration
766 Init database with admin/admin user password
768 global ro_server
, vim_admin_thread
770 cherrypy
.log
.error("Starting osm_ng_ro")
771 # update general cherrypy configuration
773 engine_config
= cherrypy
.tree
.apps
["/ro"].config
775 for k
, v
in environ
.items():
776 if not k
.startswith("OSMRO_"):
779 k1
, _
, k2
= k
[6:].lower().partition("_")
785 if k1
in ("server", "test", "auth", "log"):
786 # update [global] configuration
787 update_dict
[k1
+ "." + k2
] = yaml
.safe_load(v
)
789 # update [/static] configuration
790 engine_config
["/static"]["tools.staticdir." + k2
] = yaml
.safe_load(v
)
792 # update [/] configuration
793 engine_config
["/"]["tools." + k2
.replace("_", ".")] = yaml
.safe_load(v
)
794 elif k1
in ("message", "database", "storage", "authentication", "period"):
795 engine_config
[k1
][k2
] = yaml
.safe_load(v
)
797 except Exception as e
:
798 raise RoException("Cannot load env '{}': {}".format(k
, e
))
801 cherrypy
.config
.update(update_dict
)
802 engine_config
["global"].update(update_dict
)
805 log_format_simple
= (
806 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
808 log_formatter_simple
= logging
.Formatter(
809 log_format_simple
, datefmt
="%Y-%m-%dT%H:%M:%S"
811 logger_server
= logging
.getLogger("cherrypy.error")
812 logger_access
= logging
.getLogger("cherrypy.access")
813 logger_cherry
= logging
.getLogger("cherrypy")
814 logger
= logging
.getLogger("ro")
816 if "log.file" in engine_config
["global"]:
817 file_handler
= logging
.handlers
.RotatingFileHandler(
818 engine_config
["global"]["log.file"], maxBytes
=100e6
, backupCount
=9, delay
=0
820 file_handler
.setFormatter(log_formatter_simple
)
821 logger_cherry
.addHandler(file_handler
)
822 logger
.addHandler(file_handler
)
824 # log always to standard output
825 for format_
, logger
in {
826 "ro.server %(filename)s:%(lineno)s": logger_server
,
827 "ro.access %(filename)s:%(lineno)s": logger_access
,
828 "%(name)s %(filename)s:%(lineno)s": logger
,
830 log_format_cherry
= "%(asctime)s %(levelname)s {} %(message)s".format(format_
)
831 log_formatter_cherry
= logging
.Formatter(
832 log_format_cherry
, datefmt
="%Y-%m-%dT%H:%M:%S"
834 str_handler
= logging
.StreamHandler()
835 str_handler
.setFormatter(log_formatter_cherry
)
836 logger
.addHandler(str_handler
)
838 if engine_config
["global"].get("log.level"):
839 logger_cherry
.setLevel(engine_config
["global"]["log.level"])
840 logger
.setLevel(engine_config
["global"]["log.level"])
842 # logging other modules
848 engine_config
[k1
]["logger_name"] = logname
849 logger_module
= logging
.getLogger(logname
)
851 if "logfile" in engine_config
[k1
]:
852 file_handler
= logging
.handlers
.RotatingFileHandler(
853 engine_config
[k1
]["logfile"], maxBytes
=100e6
, backupCount
=9, delay
=0
855 file_handler
.setFormatter(log_formatter_simple
)
856 logger_module
.addHandler(file_handler
)
858 if "loglevel" in engine_config
[k1
]:
859 logger_module
.setLevel(engine_config
[k1
]["loglevel"])
860 # TODO add more entries, e.g.: storage
862 engine_config
["assignment"] = {}
863 # ^ each VIM, SDNc will be assigned one worker id. Ns class will add items and VimThread will auto-assign
864 cherrypy
.tree
.apps
["/ro"].root
.ns
.start(engine_config
)
865 cherrypy
.tree
.apps
["/ro"].root
.authenticator
.start(engine_config
)
866 cherrypy
.tree
.apps
["/ro"].root
.ns
.init_db(target_version
=database_version
)
868 # # start subscriptions thread:
869 vim_admin_thread
= VimAdminThread(config
=engine_config
, engine
=ro_server
.ns
)
870 vim_admin_thread
.start()
871 start_monitoring(config
=engine_config
)
873 # # Do not capture except SubscriptionException
875 # backend = engine_config["authentication"]["backend"]
876 # cherrypy.log.error("Starting OSM NBI Version '{} {}' with '{}' authentication backend"
877 # .format(ro_version, ro_version_date, backend))
882 Callback function called when cherrypy.engine stops
883 TODO: Ending database connections.
885 global vim_admin_thread
887 # terminate vim_admin_thread
889 vim_admin_thread
.terminate()
891 vim_admin_thread
= None
892 cherrypy
.tree
.apps
["/ro"].root
.ns
.stop()
893 cherrypy
.log
.error("Stopping osm_ng_ro")
896 def ro_main(config_file
):
900 cherrypy
.engine
.subscribe("start", _start_service
)
901 cherrypy
.engine
.subscribe("stop", _stop_service
)
902 cherrypy
.quickstart(ro_server
, "/ro", config_file
)
907 """Usage: {} [options]
908 -c|--config [configuration_file]: loads the configuration file (default: ./ro.cfg)
909 -h|--help: shows this help
914 # --log-socket-host HOST: send logs to this host")
915 # --log-socket-port PORT: send logs using this port (default: 9022)")
918 if __name__
== "__main__":
920 # load parameters and configuration
921 opts
, args
= getopt
.getopt(sys
.argv
[1:], "hvc:", ["config=", "help"])
922 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
926 if o
in ("-h", "--help"):
929 elif o
in ("-c", "--config"):
932 raise ValueError("Unhandled option")
935 if not path
.isfile(config_file
):
937 "configuration file '{}' that not exist".format(config_file
),
943 path
.dirname(__file__
) + "/ro.cfg",
947 if path
.isfile(config_file
):
951 "No configuration file 'ro.cfg' found neither at local folder nor at /etc/osm/",
957 except KeyboardInterrupt:
958 print("KeyboardInterrupt. Finishing", file=sys
.stderr
)
959 except getopt
.GetoptError
as e
:
960 print(str(e
), file=sys
.stderr
)