pyinfra 3.0.dev0__py2.py3-none-any.whl → 3.0.1__py2.py3-none-any.whl

pyinfra/facts/pacman.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+import shlex
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -17,13 +21,14 @@ class PacmanUnpackGroup(FactBase):
         ]
     """
 
-    requires_command = "pacman"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "pacman"
 
     default = list
 
-    def command(self, name):
+    def command(self, package):
         # Accept failure here (|| true) for invalid/unknown packages
-        return 'pacman -S --print-format "%n" {0} || true'.format(name)
+        return 'pacman -S --print-format "%n" {0} || true'.format(shlex.quote(package))
 
     def process(self, output):
         return output
@@ -40,8 +45,11 @@ class PacmanPackages(FactBase):
         }
     """
 
-    command = "pacman -Q"
-    requires_command = "pacman"
+    def command(self) -> str:
+        return "pacman -Q"
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "pacman"
 
     default = dict
 

pyinfra/facts/pip.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages

pyinfra/facts/pkg.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -14,9 +16,11 @@ class PkgPackages(FactBase):
         }
     """
 
-    command = "pkg info || pkg_info || true"
     regex = r"^([a-zA-Z0-9_\-\+]+)\-([0-9a-z\.]+)"
     default = dict
 
+    def command(self) -> str:
+        return "pkg info || pkg_info || true"
+
     def process(self, output):
         return parse_packages(self.regex, output)

pyinfra/facts/pkgin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -16,8 +18,11 @@ class PkginPackages(FactBase):
         }
     """
 
-    command = "pkgin list"
-    requires_command = "pkgin"
+    def command(self) -> str:
+        return "pkgin list"
+
+    def requires_command(self) -> str:
+        return "pkgin"
 
     default = dict
 

pyinfra/facts/postgres.py

@@ -0,0 +1,170 @@
+from __future__ import annotations
+
+from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
+from pyinfra.api.util import try_int
+
+from .util.databases import parse_columns_and_rows
+
+
+def make_psql_command(
+    database: str | None = None,
+    user: str | None = None,
+    password: str | None = None,
+    host: str | None = None,
+    port: str | int | None = None,
+    executable="psql",
+) -> StringCommand:
+    target_bits: list[str] = []
+
+    if password:
+        target_bits.append(MaskString('PGPASSWORD="{0}"'.format(password)))
+
+    target_bits.append(executable)
+
+    if database:
+        target_bits.append("-d {0}".format(database))
+
+    if user:
+        target_bits.append("-U {0}".format(user))
+
+    if host:
+        target_bits.append("-h {0}".format(host))
+
+    if port:
+        target_bits.append("-p {0}".format(port))
+
+    return StringCommand(*target_bits)
+
+
+def make_execute_psql_command(command, **psql_kwargs):
+    return StringCommand(
+        make_psql_command(**psql_kwargs),
+        "-Ac",
+        QuoteString(command),  # quote this whole item as a single shell argument
+    )
+
+
+class PostgresFactBase(FactBase):
+    abstract = True
+
+    psql_command: str
+
+    def requires_command(self, *args, **kwargs):
+        return "psql"
+
+    def command(
+        self,
+        psql_user=None,
+        psql_password=None,
+        psql_host=None,
+        psql_port=None,
+    ):
+        return make_execute_psql_command(
+            self.psql_command,
+            user=psql_user,
+            password=psql_password,
+            host=psql_host,
+            port=psql_port,
+        )
+
+
+class PostgresRoles(PostgresFactBase):
+    """
+    Returns a dict of PostgreSQL roles and data:
+
+    .. code:: python
+
+        {
+            "pyinfra": {
+                "super": true,
+                "createrole": false,
+                "createdb": false,
+                ...
+            },
+        }
+    """
+
+    default = dict
+    psql_command = "SELECT * FROM pg_catalog.pg_roles"
+
+    def process(self, output):
+        # Remove the last line of the output (row count)
+        output = output[:-1]
+        rows = parse_columns_and_rows(
+            output,
+            "|",
+            # Remove the "rol" prefix on column names
+            remove_column_prefix="rol",
+        )
+
+        users = {}
+
+        for details in rows:
+            for key, value in list(details.items()):
+                if key in ("oid", "connlimit"):
+                    details[key] = try_int(value)
+
+                if key in (
+                    "super",
+                    "inherit",
+                    "createrole",
+                    "createdb",
+                    "canlogin",
+                    "replication",
+                    "bypassrls",
+                ):
+                    details[key] = value == "t"
+
+            users[details.pop("name")] = details
+
+        return users
+
+
+class PostgresDatabases(PostgresFactBase):
+    """
+    Returns a dict of PostgreSQL databases and metadata:
+
+    .. code:: python
+
+        {
+            "pyinfra_stuff": {
+                "encoding": "UTF8",
+                "collate": "en_US.UTF-8",
+                "ctype": "en_US.UTF-8",
+                ...
+            },
+        }
+    """
+
+    default = dict
+    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), * FROM pg_catalog.pg_database"
+
+    def process(self, output):
+        # Remove the last line of the output (row count)
+        output = output[:-1]
+        rows = parse_columns_and_rows(
+            output,
+            "|",
+            # Remove the "dat" prefix on column names
+            remove_column_prefix="dat",
+        )
+
+        databases = {}
+
+        for details in rows:
+            details["encoding"] = details.pop("pg_encoding_to_char")
+
+            for key, value in list(details.items()):
+                if key.endswith("id") or key in (
+                    "dba",
+                    "tablespace",
+                    "connlimit",
+                ):
+                    details[key] = try_int(value)
+
+                if key in ("istemplate", "allowconn"):
+                    details[key] = value == "t"
+
+            databases[details.pop("name")] = details
+
+        return databases

