mgr/dashboard_v2: several code style enhancements

* Replace double quotes with single quotes
* Modify log messages
* Fix typo, rename autenticate to authenticate

Signed-off-by: Volker Theile <vtheile@suse.com>

diff --git a/src/pybind/mgr/dashboard_v2/ceph_module_mock.py b/src/pybind/mgr/dashboard_v2/ceph_module_mock.py
index fbf32359199292f9497303e8e5784653f970afed..254b1d903762d6dcb257bd694f6857c90b7027f3 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/ceph_module_mock.py
+++ b/src/pybind/mgr/dashboard_v2/ceph_module_mock.py
@@ -23,10 +23,10 @@ class BaseMgrModule(object):
         self.config_key_map = {}
 
     def _ceph_get_version(self):
-        return "ceph-13.0.0"
+        return 'ceph-13.0.0'
 
     def _ceph_get_mgr_id(self):
-        return "x"
+        return 'x'
 
     def _ceph_set_config(self, key, value):
         self.config_key_map[key] = value

diff --git a/src/pybind/mgr/dashboard_v2/controllers/auth.py b/src/pybind/mgr/dashboard_v2/controllers/auth.py
index b36353053e86d30e2d62f5dca9e08470c133fe52..8829c9c3f55f1b411b70d837fe7a85bc2b6c3532 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/controllers/auth.py
+++ b/src/pybind/mgr/dashboard_v2/controllers/auth.py
@@ -46,15 +46,15 @@ class Auth(RESTController):
             cherrypy.session.regenerate()
             cherrypy.session[Auth.SESSION_KEY] = username
             cherrypy.session[Auth.SESSION_KEY_TS] = now
-            self._log.debug("Login successful")
+            self._log.debug('Login successful')
             return {'username': username}
 
         cherrypy.response.status = 403
-        self._log.debug("Login fail")
+        self._log.debug('Login failed')
         return {'detail': 'Invalid credentials'}
 
     def bulk_delete(self):
-        self._log.debug("Logout successful")
+        self._log.debug('Logout successful')
         cherrypy.session[Auth.SESSION_KEY] = None
         cherrypy.session[Auth.SESSION_KEY_TS] = None
 
@@ -83,7 +83,7 @@ class Auth(RESTController):
             if username_ts and float(username_ts) < (now - expires):
                 cherrypy.session[Auth.SESSION_KEY] = None
                 cherrypy.session[Auth.SESSION_KEY_TS] = None
-                module.log.debug("Session expired.")
+                module.log.debug('Session expired')
                 raise cherrypy.HTTPError(401,
                                          'Session expired. You are not '
                                          'authorized to access that resource')

diff --git a/src/pybind/mgr/dashboard_v2/controllers/ping.py b/src/pybind/mgr/dashboard_v2/controllers/ping.py
index f04317f38c16cce08e529cf1e8143ddfc29051bc..71fa743b963115d74f7b30972bfecda186049bad 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/controllers/ping.py
+++ b/src/pybind/mgr/dashboard_v2/controllers/ping.py
@@ -11,7 +11,7 @@ from ..tools import ApiController, AuthRequired, RESTController
 class Ping(object):
     @cherrypy.expose
     def default(self):
-        return "pong"
+        return 'pong'
 
 
 @ApiController('echo1')

diff --git a/src/pybind/mgr/dashboard_v2/module.py b/src/pybind/mgr/dashboard_v2/module.py
index 14938534d9f4077ba5401acd4e6afe6155b33c59..1e23845d89bf643af0501cedc46a6bd0ebc35a14 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/module.py
+++ b/src/pybind/mgr/dashboard_v2/module.py
@@ -31,11 +31,11 @@ class Module(MgrModule):
 
     COMMANDS = [
         {
-            "cmd": "dashboard set-login-credentials "
-                   "name=username,type=CephString "
-                   "name=password,type=CephString",
-            "desc": "Set the login credentials",
-            "perm": "w"
+            'cmd': 'dashboard set-login-credentials '
+                   'name=username,type=CephString '
+                   'name=password,type=CephString',
+            'desc': 'Set the login credentials',
+            'perm': 'w'
         }
     ]
 
@@ -47,7 +47,7 @@ class Module(MgrModule):
                 'no server_addr configured; '
                 'try "ceph config-key put mgr/{}/{}/server_addr <ip>"'
                 .format(self.module_name, self.get_mgr_id()))
-        self.log.info("server_addr: %s server_port: %s", server_addr,
+        self.log.info('server_addr: %s server_port: %s', server_addr,
                       server_port)
 
         if not in_unittest:
@@ -55,34 +55,34 @@ class Module(MgrModule):
                 'server.socket_host': server_addr,
                 'server.socket_port': int(server_port),
             })
-        cherrypy.tools.autenticate = cherrypy.Tool('before_handler',
-                                                   Auth.check_auth)
+        cherrypy.tools.authenticate = cherrypy.Tool('before_handler',
+                                                    Auth.check_auth)
 
         current_dir = os.path.dirname(os.path.abspath(__file__))
         fe_dir = os.path.join(current_dir, 'frontend/dist')
         config = {
             '/': {
-                "tools.staticdir.on": True,
+                'tools.staticdir.on': True,
                 'tools.staticdir.dir': fe_dir,
-                'tools.staticdir.index': "index.html"
+                'tools.staticdir.index': 'index.html'
             }
         }
 
