pyinfra 3.1.1__py2.py3-none-any.whl → 3.3__py2.py3-none-any.whl

pyinfra/facts/opkg.py

@@ -0,0 +1,245 @@
+"""
+Gather the information provided by ``opkg`` on OpenWrt systems:
+    + ``opkg`` configuration
+    + feeds configuration
+    + list of installed packages
+    + list of packages with available upgrades
+
+
+    see https://openwrt.org/docs/guide-user/additional-software/opkg
+"""
+
+import re
+from typing import Dict, NamedTuple, Union
+
+from typing_extensions import override
+
+from pyinfra import logger
+from pyinfra.api import FactBase
+from pyinfra.facts.util.packaging import parse_packages
+
+# TODO - change NamedTuple to dataclass Opkgbut need to figure out how to get json serialization
+#        to work without changing core code
+
+
+class OpkgPkgUpgradeInfo(NamedTuple):
+    installed: str
+    available: str
+
+
+class OpkgConfInfo(NamedTuple):
+    paths: Dict[str, str]  # list of paths, e.g. {'root':'/', 'ram':'/tmp}
+    list_dir: str  # where package lists are stored, e.g. /var/opkg-lists
+    options: Dict[
+        str, Union[str, bool]
+    ]  # mapping from option to value, e.g. {'check_signature': True}
+    arch_cfg: Dict[str, int]  # priorities for architectures
+
+
+class OpkgFeedInfo(NamedTuple):
+    url: str  # url for the feed
+    fmt: str  # format of the feed, e.g. "src/gz"
+    kind: str  # whether it comes from the 'distribution' or is 'custom'
+
+
+class OpkgConf(FactBase):
+    """
+    Returns a NamedTuple with the current configuration:
+
+    .. code:: python
+
+        ConfInfo(
+            paths = {
+                "root": "/",
+                "ram": "/tmp",
+            },
+            list_dir = "/opt/opkg-lists",
+            options = {
+                "overlay_root": "/overlay"
+            },
+            arch_cfg = {
+                "all": 1,
+                "noarch": 1,
+                "i386_pentium": 10
+            }
+        )
+
+    """
+
+    regex = re.compile(
+        r"""
+                       ^(?:\s*)
+                       (?:
+                       (?:arch\s+(?P<arch>\w+)\s+(?P<priority>\d+))|
+                       (?:dest\s+(?P<dest>\w+)\s+(?P<dest_path>[\w/\-]+))|
+                       (?:lists_dir\s+(?P<lists_dir>ext)\s+(?P<list_path>[\w/\-]+))|
+                       (?:option\s+(?P<option>\w+)(?:\s+(?P<value>[^#]+))?)
+                       )?
+                       (?:\s*\#.*)?
+                       $
+                       """,
+        re.X,
+    )
+
+    @staticmethod
+    def default():
+        return OpkgConfInfo({}, "", {}, {})
+
+    @override
+    def command(self) -> str:
+        return "cat /etc/opkg.conf"
+
+    @override
+    def process(self, output):
+        dest, lists_dir, options, arch_cfg = {}, "", {}, {}
+        for line in output:
+            match = self.regex.match(line)
+
+            if match is None:
+                logger.warning(f"Opkg: could not parse opkg.conf line '{line}'")
+            elif match.group("arch") is not None:
+                arch_cfg[match.group("arch")] = int(match.group("priority"))
+            elif match.group("dest") is not None:
+                dest[match.group("dest")] = match.group("dest_path")
+            elif match.group("lists_dir") is not None:
+                lists_dir = match.group("list_path")
+            elif match.group("option") is not None:
+                options[match.group("option")] = match.group("value") or True
+
+        return OpkgConfInfo(dest, lists_dir, options, arch_cfg)
+
+
+class OpkgFeeds(FactBase):
+    """
+    Returns a dictionary containing the information for the distribution-provided and
+    custom opkg feeds:
+
+    .. code:: python
+
+        {
+         'openwrt_base': FeedInfo(url='http://downloads ... /i386_pentium/base', fmt='src/gz', kind='distribution'), # noqa: E501
+         'openwrt_core': FeedInfo(url='http://downloads ... /x86/geode/packages', fmt='src/gz', kind='distribution'), # noqa: E501
+         'openwrt_luci': FeedInfo(url='http://downloads ... /i386_pentium/luci', fmt='src/gz', kind='distribution'),# noqa: E501
+         'openwrt_packages': FeedInfo(url='http://downloads ... /i386_pentium/packages', fmt='src/gz', kind='distribution'),# noqa: E501
+         'openwrt_routing': FeedInfo(url='http://downloads ... /i386_pentium/routing', fmt='src/gz', kind='distribution'),# noqa: E501
+         'openwrt_telephony': FeedInfo(url='http://downloads ... /i386_pentium/telephony', fmt='src/gz', kind='distribution') # noqa: E501
+        }
+    """
+
+    regex = re.compile(
+        r"^(CUSTOM)|(?:\s*(?P<fmt>[\w/]+)\s+(?P<name>[\w]+)\s+(?P<url>[\w./:]+))?(?:\s*#.*)?$"
+    )
+    default = dict
+
+    @override
+    def command(self) -> str:
+        return "cat /etc/opkg/distfeeds.conf; echo CUSTOM; cat /etc/opkg/customfeeds.conf"
+
+    @override
+    def process(self, output):
+        feeds, kind = {}, "distribution"
+        for line in output:
+            match = self.regex.match(line)
+
+            if match is None:
+                logger.warning(f"Opkg: could not parse /etc/opkg/*feeds.conf line '{line}'")
+            elif match.group(0) == "CUSTOM":
+                kind = "custom"
+            elif match.group("name") is not None:
+                feeds[match.group("name")] = OpkgFeedInfo(
+                    match.group("url"), match.group("fmt"), kind
+                )
+
+        return feeds
+
+
+class OpkgInstallableArchitectures(FactBase):
+    """
+    Returns a dictionary containing the currently installable architectures for this system along
+    with their priority:
+
+    .. code:: python
+
+       {
+         'all': 1,
+         'i386_pentium': 10,
+         'noarch': 1
+        }
+    """
+
+    regex = re.compile(r"^(?:\s*arch\s+(?P<arch>[\w]+)\s+(?P<prio>\d+))?(\s*#.*)?$")
+    default = dict
+
+    @override
+    def command(self) -> str:
+        return "/bin/opkg print-architecture"
+
+    @override
+    def process(self, output):
+        arch_list = {}
+        for line in output:
+            match = self.regex.match(line)
+
+            if match is None:
+                logger.warning(f"could not parse arch line '{line}'")
+            elif match.group("arch") is not None:
+                arch_list[match.group("arch")] = int(match.group("prio"))
+
+        return arch_list
+
+
+class OpkgPackages(FactBase):
+    """
+    Returns a dict of installed opkg packages:
+
+    .. code:: python
+
+       {
+         'package_name': ['version'],
+         ...
+       }
+    """
+
+    regex = r"^([a-zA-Z0-9][\w\-\.]*)\s-\s([\w\-\.]+)"
+    default = dict
+
+    @override
+    def command(self) -> str:
+        return "/bin/opkg list-installed"
+
+    @override
+    def process(self, output):
+        return parse_packages(self.regex, sorted(output))
+
+
+class OpkgUpgradeablePackages(FactBase):
+    """
+    Returns a dict of installed and upgradable opkg packages:
+
+    .. code:: python
+
+        {
+          'package_name': (installed='1.2.3', available='1.2.8')
+          ...
+        }
+    """
+
+    regex = re.compile(r"^([a-zA-Z0-9][\w\-.]*)\s-\s([\w\-.]+)\s-\s([\w\-.]+)")
+    default = dict
+    use_default_on_error = True
+
+    @override
+    def command(self) -> str:
+        return "/bin/opkg list-upgradable"  # yes, really spelled that way
+
+    @override
+    def process(self, output):
+        result = {}
+        for line in output:
+            match = self.regex.match(line)
+            if match and len(match.groups()) == 3:
+                result[match.group(1)] = OpkgPkgUpgradeInfo(match.group(2), match.group(3))
+            else:
+                logger.warning(f"Opkg: could not list-upgradable line '{line}'")
+
+        return result