pyinfra/facts/postgresql.py

@@ -1,168 +1,11 @@
 from __future__ import annotations
 
-from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
-from pyinfra.api.util import try_int
+from .postgres import PostgresDatabases, PostgresRoles
 
-from .util.databases import parse_columns_and_rows
 
+class PostgresqlRoles(PostgresRoles):
+    deprecated = True
 
-def make_psql_command(
-    database=None,
-    user=None,
-    password=None,
-    host=None,
-    port=None,
-    executable="psql",
-):
-    target_bits: list[str] = []
 
-    if password:
-        target_bits.append(MaskString('PGPASSWORD="{0}"'.format(password)))
-
-    target_bits.append(executable)
-
-    if database:
-        target_bits.append("-d {0}".format(database))
-
-    if user:
-        target_bits.append("-U {0}".format(user))
-
-    if host:
-        target_bits.append("-h {0}".format(host))
-
-    if port:
-        target_bits.append("-p {0}".format(port))
-
-    return StringCommand(*target_bits)
-
-
-def make_execute_psql_command(command, **psql_kwargs):
-    return StringCommand(
-        make_psql_command(**psql_kwargs),
-        "-Ac",
-        QuoteString(command),  # quote this whole item as a single shell argument
-    )
-
-
-class PostgresqlFactBase(FactBase):
-    abstract = True
-
-    psql_command: str
-    requires_command = "psql"
-
-    def command(
-        self,
-        psql_user=None,
-        psql_password=None,
-        psql_host=None,
-        psql_port=None,
-    ):
-        return make_execute_psql_command(
-            self.psql_command,
-            user=psql_user,
-            password=psql_password,
-            host=psql_host,
-            port=psql_port,
-        )
-
-
-class PostgresqlRoles(PostgresqlFactBase):
-    """
-    Returns a dict of PostgreSQL roles and data:
-
-    .. code:: python
-
-        {
-            "pyinfra": {
-                "super": true,
-                "createrole": false,
-                "createdb": false,
-                ...
-            },
-        }
-    """
-
-    default = dict
-    psql_command = "SELECT * FROM pg_catalog.pg_roles"
-
-    def process(self, output):
-        # Remove the last line of the output (row count)
-        output = output[:-1]
-        rows = parse_columns_and_rows(
-            output,
-            "|",
-            # Remove the "rol" prefix on column names
-            remove_column_prefix="rol",
-        )
-
-        users = {}
-
-        for details in rows:
-            for key, value in list(details.items()):
-                if key in ("oid", "connlimit"):
-                    details[key] = try_int(value)
-
-                if key in (
-                    "super",
-                    "inherit",
-                    "createrole",
-                    "createdb",
-                    "canlogin",
-                    "replication",
-                    "bypassrls",
-                ):
-                    details[key] = value == "t"
-
-            users[details.pop("name")] = details
-
-        return users
-
-
-class PostgresqlDatabases(PostgresqlFactBase):
-    """
-    Returns a dict of PostgreSQL databases and metadata:
-
-    .. code:: python
-
-        {
-            "pyinfra_stuff": {
-                "encoding": "UTF8",
-                "collate": "en_US.UTF-8",
-                "ctype": "en_US.UTF-8",
-                ...
-            },
-        }
-    """
-
-    default = dict
-    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), * FROM pg_catalog.pg_database"
-
-    def process(self, output):
-        # Remove the last line of the output (row count)
-        output = output[:-1]
-        rows = parse_columns_and_rows(
-            output,
-            "|",
-            # Remove the "dat" prefix on column names
-            remove_column_prefix="dat",
-        )
-
-        databases = {}
-
-        for details in rows:
-            details["encoding"] = details.pop("pg_encoding_to_char")
-
-            for key, value in list(details.items()):
-                if key.endswith("id") or key in (
-                    "dba",
-                    "tablespace",
-                    "connlimit",
-                ):
-                    details[key] = try_int(value)
-
-                if key in ("istemplate", "allowconn"):
-                    details[key] = value == "t"
-
-            databases[details.pop("name")] = details
-
-        return databases
+class PostgresqlDatabases(PostgresDatabases):
+    deprecated = True

pyinfra/facts/rpm.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import re
+import shlex
 
 from pyinfra.api import FactBase
 
