Cleans, formats and does small restructures to openmanod to be compliant with pylint... 50/7450/1
authorBenjamin Diaz <bdiaz@whitestack.com>
Thu, 9 May 2019 00:24:46 +0000 (21:24 -0300)
committerBenjamin Diaz <bdiaz@whitestack.com>
Thu, 9 May 2019 00:24:50 +0000 (21:24 -0300)
Change-Id: I4a54261c9c46365877773b08a073a0f7d0b2ded6
Signed-off-by: Benjamin Diaz <bdiaz@whitestack.com>
openmanod

index 398d685..d16c8dd 100755 (executable)
--- a/openmanod
+++ b/openmanod
@@ -41,6 +41,9 @@ from jsonschema import validate as js_v, exceptions as js_e
 import logging
 import logging.handlers as log_handlers
 import socket
+
+from yaml import MarkedYAMLError
+
 from osm_ro import httpserver, nfvo, nfvo_db
 from osm_ro.openmano_schemas import config_schema
 from osm_ro.db_base import db_base_Exception
@@ -72,33 +75,33 @@ def load_configuration(configuration_file):
                       'auto_push_VNF_to_VIMs': True,
                       'db_host': 'localhost',
                       'db_ovim_host': 'localhost'
-    }
+                      }
     try:
-        #Check config file exists
+        # Check config file exists
         with open(configuration_file, 'r') as f:
             config_str = f.read()
-        #Parse configuration file
+        # Parse configuration file
         config = yaml.load(config_str)
-        #Validate configuration file with the config_schema
+        # Validate configuration file with the config_schema
         js_v(config, config_schema)
 
-        #Add default values tokens
-        for k,v in default_tokens.items():
+        # Add default values tokens
+        for k, v in default_tokens.items():
             if k not in config:
-                config[k]=v
+                config[k] = v
         return config
 
     except yaml.YAMLError as e:
         error_pos = ""
-        if hasattr(e, 'problem_mark'):
+        if isinstance(e, MarkedYAMLError):
             mark = e.problem_mark
-            error_pos = " at line:{} column:{}".format(mark.line+1, mark.column+1)
+            error_pos = " at line:{} column:{}".format(mark.line + 1, mark.column + 1)
         raise LoadConfigurationException("Bad YAML format at configuration file '{file}'{pos}: {message}".format(
             file=configuration_file, pos=error_pos, message=e))
     except js_e.ValidationError as e:
         error_pos = ""
         if e.path:
-            error_pos=" at '" + ":".join(map(str, e.path))+"'"
+            error_pos = " at '" + ":".join(map(str, e.path)) + "'"
         raise LoadConfigurationException("Invalid field at configuration file '{file}'{pos} {message}".format(
             file=configuration_file, pos=error_pos, message=e))
     except Exception as e:
@@ -107,20 +110,18 @@ def load_configuration(configuration_file):
 
 
 def console_port_iterator():