-        cherrypy.tree.mount(Module.ApiRoot(self), "/api")
+        cherrypy.tree.mount(Module.ApiRoot(self), '/api')
         cherrypy.tree.mount(Module.StaticRoot(), '/', config=config)
 
     def serve(self):
         self.configure_cherrypy()
 
         cherrypy.engine.start()
-        self.log.info("Waiting for engine...")
+        self.log.info('Waiting for engine...')
         cherrypy.engine.block()
-        self.log.info("Engine done.")
+        self.log.info('Engine done')
 
     def shutdown(self):
-        self.log.info("Stopping server...")
+        self.log.info('Stopping server...')
         cherrypy.engine.exit()
-        self.log.info("Stopped server")
+        self.log.info('Stopped server')
 
     def handle_command(self, cmd):
         if cmd['prefix'] == 'dashboard set-login-credentials':
@@ -95,9 +95,9 @@ class Module(MgrModule):
     class ApiRoot(object):
         def __init__(self, mgrmod):
             ctrls = load_controllers(mgrmod)
-            mgrmod.log.debug("loaded controllers: {}".format(ctrls))
+            mgrmod.log.debug('Loaded controllers: {}'.format(ctrls))
             for ctrl in ctrls:
-                mgrmod.log.info("adding controller: {} -> /api/{}"
+                mgrmod.log.info('Adding controller: {} -> /api/{}'
                                 .format(ctrl.__name__, ctrl._cp_path_))
                 ins = ctrl()
                 setattr(Module.ApiRoot, ctrl._cp_path_, ins)

diff --git a/src/pybind/mgr/dashboard_v2/tests/test_auth.py b/src/pybind/mgr/dashboard_v2/tests/test_auth.py
index 8b32805fa7479de13e3803ca655c0608b0544cf4..1e593b9ffd3d2f3afa72664eec3cd6f4350941f8 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/tests/test_auth.py
+++ b/src/pybind/mgr/dashboard_v2/tests/test_auth.py
@@ -22,11 +22,11 @@ class Ping(object):
 class AuthTest(ControllerTestCase):
     @classmethod
     def setup_test(cls):
-        cherrypy.tools.autenticate = cherrypy.Tool('before_handler',
+        cherrypy.tools.authenticate = cherrypy.Tool('before_handler',
                                                    Auth.check_auth)
 
         cherrypy.tree.mount(Ping(), "/api/test",
-                            config={'/': {'tools.autenticate.on': True}})
+                            config={'/': {'tools.authenticate.on': True}})
         cls._mgr_module.set_localized_config('session-expire', '2')
         cls._mgr_module.set_localized_config('username', 'admin')
         cls._mgr_module.set_localized_config('password',

diff --git a/src/pybind/mgr/dashboard_v2/tests/test_ping.py b/src/pybind/mgr/dashboard_v2/tests/test_ping.py
index 7fde17bddbccd3bad452dbc4fa5d449d88c5aca9..c382b0232f306c87b8e851a5190969e7f34f4648 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/tests/test_ping.py
+++ b/src/pybind/mgr/dashboard_v2/tests/test_ping.py
@@ -10,7 +10,7 @@ from ..controllers.ping import Ping
 class PingTest(ControllerTestCase):
     @classmethod
     def setup_test(cls):
-        Ping._cp_config['tools.autenticate.on'] = False
+        Ping._cp_config['tools.authenticate.on'] = False
 
     def test_ping(self):
         self.getPage("/api/ping")

diff --git a/src/pybind/mgr/dashboard_v2/tools.py b/src/pybind/mgr/dashboard_v2/tools.py
index e54088a5898ed633f509e5792d59e544f1dd8dd8..7394e6587745b5656cd392f00c398ede71958f1e 100644 (file)
--- a/src/pybind/mgr/dashboard_v2/tools.py
+++ b/src/pybind/mgr/dashboard_v2/tools.py
@@ -19,12 +19,12 @@ def ApiController(path):
         if not hasattr(cls, '_cp_config'):
             cls._cp_config = {
                 'tools.sessions.on': True,
-                'tools.autenticate.on': False
+                'tools.authenticate.on': False
             }
         else:
             cls._cp_config['tools.sessions.on'] = True
-            if 'tools.autenticate.on' not in cls._cp_config:
-                cls._cp_config['tools.autenticate.on'] = False
+            if 'tools.authenticate.on' not in cls._cp_config:
+                cls._cp_config['tools.authenticate.on'] = False
         return cls
     return decorate
 
@@ -33,10 +33,10 @@ def AuthRequired(enabled=True):
     def decorate(cls):
         if not hasattr(cls, '_cp_config'):
             cls._cp_config = {
-                'tools.autenticate.on': enabled
+                'tools.authenticate.on': enabled
             }
         else:
-            cls._cp_config['tools.autenticate.on'] = enabled
+            cls._cp_config['tools.authenticate.on'] = enabled
         return cls
     return decorate
 
@@ -49,7 +49,7 @@ def load_controllers(mgrmodule):
         sys.path.append(mgr_dir)
 
     controllers = []
-    ctrls_path = "{}/controllers".format(dashboard_dir)
+    ctrls_path = '{}/controllers'.format(dashboard_dir)
     mods = [mod for _, mod, _ in pkgutil.iter_modules([ctrls_path])]
     for mod_name in mods:
         mod = importlib.import_module('.controllers.{}'.format(mod_name),