pyinfra 2.9.1__py2.py3-none-any.whl → 3.0__py2.py3-none-any.whl

pyinfra/facts/postgresql.py

@@ -1,165 +1,11 @@
-from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
-from pyinfra.api.util import try_int
+from __future__ import annotations
 
-from .util.databases import parse_columns_and_rows
+from .postgres import PostgresDatabases, PostgresRoles
 
 
-def make_psql_command(
-    database=None,
-    user=None,
-    password=None,
-    host=None,
-    port=None,
-    executable="psql",
-):
-    target_bits = []
+class PostgresqlRoles(PostgresRoles):
+    deprecated = True
 
-    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
-
-    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,7 +22,7 @@ class RpmPackages(FactBase):
         }
     """
 
-    command = 'rpm --queryformat "{0}" -qa'.format(rpm_query_format)
+    command = "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
     requires_command = "rpm"
 
     default = dict
@@ -42,12 +45,12 @@ class RpmPackage(FactBase):
 
     requires_command = "rpm"
 
-    def command(self, name):
+    def command(self, package):
         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:
@@ -69,11 +72,11 @@ class RpmPackageProvides(FactBase):
     requires_command = "repoquery"
 
     @staticmethod
-    def command(name):
+    def command(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

pyinfra/facts/runit.py

@@ -0,0 +1,68 @@
+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
+        }
+    """
+
+    requires_command = "sv"
+    default = dict
+
+    def command(self, service=None, svdir="/var/service"):
+        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

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 from collections import defaultdict
 
@@ -94,7 +96,7 @@ class SEPorts(FactBase):
         return "semanage port -ln"
 
     def process(self, output):
-        labels = defaultdict(dict)
+        labels: dict[str, dict] = defaultdict(dict)
         for line in output:
             m = SEPorts._regex.match(line)
             if m is None:  # something went wrong

pyinfra/facts/server.py

@@ -1,11 +1,15 @@
+from __future__ import annotations
+
 import os
 import re
 import shutil
 from datetime import datetime
 from tempfile import mkdtemp
+from typing import Dict, List, Optional, Union
 
 from dateutil.parser import parse as parse_date
 from distro import distro
+from typing_extensions import NotRequired, TypedDict
 
 from pyinfra.api import FactBase, ShortFactBase
 from pyinfra.api.util import try_int
@@ -21,12 +25,14 @@ class User(FactBase):
     command = "echo $USER"
 
 
-class Home(FactBase):
+class Home(FactBase[Optional[str]]):
     """
-    Returns the home directory of the current user.
+    Returns the home directory of the given user, or the current user if no user is given.
     """
 
-    command = "echo $HOME"
+    @staticmethod
+    def command(user=""):
+        return f"echo ~{user}"
 
 
 class Path(FactBase):
@@ -37,6 +43,14 @@ class Path(FactBase):
     command = "echo $PATH"
 
 
+class TmpDir(FactBase):
+    """
+    Returns the temporary directory of the current server, if configured.
+    """
+
+    command = "echo $TMPDIR"
+
+
 class Hostname(FactBase):
     """
     Returns the current hostname of the server.
@@ -62,7 +76,7 @@ class KernelVersion(FactBase):
 
 
 # Deprecated/renamed -> Kernel
-class Os(FactBase):
+class Os(FactBase[str]):
     """
     Returns the OS name according to ``uname``.
 
@@ -74,7 +88,7 @@ class Os(FactBase):
 
 
 # Deprecated/renamed -> KernelVersion
-class OsVersion(FactBase):
+class OsVersion(FactBase[str]):
     """
     Returns the OS version according to ``uname``.
 
@@ -85,7 +99,7 @@ class OsVersion(FactBase):
     command = "uname -r"
 
 
-class Arch(FactBase):
+class Arch(FactBase[str]):
     """
     Returns the system architecture according to ``uname``.
     """
@@ -95,7 +109,7 @@ class Arch(FactBase):
     command = "uname -m"
 
 
-class Command(FactBase):
+class Command(FactBase[str]):
     """
     Returns the raw output lines of a given command.
     """
@@ -105,7 +119,7 @@ class Command(FactBase):
         return command
 
 
-class Which(FactBase):
+class Which(FactBase[Optional[str]]):
     """
     Returns the path of a given command, if available.
     """
@@ -115,7 +129,7 @@ class Which(FactBase):
         return "which {0} || true".format(command)
 
 
-class Date(FactBase):
+class Date(FactBase[datetime]):
     """
     Returns the current datetime on the server.
     """
@@ -124,11 +138,11 @@ class Date(FactBase):
     default = datetime.now
 
     @staticmethod
-    def process(output):
+    def process(output) -> datetime:
         return datetime.strptime(output[0], ISO_DATE_FORMAT)
 
 
-class MacosVersion(FactBase):
+class MacosVersion(FactBase[str]):
     """
     Returns the installed MacOS version.
     """
@@ -137,7 +151,13 @@ class MacosVersion(FactBase):
     requires_command = "sw_vers"
 
 
-class Mounts(FactBase):
+class MountsDict(TypedDict):
+    device: str
+    type: str
+    options: list[str]
+
+
+class Mounts(FactBase[Dict[str, MountsDict]]):
     """
     Returns a dictionary of mounted filesystems and information.
 
@@ -159,8 +179,8 @@ class Mounts(FactBase):
     default = dict
 
     @staticmethod
-    def process(output):
-        devices = {}
+    def process(output) -> dict[str, MountsDict]:
+        devices: dict[str, MountsDict] = {}
 
         for line in output:
             is_map = False
