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

pyinfra/facts/vzctl.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import json
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -20,14 +22,17 @@ class OpenvzContainers(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "vzlist -a -j"
 
+    @override
     def requires_command(self) -> str:
         return "vzlist"
 
     default = dict
 
+    @override
     def process(self, output):
         combined_json = "".join(output)
         vz_data = json.loads(combined_json)

pyinfra/facts/xbps.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
@@ -16,15 +18,18 @@ class XbpsPackages(FactBase):
         }
     """
 
+    @override
     def requires_command(self) -> str:
         return "xbps-query"
 
     default = dict
 
-    regex = r"^.. ([a-zA-Z0-9_\-\+]+)\-([0-9a-z_\.]+)"
+    regex = r"^.. ([a-zA-Z0-9_\-\+\.]+)\-([0-9a-z\.]+_[0-9]+)"
 
+    @override
     def command(self):
         return "xbps-query -l"
 
+    @override
     def process(self, output):
         return parse_packages(self.regex, output)

pyinfra/facts/yum.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command
@@ -23,16 +25,19 @@ class YumRepositories(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/yum.conf",
             "/etc/yum.repos.d/*.repo",
         )
 
+    @override
     def requires_command(self) -> str:
         return "yum"
 
     default = list
 
+    @override
     def process(self, output):
         return parse_yum_repositories(output)

pyinfra/facts/zfs.py

@@ -1,7 +1,9 @@
 """
-Manage ZFS filesystems.
+Gather information about ZFS filesystems.
 """
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase, ShortFactBase
 
 
@@ -15,43 +17,61 @@ def _process_zfs_props_table(output):
     return datasets
 
 
-class Pools(FactBase):
-    def command(self):
+class ZfsPools(FactBase):
+    @override
+    def command(self) -> str:
         return "zpool get -H all"
 
-    @staticmethod
-    def process(output):
+    @override
+    def requires_command(self) -> str:
+        return "zpool"
+
+    @override
+    def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Datasets(FactBase):
-    def command(self):
+class ZfsDatasets(FactBase):
+    @override
+    def command(self) -> str:
         return "zfs get -H all"
 
-    @staticmethod
-    def process(output):
+    @override
+    def requires_command(self) -> str:
+        return "zfs"
+
+    @override
+    def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Filesystems(ShortFactBase):
-    fact = Datasets
+class ZfsFilesystems(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    @override
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "filesystem"}
 
 
-class Snapshots(ShortFactBase):
-    fact = Datasets
+class ZfsSnapshots(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    @override
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "snapshot"}
 
 
-class Volumes(ShortFactBase):
-    fact = Datasets
+class ZfsVolumes(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    @override
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "volume"}
+
+
+# TODO: remove these in v4! Or flip the convention and remove all the other fact prefixes!
+Pools = ZfsPools
+Datasets = ZfsDatasets
+Filesystems = ZfsFilesystems
+Snapshots = ZfsSnapshots
+Volumes = ZfsVolumes

pyinfra/facts/zypper.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command
@@ -23,15 +25,18 @@ class ZypperRepositories(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/zypp/repos.d/*.repo",
         )
 
+    @override
     def requires_command(self) -> str:
         return "zypper"
 
     default = list
 
+    @override
     def process(self, output):
         return parse_zypper_repositories(output)

pyinfra/local.py

@@ -1,4 +1,5 @@
 from os import path
+from typing import Optional
 
 import click
 
@@ -10,7 +11,7 @@ from pyinfra.connectors.util import run_local_process
 from pyinfra.context import ctx_state
 
 
-def include(filename: str):
+def include(filename: str, data: Optional[dict] = None):
     """
     Executes a local python file within the ``pyinfra.state.cwd``
     directory.
@@ -33,7 +34,7 @@ def include(filename: str):
 
         from pyinfra_cli.util import exec_file
 
-        with host.deploy(path.relpath(filename, state.cwd), None, None, in_deploy=False):
+        with host.deploy(path.relpath(filename, state.cwd), None, data, in_deploy=False):
             exec_file(filename)
 
         # One potential solution to the above is to add local as an actual

pyinfra/operations/apt.py

@@ -9,7 +9,13 @@ from urllib.parse import urlparse
 
 from pyinfra import host
 from pyinfra.api import OperationError, operation
-from pyinfra.facts.apt import AptKeys, AptSources, parse_apt_repo
+from pyinfra.facts.apt import (
+    AptKeys,
+    AptSources,
+    SimulateOperationWillChange,
+    noninteractive_apt,
+    parse_apt_repo,
+)
 from pyinfra.facts.deb import DebPackage, DebPackages
 from pyinfra.facts.files import File
 from pyinfra.facts.gpg import GpgKey
