Add saf.utils.salt.MasterClient and saf.utils.salt.MinionClient

Fixes #70

Signed-off-by: Pedro Algarvio <[email protected]>

Author: s0undt3ch

changelog/70.improvement.rst

@@ -0,0 +1 @@
+Add `saf.utils.salt.MasterClient` and `saf.utils.salt.MinionClient` which are asyncio cooperative

pyproject.toml

@@ -120,6 +120,14 @@ format = "grouped"
 "src/saf/saltext/**/*.py" = [
   "N807",   # Function name should not start and end with `__`
 ]
+"src/saf/utils/salt.py" = [
+  "ANN101",   # Missing type annotation for `self` in method
+  "PLR0913",  # Too many arguments to function call (10 > 5)
+  "FBT001",   # Boolean positional arg in function definition
+  "FBT002",   # Boolean default value in function definition
+  "ANN401",   # Dynamically typed expressions (typing.Any) are disallowed in `**kwargs`
+  "RET504",   # Unnecessary variable assignment before `return` statement
+]
 "setup.py" = [
   "D",
 ]

src/saf/utils/salt.py

@@ -0,0 +1,84 @@
+# Copyright 2023 VMware, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+"""
+AsyncIO implementations of some of Salt's classes.
+"""
+from __future__ import annotations
+
+import asyncio
+from functools import partial
+from typing import Any
+
+import salt.client
+import salt.minion
+
+
+class MasterClient:
+    """
+    Naive AsyncIO wrapper around Salt's LocalClient.
+    """
+
+    def __init__(self, master_opts: dict[str, Any]) -> None:
+        self._opts = master_opts
+        if self._opts["__role"] != "master":
+            msg = "The options dictionary passed to MasterClient does not look like salt-master options."
+            raise RuntimeError(msg)
+        self._client = salt.client.LocalClient(mopts=self._opts.copy())
+
+    async def cmd(
+        self,
+        tgt: str,
+        fun: str,
+        arg: tuple[Any, ...] | list[Any] = (),
+        timeout: int | None = None,
+        tgt_type: str = "glob",
+        ret: str = "",
+        jid: str = "",
+        full_return: bool = False,
+        kwarg: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> str | dict[str, Any]:
+        """
+        Run a salt command.
+        """
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(
+            None,
+            partial(
+                self._client.cmd,
+                tgt=tgt,
+                fun=fun,
+                arg=arg,
+                timeout=timeout,
+                tgt_type=tgt_type,
+                ret=ret,
+                jid=jid,
+                full_return=full_return,
+                kwarg=kwarg,
+                **kwargs,
+            ),
+        )
+
+
+class MinionClient:
+    """
+    Naive AsyncIO wrapper around Salt's minion execution modules.
+    """
+
+    def __init__(self, minion_opts: dict[str, Any]) -> None:
+        self._opts = minion_opts.copy()
+        self._opts["file_client"] = "local"
+        self._client = salt.minion.SMinion(self._opts)
+
+    async def cmd(self, func: str, *args: Any, **kwargs: Any) -> Any:
+        """
+        Run a salt command.
+        """
+        if func not in self._client.functions:
+            msg = f"The function {func!r} was not found, or could not be loaded."
+            raise RuntimeError(msg)
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(
+            None, partial(self._client.functions[func], *args, **kwargs)
+        )

tests/unit/salt/__init__.py renamed to tests/e2e/utils/__init__.py

@@ -0,0 +1,41 @@
+# Copyright 2023 VMware, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+from __future__ import annotations
+
+import pytest
+from saltfactories.daemons.master import SaltMaster
+from saltfactories.daemons.minion import SaltMinion
+from saltfactories.utils import random_string
+
+from saf.utils.salt import MasterClient
+from saf.utils.salt import MinionClient
+
+
+@pytest.fixture(scope="module")
+def minion(master: SaltMaster) -> SaltMinion:
+    factory = master.salt_minion_daemon(random_string("minion-"))
+    with factory.started():
+        yield factory
+
+
+@pytest.mark.asyncio
+async def test_master_client(master, minion):
+    client = MasterClient(master.config)
+    ret = await client.cmd(minion.id, "test.ping")
+    assert minion.id in ret
+    assert ret[minion.id] is True
+
+
+@pytest.mark.asyncio
+async def test_minion_client_from_master(master):
+    client = MinionClient(master.config)
+    ret = await client.cmd("test.ping")
+    assert ret is True
+
+
+@pytest.mark.asyncio
+async def test_cmd_from_minion(minion):
+    client = MinionClient(minion.config)
+    ret = await client.cmd("test.ping")
+    assert ret is True

tests/e2e/utils/test_salt_client.py

@@ -0,0 +1,40 @@
+# Copyright 2023 VMware, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+from __future__ import annotations
+
+import pytest
+import salt.config
+
+from saf.utils.salt import MasterClient
+from saf.utils.salt import MinionClient
+
+
+@pytest.fixture
+def minion_opts(tmp_path):
+    """
+    Default minion configuration with relative temporary paths to not require root permissions.
+    """
+    root_dir = tmp_path / "minion"
+    opts = salt.config.DEFAULT_MINION_OPTS.copy()
+    opts["__role"] = "minion"
+    opts["root_dir"] = str(root_dir)
+    for name in ("cachedir", "pki_dir", "sock_dir", "conf_dir"):
+        dirpath = root_dir / name
+        dirpath.mkdir(parents=True)
+        opts[name] = str(dirpath)
+    opts["log_file"] = "logs/minion.log"
+    return opts
+
+
+def test_master_client_runtime_error_on_wrong_role():
+    opts = {"__role": "minion"}
+    with pytest.raises(RuntimeError):
+        MasterClient(opts)
+
+
+@pytest.mark.asyncio
+async def test_minin_client_missing_func(minion_opts):
+    client = MinionClient(minion_opts)
+    with pytest.raises(RuntimeError):
+        await client.cmd("this_func.does_not_exist")