pyinfra 2.9.2__py2.py3-none-any.whl → 3.0b1__py2.py3-none-any.whl

pyinfra/operations/server.py

@@ -8,6 +8,7 @@ from io import StringIO
 from itertools import filterfalse, tee
 from os import path
 from time import sleep
+from typing import TYPE_CHECKING
 
 from pyinfra import host, logger, state
 from pyinfra.api import FunctionCommand, OperationError, StringCommand, operation
@@ -46,6 +47,9 @@ from . import (
 )
 from .util.files import chmod, sed_replace
 
+if TYPE_CHECKING:
+    from pyinfra.api.arguments_typed import PyinfraOperation
+
 
 @operation(is_idempotent=False)
 def reboot(delay=10, interval=1, reboot_timeout=300):
@@ -75,7 +79,7 @@ def reboot(delay=10, interval=1, reboot_timeout=300):
 
     yield FunctionCommand(remove_any_askpass_file, (), {})
 
-    yield StringCommand("reboot", success_exit_codes=[0, -1])  # -1 being error/disconnected
+    yield StringCommand("reboot", _success_exit_codes=[0, -1])  # -1 being error/disconnected
 
     def wait_and_reconnect(state, host):  # pragma: no cover
         sleep(delay)
@@ -187,8 +191,8 @@ def script(src, args=()):
         )
     """
 
-    temp_file = state.get_temp_filename()
-    yield from files.put(src, temp_file)
+    temp_file = host.get_temp_filename()
+    yield from files.put._inner(src=src, dest=temp_file)
 
     yield chmod(temp_file, "+x")
     yield StringCommand(temp_file, *args)
@@ -217,14 +221,14 @@ def script_template(src, args=(), **data):
         )
     """
 
-    temp_file = state.get_temp_filename("{0}{1}".format(src, data))
-    yield from files.template(src, temp_file, **data)
+    temp_file = host.get_temp_filename("{0}{1}".format(src, data))
+    yield from files.template._inner(src, temp_file, **data)
 
     yield chmod(temp_file, "+x")
     yield StringCommand(temp_file, *args)
 
 
-@operation
+@operation()
 def modprobe(module, present=True, force=False):
     """
     Load/unload kernel modules.
@@ -259,14 +263,10 @@ def modprobe(module, present=True, force=False):
     # Module is loaded and we don't want it?
     if not present and present_mods:
         yield "modprobe{0} -r -a {1}".format(args, " ".join(present_mods))
-        for mod in present_mods:
-            modules.pop(mod)
 
     # Module isn't loaded and we want it?
     elif present and missing_mods:
         yield "modprobe{0} -a {1}".format(args, " ".join(missing_mods))
-        for mod in missing_mods:
-            modules[mod] = {}
 
     else:
         host.noop(
@@ -279,7 +279,7 @@ def modprobe(module, present=True, force=False):
         )
 
 
-@operation
+@operation()
 def mount(
     path,
     mounted=True,
@@ -322,13 +322,10 @@ def mount(
         args.append(path)
 
         yield StringCommand("mount", *args)
-        # Should we update facts with fs_type, device, etc?
-        mounts[path] = {"options": options}
 
     # Want no mount but mounted?
     elif mounted is False and is_mounted:
         yield "umount {0}".format(path)
-        mounts.pop(path)
 
     # Want mount and is mounted! Check the options
     elif is_mounted and mounted and options:
@@ -336,7 +333,6 @@ def mount(
         needed_options = set(options) - set(mounted_options)
         if needed_options:
             yield "mount -o remount,{0} {1}".format(options_string, path)
-            mounts[path]["options"] = options
 
     else:
         host.noop(
@@ -347,7 +343,7 @@ def mount(
         )
 
 
-@operation
+@operation()
 def hostname(hostname, hostname_file=None):
     """
     Set the system hostname using ``hostnamectl`` or ``hostname`` on older systems.
@@ -379,7 +375,6 @@ def hostname(hostname, hostname_file=None):
     if host.get_fact(Which, command="hostnamectl"):
         if current_hostname != hostname:
             yield "hostnamectl set-hostname {0}".format(hostname)
-            host.create_fact(Hostname, data=hostname)
         else:
             host.noop("hostname is set")
         return
@@ -394,7 +389,6 @@ def hostname(hostname, hostname_file=None):
 
     if current_hostname != hostname:
         yield "hostname {0}".format(hostname)