@@ -21,21 +27,22 @@ from .util.packaging import ensure_packages
 APT_UPDATE_FILENAME = "/var/lib/apt/periodic/update-success-stamp"
 
 
-def noninteractive_apt(command: str, force=False):
-    args = ["DEBIAN_FRONTEND=noninteractive apt-get -y"]
-
-    if force:
-        args.append("--force-yes")
-
-    args.extend(
-        (
-            '-o Dpkg::Options::="--force-confdef"',
-            '-o Dpkg::Options::="--force-confold"',
-            command,
-        ),
-    )
-
-    return " ".join(args)
+def _simulate_then_perform(command: str):
+    changes = host.get_fact(SimulateOperationWillChange, command)
+
+    if not changes:
+        # Simulating apt-get command failed, so the actual
+        # operation will probably fail too:
+        yield noninteractive_apt(command)
+    elif (
+        changes["upgraded"] == 0
+        and changes["newly_installed"] == 0
+        and changes["removed"] == 0
+        and changes["not_upgraded"] == 0
+    ):
+        host.noop(f"{command} skipped, no changes would be performed")
+    else:
+        yield noninteractive_apt(command)
 
 
 @operation()
@@ -321,12 +328,12 @@ def update(cache_time: int | None = None):
 _update = update  # noqa: E305
 
 
-@operation(is_idempotent=False)
+@operation()
 def upgrade(auto_remove: bool = False):
     """
     Upgrades all apt packages.
 
-    + autoremove: removes transitive dependencies that are no longer needed.
+    + auto_remove: removes transitive dependencies that are no longer needed.
 
     **Example:**
 
@@ -349,17 +356,19 @@ def upgrade(auto_remove: bool = False):
     if auto_remove:
         command.append("--autoremove")
 
-    yield noninteractive_apt(" ".join(command))
+    yield from _simulate_then_perform(" ".join(command))
 
 
 _upgrade = upgrade  # noqa: E305 (for use below where update is a kwarg)
 
 
-@operation(is_idempotent=False)
-def dist_upgrade():
+@operation()
+def dist_upgrade(auto_remove: bool = False):
     """
     Updates all apt packages, employing dist-upgrade.
 
+    + auto_remove: removes transitive dependencies that are no longer needed.
+
     **Example:**
 
     .. code:: python
