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

pyinfra/operations/yum.py

@@ -0,0 +1,210 @@
+"""
+Manage yum packages and repositories. Note that yum package names are case-sensitive.
+"""
+
+from __future__ import annotations
+
+from pyinfra import host, state
+from pyinfra.api import operation
+from pyinfra.facts.rpm import RpmPackageProvides, RpmPackages
+
+from .util.packaging import ensure_packages, ensure_rpm, ensure_yum_repo
+
+
+@operation(is_idempotent=False)
+def key(src: str):
+    """
+    Add yum gpg keys with ``rpm``.
+
+    + src: filename or URL
+
+    Note:
+        always returns one command, not state checking
+
+    **Example:**
+
+    .. code:: python
+
+        linux_id = host.get_fact(LinuxDistribution)["release_meta"].get("ID")
+        yum.key(
+            name="Add the Docker CentOS gpg key",
+            src=f"https://download.docker.com/linux/{linux_id}/gpg",
+        )
+
+    """
+
+    yield "rpm --import {0}".format(src)
+
+
+@operation()
+def repo(
+    src: str,
+    present=True,
+    baseurl: str | None = None,
+    description: str | None = None,
+    enabled=True,
+    gpgcheck=True,
+    gpgkey: str | None = None,
+):
+    # NOTE: if updating this docstring also update `dnf.repo`
+    """
+    Add/remove/update yum repositories.
+
+    + src: URL or name for the ``.repo``   file
+    + present: whether the ``.repo`` file should be present
+    + baseurl: the baseurl of the repo (if ``src`` is not a URL)
+    + description: optional verbose description
+    + enabled: whether this repo is enabled
+    + gpgcheck: whether set ``gpgcheck=1``
+    + gpgkey: the URL to the gpg key for this repo
+
+    ``Baseurl``/``description``/``gpgcheck``/``gpgkey``:
+        These are only valid when ``src`` is a filename (ie not a URL). This is
+        for manual construction of repository files. Use a URL to download and
+        install remote repository files.
+
+    **Examples:**
+
+    .. code:: python
+
+        # Download a repository file
+        yum.repo(
+            name="Install Docker-CE repo via URL",
+            src="https://download.docker.com/linux/centos/docker-ce.repo",
+        )
+
+        # Create the repository file from baseurl/etc
+        yum.repo(
+            name="Add the Docker CentOS repo",
+            src="DockerCE",
+            baseurl="https://download.docker.com/linux/centos/7/$basearch/stable",
+        )
+    """
+
+    yield from ensure_yum_repo(
+        host,
+        src,
+        baseurl,
+        present,
+        description,
+        enabled,
+        gpgcheck,
+        gpgkey,
+    )
+
+
+@operation()
+def rpm(src: str, present=True):
+    # NOTE: if updating this docstring also update `dnf.rpm`
+    """
+    Add/remove ``.rpm`` file packages.
+
+    + src: filename or URL of the ``.rpm`` package
+    + present: whether ore not the package should exist on the system
+
+    URL sources with ``present=False``:
+        If the ``.rpm`` file isn't downloaded, pyinfra can't remove any existing
+        package as the file won't exist until mid-deploy.
+
+    **Example:**
+
+    .. code:: python
+
+        major_version = host.get_fact(LinuxDistribution)["major"]
+        dnf.rpm(
+           name="Install EPEL rpm to enable EPEL repo",
+           src=f"https://dl.fedoraproject.org/pub/epel/epel-release-latest-{major_version}.noarch.rpm",
+        )
+    """
+
+    yield from ensure_rpm(state, host, src, present, "yum")
+
+
+@operation(is_idempotent=False)
+def update():
+    """
+    Updates all yum packages.
+    """
+
+    yield "yum update -y"
+
+
+_update = update._inner  # noqa: E305 (for use below where update is a kwarg)
+
+
+@operation()
+def packages(
+    packages: str | list[str] | None = None,
+    present=True,
+    latest=False,
+    update=False,
+    clean=False,
+    nobest=False,
+    extra_install_args: str | None = None,
+    extra_uninstall_args: str | None = None,
+):
+    """
+    Install/remove/update yum packages & updates.
+
+    + packages: list of packages to ensure
+    + present: whether the packages should be installed
+    + latest: whether to upgrade packages without a specified version
+    + update: run ``yum update`` before installing packages
+    + clean: run ``yum clean all`` before installing packages
+    + nobest: add the no best option to install
+    + extra_install_args: additional arguments to the yum install command
+    + extra_uninstall_args: additional arguments to the yum uninstall command
+
+    Versions:
+        Package versions can be pinned as follows: ``<pkg>=<version>``
+
+    **Examples:**
+
+    .. code:: python
+
+        # Update package list and install packages
+        yum.packages(
+            name="Install Vim and Vim enhanced",
+            packages=["vim-enhanced", "vim"],
+            update=True,
+        )
+
+        # Install the latest versions of packages (always check)
+        yum.packages(
+            name="Install latest Vim",
+            packages=["vim"],
+            latest=True,
+        )
+    """
+
+    if clean:
+        yield "yum clean all"
+
+    if update:
+        yield from _update()
+
+    install_command = ["yum", "install", "-y"]
+
+    if nobest:
+        install_command.append("--nobest")
+
+    if extra_install_args:
+        install_command.append(extra_install_args)
+
+    uninstall_command = ["yum", "remove", "-y"]
+
+    if extra_uninstall_args:
+        uninstall_command.append(extra_uninstall_args)
+
+    yield from ensure_packages(
+        host,
+        packages,
+        host.get_fact(RpmPackages),
+        present,
+        install_command=" ".join(install_command),
+        uninstall_command=" ".join(uninstall_command),
+        upgrade_command="yum update -y",
+        version_join="=",
+        latest=latest,
+        expand_package_fact=lambda package: host.get_fact(RpmPackageProvides, package=package),
+    )