pyinfra/facts/pacman.py

@@ -2,11 +2,13 @@ from __future__ import annotations
 
 import shlex
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
 
-PACMAN_REGEX = r"^([0-9a-zA-Z\-]+)\s([0-9\._+a-z\-]+)"
+PACMAN_REGEX = r"^([0-9a-zA-Z\-_]+)\s([0-9\._+a-z\-:]+)"
 
 
 class PacmanUnpackGroup(FactBase):
@@ -21,15 +23,18 @@ class PacmanUnpackGroup(FactBase):
         ]
     """
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "pacman"
 
     default = list
 
+    @override
     def command(self, package):
         # Accept failure here (|| true) for invalid/unknown packages
         return 'pacman -S --print-format "%n" {0} || true'.format(shlex.quote(package))
 
+    @override
     def process(self, output):
         return output
 
@@ -45,13 +50,16 @@ class PacmanPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "pacman -Q"
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "pacman"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(PACMAN_REGEX, output)

pyinfra/facts/pip.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -21,13 +23,16 @@ class PipPackages(FactBase):
     default = dict
     pip_command = "pip"
 
+    @override
     def requires_command(self, pip=None):
         return pip or self.pip_command
 
+    @override
     def command(self, pip=None):
         pip = pip or self.pip_command
         return "{0} freeze --all".format(pip)
 
+    @override
     def process(self, output):
         return parse_packages(PIP_REGEX, output)
 

pyinfra/facts/pipx.py

@@ -0,0 +1,82 @@
+import re
+
+from typing_extensions import override
+
+from pyinfra.api import FactBase
+
+from .util.packaging import parse_packages
+
+
+# TODO: move to an utils file
+def parse_environment(output):
+    environment_REGEX = r"^(?P<key>[A-Z_]+)=(?P<value>.*)$"
+    environment_variables = {}
+
+    for line in output:
+        matches = re.match(environment_REGEX, line)
+
+        if matches:
+            environment_variables[matches.group("key")] = matches.group("value")
+
+    return environment_variables
+
+
+PIPX_REGEX = r"^([a-zA-Z0-9_\-\+\.]+)\s+([0-9\.]+[a-z0-9\-]*)$"
+
+
+class PipxPackages(FactBase):
+    """
+    Returns a dict of installed pipx packages:
+
+    .. code:: python
+
+        {
+            "package_name": ["version"],
+        }
+    """
+
+    default = dict
+
+    @override
+    def requires_command(self) -> str:
+        return "pipx"
+
+    @override
+    def command(self) -> str:
+        return "pipx list --short"
+
+    @override
+    def process(self, output):
+        return parse_packages(PIPX_REGEX, output)
+
+
+class PipxEnvironment(FactBase):
+    """
+    Returns a dict of pipx environment variables:
+
+    .. code:: python
+
+        {
+            "PIPX_HOME": "/home/doodba/.local/pipx",
+            "PIPX_BIN_DIR": "/home/doodba/.local/bin",
+            "PIPX_SHARED_LIBS": "/home/doodba/.local/pipx/shared",
+            "PIPX_LOCAL_VENVS": "/home/doodba/.local/pipx/venvs",
+            "PIPX_LOG_DIR": "/home/doodba/.local/pipx/logs",
+            "PIPX_TRASH_DIR": "/home/doodba/.local/pipx/.trash",
+            "PIPX_VENV_CACHEDIR": "/home/doodba/.local/pipx/.cache",
+        }
+    """
+
+    default = dict
+
+    @override
+    def requires_command(self) -> str:
+        return "pipx"
+
+    @override
+    def command(self) -> str:
+        return "pipx environment"
+
+    @override
+    def process(self, output):
+        return parse_environment(output)

pyinfra/facts/pkg.py

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

pyinfra/facts/pkgin.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -18,13 +20,16 @@ class PkginPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "pkgin list"
 
+    @override
     def requires_command(self) -> str:
         return "pkgin"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(PKGIN_REGEX, output)

pyinfra/facts/podman.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import json
+from typing import Any, Dict, Iterable, List, TypeVar
+
+from typing_extensions import override
+
+from pyinfra.api import FactBase
+
+T = TypeVar("T")
+
+
+class PodmanFactBase(FactBase[T]):
+    """
+    Base for facts using `podman` to retrieve
+    """
+
+    abstract = True
+
+    @override
+    def requires_command(self, *args, **kwargs) -> str:
+        return "podman"
+
+
+class PodmanSystemInfo(PodmanFactBase[Dict[str, Any]]):
+    """
+    Output of 'podman system info'
+    """
+
+    @override
+    def command(self) -> str:
+        return "podman system info --format=json"
+
+    @override
+    def process(self, output: Iterable[str]) -> Dict[str, Any]:
+        output = json.loads(("").join(output))
+        assert isinstance(output, dict)
+        return output
+
+
+class PodmanPs(PodmanFactBase[List[Dict[str, Any]]]):
+    """
+    Output of 'podman ps'
+    """
+
+    @override
+    def command(self) -> str:
+        return "podman ps --format=json --all"
+
+    @override
+    def process(self, output: Iterable[str]) -> List[Dict[str, Any]]:
+        output = json.loads(("").join(output))
+        assert isinstance(output, list)
+        return output  # type: ignore

pyinfra/facts/postgres.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
 from pyinfra.api.util import try_int
 
@@ -49,15 +51,18 @@ class PostgresFactBase(FactBase):
 
     psql_command: str
 
+    @override
     def requires_command(self, *args, **kwargs):
         return "psql"
 
+    @override
     def command(
         self,
         psql_user=None,
         psql_password=None,
         psql_host=None,
         psql_port=None,
+        psql_database=None,
     ):
         return make_execute_psql_command(
             self.psql_command,
@@ -65,6 +70,7 @@ class PostgresFactBase(FactBase):
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         )
 
 
@@ -87,6 +93,7 @@ class PostgresRoles(PostgresFactBase):
     default = dict
     psql_command = "SELECT * FROM pg_catalog.pg_roles"
 
+    @override
     def process(self, output):
         # Remove the last line of the output (row count)
         output = output[:-1]
@@ -137,8 +144,9 @@ class PostgresDatabases(PostgresFactBase):
     """
 
     default = dict
