mgr/dashboard: dashboard help command showing wrong syntax for login-banner

Signed-off-by: Sarthak0702 <sarthak.dev.0702@gmail.com>
(cherry picked from commit 826741f192e754ed32b1636b06b9939efa5c5226)

diff --git a/src/pybind/mgr/dashboard/controllers/home.py b/src/pybind/mgr/dashboard/controllers/home.py
index 8f69af4dccee0103ea754104d39776334305f48c..403d4de70e62d24ef8d85c6b342bb3e853e92ca5 100644 (file)
--- a/src/pybind/mgr/dashboard/controllers/home.py
+++ b/src/pybind/mgr/dashboard/controllers/home.py
@@ -15,7 +15,6 @@ import cherrypy
 from cherrypy.lib.static import serve_file
 
 from .. import mgr
-from ..services.custom_banner import get_login_banner_mgr
 from . import BaseController, Endpoint, Proxy, Router, UIRouter
 
 logger = logging.getLogger("controllers.home")
@@ -147,4 +146,4 @@ class LangsController(BaseController, LanguageMixin):
 class LoginController(BaseController):
     @Endpoint('GET', 'custom_banner')
     def __call__(self):
-        return get_login_banner_mgr()
+        return mgr.get_store('custom_login_banner')

diff --git a/src/pybind/mgr/dashboard/module.py b/src/pybind/mgr/dashboard/module.py
index e27ff7b589d91bc0e5f62af45cb3b172c4ccef80..96e447c6d9287450def6ba78b464a2309eae36a3 100644 (file)
--- a/src/pybind/mgr/dashboard/module.py
+++ b/src/pybind/mgr/dashboard/module.py
@@ -15,9 +15,6 @@ import threading
 import time
 from typing import TYPE_CHECKING, Optional
 
-from .services.custom_banner import get_login_banner_mgr, \
-    set_login_banner_mgr, unset_login_banner_mgr
-
 if TYPE_CHECKING:
     if sys.version_info >= (3, 8):
         from typing import Literal
@@ -415,19 +412,25 @@ class Module(MgrModule, CherryPyConfig):
         return 0, 'RGW credentials configured', ''
 
     @CLIWriteCommand("dashboard set-login-banner")
-    def set_login_banner(self, mgr_id: Optional[str] = None, inbuf: Optional[str] = None):
+    def set_login_banner(self, inbuf: str):
+        '''
+        Set the custom login banner read from -i <file>
+        '''
         item_label = 'login banner file'
         if inbuf is None:
             return HandleCommandResult(
                 -errno.EINVAL,
                 stderr=f'Please specify the {item_label} with "-i" option'
             )
-        set_login_banner_mgr(inbuf, mgr_id)
+        mgr.set_store('custom_login_banner', inbuf)
         return HandleCommandResult(stdout=f'{item_label} added')
 
     @CLIReadCommand("dashboard get-login-banner")
     def get_login_banner(self):
-        banner_text = get_login_banner_mgr()
+        '''
+        Get the custom login banner text
+        '''
+        banner_text = mgr.get_store('custom_login_banner')
         if banner_text is None:
             return HandleCommandResult(stdout='No login banner set')
         else:
@@ -435,7 +438,10 @@ class Module(MgrModule, CherryPyConfig):
 
     @CLIWriteCommand("dashboard unset-login-banner")
     def unset_login_banner(self):
-        unset_login_banner_mgr()
+        '''
+        Unset the custom login banner
+        '''
+        mgr.set_store('custom_login_banner', None)
         return HandleCommandResult(stdout='Login banner removed')
 
     def handle_command(self, inbuf, cmd):

diff --git a/src/pybind/mgr/dashboard/services/custom_banner.py b/src/pybind/mgr/dashboard/services/custom_banner.py
deleted file mode 100644 (file)
index e28addd..0000000
--- a/src/pybind/mgr/dashboard/services/custom_banner.py
+++ /dev/null
@@ -1,27 +0,0 @@
-import logging
-from typing import Optional
-
-from mgr_module import _get_localized_key
-
-from .. import mgr
-
-logger = logging.getLogger(__name__)
-
-
-def set_login_banner_mgr(inbuf: str, mgr_id: Optional[str] = None):
-    item_key = 'custom_login_banner'
-    if mgr_id is not None:
-        mgr.set_store(_get_localized_key(mgr_id, item_key), inbuf)
-    else:
-        mgr.set_store(item_key, inbuf)
-
-
-def get_login_banner_mgr():
-    banner_text = mgr.get_store('custom_login_banner')
-    logger.info('Reading custom login banner: %s', banner_text)
-    return banner_text
-
-
-def unset_login_banner_mgr():
-    mgr.set_store('custom_login_banner', None)
-    logger.info('Removing custom login banner')