pyinfra/operations/zfs.py

@@ -0,0 +1,175 @@
+"""
+Manage ZFS filesystems.
+"""
+
+from pyinfra import host
+from pyinfra.api import operation
+from pyinfra.facts.zfs import ZfsDatasets, ZfsSnapshots
+
+
+@operation()
+def dataset(
+    dataset_name,
+    present=True,
+    recursive=False,
+    sparse=None,
+    volume_size=None,
+    properties={},
+    **extra_props,
+):
+    """
+    Create, destroy or set properties on a  ZFS dataset (e.g. filesystem,
+    volume, snapshot).
+
+    + dataset_name: name of the filesystem to operate on
+    + present: whether the named filesystem should exist
+    + recursive: whether to create parent datasets, or destroy child datasets
+    + sparse: for volumes, whether to create a sparse volume with no allocation
+    + volume_size: the size of the volume
+    + properties: the ZFS properties that should be set on the dataset.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+        zfs.dataset(
+            "tank/srv",
+            mountpoint="/srv",
+            compression="lz4",
+            properties={"com.sun:auto_snapshot": "true"}
+        )
+        zfs.dataset("tank/vm-disks/db_srv_04", volume_size="32G") # creates a volume
+        zfs.dataset("tank/home@old_version", present=False)
+
+    """
+
+    noop_msg = "{0} is already {1}".format(dataset_name, "present" if present else "absent")
+
+    properties.update(extra_props)
+
+    datasets = host.get_fact(ZfsDatasets)
+
+    existing_dataset = datasets.get(dataset_name)
+
+    if present and not existing_dataset:
+        args = ["-o {0}={1}".format(prop, value) for prop, value in properties.items()]
+        if recursive:
+            args.append("-p")
+        if sparse:
+            args.append("-s")
+        if volume_size:
+            args.append("-V {0}".format(volume_size))
+
+        args.sort()  # dicts are unordered, so make sure the test results are deterministic
+
+        yield "zfs create {0} {1}".format(" ".join(args), dataset_name)
+
+    elif present and existing_dataset:
+        prop_args = [
+            "{0}={1}".format(prop, value)
+            for prop, value in properties.items() - existing_dataset.items()
+        ]
+        prop_args.sort()
+        if prop_args:
+            yield "zfs set {0} {1}".format(" ".join(prop_args), dataset_name)
+        else:
+            host.noop(noop_msg)
+
+    elif existing_dataset and not present:
+        recursive_arg = "-r" if recursive else ""
+        yield "zfs destroy {0} {1}".format(recursive_arg, dataset_name)
+
+    else:
+        host.noop(noop_msg)
+
+
+@operation()
+def snapshot(snapshot_name, present=True, recursive=False, properties={}, **extra_props):
+    """
+    Create or destroy a ZFS snapshot, or modify its properties.
+
+    + dataset_name: name of the filesystem to operate on
+    + present: whether the named filesystem should exist
+    + recursive: whether to snapshot child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+        zfs.snapshot("tank/home@weekly_backup")
+
+    """
+    properties.update(extra_props)
+    snapshots = host.get_fact(ZfsSnapshots)
+
+    if snapshot_name in snapshots or not present:
+        yield from dataset._inner(snapshot_name, present=present, properties=properties)
+
+    else:
+        args = ["-o {0}={1}".format(prop, value) for prop, value in properties.items()]
+        if recursive:
+            args.append("-r")
+        yield "zfs snap {0} {1}".format(" ".join(args), snapshot_name)
+
+
+@operation()
+def volume(
+    volume_name, size, sparse=False, present=True, recursive=False, properties={}, **extra_props
+):
+    """
+    Create or destroy a ZFS volume, or modify its properties.
+
+    + volume_name: name of the volume to operate on
+    + size: the size of the volume
+    + sparse: create a sparse volume
+    + present: whether the named volume should exist
+    + recursive: whether to create parent datasets or destroy child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+        zfs.volume("tank/vm-disks/db_srv_04", "32G")
+
+    """
+    properties.update(extra_props)
+    yield from dataset._inner(
+        volume_name,
+        volume_size=size,
+        present=present,
+        sparse=sparse,
+        recursive=recursive,
+        properties=properties,
+    )
+
+
+@operation()
+def filesystem(fs_name, present=True, recursive=False, properties={}, **extra_props):
+    """
+    Create or destroy a ZFS filesystem, or modify its properties.
+
+    + fs_name: name of the volume to operate on
+    + present: whether the named volume should exist
+    + recursive: whether to create parent datasets or destroy child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+        zfs.filesystem("tank/vm-disks/db_srv_04", "32G")
+
+    """
+    properties.update(extra_props)
+    yield from dataset._inner(
+        fs_name,
+        present=present,
+        recursive=recursive,
+        properties=properties,
+    )