-    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), * FROM pg_catalog.pg_database"
+    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), *, pg_catalog.pg_get_userbyid(datdba) AS owner FROM pg_catalog.pg_database"  # noqa: E501
 
+    @override
     def process(self, output):
         # Remove the last line of the output (row count)
         output = output[:-1]
@@ -153,7 +161,7 @@ class PostgresDatabases(PostgresFactBase):
 
         for details in rows:
             details["encoding"] = details.pop("pg_encoding_to_char")
-
+            details["owner"] = details.pop("owner")
             for key, value in list(details.items()):
                 if key.endswith("id") or key in (
                     "dba",

pyinfra/facts/rpm.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 import shlex
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -22,14 +24,17 @@ class RpmPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
 
+    @override
     def requires_command(self) -> str:
         return "rpm"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(rpm_regex, output)
 
@@ -46,9 +51,11 @@ class RpmPackage(FactBase):
         }
     """
 
+    @override
     def requires_command(self, package) -> str:
         return "rpm"
 
+    @override
     def command(self, package) -> str:
         return (
             "rpm --queryformat {0} -q {1} || "
@@ -56,6 +63,7 @@ class RpmPackage(FactBase):
             "rpm --queryformat {0} -qp {1} 2> /dev/null"
         ).format(shlex.quote(rpm_query_format), shlex.quote(package))
 
+    @override
     def process(self, output):
         for line in output:
             matches = re.match(rpm_regex, line)
@@ -73,9 +81,11 @@ class RpmPackageProvides(FactBase):
 
     default = list
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "repoquery"
 
+    @override
     def command(self, package):
         # Accept failure here (|| true) for invalid/unknown packages
         return "repoquery --queryformat {0} --whatprovides {1} || true".format(
@@ -83,6 +93,7 @@ class RpmPackageProvides(FactBase):
             shlex.quote(package),
         )
 
+    @override
     def process(self, output):
         packages = []
 

pyinfra/facts/runit.py

@@ -1,3 +1,5 @@
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -20,9 +22,11 @@ class RunitStatus(FactBase):
 
     default = dict
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "sv"
 
+    @override
     def command(self, service=None, svdir="/var/service") -> str:
         if service is None:
             return (
@@ -32,6 +36,7 @@ class RunitStatus(FactBase):
         else:
             return 'SVDIR="{0}" sv status "{1}"'.format(svdir, service)
 
+    @override
     def process(self, output):
         services = {}
         for line in output:
@@ -60,11 +65,13 @@ class RunitManaged(FactBase):
 
     default = set
 
+    @override
     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)
 
+    @override
     def process(self, output):
         return set(output)