@@ -369,7 +378,12 @@ def dist_upgrade():
         )
     """
 
-    yield noninteractive_apt("dist-upgrade")
+    command = ["dist-upgrade"]
+
+    if auto_remove:
+        command.append("--autoremove")
+
+    yield from _simulate_then_perform(" ".join(command))
 
 
 @operation()

pyinfra/operations/crontab.py

@@ -0,0 +1,189 @@
+from __future__ import annotations
+
+import shlex
+
+from pyinfra import host
+from pyinfra.api import StringCommand, operation
+from pyinfra.api.util import try_int
+from pyinfra.facts.crontab import Crontab, CrontabFile
+from pyinfra.operations.util.files import sed_replace
+
+
+@operation()
+def crontab(
+    command: str,
+    present=True,
+    user: str | None = None,
+    cron_name: str | None = None,
+    minute="*",
+    hour="*",
+    month="*",
+    day_of_week="*",
+    day_of_month="*",
+    special_time: str | None = None,
+    interpolate_variables=False,
+):
+    """
+    Add/remove/update crontab entries.
+
+    + command: the command for the cron
+    + present: whether this cron command should exist
+    + user: the user whose crontab to manage
+    + cron_name: name the cronjob so future changes to the command will overwrite
+    + modify_cron_name: modify the cron name
+    + minute: which minutes to execute the cron
+    + hour: which hours to execute the cron
+    + month: which months to execute the cron
+    + day_of_week: which day of the week to execute the cron
+    + day_of_month: which day of the month to execute the cron
+    + special_time: cron "nickname" time (@reboot, @daily, etc), overrides others
+    + interpolate_variables: whether to interpolate variables in ``command``
+
+    Cron commands:
+        Unless ``name`` is specified the command is used to identify crontab entries.
+        This means commands must be unique within a given users crontab. If you require
+        multiple identical commands, provide a different name argument for each.
+
+    Special times:
+        When provided, ``special_time`` will be used instead of any values passed in
+        for ``minute``/``hour``/``month``/``day_of_week``/``day_of_month``.
+
+    **Example:**
+
+    .. code:: python
+
+        # simple example for a crontab
+        crontab.crontab(
+            name="Backup /etc weekly",
+            command="/bin/tar cf /tmp/etc_bup.tar /etc",
+            name="backup_etc",
+            day_of_week=0,
+            hour=1,
+            minute=0,
+        )
+    """
+
+    def comma_sep(value):
+        if isinstance(value, (list, tuple)):
+            return ",".join("{0}".format(v) for v in value)
+        return value
+
+    minute = comma_sep(minute)
+    hour = comma_sep(hour)
+    month = comma_sep(month)
+    day_of_week = comma_sep(day_of_week)
+    day_of_month = comma_sep(day_of_month)
+
+    ctb0: CrontabFile | dict = host.get_fact(Crontab, user=user)
+    # facts from test are in dict
+    if isinstance(ctb0, dict):
+        ctb = CrontabFile(ctb0)
+    else:
+        ctb = ctb0
+    name_comment = "# pyinfra-name={0}".format(cron_name)
+
+    existing_crontab = ctb.get_command(command=command, name=cron_name)
+    existing_crontab_command = existing_crontab["command"] if existing_crontab else command
+    existing_crontab_match = existing_crontab["command"] if existing_crontab else command
+
+    exists = existing_crontab is not None
+    exists_name = existing_crontab is not None and name_comment in existing_crontab.get(
+        "comments", ""
+    )
+
+    edit_commands: list[str | StringCommand] = []
+    temp_filename = host.get_temp_filename()
+
+    if special_time:
+        new_crontab_line = "{0} {1}".format(special_time, command)
+    else:
+        new_crontab_line = "{minute} {hour} {day_of_month} {month} {day_of_week} {command}".format(
+            minute=minute,
+            hour=hour,
+            day_of_month=day_of_month,
+            month=month,
+            day_of_week=day_of_week,
+            command=command,
+        )
+
+    existing_crontab_match = ".*{0}.*".format(existing_crontab_match)
+
+    # Don't want the cron and it does exist? Remove the line
+    if not present and exists:
+        edit_commands.append(
+            sed_replace(
+                temp_filename,
+                existing_crontab_match,
+                "",
+                interpolate_variables=interpolate_variables,
+            ),
+        )
+
+    # Want the cron but it doesn't exist? Append the line
+    elif present and not exists:
+        print("present", present, "exists", exists)
+        if ctb:  # append a blank line if cron entries already exist
+            edit_commands.append("echo '' >> {0}".format(temp_filename))
+        if cron_name:
+            edit_commands.append(
+                "echo {0} >> {1}".format(
+                    shlex.quote(name_comment),
+                    temp_filename,
+                ),
+            )
+
+        edit_commands.append(
+            "echo {0} >> {1}".format(
+                shlex.quote(new_crontab_line),
+                temp_filename,
+            ),
+        )
+
+    # We have the cron and it exists, do it's details? If not, replace the line
+    elif present and exists:
+        assert existing_crontab is not None
+        if any(
+            (
+                exists_name != (cron_name is not None),
+                special_time != existing_crontab.get("special_time"),
+                try_int(minute) != existing_crontab.get("minute"),
+                try_int(hour) != existing_crontab.get("hour"),
+                try_int(month) != existing_crontab.get("month"),
+                try_int(day_of_week) != existing_crontab.get("day_of_week"),
+                try_int(day_of_month) != existing_crontab.get("day_of_month"),
+                existing_crontab_command != command,
+            ),
+        ):
+            if not exists_name and cron_name:
+                new_crontab_line = f"{name_comment}\n{new_crontab_line}"
+            edit_commands.append(
+                sed_replace(
+                    temp_filename,
+                    existing_crontab_match,
+                    new_crontab_line,
+                    interpolate_variables=interpolate_variables,
+                ),
+            )
+
+    if edit_commands:
+        crontab_args = []
+        if user:
+            crontab_args.append("-u {0}".format(user))
+
+        # List the crontab into a temporary file if it exists
+        if ctb:
+            yield "crontab -l {0} > {1}".format(" ".join(crontab_args), temp_filename)
+
+        # Now yield any edits
+        for edit_command in edit_commands:
+            yield edit_command
+
+        # Finally, use the tempfile to write a new crontab
+        yield "crontab {0} {1}".format(" ".join(crontab_args), temp_filename)
+    else:
+        host.noop(
+            "crontab {0} {1}".format(
+                command,
+                "exists" if present else "does not exist",
+            ),
+        )