@@ -19,8 +22,11 @@ class RpmPackages(FactBase):
         }
     """
 
-    command = 'rpm --queryformat "{0}" -qa'.format(rpm_query_format)
-    requires_command = "rpm"
+    def command(self) -> str:
+        return "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
+
+    def requires_command(self) -> str:
+        return "rpm"
 
     default = dict
 
@@ -40,14 +46,15 @@ class RpmPackage(FactBase):
         }
     """
 
-    requires_command = "rpm"
+    def requires_command(self, package) -> str:
+        return "rpm"
 
-    def command(self, name):
+    def command(self, package) -> str:
         return (
-            'rpm --queryformat "{0}" -q {1} || '
+            "rpm --queryformat {0} -q {1} || "
             "! test -e {1} || "
-            'rpm --queryformat "{0}" -qp {1} 2> /dev/null'
-        ).format(rpm_query_format, name)
+            "rpm --queryformat {0} -qp {1} 2> /dev/null"
+        ).format(shlex.quote(rpm_query_format), shlex.quote(package))
 
     def process(self, output):
         for line in output:
@@ -66,18 +73,17 @@ class RpmPackageProvides(FactBase):
 
     default = list
 
-    requires_command = "repoquery"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "repoquery"
 
-    @staticmethod
-    def command(name):
+    def command(self, package):
         # Accept failure here (|| true) for invalid/unknown packages
-        return 'repoquery --queryformat "{0}" --whatprovides {1} || true'.format(
-            rpm_query_format,
-            name,
+        return "repoquery --queryformat {0} --whatprovides {1} || true".format(
+            shlex.quote(rpm_query_format),
+            shlex.quote(package),
         )
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         packages = []
 
         for line in output:

pyinfra/facts/runit.py

@@ -0,0 +1,70 @@
+from pyinfra.api import FactBase
+
+
+class RunitStatus(FactBase):
+    """
+    Returns a dict of name -> status for runit services.
+
+    + service: optionally check only for a single service
+    + svdir: alternative ``SVDIR``
+
+    .. code:: python
+
+        {
+            'agetty-tty1': True,     # service is running
+            'dhcpcd': False,         # service is down
+            'wpa_supplicant': None,  # service is managed, but not running or down,
+                                     # possibly in a fail state
+        }
+    """
+
+    default = dict
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "sv"
+
+    def command(self, service=None, svdir="/var/service") -> str:
+        if service is None:
+            return (
+                'export SVDIR="{0}" && '
+                'cd "$SVDIR" && find * -maxdepth 0 -exec sv status {{}} + 2>/dev/null'
+            ).format(svdir)
+        else:
+            return 'SVDIR="{0}" sv status "{1}"'.format(svdir, service)
+
+    def process(self, output):
+        services = {}
+        for line in output:
+            statusstr, service, _ = line.split(sep=": ", maxsplit=2)
+            status = None
+
+            if statusstr == "run":
+                status = True
+            elif statusstr == "down":
+                status = False
+            # another observable state is "fail"
+            # report as ``None`` for now
+
+            services[service] = status
+
+        return services
+
+
+class RunitManaged(FactBase):
+    """
+    Returns a set of all services managed by runit
+
+    + service: optionally check only for a single service
+    + svdir: alternative ``SVDIR``
+    """
+
+    default = set
+
+    def command(self, service=None, svdir="/var/service"):
+        if service is None:
+            return 'cd "{0}" && find -mindepth 1 -maxdepth 1 -type l -printf "%f\n"'.format(svdir)
+        else:
+            return 'cd "{0}" && test -h "{1}" && echo "{1}" || true'.format(svdir, service)
+
+    def process(self, output):
+        return set(output)

pyinfra/facts/selinux.py

@@ -14,7 +14,9 @@ class SEBoolean(FactBase):
     If ``boolean`` does not exist, ``SEBoolean`` returns the empty string.
     """
 
-    requires_command = "getsebool"
+    def requires_command(self, boolean) -> str:
+        return "getsebool"
+
     default = str
 
     def command(self, boolean):
@@ -60,9 +62,11 @@ class FileContextMapping(FactBase):
     Note: This fact requires root privileges.
     """
 
-    requires_command = "semanage"
     default = dict
 
+    def requires_command(self, target) -> str:
+        return "semanage"
+
     def command(self, target):
         return "set -o pipefail && semanage fcontext -n -l | (grep '^{0}' || true)".format(target)
 
@@ -87,11 +91,13 @@ class SEPorts(FactBase):
         }
     """
 
-    requires_command = "semanage"
     default = dict
     # example output: amqp_port_t                    tcp      15672, 5671-5672  # noqa: SC100
     _regex = re.compile(r"^([\w_]+)\s+(\w+)\s+([\w\-,\s]+)$")
 
+    def requires_command(self) -> str:
+        return "semanage"
+
     def command(self):
         return "semanage port -ln"
 
@@ -122,9 +128,11 @@ class SEPort(FactBase):
     Note: ``policycoreutils-dev`` must be installed for this to work.
     """
 
-    requires_command = "sepolicy"
     default = str
 
+    def requires_command(self, protocol, port) -> str:
+        return "sepolicy"
+
     def command(self, protocol, port):
         return "(sepolicy network -p {0} 2>/dev/null || true) | grep {1}".format(port, protocol)