Make long_running_operation decorator more specific

It should be specific to the particular D-Bus method that launches the
long-running operation.

Signed-off-by: mulhern <amulhern@redhat.com>

Author: mulkieran

src/stratis_cli/_actions/_crypt.py

@@ -58,7 +58,7 @@ class CryptActions:
     """
 
     @staticmethod
-    @long_running_operation
+    @long_running_operation(method_names=["EncryptPool"])
     def encrypt(namespace: Namespace):
         """
         Encrypt a previously unencrypted pool.
@@ -123,7 +123,7 @@ def encrypt(namespace: Namespace):
             )
 
     @staticmethod
-    @long_running_operation
+    @long_running_operation(method_names=["DecryptPool"])
     def unencrypt(namespace: Namespace):
         """
         Unencrypt a previously encrypted pool.
@@ -169,7 +169,7 @@ def unencrypt(namespace: Namespace):
             )
 
     @staticmethod
-    @long_running_operation
+    @long_running_operation(method_names=["ReencryptPool"])
     def reencrypt(namespace: Namespace):
         """
         Reencrypt an already encrypted pool with a new key.

src/stratis_cli/_actions/_utils.py

@@ -26,7 +26,7 @@
 from collections.abc import Iterator
 from enum import Enum
 from functools import wraps
-from typing import Any, Callable, Optional, Tuple
+from typing import Any, Callable, List, Optional, Tuple
 from uuid import UUID
 
 # isort: THIRDPARTY
@@ -36,7 +36,7 @@
 from justbytes import Range
 
 # isort: FIRSTPARTY
-from dbus_python_client_gen import DPClientInvocationError
+from dbus_python_client_gen import DPClientInvocationError, DPClientMethodCallContext
 
 from .._errors import (
     StratisCliKeyfileNotFoundError,
@@ -315,23 +315,44 @@ def get_errors(exc: BaseException) -> Iterator[BaseException]:
         exc = exc.__cause__
 
 
-def long_running_operation(func: Callable) -> Callable:
+def long_running_operation(
+    *, method_names: List[str]
+) -> Callable[[Callable], Callable]:
     """
     Mark a function as a long running operation and catch and ignore NoReply
-    D-Bus exception.
+    D-Bus exception so long as the method raising the exception is one
+    of the methods specified in method_names.
     """
 
-    @wraps(func)
-    def wrapper(namespace: Namespace):
-        try:
-            func(namespace)
-        except DPClientInvocationError as err:
-            if not any(
-                isinstance(e, DBusException)
-                and e.get_dbus_name() == "org.freedesktop.DBus.Error.NoReply"
-                for e in get_errors(err)
-            ):
+    def decorator(func: Callable) -> Callable:
+        """
+        Decorator
+        """
+
+        @wraps(func)
+        def wrapper(namespace: Namespace):
+            """
+            Wrapper
+            """
+            try:
+                func(namespace)
+            except DPClientInvocationError as err:
+                if not any(
+                    isinstance(e, DBusException)
+                    and e.get_dbus_name() == "org.freedesktop.DBus.Error.NoReply"
+                    for e in get_errors(err)
+                ):
+                    raise err
+
+                context = err.context
+                if (
+                    isinstance(context, DPClientMethodCallContext)
+                    and context.method_name in method_names
+                ):
+                    print("Operation initiated", file=sys.stderr)
+
                 raise err
-            print("Operation initiated", file=sys.stderr)
 
-    return wrapper
+        return wrapper
+
+    return decorator

tests/unit/test_running.py

@@ -22,7 +22,7 @@
 import dbus
 
 # isort: FIRSTPARTY
-from dbus_python_client_gen import DPClientInvocationError
+from dbus_python_client_gen import DPClientInvocationError, DPClientMethodCallContext
 
 # isort: LOCAL
 from stratis_cli._actions._utils import long_running_operation
@@ -34,20 +34,38 @@ class LongRunningOperationTestCase(unittest.TestCase):
     engine.
     """
 
-    def test_raise_dbus_exception(self):
+    def test_catch_dbus_exception(self):
         """
         Should succeed because it catches the distinguishing NoReply D-Bus
-        error.
+        error from the identified method.
         """
 
         def raises_error(_):
             raise DPClientInvocationError(
-                "fake", "intf", None
+                "fake", "intf", DPClientMethodCallContext("MethodName", [])
             ) from dbus.exceptions.DBusException(
                 name="org.freedesktop.DBus.Error.NoReply"
             )
 
-        self.assertIsNone(long_running_operation(raises_error)(None))
+        self.assertIsNone(
+            long_running_operation(method_names=["MethodName"])(raises_error)(None)
+        )
+
+    def test_raise_dbus_exception_no_name_match(self):
+        """
+        Should succeed because it catches the distinguishing NoReply D-Bus
+        error from the identified method.
+        """
+
+        def raises_error(_):
+            raise DPClientInvocationError(
+                "fake", "intf", DPClientMethodCallContext("MethodName", [])
+            ) from dbus.exceptions.DBusException(
+                name="org.freedesktop.DBus.Error.NoReply"
+            )
+
+        with self.assertRaises(DPClientInvocationError):
+            long_running_operation(method_names=["OtherMethodName"])(raises_error)(None)
 
     def test_no_dbus_exception(self):
         """
@@ -58,4 +76,4 @@ def raises_error(_):
             raise DPClientInvocationError("fake", "intf", None)
 
         with self.assertRaises(DPClientInvocationError):
-            long_running_operation(raises_error)(None)
+            long_running_operation(method_names=["OtherMethodName"])(raises_error)(None)