pyinfra 0.11.dev3__py3-none-any.whl → 3.5.1__py3-none-any.whl

pyinfra/facts/openrc.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+import re
+
+from typing_extensions import override
+
+from pyinfra.api import FactBase
+
+
+class OpenrcStatus(FactBase):
+    """
+    Returns a dict of name -> status for OpenRC services for a given runlevel.
+    """
+
+    default = dict
+    regex = (
+        r"\s+([a-zA-Z0-9\-_]+)"
+        r"\s+\[\s+"
+        r"([a-z]+)"
+        r"(?:\s(?:[0-9]+\sday\(s\)\s)?"
+        r"[0-9]+\:[0-9]+\:[0-9]+\s\([0-9]+\))?"
+        r"\s+\]"
+    )
+
+    @override
+    def requires_command(self, runlevel="default") -> str:
+        return "rc-status"
+
+    @override
+    def command(self, runlevel="default"):
+        return "rc-status {0}".format(runlevel)
+
+    @override
+    def process(self, output):
+        services = {}
+
+        for line in output:
+            matches = re.match(self.regex, line)
+            if matches:
+                services[matches.group(1)] = matches.group(2) == "started"
+
+        return services
+
+
+class OpenrcEnabled(FactBase):
+    """
+    Returns a dict of name -> whether enabled for OpenRC services for a given runlevel.
+    """
+
+    default = dict
+
+    @override
+    def requires_command(self, runlevel="default") -> str:
+        return "rc-update"
+
+    @override
+    def command(self, runlevel="default"):
+        self.runlevel = runlevel
+        return "rc-update show -v"
+
+    @override
+    def process(self, output):
+        services = {}
+
+        for line in output:
+            name, levels = line.split("|", 1)
+            name = name.strip()
+            levels = levels.split()
+            services[name] = self.runlevel in levels
+
+        return services

pyinfra/facts/opkg.py

@@ -0,0 +1,246 @@
+"""
+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,
+    )
+
+    @override
+    @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

@@ -1,22 +1,65 @@
+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'^([a-zA-Z\-]+)\s([0-9\._+a-z\-]+)'
+PACMAN_REGEX = r"^([0-9a-zA-Z\-_]+)\s([0-9\._+a-z\-:]+)"
+
+
+class PacmanUnpackGroup(FactBase):
+    """
+    Returns a list of actual packages belonging to the provided package name,
+    expanding groups or virtual packages.
+
+    .. code:: python
+
+        [
+            "package_name",
+        ]
+    """
+
+    @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
 
 
 class PacmanPackages(FactBase):
-    '''
+    """
     Returns a dict of installed pacman packages:
 
     .. code:: python
 
-        'package_name': ['version'],
-        ...
-    '''
+        {
+            "package_name": ["version"],
+        }
+    """
+
+    @override
+    def command(self) -> str:
+        return "pacman -Q"
+
+    @override
+    def requires_command(self, *args, **kwargs) -> str:
+        return "pacman"
 
-    command = 'pacman -Q'
-    deafult = dict
+    default = dict
 
+    @override
     def process(self, output):
         return parse_packages(PACMAN_REGEX, output)

pyinfra/facts/pip.py

@@ -1,24 +1,41 @@
+from __future__ import annotations
+
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
 
-PIP_REGEX = r'^([a-zA-Z0-9_\-\+\.]+)==([0-9\.]+[a-z0-9\-]*)$'
+PIP_REGEX = r"^([a-zA-Z0-9_\-\+\.]+)==([0-9\.]+[a-z0-9\-]*)$"
 
 
 class PipPackages(FactBase):
-    '''
+    """
     Returns a dict of installed pip packages:
 
     .. code:: python
 
-        'package_name': ['version'],
-        ...
-    '''
+        {
+            "package_name": ["version"],
+        }
+    """
 
     default = dict
+    pip_command = "pip"
+
+    @override
+    def requires_command(self, pip=None):
+        return pip or self.pip_command
 
-    def command(self, pip='pip'):
-        return '{0} freeze --all'.format(pip)
+    @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)
+
+
+class Pip3Packages(PipPackages):
+    pip_command = "pip3"

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,21 +1,30 @@
+from __future__ import annotations
+
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
 
 
 class PkgPackages(FactBase):
-    '''
+    """
     Returns a dict of installed pkg packages:
 
     .. code:: python
 
-        'package_name': ['version'],
-        ...
-    '''
+        {
+            "package_name": ["version"],
+        }
+    """
 
-    command = 'pkg_info'
-    regex = r'^([a-zA-Z0-9_\-\+]+)\-([0-9a-z\.]+)'
+    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

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing_extensions import override
+
+from pyinfra.api import FactBase
+
+from .util.packaging import parse_packages
+
+PKGIN_REGEX = r"^([a-zA-Z\-0-9]+)-([0-9\.]+\-?[a-z0-9]*)\s"
+
+
+class PkginPackages(FactBase):
+    """
+    Returns a dict of installed pkgin packages:
+
+    .. code:: python
+
+        {
+            "package_name": ["version"],
+        }
+    """
+
+    @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