pyinfra/operations/zypper.py

@@ -0,0 +1,192 @@
+from __future__ import annotations
+
+from pyinfra import host, state
+from pyinfra.api import operation
+from pyinfra.facts.rpm import RpmPackages
+
+from .util.packaging import ensure_packages, ensure_rpm, ensure_yum_repo
+from .yum import key as yum_key
+
+key = yum_key
+
+
+@operation()
+def repo(
+    src,
+    baseurl=None,
+    present=True,
+    description=None,
+    enabled=True,
+    gpgcheck=True,
+    gpgkey=None,
+    type="rpm-md",
+):
+    """
+    Add/remove/update zypper repositories.
+
+    + src: URL or name for the ``.repo``   file
+    + baseurl: the baseurl of the repo (if ``name`` is not a URL)
+    + present: whether the ``.repo`` file should be present
+    + description: optional verbose description
+    + enabled: whether this repo is enabled
+    + gpgcheck: whether set ``gpgcheck=1``
+    + gpgkey: the URL to the gpg key for this repo
+    + type: the type field this repo (defaults to ``rpm-md``)
+
+    ``Baseurl``/``description``/``gpgcheck``/``gpgkey``:
+        These are only valid when ``name`` is a filename (ie not a URL). This is
+        for manual construction of repository files. Use a URL to download and
+        install remote repository files.
+
+    **Examples:**
+
+    .. code:: python
+
+        # Download a repository file
+        zypper.repo(
+            name="Install container virtualization repo via URL",
+            src="https://download.opensuse.org/repositories/Virtualization:containers/openSUSE_Tumbleweed/Virtualization:containers.repo",
+        )
+
+        # Create the repository file from baseurl/etc
+        zypper.repo(
+            name="Install container virtualization repo",
+            src=="Virtualization:containers (openSUSE_Tumbleweed)",
+            baseurl="https://download.opensuse.org/repositories/Virtualization:/containers/openSUSE_Tumbleweed/",
+        )
+    """
+
+    yield from ensure_yum_repo(
+        host,
+        src,
+        baseurl,
+        present,
+        description,
+        enabled,
+        gpgcheck,
+        gpgkey,
+        type_=type,
+        repo_directory="/etc/zypp/repos.d/",
+    )
+
+
+@operation()
+def rpm(src, present=True):
+    # NOTE: if updating this docstring also update `dnf.rpm`
+    """
+    Add/remove ``.rpm`` file packages.
+
+    + src: filename or URL of the ``.rpm`` package
+    + present: whether ore not the package should exist on the system
+
+    URL sources with ``present=False``:
+        If the ``.rpm`` file isn't downloaded, pyinfra can't remove any existing
+        package as the file won't exist until mid-deploy.
+
+    **Example:**
+
+    .. code:: python
+
+        zypper.rpm(
+           name="Install task from rpm",
+           src="https://github.com/go-task/task/releases/download/v2.8.1/task_linux_amd64.rpm",
+        )
+    """
+
+    yield from ensure_rpm(state, host, src, present, "zypper --non-interactive")
+
+
+@operation(is_idempotent=False)
+def update():
+    """
+    Updates all zypper packages.
+    """
+
+    yield "zypper update -y"
+
+
+_update = update._inner  # noqa: E305 (for use below where update is a kwarg)
+
+
+@operation()
+def packages(
+    packages: str | list[str] | None = None,
+    present=True,
+    latest=False,
+    update=False,
+    clean=False,
+    extra_global_install_args: str | None = None,
+    extra_install_args: str | None = None,
+    extra_global_uninstall_args: str | None = None,
+    extra_uninstall_args: str | None = None,
+):
+    """
+    Install/remove/update zypper packages & updates.
+
+    + packages: list of packages to ensure
+    + present: whether the packages should be installed
+    + latest: whether to upgrade packages without a specified version
+    + update: run ``zypper update`` before installing packages
+    + clean: run ``zypper clean --all`` before installing packages
+    + extra_global_install_args: additional global arguments to the zypper install command
+    + extra_install_args: additional arguments to the zypper install command
+    + extra_global_uninstall_args: additional global arguments to the zypper uninstall command
+    + extra_uninstall_args: additional arguments to the zypper uninstall command
+
+    Versions:
+        Package versions can be pinned like zypper: ``<pkg>=<version>``
+
+    **Examples:**
+
+    .. code:: python
+
+        # Update package list and install packages
+        zypper.packages(
+            name="Install Vim and Vim enhanced",
+            packages=["vim-enhanced", "vim"],
+            update=True,
+        )
+
+        # Install the latest versions of packages (always check)
+        zypper.packages(
+            name="Install latest Vim",
+            packages=["vim"],
+            latest=True,
+        )
+    """
+
+    if clean:
+        yield "zypper clean --all"
+
+    if update:
+        yield from _update()
+
+    install_command = ["zypper", "--non-interactive", "install", "-y"]
+
+    if extra_install_args:
+        install_command.append(extra_install_args)
+
+    if extra_global_install_args:
+        install_command.insert(1, extra_global_install_args)
+
+    uninstall_command = ["zypper", "--non-interactive", "remove", "-y"]
+
+    if extra_uninstall_args:
+        uninstall_command.append(extra_uninstall_args)
+
+    if extra_global_uninstall_args:
+        uninstall_command.insert(1, extra_global_uninstall_args)
+
+    upgrade_command = "zypper update -y"
+
+    yield from ensure_packages(
+        host,
+        packages,
+        host.get_fact(RpmPackages),
+        present,
+        install_command=" ".join(install_command),
+        uninstall_command=" ".join(uninstall_command),
+        upgrade_command=upgrade_command,
+        version_join="=",
+        latest=latest,
+    )