Add shell completions for molecule inside execution environment

final/setup.sh

@@ -2,13 +2,13 @@
 # cspell: ignore onigurumacffi,makecache,euxo,libssh,overlayfs,setcaps,minrate,openh264,additionalimage,mountopt,nodev,iname,chsh,PIND
 set -euxo pipefail
 
-DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
 # When building for multiple-architectures in parallel using emulation
 # it's really easy for one/more dnf processes to timeout or mis-count
 # the minimum download rates.  Bump both to be extremely forgiving of
 # an overworked host.
-echo -e "\n\n# Added during image build" >> /etc/dnf/dnf.conf
-echo -e "minrate=100\ntimeout=60\n" >> /etc/dnf/dnf.conf
+echo -e "\n\n# Added during image build" >>/etc/dnf/dnf.conf
+echo -e "minrate=100\ntimeout=60\n" >>/etc/dnf/dnf.conf
 #  might config-manager is not available
 # microdnf config-manager --disable fedora-cisco-openh264
 rm -f /etc/yum.repos.d/fedora-cisco-openh264.repo
@@ -23,32 +23,32 @@ microdnf remove -y subscription-manager dnf-plugin-subscription-manager
 # ncurses: for ansible-navigator
 # oniguruma-devel: onigurumacffi/arm64 (does not have binary)
 microdnf install -q -y \
-tar \
-echo \
-podman \
-fuse-overlayfs \
-openssh-clients \
-zsh \
-util-linux-user \
-which \
-git \
-nano \
-vim \
-dumb-init \
-gcc \
-git-core \
-libssh-devel \
-python3-markupsafe \
-ncurses \
-oniguruma-devel \
-python3-bcrypt \
-python3-cffi \
-python3-devel \
-python3-pip \
-python3-pyyaml \
-python3-ruamel-yaml \
-python3-wheel \
---exclude container-selinux
+  tar \
+  echo \
+  podman \
+  fuse-overlayfs \
+  openssh-clients \
+  zsh \
+  util-linux-user \
+  which \
+  git \
+  nano \
+  vim \
+  dumb-init \
+  gcc \
+  git-core \
+  libssh-devel \
+  python3-markupsafe \
+  ncurses \
+  oniguruma-devel \
+  python3-bcrypt \
+  python3-cffi \
+  python3-devel \
+  python3-pip \
+  python3-pyyaml \
+  python3-ruamel-yaml \
+  python3-wheel \
+  --exclude container-selinux
 
 microdnf -q clean all
 ln -s /usr/bin/vim /usr/bin/vi
@@ -59,45 +59,44 @@ chmod 644 /etc/containers/containers.conf
 # Copy & modify the defaults to provide reference if runtime changes needed.
 # Changes here are required for running with fuse-overlay storage inside container.
 sed -e 's|^#mount_program|mount_program|g' \
-    -e '/additionalimage.*/a "/var/lib/shared",' \
-    -e 's|^mountopt[[:space:]]*=.*$|mountopt = "nodev,fsync=0"|g' \
-    /usr/share/containers/storage.conf \
-    > /etc/containers/storage.conf
+  -e '/additionalimage.*/a "/var/lib/shared",' \
+  -e 's|^mountopt[[:space:]]*=.*$|mountopt = "nodev,fsync=0"|g' \
+  /usr/share/containers/storage.conf \
+  >/etc/containers/storage.conf
 
 # Apparently, PIND on MacOS fails to build containers when drive=overlayfs but works with vfs!
 sed -i -e 's|^driver =.*$|driver = "vfs"|g' /etc/containers/storage.conf
 
-DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
 
 mkdir -p /var/lib/shared/overlay-images /var/lib/shared/overlay-layers /var/lib/shared/vfs-images /var/lib/shared/vfs-layers
 touch /var/lib/shared/overlay-images/images.lock /var/lib/shared/overlay-layers/layers.lock /var/lib/shared/vfs-images/images.lock /var/lib/shared/vfs-layers/layers.lock
 
 # In OpenShift, container will run as a random uid number and gid 0. Make sure things
 # are writeable by the root group.
 for dir in \
