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

pyinfra/operations/postgres.py

@@ -8,6 +8,7 @@ All operations in this module take four optional arguments:
     + ``psql_password``: the password for the connecting user
     + ``psql_host``: the hostname of the server to connect to
     + ``psql_port``: the port of the server to connect to
+    + ``psql_database``: the database on the server to connect to
 
 See example/postgresql.py for detailed example
 
@@ -28,48 +29,48 @@ from pyinfra.facts.postgres import (
 @operation(is_idempotent=False)
 def sql(
     sql: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Execute arbitrary SQL against PostgreSQL.
 
     + sql: SQL command(s) to execute
-    + database: optional database to execute against
     + psql_*: global module arguments, see above
     """
 
     yield make_execute_psql_command(
         sql,
-        database=database,
         user=psql_user,
         password=psql_password,
         host=psql_host,
         port=psql_port,
+        database=psql_database,
     )
 
 
 @operation()
 def role(
     role: str,
-    present=True,
+    present: bool = True,
     password: str | None = None,
-    login=True,
-    superuser=False,
-    inherit=False,
-    createdb=False,
-    createrole=False,
-    replication=False,
+    login: bool = True,
+    superuser: bool = False,
+    inherit: bool = False,
+    createdb: bool = False,
+    createrole: bool = False,
+    replication: bool = False,
     connection_limit: int | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Add/remove PostgreSQL roles.
@@ -101,7 +102,7 @@ def role(
             password="somepassword",
             superuser=True,
             login=True,
-            sudo_user="postgres",
+            _sudo_user="postgres",
         )
 
     """
@@ -112,6 +113,7 @@ def role(
         psql_password=psql_password,
         psql_host=psql_host,
         psql_port=psql_port,
+        psql_database=psql_database,
     )
 
     is_present = role in roles
@@ -125,6 +127,7 @@ def role(
                 password=psql_password,
                 host=psql_host,
                 port=psql_port,
+                database=psql_database,
             )
         else:
             host.noop("postgresql role {0} does not exist".format(role))
@@ -157,9 +160,50 @@ def role(
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         )
     else:
-        host.noop("postgresql role {0} exists".format(role))
+        # Check if any attributes need updating
+        current_role = roles[role]
+        should_execute = False
+        sql_bits = ['ALTER ROLE "{0}"'.format(role)]
+        if login and "login" in current_role and current_role["login"] != login:
+            sql_bits.append("LOGIN")
+            should_execute = True
+        if superuser and "superuser" in current_role and current_role["superuser"] != superuser:
+            sql_bits.append("SUPERUSER")
+            should_execute = True
+        if inherit and "inherit" in current_role and current_role["inherit"] != inherit:
+            sql_bits.append("INHERIT")
+            should_execute = True
+        if createdb and "createdb" in current_role and current_role["createdb"] != createdb:
+            sql_bits.append("CREATEDB")
+            should_execute = True
+        if createrole and "createrole" in current_role and current_role["createrole"] != createrole:
+            sql_bits.append("CREATEROLE")
+            should_execute = True
+        if (
+            connection_limit
+            and "connection_limit" in current_role
+            and roles[role]["connection_limit"] != connection_limit
+        ):
+            sql_bits.append("CONNECTION LIMIT {0}".format(connection_limit))
+            should_execute = True
+        if password:
+            sql_bits.append(MaskString("PASSWORD '{0}'".format(password)))
+            should_execute = True
+
+        if should_execute:
+            yield make_execute_psql_command(
+                StringCommand(*sql_bits),
+                user=psql_user,
+                password=psql_password,
+                host=psql_host,
+                port=psql_port,
+                database=psql_database,
+            )
+        else:
+            host.noop("postgresql role {0} exists and does not need updates".format(role))
 
 
 @operation()
@@ -178,6 +222,7 @@ def database(
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Add/remove PostgreSQL databases.
@@ -194,9 +239,8 @@ def database(
     + psql_*: global module arguments, see above
 
     Updates:
-        pyinfra will not attempt to change existing databases - it will either
-        create or drop databases, but not alter them (if the db exists this
-        operation will make no changes).
+        pyinfra will change existing databases - but some parameters are not
+        changeable (template, encoding, lc_collate and lc_ctype).
 
     **Example:**
 
@@ -207,7 +251,7 @@ def database(
             database="pyinfra_stuff",
             owner="pyinfra",
             encoding="UTF8",
-            sudo_user="postgres",
+            _sudo_user="postgres",
         )
 
     """
@@ -218,6 +262,7 @@ def database(
         psql_password=psql_password,
         psql_host=psql_host,
         psql_port=psql_port,
+        psql_database=psql_database,
     )
 
     is_present = database in current_databases
@@ -230,6 +275,7 @@ def database(
                 password=psql_password,
                 host=psql_host,
                 port=psql_port,
+                database=psql_database,
             )
         else:
             host.noop("postgresql database {0} does not exist".format(database))
@@ -243,8 +289,8 @@ def database(
             ("OWNER", '"{0}"'.format(owner) if owner else owner),
             ("TEMPLATE", template),
             ("ENCODING", encoding),
-            ("LC_COLLATE", lc_collate),
-            ("LC_CTYPE", lc_ctype),
+            ("LC_COLLATE", "'{0}'".format(lc_collate) if lc_collate else lc_collate),
+            ("LC_CTYPE", "'{0}'".format(lc_ctype) if lc_ctype else lc_ctype),
             ("TABLESPACE", tablespace),
             ("CONNECTION LIMIT", connection_limit),
         ):
@@ -257,26 +303,70 @@ def database(
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         )
     else:
-        host.noop("postgresql database {0} exists".format(database))
+        current_db = current_databases[database]
+
+        for key, value, current_value in (
+            ("TEMPLATE", template, current_db.get("istemplate")),
+            ("ENCODING", encoding, current_db.get("encoding")),
+            ("LC_COLLATE", lc_collate, None),
+            ("LC_CTYPE", lc_ctype, None),
+        ):
+            if value and (current_value is None or current_value != value):
+                host.noop(
+                    "postgresql database {0} already exists, skipping {1}".format(database, key)
+                )
+
+        sql_bits = []
+
+        if owner and "owner" in current_db and current_db["owner"] != owner:
+            sql_bits.append('ALTER DATABASE "{0}" OWNER TO "{1}";'.format(database, owner))
+
+        if tablespace and "tablespace" in current_db and current_db["tablespace"] != tablespace:
+            sql_bits.append(
+                'ALTER DATABASE "{0}" SET TABLESPACE "{1}";'.format(database, tablespace)
+            )
+
+        if (
+            connection_limit
+            and "connlimit" in current_db
+            and current_db["connlimit"] != connection_limit
+        ):
+            sql_bits.append(
+                'ALTER DATABASE "{0}" CONNECTION LIMIT {1};'.format(database, connection_limit)
+            )
+
+        if len(sql_bits) > 0:
+            yield make_execute_psql_command(
+                StringCommand(*sql_bits),
+                user=psql_user,
+                password=psql_password,
+                host=psql_host,
+                port=psql_port,
+                database=psql_database,
+            )
+        else:
+            host.noop(
+                "postgresql database {0} already exists with the same parameters".format(database)
+            )
 
 
 @operation(is_idempotent=False)
 def dump(
     dest: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Dump a PostgreSQL database into a ``.sql`` file. Requires ``pg_dump``.
 
     + dest: name of the file to dump the SQL to
-    + database: name of the database to dump
     + psql_*: global module arguments, see above
 
     **Example:**
@@ -286,7 +376,6 @@ def dump(
         postgresql.dump(
             name="Dump the pyinfra_stuff database",
             dest="/tmp/pyinfra_stuff.dump",
-            database="pyinfra_stuff",
             sudo_user="postgres",
         )
 
@@ -295,11 +384,11 @@ def dump(
     yield StringCommand(
         make_psql_command(
             executable="pg_dump",
-            database=database,
             user=psql_user,
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         ),
         ">",
         QuoteString(dest),
@@ -309,18 +398,17 @@ def dump(
 @operation(is_idempotent=False)
 def load(
     src: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Load ``.sql`` file into a database.
 
     + src: the filename to read from
-    + database: name of the database to import into
     + psql_*: global module arguments, see above
 
     **Example:**
@@ -330,7 +418,6 @@ def load(
         postgresql.load(
             name="Import the pyinfra_stuff dump into pyinfra_stuff_copy",
             src="/tmp/pyinfra_stuff.dump",
-            database="pyinfra_stuff_copy",
             sudo_user="postgres",
         )
 
@@ -338,11 +425,11 @@ def load(
 
     yield StringCommand(
         make_psql_command(
-            database=database,
             user=psql_user,
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         ),
         "<",
         QuoteString(src),

pyinfra/operations/runit.py

@@ -2,6 +2,8 @@
 Manage runit services.
 """
 
+from __future__ import annotations
+
 from typing import Optional
 
 from pyinfra import host

pyinfra/operations/server.py

@@ -5,7 +5,6 @@ Linux/BSD.
 
 from __future__ import annotations
 
-import shlex
 from io import StringIO
 from itertools import filterfalse, tee
 from os import path
@@ -18,7 +17,6 @@ from pyinfra.api.util import try_int
 from pyinfra.connectors.util import remove_any_sudo_askpass_file
 from pyinfra.facts.files import Directory, FindInFile, Link
 from pyinfra.facts.server import (
-    Crontab,
     Groups,
     Home,
     Hostname,
@@ -30,6 +28,7 @@ from pyinfra.facts.server import (
     Users,
     Which,
 )
+from pyinfra.operations import crontab as crontab_
 
 from . import (
     apk,
@@ -49,7 +48,7 @@ from . import (
     yum,
     zypper,
 )
-from .util.files import chmod, sed_replace
+from .util.files import chmod
 
 if TYPE_CHECKING:
     from pyinfra.api.arguments_typed import PyinfraOperation
@@ -438,7 +437,7 @@ def sysctl(
     existing_sysctls = host.get_fact(Sysctl, keys=[key])
     existing_value = existing_sysctls.get(key)
 
-    if not existing_value or existing_value != value:
+    if existing_value != value:
         yield "sysctl {0}='{1}'".format(key, string_value)
     else:
         host.noop("sysctl {0} is set to {1}".format(key, string_value))
@@ -588,180 +587,7 @@ def packages(
     yield from package_operation._inner(packages=packages, present=present)
 
 
-@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
-    + 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
-        server.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)
-
-    crontab = host.get_fact(Crontab, user=user)
-    name_comment = "# pyinfra-name={0}".format(cron_name)
-
-    existing_crontab = crontab.get(command)
-    existing_crontab_command = command
-    existing_crontab_match = command
-
-    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
-                existing_crontab_command = cmd
-
-    exists = existing_crontab is not None
-
-    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:
-        if cron_name:
-            if crontab:  # append a blank line if cron entries already exist
-                edit_commands.append("echo '' >> {0}".format(temp_filename))
-            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(
-            (
-                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,
-            ),
-        ):
-            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 crontab:
-            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",
-            ),
-        )
+crontab = crontab_.crontab
 
 
 @operation()
@@ -938,6 +764,7 @@ def user(
     shell: str | None = None,
     group: str | None = None,
     groups: list[str] | None = None,
+    append=False,
     public_keys: str | list[str] | None = None,
     delete_keys=False,
     ensure_home=True,
@@ -945,7 +772,6 @@ def user(
     system=False,
     uid: int | None = None,
     comment: str | None = None,
-    add_deploy_dir=True,
     unique=True,
     password: str | None = None,
 ):
@@ -958,14 +784,14 @@ def user(
     + shell: the users shell
     + group: the users primary group
     + groups: the users secondary groups
+    + append: whether to add `user` to `groups`, w/o losing membership of other groups
     + public_keys: list of public keys to attach to this user, ``home`` must be specified
     + delete_keys: whether to remove any keys not specified in ``public_keys``
     + ensure_home: whether to ensure the ``home`` directory exists
-    + create_home: whether to new user create home directories from the system skeleton
+    + create_home: whether user create new user home directories from the system skeleton
     + system: whether to create a system account
     + uid: use a specific userid number
     + comment: the user GECOS comment
-    + add_deploy_dir: any public_key filenames are relative to the deploy directory
     + unique: prevent creating users with duplicate UID
     + password: set the encrypted password for the user
 
@@ -1105,6 +931,8 @@ def user(
 
         # Check secondary groups, if defined
         if groups and set(existing_user["groups"]) != set(groups):
+            if append:
+                args.append("-a")
             args.append("-G {0}".format(",".join(groups)))
 
         if comment and existing_user["comment"] != comment:

pyinfra/operations/util/docker.py

@@ -1,38 +1,60 @@
+import dataclasses
+from typing import Any, Dict, List
+
 from pyinfra.api import OperationError
 
 
-def _create_container(**kwargs):
-    command = []
+@dataclasses.dataclass
+class ContainerSpec:
+    image: str = ""
+    ports: List[str] = dataclasses.field(default_factory=list)
+    networks: List[str] = dataclasses.field(default_factory=list)
+    volumes: List[str] = dataclasses.field(default_factory=list)
+    env_vars: List[str] = dataclasses.field(default_factory=list)
+    pull_always: bool = False
+
+    def container_create_args(self):
+        args = []
+        for network in self.networks:
+            args.append("--network {0}".format(network))
 
-    networks = kwargs["networks"] if kwargs["networks"] else []
-    ports = kwargs["ports"] if kwargs["ports"] else []
-    volumes = kwargs["volumes"] if kwargs["volumes"] else []
-    env_vars = kwargs["env_vars"] if kwargs["env_vars"] else []
+        for port in self.ports:
+            args.append("-p {0}".format(port))
 
-    if kwargs["image"] == "":
-        raise OperationError("missing 1 required argument: 'image'")
+        for volume in self.volumes:
+            args.append("-v {0}".format(volume))
 
-    command.append("docker container create --name {0}".format(kwargs["container"]))
+        for env_var in self.env_vars:
+            args.append("-e {0}".format(env_var))
 
-    for network in networks:
-        command.append("--network {0}".format(network))
+        if self.pull_always:
+            args.append("--pull always")
 
-    for port in ports:
-        command.append("-p {0}".format(port))
+        args.append(self.image)
 
-    for volume in volumes:
-        command.append("-v {0}".format(volume))
+        return args
 
-    for env_var in env_vars:
-        command.append("-e {0}".format(env_var))
+    def diff_from_inspect(self, inspect_dict: Dict[str, Any]) -> List[str]:
+        # TODO(@minor-fixes): Diff output of "docker inspect" against this spec
+        # to determine if the container needs to be recreated. Currently, this
+        # function will never recreate when attributes change, which is
+        # consistent with prior behavior.
+        del inspect_dict
+        return []
+
+
+def _create_container(**kwargs):
+    if "spec" not in kwargs:
+        raise OperationError("missing 1 required argument: 'spec'")
 
-    if kwargs["pull_always"]:
-        command.append("--pull always")
+    spec = kwargs["spec"]
 
-    command.append(kwargs["image"])
+    if not spec.image:
+        raise OperationError("Docker image not specified")
 
-    if kwargs["start"]:
-        command.append("; {0}".format(_start_container(container=kwargs["container"])))
+    command = [
+        "docker container create --name {0}".format(kwargs["container"])
+    ] + spec.container_create_args()
 
     return " ".join(command)