From: John Mulligan <jmulligan@redhat.com>
Date: Tue, 30 Jan 2024 19:39:16 +0000 (-0500)
Subject: pybind/mgr/smb: add cli.py wrapper funcs for cli/mgr interaction
X-Git-Tag: testing/wip-pdonnell-testing-20240503.010653-debug~22^2~17
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=06feeb9b5af2905c06964e8085f965e267430e69;p=ceph-ci.git

pybind/mgr/smb: add cli.py wrapper funcs for cli/mgr interaction

Signed-off-by: John Mulligan <jmulligan@redhat.com>
---

diff --git a/src/pybind/mgr/smb/cli.py b/src/pybind/mgr/smb/cli.py
new file mode 100644
index 00000000000..fa39690fa2a
--- /dev/null
+++ b/src/pybind/mgr/smb/cli.py
@@ -0,0 +1,58 @@
+from typing import Any, Callable, Tuple
+
+import errno
+
+import object_format
+from mgr_module import CLICommand
+
+from .proto import Self
+
+
+class _cmdlet:
+    def __init__(self, func: Callable, cmd: Callable) -> None:
+        self._func = func
+        self.command = cmd
+
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        return self._func(*args, **kwargs)
+
+
+class SMBCommand:
+    """A combined decorator and descriptor. Sets up the common parts of the
+    CLICommand and object formatter.
+    As a descriptor, it returns objects that can be called and wrap the
+    "normal" function but also have a `.command` attribute so the CLI wrapped
+    version can also be used under the same namespace.
+
+    Example:
+    >>> class Example:
+    ...     @SMBCommand('share foo', perm='r')
+    ...     def foo(self):
+    ...         return {'test': 1}
+    ...
+    >>> ex = Example()
+    >>> assert ex.foo() == {'test': 1}
+    >>> assert ex.foo.command(format='yaml') == (0, "test: 1\\n", "")
+    """
+
+    def __init__(self, name: str, perm: str) -> None:
+        self._name = name
+        self._perm = perm
+
+    def __call__(self, func: Callable) -> Self:
+        self._func = func
+        cc = CLICommand(f'smb {self._name}', perm=self._perm)
+        rsp = object_format.Responder()
+        self._command = cc(rsp(func))
+        return self
+
+    def __get__(self, obj: Any, objtype: Any = None) -> _cmdlet:
+        return _cmdlet(
+            self._func.__get__(obj, objtype),
+            self._command.__get__(obj, objtype),
+        )
+
+
+class InvalidInputValue(object_format.ErrorResponseBase):
+    def format_response(self) -> Tuple[int, str, str]:
+        return -errno.EINVAL, "", str(self)