-    /tmp/dist \
-    /home/runner \
-    /home/runner/.ansible \
-    /home/runner/.ansible/tmp \
-    /runner \
-    /home/runner \
-    /runner/env \
-    /runner/inventory \
-    /runner/project \
-    /runner/artifacts ; \
-    do
-    # shellcheck disable=SC2174
-    mkdir -m 0775 -p $dir
-    # do not use recursive (-R) because it will fail with read-only bind mounts
-    find $dir -type d -exec chmod g+rwx {} \;
-    find $dir -type f -exec chmod g+rw {} \;
-    find $dir -exec chgrp root {} \;
+  /tmp/dist \
+  /home/runner \
+  /home/runner/.ansible \
+  /home/runner/.ansible/tmp \
+  /runner \
+  /home/runner \
+  /runner/env \
+  /runner/inventory \
+  /runner/project \
+  /runner/artifacts; do
+  # shellcheck disable=SC2174
+  mkdir -m 0775 -p $dir
+  # do not use recursive (-R) because it will fail with read-only bind mounts
+  find $dir -type d -exec chmod g+rwx {} \;
+  find $dir -type f -exec chmod g+rw {} \;
+  find $dir -exec chgrp root {} \;
 done
 
 for file in /home/runner/.ansible/galaxy_token /etc/passwd /etc/group; do
-    touch $file
-    chmod g+rw $file
-    chgrp root $file;
+  touch $file
+  chmod g+rw $file
+  chgrp root $file
 done
 
 # this must run as user root
@@ -113,6 +112,9 @@ chsh -s "$(which zsh)" root
 python3 -m pip install argcomplete
 activate-global-python-argcomplete
 
+# Add completions to zsh
+echo eval \"\$\(_MOLECULE_COMPLETE=zsh_source molecule\)\" > ~/.oh-my-zsh/custom/molecule-completions.zsh
+
 # shellcheck disable=SC1091
 source "$DIR/setup-image.sh"
 

tests/integration/test_zsh_completions.py

@@ -0,0 +1,95 @@
+"""Test suite for shell completion functionality.
+
+This module provides pytest fixtures and tests to verify that ZSH shell
+completions are active for various commands.
+"""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+@pytest.fixture(scope="module")
+def completion_checker() -> Callable[[str], tuple[bool, str]]:
+    """Provide a function to test ZSH completion status for commands.
+
+    Returns:
+        A tuple of (is_active, details) indicating whether completions
+        are active for that command.
+    """
+
+    def check(command: str) -> tuple[bool, str]:
+        """Check if ZSH completions are active for a given command.
+
+        Args:
+            command: The command to test completions for.
+
+        Returns:
+            A tuple of (is_active, details) indicating whether completions
+            are active for that command.
+        """
+        zsh_path = shutil.which("zsh")
+        if zsh_path is None:
+            msg = "ZSH not found in $PATH, skipping completion tests."
+            pytest.skip(msg)
+
+        # Construct the test command
+        test_command = (
+            "source ~/.zshrc && "
+            f"type _{command} &>/dev/null && "
+            'echo "COMPLETIONS_ACTIVE=true" || '
+            'echo "COMPLETIONS_ACTIVE=false"'
+        )
+
+        try:
+            result = subprocess.run(  # noqa: S603
+                [zsh_path, "-c", test_command],
+                capture_output=True,
+                text=True,
+                check=False,
+                timeout=5,  # Prevent hanging
+            )
+            is_active = "COMPLETIONS_ACTIVE=true" in result.stdout
+            return is_active, result.stdout.strip()
+
+        except subprocess.TimeoutExpired:
+            return False, "Command timed out after 5 seconds"
+        except OSError as e:
+            return False, f"OS error occurred: {e!s}"
+
+    return check
+
+
+class TestShellCompletions:
+    """Test suite for shell completion functionality."""
+
+    @pytest.mark.parametrize(
+        "command",
+        (
+            "molecule_completion",
+            # Add more commands here as needed
+        ),
+    )
+    def test_command_completions(
+        self,
+        command: str,
+        completion_checker: Callable[[str], tuple[bool, str]],  # pylint: disable=redefined-outer-name
+    ) -> None:
+        """Verify that command completions are properly configured and active.
+
+        Args:
+            command: The command to test completions for.
+            completion_checker: Fixture that checks completion status
+
+        """
+        is_active, details = completion_checker(command)
+        assert is_active, f"Completions for '{command}' are not active. Details:\n{details}"