-    '''this iterator deals with the http_console_ports
+    """
+    this iterator deals with the http_console_ports
     returning the ports one by one
-    '''
+    """
     index = 0
     while index < len(global_config["http_console_ports"]):
         port = global_config["http_console_ports"][index]
-        #print("ports -> ", port)
         if type(port) is int:
             yield port
-        else: #this is dictionary with from to keys
+        else:  # this is dictionary with from to keys
             port2 = port["from"]
-            #print("ports -> ", port, port2)
             while port2 <= port["to"]:
-                #print("ports -> ", port, port2)
                 yield port2
                 port2 += 1
         index += 1
@@ -131,13 +132,15 @@ def usage():
     print("      -v|--version: prints current version")
     print("      -c|--config [configuration_file]: loads the configuration file (default: openmanod.cfg)")
     print("      -h|--help: shows this help")
-    print("      -p|--port [port_number]: changes port number and overrides the port number in the configuration file (default: 9090)")
-    print("      -P|--adminport [port_number]: changes admin port number and overrides the port number in the configuration file (default: 9095)")
-    # print( "      -V|--vnf-repository: changes the path of the vnf-repository and overrides the path in the configuration file")
+    print(
+        "      -p|--port [port_number]: changes port number and overrides the port number in the configuration file (default: 9090)")
+    print(
+        "      -P|--adminport [port_number]: changes admin port number and overrides the port number in the configuration file (default: 9095)")
     print("      --log-socket-host HOST: send logs to this host")
     print("      --log-socket-port PORT: send logs using this port (default: 9022)")
     print("      --log-file FILE: send logs to this file")
-    print("      --create-tenant NAME: Try to creates this tenant name before starting, ignoring any errors as e.g. conflict")
+    print(
+        "      --create-tenant NAME: Try to creates this tenant name before starting, ignoring any errors as e.g. conflict")
     return
 
 
@@ -146,7 +149,6 @@ def set_logging_file(log_file):
         file_handler = logging.handlers.RotatingFileHandler(log_file, maxBytes=100e6, backupCount=9, delay=0)
         file_handler.setFormatter(log_formatter_simple)
         logger.addHandler(file_handler)
-        # logger.debug("moving logs to '%s'", global_config["log_file"])
         # remove initial stream handler
         logging.root.removeHandler(logging.root.handlers[0])
         print ("logging on '{}'".format(log_file))
@@ -155,34 +157,28 @@ def set_logging_file(log_file):
             "Cannot open logging file '{}': {}. Check folder exist and permissions".format(log_file, e))
 
 
-if __name__=="__main__":
-    # env2config contains envioron variable names and the correspondence with configuration file openmanod.cfg keys.
+if __name__ == "__main__":
+    # env2config contains environ variable names and the correspondence with configuration file openmanod.cfg keys.
     # If this environ is defined, this value is taken instead of the one at at configuration file
     env2config = {
         'RO_DB_HOST': 'db_host',
         'RO_DB_NAME': 'db_name',
         'RO_DB_USER': 'db_user',
         'RO_DB_PASSWORD': 'db_passwd',
-        # 'RO_DB_PORT': 'db_port',
         'RO_DB_OVIM_HOST': 'db_ovim_host',
         'RO_DB_OVIM_NAME': 'db_ovim_name',
         'RO_DB_OVIM_USER': 'db_ovim_user',
         'RO_DB_OVIM_PASSWORD': 'db_ovim_passwd',
-        # 'RO_DB_OVIM_PORT': 'db_ovim_port',
         'RO_LOG_LEVEL': 'log_level',
         'RO_LOG_FILE': 'log_file',
     }
     # Configure logging step 1
     hostname = socket.gethostname()
-    # streamformat = "%(levelname)s (%(module)s:%(lineno)d) %(message)s"
-    # "%(asctime)s %(name)s %(levelname)s %(filename)s:%(lineno)d %(funcName)s %(process)d: %(message)s"
-    log_formatter_complete = logging.Formatter('%(asctime)s.%(msecs)03d00Z[{host}@openmanod] %(filename)s:%(lineno)s '
-                                               'severity:%(levelname)s logger:%(name)s log:%(message)s'.format(
-                                                    host=hostname),
-                                               datefmt='%Y-%m-%dT%H:%M:%S')
-    log_format_simple =  "%(asctime)s %(levelname)s  %(name)s %(thread)d %(filename)s:%(lineno)s %(message)s"
+    log_formatter_str = '%(asctime)s.%(msecs)03d00Z[{host}@openmanod] %(filename)s:%(lineno)s severity:%(levelname)s logger:%(name)s log:%(message)s'
+    log_formatter_complete = logging.Formatter(log_formatter_str.format(host=hostname), datefmt='%Y-%m-%dT%H:%M:%S')
+    log_format_simple = "%(asctime)s %(levelname)s  %(name)s %(thread)d %(filename)s:%(lineno)s %(message)s"
     log_formatter_simple = logging.Formatter(log_format_simple, datefmt='%Y-%m-%dT%H:%M:%S')
-    logging.basicConfig(format=log_format_simple, level= logging.DEBUG)
+    logging.basicConfig(format=log_format_simple, level=logging.DEBUG)
     logger = logging.getLogger('openmano')
     logger.setLevel(logging.DEBUG)
     socket_handler = None
@@ -193,7 +189,7 @@ if __name__=="__main__":
         opts, args = getopt.getopt(sys.argv[1:], "hvc:V:p:P:",
                                    ["config=", "help", "version", "port=", "vnf-repository=", "adminport=",
                                     "log-socket-host=", "log-socket-port=", "log-file=", "create-tenant="])
-        port=None
+        port = None
         port_admin = None
         config_file = 'osm_ro/openmanod.cfg'
         vnf_repository = None
@@ -233,7 +229,6 @@ if __name__=="__main__":
         global_config = load_configuration(config_file)
         global_config["version"] = __version__
         global_config["version_date"] = version_date
-        #print global_config
         # Override parameters obtained by command line on ENV
         if port:
             global_config['http_port'] = port
@@ -250,52 +245,37 @@ if __name__=="__main__":
                 if not env_k.startswith("RO_") or env_k not in env2config or not env_v:
                     continue
                 global_config[env2config[env_k]] = env_v
-                if env_k.endswith("PORT"):    # convert to int, skip if not possible
+                if env_k.endswith("PORT"):  # convert to int, skip if not possible
                     global_config[env2config[env_k]] = int(env_v)
             except Exception as e:
                 logger.warn("skipping environ '{}={}' because exception '{}'".format(env_k, env_v, e))
 
-#         if vnf_repository is not None:
-#             global_config['vnf_repository'] = vnf_repository
-#         else:
-#             if not 'vnf_repository' in global_config:
-#                 logger.error( os.getcwd() )
-#                 global_config['vnf_repository'] = os.getcwd()+'/vnfrepo'
-#         #print global_config
-#         if not os.path.exists(global_config['vnf_repository']):
-#             logger.error( "Creating folder vnf_repository folder: '%s'.", global_config['vnf_repository'])
-#             try:
-#                 os.makedirs(global_config['vnf_repository'])
-#             except Exception as e:
-#                 logger.error( "Error '%s'. Ensure the path 'vnf_repository' is properly set at %s",e.args[1], config_file)
-#                 exit(-1)
-
         global_config["console_port_iterator"] = console_port_iterator
-        global_config["console_thread"]={}
-        global_config["console_ports"]={}
+        global_config["console_thread"] = {}
+        global_config["console_ports"] = {}
         if not global_config["http_console_host"]:
             global_config["http_console_host"] = global_config["http_host"]
-            if global_config["http_host"]=="0.0.0.0":
+            if global_config["http_host"] == "0.0.0.0":
                 global_config["http_console_host"] = socket.gethostname()
 
         # Configure logging STEP 2
         if "log_host" in global_config:
-            socket_handler= log_handlers.SocketHandler(global_config["log_socket_host"], global_config["log_socket_port"])
+            socket_handler = log_handlers.SocketHandler(global_config["log_socket_host"],
+                                                        global_config["log_socket_port"])
             socket_handler.setFormatter(log_formatter_complete)
-            if global_config.get("log_socket_level") and global_config["log_socket_level"] != global_config["log_level"]:
+            if global_config.get("log_socket_level") \
+                    and global_config["log_socket_level"] != global_config["log_level"]:
                 socket_handler.setLevel(global_config["log_socket_level"])
             logger.addHandler(socket_handler)
 
-        # logger.addHandler(log_handlers.SysLogHandler())
         if log_file:
             global_config['log_file'] = log_file
         elif global_config.get('log_file'):
             set_logging_file(global_config['log_file'])
 
-        # logging.basicConfig(level = getattr(logging, global_config.get('log_level',"debug")))
         logger.setLevel(getattr(logging, global_config['log_level']))
         logger.critical("Starting openmano server version: '%s %s' command: '%s'",
-                         __version__, version_date, " ".join(sys.argv))
+                        __version__, version_date, " ".join(sys.argv))
 
         for log_module in ("nfvo", "http", "vim", "wim", "db", "console", "ovim"):
             log_level_module = "log_level_" + log_module
@@ -312,14 +292,13 @@ if __name__=="__main__":
                 except IOError as e:
                     raise LoadConfigurationException(
                         "Cannot open logging file '{}': {}. Check folder exist and permissions".format(
-                            global_config[log_file_module], str(e)) )
-            global_config["logger_"+log_module] = logger_module
-        #httpserver.logger = global_config["logger_http"]
-        #nfvo.logger = global_config["logger_nfvo"]
+                            global_config[log_file_module], str(e)))
+            global_config["logger_" + log_module] = logger_module
 
         # Initialize DB connection
-        mydb = nfvo_db.nfvo_db();
-        mydb.connect(global_config['db_host'], global_config['db_user'], global_config['db_passwd'], global_config['db_name'])
+        mydb = nfvo_db.nfvo_db()
+        mydb.connect(global_config['db_host'], global_config['db_user'], global_config['db_passwd'],
+                     global_config['db_name'])
         db_path = osm_ro.__path__[0] + "/database_utils"
         if not os_path.exists(db_path + "/migrate_mano_db.sh"):
             db_path = osm_ro.__path__[0] + "/../database_utils"
@@ -327,22 +306,23 @@ if __name__=="__main__":
             r = mydb.get_db_version()
             if r[0] != database_version:
                 logger.critical("DATABASE wrong version '{current}'. Try to upgrade/downgrade to version '{target}'"
-                                " with '{db_path}/migrate_mano_db.sh {target}'".format(
-                                current=r[0], target=database_version,  db_path=db_path))
+                                " with '{db_path}/migrate_mano_db.sh {target}'".format(current=r[0],
+                                                                                       target=database_version,
+                                                                                       db_path=db_path))
                 exit(-1)
         except db_base_Exception as e:
             logger.critical("DATABASE is not valid. If you think it is corrupted, you can init it with"
                             " '{db_path}/init_mano_db.sh' script".format(db_path=db_path))
             exit(-1)
 
-        nfvo.global_config=global_config
+        nfvo.global_config = global_config
         if create_tenant:
             try:
                 nfvo.new_tenant(mydb, {"name": create_tenant})
             except Exception as e:
                 if isinstance(e, nfvo.NfvoException) and e.http_code == 409:
                     pass  # if tenant exist (NfvoException error 409), ignore
-                else:     # otherwise print and error and continue
+                else:  # otherwise print and error and continue
                     logger.error("Cannot create tenant '{}': {}".format(create_tenant, e))
 
         # WIM module
@@ -359,7 +339,8 @@ if __name__=="__main__":
 
         httpthread.start()
         if 'http_admin_port' in global_config:
-            httpthreadadmin = httpserver.httpserver(mydb, True, global_config['http_host'], global_config['http_admin_port'])
+            httpthreadadmin = httpserver.httpserver(mydb, True, global_config['http_host'],
+                                                    global_config['http_admin_port'])
             httpthreadadmin.start()
         time.sleep(1)
         logger.info('Waiting for http clients')
@@ -369,10 +350,10 @@ if __name__=="__main__":
         time.sleep(20)
         sys.stdout.flush()
 
-        #TODO: Interactive console must be implemented here instead of join or sleep
+        # TODO: Interactive console must be implemented here instead of join or sleep
 
-        #httpthread.join()
-        #if 'http_admin_port' in global_config:
+        # httpthread.join()
+        # if 'http_admin_port' in global_config:
         #    httpthreadadmin.join()
         while True:
             time.sleep(86400)
@@ -382,8 +363,7 @@ if __name__=="__main__":
     except SystemExit:
         pass
     except getopt.GetoptError as e:
-        logger.critical(str(e)) # will print something like "option -a not recognized"
-        #usage()
+        logger.critical(str(e))  # will print something like "option -a not recognized"
         exit(-1)
     except LoadConfigurationException as e:
         logger.critical(str(e))
@@ -397,4 +377,3 @@ if __name__=="__main__":
     nfvo.stop_service()
     if httpthread:
         httpthread.join(1)
-