@@ -285,9 +305,14 @@ class Sysctl(FactBase):
         }
     """
 
-    command = "sysctl -a"
     default = dict
 
+    @staticmethod
+    def command(keys=None):
+        if keys is None:
+            return "sysctl -a"
+        return f"sysctl {' '.join(keys)}"
+
     @staticmethod
     def process(output):
         sysctls = {}
@@ -317,7 +342,7 @@ class Sysctl(FactBase):
         return sysctls
 
 
-class Groups(FactBase):
+class Groups(FactBase[List[str]]):
     """
     Returns a list of groups on the system.
     """
@@ -325,9 +350,8 @@ class Groups(FactBase):
     command = "cat /etc/group"
     default = list
 
-    @staticmethod
-    def process(output):
-        groups = []
+    def process(self, output) -> list[str]:
+        groups: list[str] = []
 
         for line in output:
             if ":" in line:
@@ -336,7 +360,17 @@ class Groups(FactBase):
         return groups
 
 
-class Crontab(FactBase):
+class CrontabDict(TypedDict):
+    minute: NotRequired[Union[int, str]]
+    hour: NotRequired[Union[int, str]]
+    month: NotRequired[Union[int, str]]
+    day_of_month: NotRequired[Union[int, str]]
+    day_of_week: NotRequired[Union[int, str]]
+    comments: Optional[list[str]]
+    special_time: NotRequired[str]
+
+
+class Crontab(FactBase[Dict[str, CrontabDict]]):
     """
     Returns a dictionary of cron command -> execution time.
 
@@ -366,9 +400,8 @@ class Crontab(FactBase):
             return "crontab -l -u {0} || true".format(user)
         return "crontab -l || true"
 
-    @staticmethod
-    def process(output):
-        crons = {}
+    def process(self, output):
+        crons: dict[str, CrontabDict] = {}
         current_comments = []
 
         for line in output:
@@ -478,7 +511,14 @@ class Users(FactBase):
         return users
 
 
-class LinuxDistribution(FactBase):
+class LinuxDistributionDict(TypedDict):
+    name: Optional[str]
+    major: Optional[int]
+    minor: Optional[int]
+    release_meta: Dict
+
+
+class LinuxDistribution(FactBase[LinuxDistributionDict]):
     """
     Returns a dict of the Linux distribution version. Ubuntu, Debian, CentOS,
     Fedora & Gentoo currently. Also contains any key/value items located in
@@ -516,7 +556,7 @@ class LinuxDistribution(FactBase):
     }
 
     @staticmethod
-    def default():
+    def default() -> LinuxDistributionDict:
         return {
             "name": None,
             "major": None,
@@ -524,7 +564,7 @@ class LinuxDistribution(FactBase):
             "release_meta": {},
         }
 
-    def process(self, output):
+    def process(self, output) -> LinuxDistributionDict:
         parts = {}
         for part in "\n".join(output).strip().split("---"):
             if not part.strip():
@@ -578,7 +618,7 @@ class LinuxDistribution(FactBase):
         return release_info
 
 
-class LinuxName(ShortFactBase):
+class LinuxName(ShortFactBase[str]):
     """
     Returns the name of the Linux distribution. Shortcut for
     ``host.get_fact(LinuxDistribution)['name']``.
@@ -591,7 +631,11 @@ class LinuxName(ShortFactBase):
         return data["name"]
 
 
-class Selinux(FactBase):
+class SelinuxDict(TypedDict):
+    mode: Optional[str]
+
+
+class Selinux(FactBase[SelinuxDict]):
     """
     Discovers the SELinux related facts on the target host.
 
@@ -606,12 +650,12 @@ class Selinux(FactBase):
     requires_command = "sestatus"
 
     @staticmethod
-    def default():
+    def default() -> SelinuxDict:
         return {
             "mode": None,
         }
 
-    def process(self, output):
+    def process(self, output) -> SelinuxDict:
         selinux_info = self.default()
 
         match = re.match(r"^SELinux status:\s+(\S+)", "\n".join(output))
@@ -624,7 +668,7 @@ class Selinux(FactBase):
         return selinux_info
 
 
-class LinuxGui(FactBase):
+class LinuxGui(FactBase[List[str]]):
     """
     Returns a list of available Linux GUIs.
     """
@@ -640,7 +684,7 @@ class LinuxGui(FactBase):
         "/usr/bin/xfce4-session": "XFCE 4",
     }
 
-    def process(self, output):
+    def process(self, output) -> list[str]:
         gui_names = []
 
         for line in output:
@@ -651,7 +695,7 @@ class LinuxGui(FactBase):
         return gui_names
 
 
-class HasGui(ShortFactBase):
+class HasGui(ShortFactBase[bool]):
     """
     Returns a boolean indicating the remote side has GUI capabilities. Linux only.
     """
@@ -659,11 +703,11 @@ class HasGui(ShortFactBase):
     fact = LinuxGui
 
     @staticmethod
-    def process_data(data):
+    def process_data(data) -> bool:
         return len(data) > 0
 
 
-class Locales(FactBase):
+class Locales(FactBase[List[str]]):
     """
     Returns installed locales on the target host.
 
@@ -676,7 +720,7 @@ class Locales(FactBase):
     requires_command = "locale"
     default = list
 
-    def process(self, output):
+    def process(self, output) -> list[str]:
         # replace utf8 with UTF-8 to match names in /etc/locale.gen
         # return a list of enabled locales
         return [line.replace("utf8", "UTF-8") for line in output]

pyinfra/facts/snap.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase