From: Ernesto Puerta <epuertat@redhat.com>
Date: Thu, 10 Oct 2019 09:19:59 +0000 (+0200)
Subject: mgr/dashboard: add SimplePlugin helper
X-Git-Tag: v14.2.8~99^2~9
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7979e20b0a2837ae718950041d85aa4e05c7c165;p=ceph.git

mgr/dashboard: add SimplePlugin helper

Helper added to simplify common tasks when creating a new plugin
(OPTIONS, COMMANDS, etc).

Fixes: https://tracker.ceph.com/issues/41990
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
(cherry picked from commit e5c5b216f2bd2de6a3c3c777e605d2cb83f215dc)
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
---

diff --git a/src/pybind/mgr/dashboard/plugins/plugin.py b/src/pybind/mgr/dashboard/plugins/plugin.py
new file mode 100644
index 000000000000..0f52aefbf95c
--- /dev/null
+++ b/src/pybind/mgr/dashboard/plugins/plugin.py
@@ -0,0 +1,33 @@
+from mgr_module import Option, Command
+
+from . import PLUGIN_MANAGER as PM
+from . import interfaces as I  # noqa: E741,N812
+
+
+class SimplePlugin(I.CanMgr, I.CanLog, I.HasOptions, I.HasCommands):
+    """
+    Helper class that provides simplified creation of plugins:
+        - Default Mixins/Interfaces: CanMgr, CanLog, HasOptions & HasCommands
+    - Options are defined by OPTIONS class variable, instead from get_options hook
+    - Commands are created with by COMMANDS list of Commands() and handlers
+    (less compact than CLICommand, but allows using method instances)
+    """
+    Option = Option
+    Command = Command
+
+    @PM.add_hook
+    def get_options(self):
+        return self.OPTIONS
+
+    @PM.final
+    def get_option(self, option):
+        return self.mgr.get_module_option(option)
+
+    @PM.final
+    def set_option(self, option, value):
+        self.mgr.set_module_option(option, value)
+
+    @PM.add_hook
+    def register_commands(self):
+        for cmd in self.COMMANDS:
+            cmd.register(instance=self)