-        host.create_fact(Hostname, data=hostname)
     else:
         host.noop("hostname is set")
 
@@ -403,10 +397,10 @@ def hostname(hostname, hostname_file=None):
         file = StringIO("{0}\n".format(hostname))
 
         # And ensure it exists
-        yield from files.put(file, hostname_file)
+        yield from files.put._inner(src=file, dest=hostname_file)
 
 
-@operation
+@operation()
 def sysctl(
     key,
     value,
@@ -437,24 +431,23 @@ def sysctl(
 
     value = [try_int(v) for v in value] if isinstance(value, list) else try_int(value)
 
-    existing_sysctls = host.get_fact(Sysctl)
-
+    existing_sysctls = host.get_fact(Sysctl, keys=[key])
     existing_value = existing_sysctls.get(key)
+
     if not existing_value or existing_value != value:
         yield "sysctl {0}='{1}'".format(key, string_value)
-        existing_sysctls[key] = value
     else:
         host.noop("sysctl {0} is set to {1}".format(key, string_value))
 
     if persist:
-        yield from files.line(
+        yield from files.line._inner(
             path=persist_file,
             line="{0}[[:space:]]*=[[:space:]]*{1}".format(key, string_value),
             replace="{0} = {1}".format(key, string_value),
         )
 
 
-@operation
+@operation()
 def service(
     service,
     running=True,
@@ -465,7 +458,7 @@ def service(
 ):
     """
     Manage the state of services. This command checks for the presence of all the
-    Linux init systems ``pyinfra`` can handle and executes the relevant operation.
+    Linux init systems pyinfra can handle and executes the relevant operation.
 
     + service: name of the service to manage
     + running: whether the service should be running
@@ -485,6 +478,8 @@ def service(
         )
     """
 
+    service_operation: "PyinfraOperation"
+
     if host.get_fact(Which, command="systemctl"):
         service_operation = systemd.service
 
@@ -503,7 +498,7 @@ def service(
 
     # NOTE: important that we are not Linux here because /etc/rc.d will exist but checking it's
     # contents may trigger things (like a reboot: https://github.com/Fizzadar/pyinfra/issues/819)
-    elif host.get_fact(Os) != "Linux" and host.get_fact(Directory, path="/etc/rc.d"):
+    elif host.get_fact(Os) != "Linux" and bool(host.get_fact(Directory, path="/etc/rc.d")):
         service_operation = bsdinit.service
 
     else:
@@ -511,8 +506,8 @@ def service(
             ("No init system found " "(no systemctl, initctl, /etc/init.d or /etc/rc.d found)"),
         )
 
-    yield from service_operation(
-        service,
+    yield from service_operation._inner(
+        service=service,
         running=running,
         restarted=restarted,
         reloaded=reloaded,
@@ -521,14 +516,14 @@ def service(
     )
 
 
-@operation
+@operation()
 def packages(
     packages,
     present=True,
 ):
     """
     Add or remove system packages. This command checks for the presence of all the
-    system package managers ``pyinfra`` can handle and executes the relevant operation.
+    system package managers pyinfra can handle and executes the relevant operation.
 
     + packages: list of packages to ensure
     + present: whether the packages should be installed
@@ -543,6 +538,8 @@ def packages(
         )
     """
 
+    package_operation: "PyinfraOperation"
+
     # TODO: improve this - use LinuxDistribution fact + mapping with fallback below?
     # Here to be preferred on openSUSE which also provides aptitude
     # See: https://github.com/Fizzadar/pyinfra/issues/799
@@ -581,10 +578,10 @@ def packages(
             ),
         )
 
-    yield from package_operation(packages=packages, present=present)
+    yield from package_operation._inner(packages=packages, present=present)
 
 
-@operation
+@operation()
 def crontab(
     command,
     present=True,
@@ -657,6 +654,8 @@ def crontab(
 
     if not existing_crontab and cron_name:  # find the crontab by name if provided
         for cmd, details in crontab.items():
+            if not details["comments"]:
+                continue
             if name_comment in details["comments"]:
                 existing_crontab = details
                 existing_crontab_match = cmd
@@ -665,7 +664,7 @@ def crontab(
     exists = existing_crontab is not None
 
     edit_commands = []
-    temp_filename = state.get_temp_filename()
+    temp_filename = host.get_temp_filename()
 
     if special_time:
         new_crontab_line = "{0} {1}".format(special_time, command)
@@ -713,6 +712,7 @@ def crontab(
 
     # 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(
             (
                 special_time != existing_crontab.get("special_time"),
@@ -748,20 +748,6 @@ def crontab(
 
         # Finally, use the tempfile to write a new crontab
         yield "crontab {0} {1}".format(" ".join(crontab_args), temp_filename)
-
-        # Update the crontab fact
-        if present:
-            crontab[command] = {
-                "special_time": special_time,
-                "minute": minute,
-                "hour": hour,
-                "month": month,
-                "day_of_week": day_of_week,
-                "day_of_month": day_of_month,
-                "comments": [cron_name] if cron_name else [],
-            }
-        else:
-            crontab.pop(command)
     else:
         host.noop(
             "crontab {0} {1}".format(
@@ -771,7 +757,7 @@ def crontab(
         )
 
 
-@operation
+@operation()
 def group(group, present=True, system=False, gid=None):
     """
     Add/remove system groups.
@@ -811,7 +797,6 @@ def group(group, present=True, system=False, gid=None):
             yield "pw groupdel -n {0}".format(group)
         else:
             yield "groupdel {0}".format(group)
-        groups.remove(group)
 
     # Group doesn't exist and we want it?
     elif present and not is_present:
@@ -837,11 +822,10 @@ def group(group, present=True, system=False, gid=None):
         group_add_command = "groupadd"
         if os_type == "FreeBSD":
             group_add_command = "pw groupadd"
-        yield "grep '^{0}:' /etc/group || {2} {1}".format(group, " ".join(args), group_add_command)
-        groups.append(group)
+        yield "{0} {1}".format(group_add_command, " ".join(args))
 
 
-@operation
+@operation()
 def user_authorized_keys(
     user,
     public_keys,
@@ -860,7 +844,7 @@ def user_authorized_keys(
 
     Public keys:
         These can be provided as strings containing the public key or as a path to
-        a public key file which ``pyinfra`` will read.
+        a public key file which pyinfra will read.
 
     **Examples:**
 
@@ -872,6 +856,7 @@ def user_authorized_keys(
             public_keys=["ed25519..."],
         )
     """
+
     if not authorized_key_directory:
         authorized_key_directory = f"/home/{user}/.ssh/"
     if not authorized_key_filename:
@@ -889,15 +874,15 @@ def user_authorized_keys(
             with open(try_path, "r") as f:
                 return f.read().strip()
 
-        return key
+        return key.strip()
 
     public_keys = list(map(read_any_pub_key_file, public_keys))
 
     # Ensure .ssh directory
     # note that this always outputs commands unless the SSH user has access to the
     # authorized_keys file, ie the SSH user is the user defined in this function
-    yield from files.directory(
-        authorized_key_directory,
+    yield from files.directory._inner(
+        path=authorized_key_directory,
         user=user,
         group=group or user,
         mode=700,
@@ -914,7 +899,7 @@ def user_authorized_keys(
         )
 
         # And ensure it exists
-        yield from files.put(
+        yield from files.put._inner(
             src=keys_file,
             dest=authorized_key_file,
             user=user,
@@ -924,7 +909,7 @@ def user_authorized_keys(
 
     else:
         # Ensure authorized_keys exists
-        yield from files.file(
+        yield from files.file._inner(
             path=authorized_key_file,
             user=user,
             group=group or user,
@@ -933,10 +918,10 @@ def user_authorized_keys(
 
         # And every public key is present
         for key in public_keys:
-            yield from files.line(path=authorized_key_file, line=key, ensure_newline=True)
+            yield from files.line._inner(path=authorized_key_file, line=key, ensure_newline=True)
 
 
-@operation
+@operation()
 def user(
     user,
     present=True,
@@ -983,7 +968,7 @@ def user(
 
     Public keys:
         These can be provided as strings containing the public key or as a path to
-        a public key file which ``pyinfra`` will read.
+        a public key file which pyinfra will read.
 
     **Examples:**
 
@@ -1029,7 +1014,6 @@ def user(
                 yield "pw userdel -n {0}".format(user)
             else:
                 yield "userdel {0}".format(user)
-            users.pop(user)
         return
 
     # User doesn't exist but we want them?
@@ -1079,29 +1063,20 @@ def user(
 
         # Users are often added by other operations (package installs), so check
         # for the user at runtime before adding.
-
         add_user_command = "useradd"
         if os_type == "FreeBSD":
             add_user_command = "pw useradd"
-            yield "grep '^{2}:' /etc/passwd || {0} -n {2} {1}".format(
+            yield "{0} -n {2} {1}".format(
                 add_user_command,
                 " ".join(args),
                 user,
             )
         else:
-            yield "grep '^{2}:' /etc/passwd || {0} {1} {2}".format(
+            yield "{0} {1} {2}".format(
                 add_user_command,
                 " ".join(args),
                 user,
             )
-        users[user] = {
-            "comment": comment,
-            "home": home,
-            "shell": shell,
-            "group": group,
-            "groups": groups,
-            "password": password,
-        }
 
     # User exists and we want them, check home/shell/keys/password
     else:
@@ -1150,8 +1125,8 @@ def user(
 
     # Ensure home directory ownership
     if ensure_home:
-        yield from files.directory(
-            home,
+        yield from files.directory._inner(
+            path=home,
             user=user,
             group=group or user,
             # Don't fail if the home directory exists as a link
@@ -1160,9 +1135,9 @@ def user(
 
     # Add SSH keys
     if public_keys is not None:
-        yield from user_authorized_keys(
-            user,
-            public_keys,
+        yield from user_authorized_keys._inner(
+            user=user,
+            public_keys=public_keys,
             group=group,
             delete_keys=delete_keys,
             authorized_key_directory="{0}/.ssh".format(home),
@@ -1170,7 +1145,7 @@ def user(
         )
 
 
-@operation
+@operation()
 def locale(
     locale,
     present=True,
@@ -1221,7 +1196,7 @@ def locale(
     if not present and locale in locales:
         logger.debug(f"Removing locale {locale}")
 
-        yield from files.line(
+        yield from files.line._inner(
             path=locales_definitions_file, line=f"^{matching_line}$", replace=f"# {matching_line}"
         )
 
@@ -1231,7 +1206,7 @@ def locale(
     if present and locale not in locales:
         logger.debug(f"Adding locale {locale}")
 
-        yield from files.replace(
+        yield from files.replace._inner(
             path=locales_definitions_file,
             text=f"^{matching_line}$",
             replace=f"{matching_line}".replace("# ", ""),
@@ -1240,7 +1215,7 @@ def locale(
         yield "locale-gen"
 
 
-@operation
+@operation()
 def security_limit(
     domain,
     limit_type,
@@ -1270,7 +1245,7 @@ def security_limit(
 
     line_format = f"{domain}\t{limit_type}\t{item}\t{value}"
 
-    yield from files.line(
+    yield from files.line._inner(
         path="/etc/security/limits.conf",
         line=f"^{domain}[[:space:]]+{limit_type}[[:space:]]+{item}",
         replace=line_format,

pyinfra/operations/snap.py

@@ -7,7 +7,7 @@ from pyinfra.api import operation
 from pyinfra.facts.snap import SnapPackage, SnapPackages
 
 
-@operation
+@operation()
 def package(
     packages=None,
     channel="latest/stable",
@@ -91,14 +91,12 @@ def package(
             else:
                 # we don't want it
                 remove_packages.append(package)
-                snap_packages.remove(package)
 
         # it's not installed
         if package not in snap_packages:
             # we want it
             if present:
                 install_packages.append(package)
-                snap_packages.append(package)
 
             # we don't want it
             else:

pyinfra/operations/ssh.py

@@ -6,7 +6,7 @@ Eg: ``pyinfra -> inventory-host.net <-> another-host.net``
 
 import shlex
 
-from pyinfra import host, state
+from pyinfra import host
 from pyinfra.api import OperationError, operation
 from pyinfra.facts.files import File, FindInFile
 from pyinfra.facts.server import Home
@@ -14,7 +14,7 @@ from pyinfra.facts.server import Home
 from . import files
 
 
-@operation
+@operation()
 def keyscan(hostname, force=False, port=22):
     """
     Check/add hosts to the ``~/.ssh/known_hosts`` file.
@@ -34,7 +34,7 @@ def keyscan(hostname, force=False, port=22):
 
     homedir = host.get_fact(Home)
 
-    yield from files.directory(
+    yield from files.directory._inner(
         "{0}/.ssh".format(homedir),
         mode=700,
     )
@@ -45,7 +45,6 @@ def keyscan(hostname, force=False, port=22):
         pattern=hostname,
     )
 
-    did_keyscan = False
     keyscan_command = "ssh-keyscan -p {0} {1} >> {2}/.ssh/known_hosts".format(
         port,
         hostname,
@@ -54,23 +53,14 @@ def keyscan(hostname, force=False, port=22):
 
     if not hostname_present:
         yield keyscan_command
-        did_keyscan = True
 
     elif force:
         yield "ssh-keygen -R {0}".format(hostname)
         yield keyscan_command
-        did_keyscan = True
 
     else:
         host.noop("host key for {0} already exists".format(hostname))
 
-    if did_keyscan:
-        host.create_fact(
-            FindInFile,
-            kwargs={"path": "{0}/.ssh/known_hosts".format(homedir), "pattern": hostname},
-            data=["{0} unknown unknown".format(hostname)],
-        )
-
 
 @operation(is_idempotent=False)
 def command(hostname, command, user=None, port=22):
@@ -133,7 +123,7 @@ def upload(
         connection_target = "@".join((user, hostname))
 
     if ssh_keyscan:
-        yield from keyscan(hostname)
+        yield from keyscan._inner(hostname)
 
     # If we're not using sudo on the remote side, just scp the file over
     if not use_remote_sudo:
@@ -146,7 +136,7 @@ def upload(
 
     else:
         # Otherwise - we need a temporary location for the file
-        temp_remote_filename = state.get_temp_filename()
+        temp_remote_filename = host.get_temp_filename()
 
         # scp it to the temporary location
         upload_cmd = "scp -P {0} {1} {2}:{3}".format(
@@ -159,7 +149,7 @@ def upload(
         yield upload_cmd
 
         # And sudo sudo to move it
-        yield from command(
+        yield from command._inner(
             hostname=hostname,
             command="sudo mv {0} {1}".format(temp_remote_filename, remote_filename),
             port=port,
@@ -167,7 +157,7 @@ def upload(
         )
 
 
-@operation
+@operation()
 def download(
     hostname,
     filename,
@@ -213,7 +203,7 @@ def download(
         connection_target = "@".join((user, hostname))
 
     if ssh_keyscan:
-        yield from keyscan(hostname)
+        yield from keyscan._inner(hostname)
 
     # Download the file with scp
     yield "scp -P {0} {1}:{2} {3}".format(
@@ -222,8 +212,3 @@ def download(
         filename,
         local_filename,
     )
-    host.create_fact(
-        File,
-        kwargs={"path": local_filename},
-        data={"mode": None, "group": None, "user": user, "mtime": None},
-    )

pyinfra/operations/systemd.py

@@ -3,7 +3,7 @@ Manage systemd services.
 """
 
 from pyinfra import host
-from pyinfra.api import operation
+from pyinfra.api import StringCommand, operation
 from pyinfra.facts.systemd import SystemdEnabled, SystemdStatus, _make_systemctl_cmd
 
 from .util.service import handle_service_control
@@ -25,13 +25,13 @@ def daemon_reload(user_mode=False, machine=None, user_name=None):
         user_name=user_name,
     )
 
-    yield "{0} daemon-reload".format(systemctl_cmd)
+    yield StringCommand(systemctl_cmd, "daemon-reload")
 
 
-_daemon_reload = daemon_reload  # noqa: E305
+_daemon_reload = daemon_reload._inner  # noqa: E305
 
 
-@operation
+@operation()
 def service(
     service,
     running=True,
@@ -117,8 +117,9 @@ def service(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
+            services=[service],
         ),
-        " ".join([systemctl_cmd, "{1}", "{0}"]),
+        " ".join([systemctl_cmd.get_raw_value(), "{1}", "{0}"]),
         running,
         restarted,
         reloaded,
@@ -131,15 +132,14 @@ def service(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
+            services=[service],
         )
         is_enabled = systemd_enabled.get(service, False)
 
         # Isn't enabled and want enabled?
         if not is_enabled and enabled is True:
             yield "{0} enable {1}".format(systemctl_cmd, service)
-            systemd_enabled[service] = True
 
         # Is enabled and want disabled?
         elif is_enabled and enabled is False:
             yield "{0} disable {1}".format(systemctl_cmd, service)
-            systemd_enabled[service] = False