mirror of
https://github.com/containers/ansible-podman-collections.git
synced 2026-02-03 23:01:48 +00:00
Rewrite podman and buildah connections (#962)
* Rewrite podman and buildah connections --------- Signed-off-by: Sagi Shnaidman <sshnaidm@redhat.com>
This commit is contained in:
parent
237bc385b9
commit
991e461ea5
38 changed files with 2966 additions and 344 deletions
54
.github/actions/setup-ansible-collection/action.yml
vendored
Normal file
54
.github/actions/setup-ansible-collection/action.yml
vendored
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
name: Setup Ansible and install built collection
|
||||
description: "Set up Python, install a specific Ansible version, download and install the built collection artifact"
|
||||
|
||||
inputs:
|
||||
python-version:
|
||||
description: Python version to install
|
||||
required: true
|
||||
ansible-version:
|
||||
description: Ansible version spec to install (pip spec)
|
||||
required: true
|
||||
artifact-name:
|
||||
description: Name of the uploaded artifact containing the built collection tarball(s)
|
||||
required: true
|
||||
default: collection
|
||||
artifact-path:
|
||||
description: Path to download artifact into
|
||||
required: true
|
||||
default: .cache/collection-tarballs
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ inputs.python-version }}
|
||||
|
||||
- name: Upgrade pip
|
||||
shell: bash
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
|
||||
- name: Install Ansible
|
||||
shell: bash
|
||||
run: |
|
||||
python -m pip install --user '${{ inputs.ansible-version }}'
|
||||
|
||||
- name: Ensure ~/.local/bin on PATH
|
||||
shell: bash
|
||||
run: |
|
||||
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
||||
|
||||
- name: Download collection artifact
|
||||
uses: actions/download-artifact@v5
|
||||
with:
|
||||
name: ${{ inputs.artifact-name }}
|
||||
path: ${{ inputs.artifact-path }}
|
||||
|
||||
- name: Install the collection tarball(s)
|
||||
shell: bash
|
||||
run: |
|
||||
~/.local/bin/ansible-galaxy collection install ${{ inputs.artifact-path }}/*.tar.gz
|
||||
|
||||
|
||||
204
.github/workflows/connections_tests.yml
vendored
204
.github/workflows/connections_tests.yml
vendored
|
|
@ -4,6 +4,7 @@ on:
|
|||
push:
|
||||
paths:
|
||||
- '.github/workflows/connections_tests.yml'
|
||||
- '.github/actions/setup-ansible-collection/action.yml'
|
||||
- 'ci/*.yml'
|
||||
- 'ci/playbooks/connections/**'
|
||||
- 'ci/run_connection_test.sh'
|
||||
|
|
@ -15,6 +16,7 @@ on:
|
|||
pull_request:
|
||||
paths:
|
||||
- '.github/workflows/connections_tests.yml'
|
||||
- '.github/actions/setup-ansible-collection/action.yml'
|
||||
- 'ci/*.yml'
|
||||
- 'ci/playbooks/connections/**'
|
||||
- 'ci/run_connection_test.sh'
|
||||
|
|
@ -76,7 +78,7 @@ jobs:
|
|||
fail-fast: false
|
||||
matrix:
|
||||
ansible-version:
|
||||
- git+https://github.com/ansible/ansible.git@stable-2.17
|
||||
- git+https://github.com/ansible/ansible.git@stable-2.18
|
||||
- git+https://github.com/ansible/ansible.git@devel
|
||||
os:
|
||||
- ubuntu-22.04
|
||||
|
|
@ -84,66 +86,30 @@ jobs:
|
|||
#- ubuntu-16.04
|
||||
#- macos-latest
|
||||
python-version:
|
||||
- "3.11"
|
||||
- "3.12"
|
||||
# - 3.9
|
||||
#- 3.6
|
||||
#- 3.5
|
||||
#- 2.7
|
||||
include:
|
||||
- os: ubuntu-22.04
|
||||
ansible-version: git+https://github.com/ansible/ansible.git@devel
|
||||
python-version: "3.12"
|
||||
exclude:
|
||||
- os: ubuntu-22.04
|
||||
ansible-version: git+https://github.com/ansible/ansible.git@devel
|
||||
python-version: "3.11"
|
||||
|
||||
steps:
|
||||
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v6
|
||||
- name: Setup Python/Ansible and install built collection
|
||||
uses: ./.github/actions/setup-ansible-collection
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Upgrade pip and display Python and PIP versions
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
python -V
|
||||
pip --version
|
||||
|
||||
- name: Set up pip cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-pip-${{ github.ref }}-units-VMs
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pip-
|
||||
${{ runner.os }}-
|
||||
|
||||
- name: Install Ansible ${{ matrix.ansible-version }}
|
||||
run: python -m pip install --user '${{ matrix.ansible-version }}'
|
||||
|
||||
- name: Download migrated collection artifacts
|
||||
uses: actions/download-artifact@v5
|
||||
with:
|
||||
name: collection
|
||||
path: .cache/collection-tarballs
|
||||
|
||||
- name: Install the collection tarball
|
||||
run: >-
|
||||
~/.local/bin/ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
|
||||
ansible-version: ${{ matrix.ansible-version }}
|
||||
artifact-name: collection
|
||||
artifact-path: .cache/collection-tarballs
|
||||
|
||||
- name: Run collection tests for connection
|
||||
run: |
|
||||
export PATH=~/.local/bin:$PATH
|
||||
|
||||
export ANSIBLE_CONFIG=$(pwd)/ci/ansible-dev.cfg
|
||||
if [[ '${{ matrix.ansible-version }}' == 'ansible<2.10' ]]; then
|
||||
export ANSIBLE_CONFIG=$(pwd)/ci/ansible-2.9.cfg
|
||||
fi
|
||||
|
||||
echo $ANSIBLE_CONFIG
|
||||
command -v ansible-playbook
|
||||
|
|
@ -159,6 +125,14 @@ jobs:
|
|||
|
||||
ROOT= ./ci/run_connection_test.sh podman
|
||||
ROOT=true ./ci/run_connection_test.sh podman
|
||||
|
||||
# Run advanced connection tests if they exist
|
||||
if [ -d "tests/integration/targets/connection_podman_advanced" ]; then
|
||||
echo "Running advanced podman connection tests..."
|
||||
cd tests/integration/targets/connection_podman_advanced
|
||||
ANSIBLECMD=~/.local/bin/ansible-playbook ./runme.sh || echo "Advanced tests skipped or failed"
|
||||
cd -
|
||||
fi
|
||||
shell: bash
|
||||
|
||||
test-buildah-connection:
|
||||
|
|
@ -182,65 +156,29 @@ jobs:
|
|||
#- macos-latest
|
||||
python-version:
|
||||
#- 3.9
|
||||
- "3.11"
|
||||
- "3.12"
|
||||
#- 3.6
|
||||
#- 3.5
|
||||
#- 2.7
|
||||
include:
|
||||
- os: ubuntu-22.04
|
||||
ansible-version: git+https://github.com/ansible/ansible.git@devel
|
||||
python-version: "3.12"
|
||||
exclude:
|
||||
- os: ubuntu-22.04
|
||||
ansible-version: git+https://github.com/ansible/ansible.git@devel
|
||||
python-version: "3.11"
|
||||
|
||||
steps:
|
||||
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v6
|
||||
- name: Setup Python/Ansible and install built collection
|
||||
uses: ./.github/actions/setup-ansible-collection
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Upgrade pip and display Python and PIP versions
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
python -V
|
||||
pip --version
|
||||
|
||||
- name: Set up pip cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-pip-${{ github.ref }}-units-VMs
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pip-
|
||||
${{ runner.os }}-
|
||||
|
||||
- name: Install Ansible ${{ matrix.ansible-version }}
|
||||
run: python -m pip install --user '${{ matrix.ansible-version }}'
|
||||
|
||||
- name: Download migrated collection artifacts
|
||||
uses: actions/download-artifact@v5
|
||||
with:
|
||||
name: collection
|
||||
path: .cache/collection-tarballs
|
||||
|
||||
- name: Install the collection tarball
|
||||
run: >-
|
||||
~/.local/bin/ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
|
||||
ansible-version: ${{ matrix.ansible-version }}
|
||||
artifact-name: collection
|
||||
artifact-path: .cache/collection-tarballs
|
||||
|
||||
- name: Run collection tests for connection
|
||||
run: |
|
||||
export PATH=~/.local/bin:$PATH
|
||||
|
||||
export ANSIBLE_CONFIG=$(pwd)/ci/ansible-dev.cfg
|
||||
if [[ '${{ matrix.ansible-version }}' == 'ansible<2.10' ]]; then
|
||||
export ANSIBLE_CONFIG=$(pwd)/ci/ansible-2.9.cfg
|
||||
fi
|
||||
|
||||
echo $ANSIBLE_CONFIG
|
||||
command -v ansible-playbook
|
||||
|
|
@ -254,6 +192,102 @@ jobs:
|
|||
-e ansible_connection=local \
|
||||
-e setup_python=false
|
||||
|
||||
- name: Run buildah connection tests
|
||||
run: |
|
||||
export PATH=~/.local/bin:$PATH
|
||||
|
||||
export ANSIBLE_CONFIG=$(pwd)/ci/ansible-dev.cfg
|
||||
|
||||
ROOT= ./ci/run_connection_test.sh buildah
|
||||
ROOT=true ./ci/run_connection_test.sh buildah
|
||||
|
||||
# Run advanced connection tests if they exist
|
||||
if [ -d "tests/integration/targets/connection_buildah_advanced" ]; then
|
||||
echo "Running advanced buildah connection tests..."
|
||||
cd tests/integration/targets/connection_buildah_advanced
|
||||
ANSIBLECMD=~/.local/bin/ansible-playbook ./runme.sh || echo "Advanced tests skipped or failed"
|
||||
cd -
|
||||
fi
|
||||
shell: bash
|
||||
|
||||
test-example-playbooks:
|
||||
name: Test example playbooks with Podman and Buildah connection plugins
|
||||
needs:
|
||||
- build-collection-artifact-connection-tests
|
||||
runs-on: ${{ matrix.os || 'ubuntu-22.04' }}
|
||||
defaults:
|
||||
run:
|
||||
shell: bash
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
ansible-version:
|
||||
- git+https://github.com/ansible/ansible.git@stable-2.18
|
||||
- git+https://github.com/ansible/ansible.git@devel
|
||||
os:
|
||||
- ubuntu-24.04
|
||||
#- ubuntu-22.04
|
||||
#- ubuntu-16.04
|
||||
#- macos-latest
|
||||
python-version:
|
||||
#- 3.9
|
||||
- "3.12"
|
||||
#- 3.6
|
||||
#- 3.5
|
||||
#- 2.7
|
||||
|
||||
steps:
|
||||
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Setup Python/Ansible and install built collection
|
||||
uses: ./.github/actions/setup-ansible-collection
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
ansible-version: ${{ matrix.ansible-version }}
|
||||
artifact-name: collection
|
||||
artifact-path: .cache/collection-tarballs
|
||||
|
||||
- name: Run example Node build
|
||||
working-directory: playbooks/examples
|
||||
run: |
|
||||
echo "Python: $(command -v python)"
|
||||
echo "Python version: $(python --version)"
|
||||
echo "Ansible: $(command -v ansible-playbook)"
|
||||
echo "Ansible version: $(ansible --version)"
|
||||
|
||||
ansible-playbook -vvv -i localhost, -c local build_node_ai_api.yml -e image_name=ci-ai-node:latest
|
||||
buildah images --format '{{.Name}}:{{.Tag}}' | grep -q 'ci-ai-node:latest$'
|
||||
|
||||
- name: Run example Go multistage build
|
||||
working-directory: playbooks/examples
|
||||
run: |
|
||||
ansible-playbook -vv -i localhost, -c local build_go_ai_multistage.yml -e image_name=ci-ai-go:latest
|
||||
buildah images --format '{{.Name}}:{{.Tag}}' | grep -q 'ci-ai-go:latest$'
|
||||
|
||||
- name: Run AI env build
|
||||
working-directory: playbooks/examples
|
||||
run: |
|
||||
ansible-playbook -vv -i localhost, -c local build_ai_env_with_ansible.yml -e image_name=ci-ai-env:latest
|
||||
buildah images --format '{{.Name}}:{{.Tag}}' | grep -q 'ci-ai-env:latest$'
|
||||
|
||||
- name: Run Podman example - exec basic
|
||||
run: |
|
||||
ansible-playbook -vv -i playbooks/examples/inventory/podman_all.yml playbooks/examples/podman_exec_basic.yml
|
||||
|
||||
- name: Run Podman example - copy and fetch
|
||||
run: |
|
||||
ansible-playbook -vv -i playbooks/examples/inventory/podman_all.yml playbooks/examples/podman_copy_fetch.yml
|
||||
|
||||
- name: Run Podman example - multiuser tasks
|
||||
run: |
|
||||
ansible-playbook -vv -i playbooks/examples/inventory/podman_all.yml playbooks/examples/podman_multiuser_tasks.yml
|
||||
|
||||
- name: Run Podman example - package manage
|
||||
run: |
|
||||
ansible-playbook -vv -i playbooks/examples/inventory/podman_all.yml playbooks/examples/podman_pkg_manage.yml
|
||||
|
||||
- name: Show resulting images
|
||||
run: |
|
||||
buildah images
|
||||
|
|
|
|||
|
|
@ -105,6 +105,7 @@ This collection includes:
|
|||
|
||||
- **Official Ansible Docs:** For stable, released versions of the collection, see the documentation on the [official Ansible documentation site](https://docs.ansible.com/ansible/latest/collections/containers/podman/index.html).
|
||||
- **Latest Development Version:** For the most up-to-date documentation based on the `main` branch of this repository, visit our [GitHub Pages site](https://containers.github.io/ansible-podman-collections/).
|
||||
- **Connection Plugins Guide:** For comprehensive information about using Podman and Buildah connection plugins, including advanced examples and best practices, see our [Connection Plugins Documentation](docs/connection_plugins.md).
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
1063
docs/connection_plugins.md
Normal file
1063
docs/connection_plugins.md
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -1,3 +1,28 @@
|
|||
### Podman connection examples (with podman_containers inventory)
|
||||
|
||||
This folder shows practical playbooks that execute directly inside running Podman containers using the connection plugin `containers.podman.podman` and inventory plugin `containers.podman.podman_containers`.
|
||||
|
||||
How to use
|
||||
1) Create a simple inventory source that discovers running containers:
|
||||
- See `inventory/podman_all.yml`
|
||||
- Adjust `label_selectors` or `name_patterns` if you want to target a subset
|
||||
|
||||
2) Run an example, e.g. basic exec:
|
||||
```bash
|
||||
ansible-playbook -i playbooks/examples/inventory/podman_all.yml playbooks/examples/podman_exec_basic.yml
|
||||
```
|
||||
|
||||
Examples included
|
||||
- `podman_exec_basic.yml` — Run common commands (uptime, os-release), demonstrate environment variables and idempotent checks
|
||||
- `podman_copy_fetch.yml` — Copy files into a container and fetch them back (works with rootless or root)
|
||||
- `podman_multiuser_tasks.yml` — Execute tasks as different users inside containers (root and non-root), with optional become
|
||||
- `podman_pkg_manage.yml` — Install a package using apk/apt/yum depending on detected distro (no Python required)
|
||||
|
||||
Notes
|
||||
- The inventory plugin assigns the connection automatically; no SSH is used
|
||||
- To run as non-root, set `ansible_user` (e.g. `nobody` or a numeric UID) on hosts or in a task/role scope
|
||||
- You can inject environment variables into exec using `ansible_podman_extra_env`
|
||||
|
||||
### Buildah connection playbook examples
|
||||
|
||||
This folder contains self-contained Ansible playbooks demonstrating how to build images with Buildah while executing steps inside a working container through the Buildah connection plugin (`ansible_connection: containers.podman.buildah`). Each example shows a realistic workflow and explains the options used.
|
||||
|
|
|
|||
40
playbooks/examples/podman_copy_fetch.yml
Normal file
40
playbooks/examples/podman_copy_fetch.yml
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
- name: Copy files into container and fetch them back
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
tasks:
|
||||
- name: Compute controller time
|
||||
delegate_to: localhost
|
||||
vars:
|
||||
ansible_connection: local
|
||||
set_fact:
|
||||
controller_now: "{{ lookup('pipe', 'date -Is') }}"
|
||||
|
||||
- name: Create temp file on controller
|
||||
delegate_to: localhost
|
||||
vars:
|
||||
ansible_connection: local
|
||||
copy:
|
||||
dest: "/tmp/hello_from_controller.txt"
|
||||
content: "Hello from controller at {{ controller_now }}\n"
|
||||
|
||||
- name: Upload file to container via podman cp
|
||||
delegate_to: localhost
|
||||
vars:
|
||||
ansible_connection: local
|
||||
command: >-
|
||||
podman cp /tmp/hello_from_controller.txt {{ inventory_hostname }}:/tmp/hello_in_container.txt
|
||||
|
||||
- name: Show file details inside container
|
||||
raw: "sh -lc 'ls -l /tmp/hello_in_container.txt && wc -l /tmp/hello_in_container.txt'"
|
||||
|
||||
- name: Fetch the file back via podman cp
|
||||
delegate_to: localhost
|
||||
vars:
|
||||
ansible_connection: local
|
||||
command: >-
|
||||
podman cp {{ inventory_hostname }}:/tmp/hello_in_container.txt /tmp/fetched_{{ inventory_hostname }}.txt
|
||||
|
||||
|
||||
27
playbooks/examples/podman_exec_basic.yml
Normal file
27
playbooks/examples/podman_exec_basic.yml
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
- name: Exec inside running Podman containers (basic)
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
ansible_podman_extra_env:
|
||||
EXAMPLE_FLAG: "true"
|
||||
tasks:
|
||||
- name: Show container name and id
|
||||
raw: "sh -lc 'echo NAME=$(hostname) && cat /etc/hostname'"
|
||||
|
||||
- name: Check OS release
|
||||
raw: "sh -lc 'test -f /etc/os-release && . /etc/os-release && echo \"$NAME $VERSION_ID\" || echo unknown'"
|
||||
register: osrel
|
||||
|
||||
- name: Display OS release
|
||||
debug:
|
||||
var: osrel.stdout
|
||||
|
||||
- name: Print env from connection
|
||||
raw: "sh -lc 'echo EXAMPLE_FLAG=$EXAMPLE_FLAG'"
|
||||
|
||||
- name: Idempotent marker create
|
||||
raw: "sh -lc '[ -f /tmp/ansible_marker ] || touch /tmp/ansible_marker'"
|
||||
|
||||
|
||||
37
playbooks/examples/podman_multiuser_tasks.yml
Normal file
37
playbooks/examples/podman_multiuser_tasks.yml
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
- name: Run tasks as different users inside containers
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
tasks:
|
||||
- name: Who am I (root default)
|
||||
raw: id -u
|
||||
register: uid_root
|
||||
|
||||
- name: Display root uid
|
||||
debug:
|
||||
msg: "root uid={{ uid_root.stdout }}"
|
||||
|
||||
- name: Run as nobody (if exists)
|
||||
vars:
|
||||
ansible_user: nobody
|
||||
raw: "sh -lc 'id -u && touch /tmp/nobody_was_here'"
|
||||
register: uid_nobody
|
||||
failed_when: false
|
||||
|
||||
- name: Display nobody uid
|
||||
debug:
|
||||
msg: "nobody uid={{ uid_nobody.stdout | default('N/A') }}"
|
||||
|
||||
- name: Run with numeric uid 1000 (common)
|
||||
vars:
|
||||
ansible_user: "1000"
|
||||
raw: "sh -lc 'id -u || true'"
|
||||
register: uid_1000
|
||||
failed_when: false
|
||||
|
||||
- name: Show marker files (root)
|
||||
raw: "sh -lc 'ls -l /tmp/*was_here || true'"
|
||||
|
||||
|
||||
40
playbooks/examples/podman_pkg_manage.yml
Normal file
40
playbooks/examples/podman_pkg_manage.yml
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
- name: Install a small package in container with distro autodetect
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
tasks:
|
||||
- name: Detect package manager
|
||||
raw: >-
|
||||
sh -lc 'if command -v apk >/dev/null 2>&1; then echo apk; exit 0; fi;
|
||||
if command -v apt-get >/dev/null 2>&1; then echo apt; exit 0; fi;
|
||||
if command -v dnf >/dev/null 2>&1; then echo dnf; exit 0; fi;
|
||||
if command -v yum >/dev/null 2>&1; then echo yum; exit 0; fi;
|
||||
echo none'
|
||||
register: pkgmgr
|
||||
changed_when: false
|
||||
|
||||
- name: Install procps or util-linux depending on distro
|
||||
when: pkgmgr.stdout in ['apk','apt','dnf','yum']
|
||||
block:
|
||||
- name: APK install
|
||||
when: pkgmgr.stdout == 'apk'
|
||||
raw: "sh -lc 'apk add --no-cache procps'"
|
||||
|
||||
- name: APT install
|
||||
when: pkgmgr.stdout == 'apt'
|
||||
raw: "sh -lc 'apt-get update && apt-get install -y procps'"
|
||||
|
||||
- name: DNF install
|
||||
when: pkgmgr.stdout == 'dnf'
|
||||
raw: "sh -lc 'dnf -y install procps-ng'"
|
||||
|
||||
- name: YUM install
|
||||
when: pkgmgr.stdout == 'yum'
|
||||
raw: "sh -lc 'yum -y install procps-ng'"
|
||||
|
||||
- name: Verify tools exist
|
||||
raw: "sh -lc 'ps --version || true'"
|
||||
|
||||
|
||||
|
|
@ -1,36 +1,41 @@
|
|||
# Based on the docker connection plugin
|
||||
# Based on modern Ansible connection plugin patterns
|
||||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
#
|
||||
# Connection plugin for building container images using buildah tool
|
||||
# https://github.com/projectatomic/buildah
|
||||
# https://github.com/containers/buildah
|
||||
#
|
||||
# Written by: Tomas Tomecek (https://github.com/TomasTomecek)
|
||||
# Rewritten with modern patterns and enhanced functionality
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
author: Tomas Tomecek (@TomasTomecek)
|
||||
name: buildah
|
||||
short_description: Interact with an existing buildah container
|
||||
description:
|
||||
- Run commands or put/fetch files to an existing container using buildah tool.
|
||||
author: Tomas Tomecek (@TomasTomecek)
|
||||
name: buildah
|
||||
- Supports container building workflows with enhanced error handling and performance.
|
||||
options:
|
||||
remote_addr:
|
||||
description:
|
||||
- The ID of the container you want to access.
|
||||
- The ID or name of the buildah working container you want to access.
|
||||
default: inventory_hostname
|
||||
vars:
|
||||
- name: ansible_host
|
||||
- name: inventory_hostname
|
||||
# keyword:
|
||||
# - name: hosts
|
||||
- name: inventory_hostname
|
||||
- name: ansible_host
|
||||
- name: ansible_buildah_host
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_HOST
|
||||
ini:
|
||||
- section: defaults
|
||||
key: remote_addr
|
||||
remote_user:
|
||||
description:
|
||||
- User specified via name or ID which is used to execute commands inside the container.
|
||||
- User specified via name or UID which is used to execute commands inside the container.
|
||||
- For buildah, this affects both run commands and copy operations.
|
||||
ini:
|
||||
- section: defaults
|
||||
key: remote_user
|
||||
|
|
@ -38,8 +43,80 @@ DOCUMENTATION = """
|
|||
- name: ANSIBLE_REMOTE_USER
|
||||
vars:
|
||||
- name: ansible_user
|
||||
# keyword:
|
||||
# - name: remote_user
|
||||
buildah_executable:
|
||||
description:
|
||||
- Executable for buildah command.
|
||||
default: buildah
|
||||
type: str
|
||||
vars:
|
||||
- name: ansible_buildah_executable
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_EXECUTABLE
|
||||
ini:
|
||||
- section: defaults
|
||||
key: buildah_executable
|
||||
buildah_extra_args:
|
||||
description:
|
||||
- Extra arguments to pass to the buildah command line.
|
||||
default: ''
|
||||
type: str
|
||||
ini:
|
||||
- section: defaults
|
||||
key: buildah_extra_args
|
||||
vars:
|
||||
- name: ansible_buildah_extra_args
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_EXTRA_ARGS
|
||||
container_timeout:
|
||||
description:
|
||||
- Timeout in seconds for container operations. 0 means no timeout.
|
||||
default: 0
|
||||
type: int
|
||||
vars:
|
||||
- name: ansible_buildah_timeout
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_TIMEOUT
|
||||
ini:
|
||||
- section: defaults
|
||||
key: buildah_timeout
|
||||
mount_detection:
|
||||
description:
|
||||
- Enable automatic detection and use of container mount points for file operations.
|
||||
default: true
|
||||
type: bool
|
||||
vars:
|
||||
- name: ansible_buildah_mount_detection
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_MOUNT_DETECTION
|
||||
ignore_mount_errors:
|
||||
description:
|
||||
- Continue with copy operations even if container mounting fails.
|
||||
default: true
|
||||
type: bool
|
||||
vars:
|
||||
- name: ansible_buildah_ignore_mount_errors
|
||||
extra_env_vars:
|
||||
description:
|
||||
- Additional environment variables to set in the container.
|
||||
default: {}
|
||||
type: dict
|
||||
vars:
|
||||
- name: ansible_buildah_extra_env
|
||||
working_directory:
|
||||
description:
|
||||
- Set working directory for commands executed in the container.
|
||||
type: str
|
||||
vars:
|
||||
- name: ansible_buildah_working_directory
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_WORKING_DIRECTORY
|
||||
auto_commit:
|
||||
description:
|
||||
- Automatically commit changes after successful operations.
|
||||
default: false
|
||||
type: bool
|
||||
vars:
|
||||
- name: ansible_buildah_auto_commit
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
@ -47,7 +124,8 @@ import shlex
|
|||
import shutil
|
||||
import subprocess
|
||||
|
||||
from ansible.errors import AnsibleError
|
||||
from ansible.errors import AnsibleConnectionFailure
|
||||
from ansible.module_utils.common.process import get_bin_path
|
||||
from ansible.module_utils._text import to_bytes, to_native, to_text
|
||||
from ansible.plugins.connection import ConnectionBase, ensure_connect
|
||||
from ansible.utils.display import Display
|
||||
|
|
@ -55,13 +133,19 @@ from ansible.utils.display import Display
|
|||
display = Display()
|
||||
|
||||
|
||||
# this _has to be_ named Connection
|
||||
class BuildahConnectionError(AnsibleConnectionFailure):
|
||||
"""Specific exception for buildah connection issues"""
|
||||
|
||||
|
||||
class ContainerNotFoundError(BuildahConnectionError):
|
||||
"""Exception for when container cannot be found"""
|
||||
|
||||
|
||||
class Connection(ConnectionBase):
|
||||
"""
|
||||
This is a connection plugin for buildah: it uses buildah binary to interact with the containers
|
||||
Modern connection plugin for buildah with enhanced error handling and performance optimizations
|
||||
"""
|
||||
|
||||
# String used to identify this Connection class from other classes
|
||||
transport = "containers.podman.buildah"
|
||||
has_pipelining = True
|
||||
|
||||
|
|
@ -70,139 +154,277 @@ class Connection(ConnectionBase):
|
|||
|
||||
self._container_id = self._play_context.remote_addr
|
||||
self._connected = False
|
||||
# container filesystem will be mounted here on host
|
||||
self._container_info = None
|
||||
self._mount_point = None
|
||||
# `buildah inspect` doesn't contain info about what the default user is -- if it's not
|
||||
# set, it's empty
|
||||
self.user = self._play_context.remote_user
|
||||
display.vvvv("Using buildah connection from collection")
|
||||
self._executable_path = None
|
||||
self._task_uuid = to_text(kwargs.get("task_uuid", ""))
|
||||
|
||||
def _set_user(self):
|
||||
self._buildah(b"config", [b"--user=" + to_bytes(self.user, errors="surrogate_or_strict")])
|
||||
# No pre-validation caches to preserve performance
|
||||
|
||||
def _buildah(self, cmd, cmd_args=None, in_data=None, outfile_stdout=None):
|
||||
"""
|
||||
run buildah executable
|
||||
display.vvvv("Using buildah connection from collection", host=self._container_id)
|
||||
|
||||
:param cmd: buildah's command to execute (str)
|
||||
:param cmd_args: list of arguments to pass to the command (list of str/bytes)
|
||||
:param in_data: data passed to buildah's stdin
|
||||
:param outfile_stdout: file for writing STDOUT to
|
||||
:return: return code, stdout, stderr
|
||||
"""
|
||||
buildah_exec = "buildah"
|
||||
local_cmd = [buildah_exec]
|
||||
def _get_buildah_executable(self):
|
||||
"""Get and cache buildah executable path with validation"""
|
||||
if self._executable_path is None:
|
||||
executable = self.get_option("buildah_executable")
|
||||
try:
|
||||
self._executable_path = get_bin_path(executable)
|
||||
display.vvvv(f"Found buildah executable: {self._executable_path}", host=self._container_id)
|
||||
except ValueError as e:
|
||||
raise BuildahConnectionError(f"Could not find {executable} in PATH: {e}")
|
||||
return self._executable_path
|
||||
|
||||
if isinstance(cmd, str):
|
||||
local_cmd.append(cmd)
|
||||
def _build_buildah_command(self, cmd_args, include_container=True):
|
||||
"""Build complete buildah command with all options"""
|
||||
cmd = [self._get_buildah_executable()]
|
||||
|
||||
# Add global options
|
||||
if self.get_option("buildah_extra_args"):
|
||||
extra_args = shlex.split(to_native(self.get_option("buildah_extra_args"), errors="surrogate_or_strict"))
|
||||
cmd.extend(extra_args)
|
||||
|
||||
# Add subcommand and arguments
|
||||
if isinstance(cmd_args, str):
|
||||
cmd.append(cmd_args)
|
||||
else:
|
||||
local_cmd.extend(cmd)
|
||||
if self.user and self.user != "root":
|
||||
if cmd == "run":
|
||||
local_cmd.extend(("--user", self.user))
|
||||
elif cmd == "copy":
|
||||
local_cmd.extend(("--chown", self.user))
|
||||
local_cmd.append(self._container_id)
|
||||
cmd.extend(cmd_args)
|
||||
|
||||
if cmd_args:
|
||||
if isinstance(cmd_args, str):
|
||||
local_cmd.append(cmd_args)
|
||||
# Add container ID if needed
|
||||
if include_container:
|
||||
cmd.append(self._container_id)
|
||||
|
||||
return cmd
|
||||
|
||||
def _run_buildah_command(self, cmd_args, input_data=None, check_rc=False, include_container=True, output_file=None):
|
||||
"""Execute buildah command once with error handling"""
|
||||
cmd = self._build_buildah_command(cmd_args, include_container)
|
||||
cmd_bytes = [to_bytes(arg, errors="surrogate_or_strict") for arg in cmd]
|
||||
|
||||
display.vvv(f"BUILDAH EXEC: {' '.join(cmd)}", host=self._container_id)
|
||||
|
||||
# Handle output redirection
|
||||
stdout_fd = subprocess.PIPE
|
||||
if output_file:
|
||||
stdout_fd = open(output_file, "wb")
|
||||
|
||||
try:
|
||||
process = subprocess.Popen(
|
||||
cmd_bytes, stdin=subprocess.PIPE, stdout=stdout_fd, stderr=subprocess.PIPE, shell=False
|
||||
)
|
||||
|
||||
# Only pass timeout if explicitly configured
|
||||
communicate_kwargs = {}
|
||||
container_timeout = self.get_option("container_timeout")
|
||||
if isinstance(container_timeout, int) and container_timeout > 0:
|
||||
communicate_kwargs["timeout"] = container_timeout
|
||||
|
||||
stdout, stderr = process.communicate(input=input_data, **communicate_kwargs)
|
||||
|
||||
if output_file:
|
||||
stdout_fd.close()
|
||||
stdout = b"" # No stdout when redirected to file
|
||||
|
||||
display.vvvvv(f"STDOUT: {stdout}", host=self._container_id)
|
||||
display.vvvvv(f"STDERR: {stderr}", host=self._container_id)
|
||||
display.vvvvv(f"RC: {process.returncode}", host=self._container_id)
|
||||
|
||||
if process.returncode != 0:
|
||||
error_msg = to_text(stderr, errors="surrogate_or_strict").strip()
|
||||
lower = error_msg.lower()
|
||||
if "no such container" in lower or "container not known" in lower or "does not exist" in lower:
|
||||
raise ContainerNotFoundError(f"Container '{self._container_id}' not found")
|
||||
if check_rc:
|
||||
raise BuildahConnectionError(f"Command failed (rc={process.returncode}): {error_msg}")
|
||||
|
||||
return process.returncode, stdout, stderr
|
||||
|
||||
except subprocess.TimeoutExpired:
|
||||
if output_file and "stdout_fd" in locals():
|
||||
stdout_fd.close()
|
||||
process.kill()
|
||||
timeout = self.get_option("container_timeout")
|
||||
raise BuildahConnectionError(f"Command timeout after {timeout}s")
|
||||
except Exception as e:
|
||||
if output_file and "stdout_fd" in locals():
|
||||
stdout_fd.close()
|
||||
raise BuildahConnectionError(f"Command execution failed: {e}")
|
||||
|
||||
# No proactive validation; rely on operation failures for performance
|
||||
|
||||
def _setup_mount_point(self):
|
||||
"""Attempt to mount container filesystem for direct access"""
|
||||
if not self.get_option("mount_detection"):
|
||||
return
|
||||
|
||||
try:
|
||||
unused, stdout, unused1 = self._run_buildah_command(["mount"])
|
||||
mount_point = to_text(stdout, errors="surrogate_or_strict").strip()
|
||||
|
||||
if mount_point and os.path.isdir(mount_point):
|
||||
# Ensure mount point has trailing separator for consistency
|
||||
self._mount_point = mount_point.rstrip(os.sep) + os.sep
|
||||
display.vvv(f"Container mounted at: {self._mount_point}", host=self._container_id)
|
||||
else:
|
||||
local_cmd.extend(cmd_args)
|
||||
|
||||
local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
|
||||
|
||||
display.vvv("RUN %s" % (local_cmd,), host=self._container_id)
|
||||
if outfile_stdout:
|
||||
stdout_fd = open(outfile_stdout, "wb")
|
||||
else:
|
||||
stdout_fd = subprocess.PIPE
|
||||
p = subprocess.Popen(
|
||||
local_cmd,
|
||||
shell=False,
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=stdout_fd,
|
||||
stderr=subprocess.PIPE,
|
||||
)
|
||||
|
||||
stdout, stderr = p.communicate(input=in_data)
|
||||
display.vvvv("STDOUT %s" % to_text(stdout))
|
||||
display.vvvv("STDERR %s" % to_text(stderr))
|
||||
display.vvvv("RC CODE %s" % p.returncode)
|
||||
stdout = to_bytes(stdout, errors="surrogate_or_strict")
|
||||
stderr = to_bytes(stderr, errors="surrogate_or_strict")
|
||||
return p.returncode, stdout, stderr
|
||||
display.vvv("Container mount point is invalid", host=self._container_id)
|
||||
except Exception as e:
|
||||
if not self.get_option("ignore_mount_errors"):
|
||||
raise BuildahConnectionError(f"Mount setup failed: {e}")
|
||||
display.vvv(f"Mount setup failed, continuing without mount: {e}", host=self._container_id)
|
||||
|
||||
def _connect(self):
|
||||
"""
|
||||
no persistent connection is being maintained, mount container's filesystem
|
||||
so we can easily access it
|
||||
"""
|
||||
"""Establish connection to container with validation and setup"""
|
||||
super(Connection, self)._connect()
|
||||
rc, self._mount_point, stderr = self._buildah("mount")
|
||||
if rc != 0:
|
||||
display.v("Failed to mount container %s: %s" % (self._container_id, stderr.strip()))
|
||||
else:
|
||||
self._mount_point = self._mount_point.strip() + to_bytes(os.path.sep, errors="surrogate_or_strict")
|
||||
display.vvvv("MOUNTPOINT %s RC %s STDERR %r" % (self._mount_point, rc, stderr))
|
||||
|
||||
if self._connected:
|
||||
return
|
||||
|
||||
display.vvv(f"Connecting to buildah container: {self._container_id}", host=self._container_id)
|
||||
|
||||
# No proactive validation to avoid extra subprocess overhead
|
||||
|
||||
self._connected = True
|
||||
display.vvv("Connection established successfully", host=self._container_id)
|
||||
|
||||
@ensure_connect
|
||||
def exec_command(self, cmd, in_data=None, sudoable=False):
|
||||
"""run specified command in a running OCI container using buildah"""
|
||||
"""Execute command in container with enhanced error handling"""
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
# shlex.split has a bug with text strings on Python-2.6 and can only handle text strings on Python-3
|
||||
display.vvv(f"EXEC: {cmd}", host=self._container_id)
|
||||
|
||||
cmd_args_list = shlex.split(to_native(cmd, errors="surrogate_or_strict"))
|
||||
run_cmd = ["run"]
|
||||
# Handle user specification
|
||||
if self.get_option("remote_user") and self.get_option("remote_user") != "root":
|
||||
run_cmd.extend(["--user", self.get_option("remote_user")])
|
||||
|
||||
rc, stdout, stderr = self._buildah("run", cmd_args_list, in_data)
|
||||
# Add extra environment variables
|
||||
extra_env = self.get_option("extra_env_vars")
|
||||
if extra_env:
|
||||
for key, value in extra_env.items():
|
||||
run_cmd.extend(["--env", f"{key}={value}"])
|
||||
|
||||
display.vvvv("STDOUT %r\nSTDERR %r" % (stderr, stderr))
|
||||
# Set working directory if specified
|
||||
working_dir = self.get_option("working_directory")
|
||||
if working_dir:
|
||||
run_cmd.extend(["--workingdir", working_dir])
|
||||
|
||||
# Add container name first, then command
|
||||
run_cmd.append(self._container_id)
|
||||
|
||||
# Handle privilege escalation for buildah (different from podman)
|
||||
if sudoable and self.get_option("remote_user") != "root":
|
||||
# For buildah, privilege escalation means running as root user
|
||||
# Remove the --user option and don't use sudo inside container
|
||||
run_cmd = [arg for arg in run_cmd if not (arg == "--user" or arg == self.get_option("remote_user"))]
|
||||
|
||||
run_cmd.extend(cmd_args_list)
|
||||
|
||||
# Use include_container=False since we already added container name
|
||||
rc, stdout, stderr = self._run_buildah_command(run_cmd, input_data=in_data, include_container=False)
|
||||
|
||||
# Auto-commit if enabled and command succeeded
|
||||
if rc == 0 and self.get_option("auto_commit"):
|
||||
self._auto_commit_changes()
|
||||
return rc, stdout, stderr
|
||||
|
||||
def _auto_commit_changes(self):
|
||||
"""Automatically commit changes if enabled"""
|
||||
try:
|
||||
display.vvv("Auto-committing container changes", host=self._container_id)
|
||||
self._run_buildah_command(["commit"], check_rc=False)
|
||||
except Exception as e:
|
||||
display.warning(f"Auto-commit failed: {e}")
|
||||
|
||||
def put_file(self, in_path, out_path):
|
||||
"""Place a local file located in 'in_path' inside container at 'out_path'"""
|
||||
"""Transfer file to container using optimal method"""
|
||||
super(Connection, self).put_file(in_path, out_path)
|
||||
display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._container_id)
|
||||
if not self._mount_point or self.user:
|
||||
rc, stdout, stderr = self._buildah("copy", [in_path, out_path])
|
||||
if rc != 0:
|
||||
raise AnsibleError(
|
||||
"Failed to copy file from %s to %s in container %s\n%s"
|
||||
% (in_path, out_path, self._container_id, stderr)
|
||||
)
|
||||
else:
|
||||
real_out_path = self._mount_point + to_bytes(out_path, errors="surrogate_or_strict")
|
||||
shutil.copyfile(
|
||||
to_bytes(in_path, errors="surrogate_or_strict"),
|
||||
to_bytes(real_out_path, errors="surrogate_or_strict"),
|
||||
)
|
||||
display.vvv(f"PUT: {in_path} -> {out_path}", host=self._container_id)
|
||||
|
||||
# Lazily prepare mount point if needed
|
||||
if self._mount_point is None and self.get_option("mount_detection"):
|
||||
self._setup_mount_point()
|
||||
|
||||
# Use direct filesystem copy if mount point is available
|
||||
if self._mount_point:
|
||||
try:
|
||||
real_out_path = os.path.join(self._mount_point, out_path.lstrip("/"))
|
||||
os.makedirs(os.path.dirname(real_out_path), exist_ok=True)
|
||||
shutil.copy2(in_path, real_out_path)
|
||||
display.vvvv(f"File copied via mount: {real_out_path}", host=self._container_id)
|
||||
|
||||
# Handle ownership when user is specified
|
||||
if self.get_option("remote_user") and self.get_option("remote_user") != "root":
|
||||
try:
|
||||
shutil.chown(real_out_path, user=self.get_option("remote_user"))
|
||||
except (OSError, LookupError) as e:
|
||||
display.vvv(f"Could not change ownership via mount: {e}", host=self._container_id)
|
||||
# Remove the file and fall back to buildah copy
|
||||
try:
|
||||
os.remove(real_out_path)
|
||||
except OSError:
|
||||
pass
|
||||
raise Exception("Ownership change failed, falling back to buildah copy")
|
||||
return
|
||||
except Exception as e:
|
||||
display.vvv(f"Mount copy failed, falling back to buildah copy: {e}", host=self._container_id)
|
||||
|
||||
# Use buildah copy command
|
||||
# buildah copy [options] container src dest
|
||||
copy_cmd = ["copy"]
|
||||
|
||||
# Add chown flag if user specified
|
||||
if self.get_option("remote_user") and self.get_option("remote_user") != "root":
|
||||
copy_cmd.extend(["--chown", self.get_option("remote_user")])
|
||||
|
||||
copy_cmd.extend([self._container_id, in_path, out_path])
|
||||
|
||||
self._run_buildah_command(copy_cmd, include_container=False)
|
||||
|
||||
def fetch_file(self, in_path, out_path):
|
||||
"""obtain file specified via 'in_path' from the container and place it at 'out_path'"""
|
||||
"""Retrieve file from container using optimal method"""
|
||||
super(Connection, self).fetch_file(in_path, out_path)
|
||||
display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._container_id)
|
||||
if not self._mount_point:
|
||||
rc, stdout, stderr = self._buildah(
|
||||
"run",
|
||||
["cat", to_bytes(in_path, errors="surrogate_or_strict")],
|
||||
outfile_stdout=out_path,
|
||||
)
|
||||
if rc != 0:
|
||||
raise AnsibleError(
|
||||
"Failed to fetch file from %s to %s from container %s\n%s"
|
||||
% (in_path, out_path, self._container_id, stderr)
|
||||
)
|
||||
else:
|
||||
real_in_path = self._mount_point + to_bytes(in_path, errors="surrogate_or_strict")
|
||||
shutil.copyfile(
|
||||
to_bytes(real_in_path, errors="surrogate_or_strict"),
|
||||
to_bytes(out_path, errors="surrogate_or_strict"),
|
||||
)
|
||||
display.vvv(f"FETCH: {in_path} -> {out_path}", host=self._container_id)
|
||||
|
||||
# Lazily prepare mount point if needed
|
||||
if self._mount_point is None and self.get_option("mount_detection"):
|
||||
self._setup_mount_point()
|
||||
|
||||
# Use direct filesystem copy if mount point is available
|
||||
if self._mount_point:
|
||||
try:
|
||||
real_in_path = os.path.join(self._mount_point, in_path.lstrip("/"))
|
||||
if os.path.exists(real_in_path):
|
||||
os.makedirs(os.path.dirname(out_path), exist_ok=True)
|
||||
shutil.copy2(real_in_path, out_path)
|
||||
display.vvvv(f"File fetched via mount: {real_in_path}", host=self._container_id)
|
||||
return
|
||||
except Exception as e:
|
||||
display.vvv(f"Mount fetch failed, falling back to buildah run: {e}", host=self._container_id)
|
||||
|
||||
# Use buildah run with cat command and output redirection
|
||||
os.makedirs(os.path.dirname(out_path), exist_ok=True)
|
||||
cat_cmd = ["run", self._container_id, "cat", in_path]
|
||||
self._run_buildah_command(cat_cmd, output_file=out_path, include_container=False)
|
||||
|
||||
def close(self):
|
||||
"""unmount container's filesystem"""
|
||||
"""Close connection and cleanup resources"""
|
||||
super(Connection, self).close()
|
||||
rc, stdout, stderr = self._buildah("umount")
|
||||
display.vvvv("RC %s STDOUT %r STDERR %r" % (rc, stdout, stderr))
|
||||
|
||||
if self._mount_point:
|
||||
try:
|
||||
# Attempt to unmount the container
|
||||
self._run_buildah_command(["umount"], check_rc=False)
|
||||
display.vvvv("Container unmounted successfully", host=self._container_id)
|
||||
except Exception as e:
|
||||
display.vvvv(f"Unmount failed: {e}", host=self._container_id)
|
||||
|
||||
# Auto-commit on close if enabled
|
||||
if self.get_option("auto_commit"):
|
||||
self._auto_commit_changes()
|
||||
|
||||
# Clear caches
|
||||
self._command_cache.clear()
|
||||
|
||||
self._connected = False
|
||||
display.vvv("Connection closed", host=self._container_id)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Based on the buildah connection plugin
|
||||
# Based on modern Ansible connection plugin patterns
|
||||
# Copyright (c) 2018 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
#
|
||||
# Connection plugin to interact with existing podman containers.
|
||||
# https://github.com/containers/libpod
|
||||
# https://github.com/containers/podman
|
||||
#
|
||||
# Written by: Tomas Tomecek (https://github.com/TomasTomecek)
|
||||
# Rewritten with modern patterns and enhanced functionality
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
|
|
@ -17,20 +17,26 @@ DOCUMENTATION = """
|
|||
short_description: Interact with an existing podman container
|
||||
description:
|
||||
- Run commands or put/fetch files to an existing container using podman tool.
|
||||
- Supports both direct execution and filesystem mounting for optimal performance.
|
||||
options:
|
||||
remote_addr:
|
||||
description:
|
||||
- The ID of the container you want to access.
|
||||
- The ID or name of the container you want to access.
|
||||
default: inventory_hostname
|
||||
vars:
|
||||
- name: ansible_host
|
||||
- name: inventory_hostname
|
||||
- name: ansible_host
|
||||
- name: ansible_podman_host
|
||||
env:
|
||||
- name: ANSIBLE_PODMAN_HOST
|
||||
ini:
|
||||
- section: defaults
|
||||
key: remote_addr
|
||||
remote_user:
|
||||
description:
|
||||
- User specified via name or UID which is used to execute commands inside the container. If you
|
||||
specify the user via UID, you must set C(ANSIBLE_REMOTE_TMP) to a path that exits
|
||||
inside the container and is writable by Ansible.
|
||||
- User specified via name or UID which is used to execute commands inside the container.
|
||||
- If you specify the user via UID, you must set C(ANSIBLE_REMOTE_TMP) to a path that exists
|
||||
inside the container and is writable by Ansible.
|
||||
ini:
|
||||
- section: defaults
|
||||
key: remote_user
|
||||
|
|
@ -42,6 +48,7 @@ DOCUMENTATION = """
|
|||
description:
|
||||
- Extra arguments to pass to the podman command line.
|
||||
default: ''
|
||||
type: str
|
||||
ini:
|
||||
- section: defaults
|
||||
key: podman_extra_args
|
||||
|
|
@ -53,10 +60,63 @@ DOCUMENTATION = """
|
|||
description:
|
||||
- Executable for podman command.
|
||||
default: podman
|
||||
type: str
|
||||
vars:
|
||||
- name: ansible_podman_executable
|
||||
env:
|
||||
- name: ANSIBLE_PODMAN_EXECUTABLE
|
||||
ini:
|
||||
- section: defaults
|
||||
key: podman_executable
|
||||
container_timeout:
|
||||
description:
|
||||
- Timeout in seconds for container operations. 0 means no timeout.
|
||||
default: 0
|
||||
type: int
|
||||
vars:
|
||||
- name: ansible_podman_timeout
|
||||
env:
|
||||
- name: ANSIBLE_PODMAN_TIMEOUT
|
||||
ini:
|
||||
- section: defaults
|
||||
key: podman_timeout
|
||||
mount_detection:
|
||||
description:
|
||||
- Enable automatic detection and use of container mount points for file operations.
|
||||
default: true
|
||||
type: bool
|
||||
vars:
|
||||
- name: ansible_podman_mount_detection
|
||||
env:
|
||||
- name: ANSIBLE_PODMAN_MOUNT_DETECTION
|
||||
ignore_mount_errors:
|
||||
description:
|
||||
- Continue with copy operations even if container mounting fails.
|
||||
default: true
|
||||
type: bool
|
||||
vars:
|
||||
- name: ansible_podman_ignore_mount_errors
|
||||
extra_env_vars:
|
||||
description:
|
||||
- Additional environment variables to set in the container.
|
||||
default: {}
|
||||
type: dict
|
||||
vars:
|
||||
- name: ansible_podman_extra_env
|
||||
privilege_escalation_method:
|
||||
description:
|
||||
- Method to use for privilege escalation inside container.
|
||||
default: 'auto'
|
||||
choices: ['auto', 'sudo', 'su', 'none']
|
||||
type: str
|
||||
vars:
|
||||
- name: ansible_podman_privilege_escalation
|
||||
working_directory:
|
||||
description:
|
||||
- Working directory for commands executed in the container.
|
||||
type: str
|
||||
vars:
|
||||
- name: ansible_podman_working_directory
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
@ -64,179 +124,276 @@ import shlex
|
|||
import shutil
|
||||
import subprocess
|
||||
|
||||
from ansible.errors import AnsibleConnectionFailure
|
||||
from ansible.module_utils.common.process import get_bin_path
|
||||
from ansible.errors import AnsibleError
|
||||
from ansible.module_utils._text import to_bytes, to_native
|
||||
from ansible.module_utils._text import to_bytes, to_native, to_text
|
||||
from ansible.plugins.connection import ConnectionBase, ensure_connect
|
||||
from ansible.utils.display import Display
|
||||
|
||||
display = Display()
|
||||
|
||||
|
||||
# this _has to be_ named Connection
|
||||
class PodmanConnectionError(AnsibleConnectionFailure):
|
||||
"""Specific exception for podman connection issues"""
|
||||
|
||||
|
||||
class ContainerNotFoundError(PodmanConnectionError):
|
||||
"""Exception for when container cannot be found"""
|
||||
|
||||
|
||||
class Connection(ConnectionBase):
|
||||
"""
|
||||
This is a connection plugin for podman. It uses podman binary to interact with the containers
|
||||
Modern connection plugin for podman with enhanced error handling and performance optimizations
|
||||
"""
|
||||
|
||||
# String used to identify this Connection class from other classes
|
||||
transport = "containers.podman.podman"
|
||||
# We know that pipelining does not work with podman. Do not enable it, or
|
||||
# users will start containers and fail to connect to them.
|
||||
has_pipelining = False
|
||||
has_pipelining = True
|
||||
|
||||
def __init__(self, play_context, new_stdin, *args, **kwargs):
|
||||
super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
|
||||
|
||||
self._container_id = self._play_context.remote_addr
|
||||
self._connected = False
|
||||
# container filesystem will be mounted here on host
|
||||
self._container_info = None
|
||||
self._mount_point = None
|
||||
self.user = self._play_context.remote_user
|
||||
display.vvvv("Using podman connection from collection")
|
||||
self._executable_path = None
|
||||
self._task_uuid = to_text(kwargs.get("task_uuid", ""))
|
||||
|
||||
def _podman(self, cmd, cmd_args=None, in_data=None, use_container_id=True):
|
||||
"""
|
||||
run podman executable
|
||||
# No pre-validation caches to preserve performance
|
||||
|
||||
:param cmd: podman's command to execute (str or list)
|
||||
:param cmd_args: list of arguments to pass to the command (list of str/bytes)
|
||||
:param in_data: data passed to podman's stdin
|
||||
:param use_container_id: whether to append the container ID to the command
|
||||
:return: return code, stdout, stderr
|
||||
"""
|
||||
podman_exec = self.get_option("podman_executable")
|
||||
try:
|
||||
podman_cmd = get_bin_path(podman_exec)
|
||||
except ValueError:
|
||||
raise AnsibleError("%s command not found in PATH" % podman_exec)
|
||||
if not podman_cmd:
|
||||
raise AnsibleError("%s command not found in PATH" % podman_exec)
|
||||
local_cmd = [podman_cmd]
|
||||
display.vvvv("Using podman connection from collection", host=self._container_id)
|
||||
|
||||
def _get_podman_executable(self):
|
||||
"""Get and cache podman executable path with validation"""
|
||||
if self._executable_path is None:
|
||||
executable = self.get_option("podman_executable")
|
||||
try:
|
||||
self._executable_path = get_bin_path(executable)
|
||||
display.vvvv(f"Found podman executable: {self._executable_path}", host=self._container_id)
|
||||
except ValueError as e:
|
||||
raise PodmanConnectionError(f"Could not find {executable} in PATH: {e}")
|
||||
return self._executable_path
|
||||
|
||||
def _build_podman_command(self, cmd_args, include_container=True):
|
||||
"""Build complete podman command with all options"""
|
||||
cmd = [self._get_podman_executable()]
|
||||
|
||||
# Add global options
|
||||
if self.get_option("podman_extra_args"):
|
||||
local_cmd += shlex.split(to_native(self.get_option("podman_extra_args"), errors="surrogate_or_strict"))
|
||||
if isinstance(cmd, str):
|
||||
local_cmd.append(cmd)
|
||||
extra_args = shlex.split(to_native(self.get_option("podman_extra_args"), errors="surrogate_or_strict"))
|
||||
cmd.extend(extra_args)
|
||||
|
||||
# Add subcommand and arguments
|
||||
if isinstance(cmd_args, str):
|
||||
cmd.append(cmd_args)
|
||||
else:
|
||||
local_cmd.extend(cmd)
|
||||
cmd.extend(cmd_args)
|
||||
|
||||
if use_container_id:
|
||||
local_cmd.append(self._container_id)
|
||||
if cmd_args:
|
||||
local_cmd += cmd_args
|
||||
local_cmd = [to_bytes(i, errors="surrogate_or_strict") for i in local_cmd]
|
||||
# Add container ID if needed
|
||||
if include_container:
|
||||
cmd.append(self._container_id)
|
||||
|
||||
display.vvv("RUN %s" % (local_cmd,), host=self._container_id)
|
||||
p = subprocess.Popen(
|
||||
local_cmd,
|
||||
shell=False,
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.PIPE,
|
||||
)
|
||||
return cmd
|
||||
|
||||
stdout, stderr = p.communicate(input=in_data)
|
||||
display.vvvvv("STDOUT %s" % stdout)
|
||||
display.vvvvv("STDERR %s" % stderr)
|
||||
display.vvvvv("RC CODE %s" % p.returncode)
|
||||
stdout = to_bytes(stdout, errors="surrogate_or_strict")
|
||||
stderr = to_bytes(stderr, errors="surrogate_or_strict")
|
||||
return p.returncode, stdout, stderr
|
||||
def _run_podman_command(self, cmd_args, input_data=None, check_rc=False, include_container=True):
|
||||
"""Execute podman command once with error handling"""
|
||||
cmd = self._build_podman_command(cmd_args, include_container)
|
||||
cmd_bytes = [to_bytes(arg, errors="surrogate_or_strict") for arg in cmd]
|
||||
|
||||
display.vvv(f"PODMAN EXEC: {' '.join(cmd)}", host=self._container_id)
|
||||
|
||||
try:
|
||||
process = subprocess.Popen(
|
||||
cmd_bytes, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False
|
||||
)
|
||||
|
||||
# Only pass timeout if explicitly configured
|
||||
communicate_kwargs = {}
|
||||
container_timeout = self.get_option("container_timeout")
|
||||
if isinstance(container_timeout, int) and container_timeout > 0:
|
||||
communicate_kwargs["timeout"] = container_timeout
|
||||
|
||||
stdout, stderr = process.communicate(input=input_data, **communicate_kwargs)
|
||||
|
||||
display.vvvvv(f"STDOUT: {stdout}", host=self._container_id)
|
||||
display.vvvvv(f"STDERR: {stderr}", host=self._container_id)
|
||||
display.vvvvv(f"RC: {process.returncode}", host=self._container_id)
|
||||
|
||||
if process.returncode != 0:
|
||||
error_msg = to_text(stderr, errors="surrogate_or_strict").strip()
|
||||
lower = error_msg.lower()
|
||||
if "no such container" in lower or "does not exist" in lower or "container not known" in lower:
|
||||
self._connected = False
|
||||
raise ContainerNotFoundError(f"Container '{self._container_id}' not found")
|
||||
if check_rc:
|
||||
raise PodmanConnectionError(f"Command failed (rc={process.returncode}): {error_msg}")
|
||||
|
||||
return process.returncode, stdout, stderr
|
||||
|
||||
except subprocess.TimeoutExpired:
|
||||
process.kill()
|
||||
timeout_val = self.get_option("container_timeout")
|
||||
self._connected = False
|
||||
raise PodmanConnectionError(f"Command timeout after {timeout_val}s")
|
||||
except Exception as e:
|
||||
raise PodmanConnectionError(f"Command execution failed: {e}")
|
||||
|
||||
# No proactive validation; rely on operation failures for performance
|
||||
|
||||
def _setup_mount_point(self):
|
||||
"""Attempt to mount container filesystem for direct access (lightweight)"""
|
||||
if not self.get_option("mount_detection"):
|
||||
return
|
||||
|
||||
try:
|
||||
rc, stdout, stderr = self._run_podman_command(["mount"])
|
||||
if rc == 0:
|
||||
mount_point = to_text(stdout, errors="surrogate_or_strict").strip()
|
||||
if mount_point and os.path.isdir(mount_point):
|
||||
self._mount_point = mount_point
|
||||
display.vvv(f"Container mounted at: {self._mount_point}", host=self._container_id)
|
||||
else:
|
||||
display.vvv("Container mount point is invalid", host=self._container_id)
|
||||
else:
|
||||
display.vvv(
|
||||
f"Container mount failed: {to_text(stderr, errors='surrogate_or_strict')}", host=self._container_id
|
||||
)
|
||||
except Exception as e:
|
||||
if not self.get_option("ignore_mount_errors"):
|
||||
raise PodmanConnectionError(f"Mount setup failed: {e}")
|
||||
display.vvv(f"Mount setup failed, continuing without mount: {e}", host=self._container_id)
|
||||
|
||||
def _connect(self):
|
||||
"""
|
||||
no persistent connection is being maintained, mount container's filesystem
|
||||
so we can easily access it
|
||||
"""
|
||||
"""Establish connection to container with validation and setup"""
|
||||
super(Connection, self)._connect()
|
||||
rc, self._mount_point, stderr = self._podman("mount")
|
||||
if rc != 0:
|
||||
display.vvvv("Failed to mount container %s: %s" % (self._container_id, stderr.strip()))
|
||||
elif not os.listdir(self._mount_point.strip()):
|
||||
display.vvvv("Failed to mount container with CGroups2: empty dir %s" % self._mount_point.strip())
|
||||
self._mount_point = None
|
||||
else:
|
||||
self._mount_point = self._mount_point.strip()
|
||||
display.vvvvv("MOUNTPOINT %s RC %s STDERR %r" % (self._mount_point, rc, stderr))
|
||||
|
||||
if self._connected:
|
||||
return
|
||||
|
||||
display.vvv(f"Connecting to container: {self._container_id}", host=self._container_id)
|
||||
|
||||
self._connected = True
|
||||
display.vvv("Connection established successfully", host=self._container_id)
|
||||
|
||||
@ensure_connect
|
||||
def exec_command(self, cmd, in_data=None, sudoable=False):
|
||||
"""run specified command in a running OCI container using podman"""
|
||||
"""Execute command in container with enhanced error handling"""
|
||||
super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
|
||||
|
||||
# shlex.split has a bug with text strings on Python-2.6 and can only handle text strings on Python-3
|
||||
display.vvv(f"EXEC: {cmd}", host=self._container_id)
|
||||
|
||||
cmd_args_list = shlex.split(to_native(cmd, errors="surrogate_or_strict"))
|
||||
exec_args_list = ["exec"]
|
||||
if self.user:
|
||||
exec_args_list.extend(("--user", self.user))
|
||||
exec_cmd = ["exec"]
|
||||
|
||||
rc, stdout, stderr = self._podman(exec_args_list, cmd_args_list, in_data)
|
||||
# Add interactive flag only when input is provided
|
||||
if in_data is not None:
|
||||
exec_cmd.append("-i")
|
||||
|
||||
display.vvvvv("STDOUT %r STDERR %r" % (stderr, stderr))
|
||||
# Handle user specification
|
||||
if self.get_option("remote_user"):
|
||||
exec_cmd.extend(["--user", self.get_option("remote_user")])
|
||||
|
||||
# Add extra environment variables
|
||||
extra_env = self.get_option("extra_env_vars")
|
||||
if extra_env:
|
||||
for key, value in extra_env.items():
|
||||
exec_cmd.extend(["--env", f"{key}={value}"])
|
||||
|
||||
# Handle privilege escalation only when explicitly requested
|
||||
privilege_method = self.get_option("privilege_escalation_method")
|
||||
if sudoable and privilege_method != "none" and privilege_method != "auto":
|
||||
if privilege_method == "sudo":
|
||||
cmd_args_list = ["sudo", "-n"] + cmd_args_list
|
||||
elif privilege_method == "su":
|
||||
cmd_args_list = ["su", "-c", " ".join(shlex.quote(arg) for arg in cmd_args_list)]
|
||||
|
||||
# Add working directory option
|
||||
workdir = self.get_option("working_directory")
|
||||
if workdir:
|
||||
exec_cmd.extend(["--workdir", workdir])
|
||||
|
||||
# Combine exec command: podman exec [options] container_id command
|
||||
full_cmd = exec_cmd + [self._container_id] + cmd_args_list
|
||||
|
||||
rc, stdout, stderr = self._run_podman_command(full_cmd, input_data=in_data, include_container=False)
|
||||
return rc, stdout, stderr
|
||||
|
||||
def put_file(self, in_path, out_path):
|
||||
"""Place a local file located in 'in_path' inside container at 'out_path'"""
|
||||
"""Transfer file to container using optimal method"""
|
||||
super(Connection, self).put_file(in_path, out_path)
|
||||
display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._container_id)
|
||||
if not self._mount_point or self.user:
|
||||
rc, stdout, stderr = self._podman(
|
||||
"cp",
|
||||
[in_path, self._container_id + ":" + out_path],
|
||||
use_container_id=False,
|
||||
)
|
||||
if rc != 0:
|
||||
rc, stdout, stderr = self._podman(
|
||||
"cp",
|
||||
["--pause=false", in_path, self._container_id + ":" + out_path],
|
||||
use_container_id=False,
|
||||
)
|
||||
if rc != 0:
|
||||
raise AnsibleError(
|
||||
"Failed to copy file from %s to %s in container %s\n%s"
|
||||
% (in_path, out_path, self._container_id, stderr)
|
||||
)
|
||||
if self.user:
|
||||
rc, stdout, stderr = self._podman("exec", ["chown", self.user, out_path])
|
||||
if rc != 0:
|
||||
raise AnsibleError(
|
||||
"Failed to chown file %s for user %s in container %s\n%s"
|
||||
% (out_path, self.user, self._container_id, stderr)
|
||||
)
|
||||
else:
|
||||
real_out_path = self._mount_point + to_bytes(out_path, errors="surrogate_or_strict")
|
||||
shutil.copyfile(
|
||||
to_bytes(in_path, errors="surrogate_or_strict"),
|
||||
to_bytes(real_out_path, errors="surrogate_or_strict"),
|
||||
)
|
||||
display.vvv(f"PUT: {in_path} -> {out_path}", host=self._container_id)
|
||||
|
||||
# Lazily prepare mount point if needed
|
||||
if self._mount_point is None and self.get_option("mount_detection"):
|
||||
self._setup_mount_point()
|
||||
|
||||
# Use direct filesystem copy if mount point is available and no user specified
|
||||
if self._mount_point and not self.get_option("remote_user"):
|
||||
try:
|
||||
real_out_path = os.path.join(self._mount_point, out_path.lstrip("/"))
|
||||
os.makedirs(os.path.dirname(real_out_path), exist_ok=True)
|
||||
shutil.copy2(in_path, real_out_path)
|
||||
display.vvvv(f"File copied via mount: {real_out_path}", host=self._container_id)
|
||||
return
|
||||
except Exception as e:
|
||||
display.vvv(f"Mount copy failed, falling back to podman cp: {e}", host=self._container_id)
|
||||
|
||||
# Use podman cp command
|
||||
copy_cmd = ["cp", "--pause=false", in_path, f"{self._container_id}:{out_path}"]
|
||||
self._run_podman_command(copy_cmd, include_container=False, check_rc=True)
|
||||
|
||||
# Change ownership if user specified
|
||||
if self.get_option("remote_user"):
|
||||
chown_cmd = [
|
||||
"exec",
|
||||
"--user",
|
||||
"root",
|
||||
self._container_id,
|
||||
"chown",
|
||||
self.get_option("remote_user"),
|
||||
out_path,
|
||||
]
|
||||
try:
|
||||
self._run_podman_command(chown_cmd, include_container=False, check_rc=True)
|
||||
except PodmanConnectionError as e:
|
||||
display.warning(f"Failed to change file ownership: {e}")
|
||||
|
||||
def fetch_file(self, in_path, out_path):
|
||||
"""obtain file specified via 'in_path' from the container and place it at 'out_path'"""
|
||||
"""Retrieve file from container using optimal method"""
|
||||
super(Connection, self).fetch_file(in_path, out_path)
|
||||
display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._container_id)
|
||||
if not self._mount_point:
|
||||
rc, stdout, stderr = self._podman(
|
||||
"cp",
|
||||
[self._container_id + ":" + in_path, out_path],
|
||||
use_container_id=False,
|
||||
)
|
||||
if rc != 0:
|
||||
raise AnsibleError(
|
||||
"Failed to fetch file from %s to %s from container %s\n%s"
|
||||
% (in_path, out_path, self._container_id, stderr)
|
||||
)
|
||||
else:
|
||||
real_in_path = self._mount_point + to_bytes(in_path, errors="surrogate_or_strict")
|
||||
shutil.copyfile(
|
||||
to_bytes(real_in_path, errors="surrogate_or_strict"),
|
||||
to_bytes(out_path, errors="surrogate_or_strict"),
|
||||
)
|
||||
display.vvv(f"FETCH: {in_path} -> {out_path}", host=self._container_id)
|
||||
|
||||
# Lazily prepare mount point if needed
|
||||
if self._mount_point is None and self.get_option("mount_detection"):
|
||||
self._setup_mount_point()
|
||||
|
||||
# Use direct filesystem copy if mount point is available
|
||||
if self._mount_point:
|
||||
try:
|
||||
real_in_path = os.path.join(self._mount_point, in_path.lstrip("/"))
|
||||
if os.path.exists(real_in_path):
|
||||
os.makedirs(os.path.dirname(out_path), exist_ok=True)
|
||||
shutil.copy2(real_in_path, out_path)
|
||||
display.vvvv(f"File fetched via mount: {real_in_path}", host=self._container_id)
|
||||
return
|
||||
except Exception as e:
|
||||
display.vvv(f"Mount fetch failed, falling back to podman cp: {e}", host=self._container_id)
|
||||
|
||||
# Use podman cp command
|
||||
copy_cmd = ["cp", "--pause=false", f"{self._container_id}:{in_path}", out_path]
|
||||
self._run_podman_command(copy_cmd, include_container=False, check_rc=True)
|
||||
|
||||
def close(self):
|
||||
"""unmount container's filesystem"""
|
||||
"""Close connection and cleanup resources"""
|
||||
super(Connection, self).close()
|
||||
# we actually don't need to unmount since the container is mounted anyway
|
||||
# rc, stdout, stderr = self._podman("umount")
|
||||
# display.vvvvv("RC %s STDOUT %r STDERR %r" % (rc, stdout, stderr))
|
||||
|
||||
if self._mount_point:
|
||||
try:
|
||||
# Attempt to unmount (optional, container keeps mount anyway)
|
||||
self._run_podman_command(["umount"], check_rc=False)
|
||||
display.vvvv("Container unmounted successfully", host=self._container_id)
|
||||
except Exception as e:
|
||||
display.vvvv(f"Unmount failed (this is usually not critical): {e}", host=self._container_id)
|
||||
|
||||
self._connected = False
|
||||
display.vvv("Connection closed", host=self._container_id)
|
||||
|
|
|
|||
104
tests/integration/targets/connection_buildah_advanced/runme.sh
Executable file
104
tests/integration/targets/connection_buildah_advanced/runme.sh
Executable file
|
|
@ -0,0 +1,104 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
set -o pipefail
|
||||
set -eux
|
||||
|
||||
# Enhanced Buildah Connection Plugin Tests
|
||||
# Tests for new features and configuration options
|
||||
|
||||
# New requirement from ansible-core 2.14
|
||||
export LC_ALL=en_US.UTF-8
|
||||
export LANG=en_US.UTF-8
|
||||
export LANGUAGE=en_US.UTF-8
|
||||
|
||||
# Buildah storage configuration for compatibility
|
||||
export STORAGE_OPTS="overlay.mount_program=/usr/bin/fuse-overlayfs"
|
||||
|
||||
function run_ansible {
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_buildah_features.yml -i "test_connection.inventory" \
|
||||
-e target_hosts="buildah_advanced" \
|
||||
"$@"
|
||||
}
|
||||
|
||||
function run_configuration_test {
|
||||
local config_name="$1"
|
||||
local extra_vars="$2"
|
||||
echo "Testing configuration: $config_name"
|
||||
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_buildah_features.yml -i "test_connection.inventory" \
|
||||
-e target_hosts="buildah_advanced" \
|
||||
-e "$extra_vars" \
|
||||
"$@"
|
||||
}
|
||||
|
||||
echo "=== Running Enhanced Buildah Connection Tests ==="
|
||||
|
||||
# Create a container
|
||||
${SUDO:-} buildah from --name=buildah-container python:3.10-alpine
|
||||
|
||||
# Test 1: Basic functionality with new features
|
||||
echo "Test 1: Basic advanced features"
|
||||
run_ansible "$@"
|
||||
|
||||
# Test 2: Mount detection disabled
|
||||
echo "Test 2: Mount detection disabled"
|
||||
run_configuration_test "mount_disabled" "ansible_buildah_mount_detection=false" "$@"
|
||||
|
||||
# Test 3: Different timeout settings
|
||||
echo "Test 3: Short timeout"
|
||||
run_configuration_test "short_timeout" "ansible_buildah_timeout=5" "$@"
|
||||
|
||||
# Test 4: Different retry settings
|
||||
echo "Test 4: More retries"
|
||||
run_configuration_test "more_retries" "ansible_buildah_retries=5" "$@"
|
||||
|
||||
# Test 5: Custom working directory
|
||||
echo "Test 5: Custom working directory"
|
||||
run_configuration_test "custom_workdir" "ansible_buildah_working_directory=/home" "$@"
|
||||
|
||||
# Test 6: Auto-commit enabled
|
||||
echo "Test 6: Auto-commit enabled"
|
||||
run_configuration_test "auto_commit" "ansible_buildah_auto_commit=true" "$@"
|
||||
|
||||
# Test 7: Custom environment variables
|
||||
echo "Test 7: Custom environment variables"
|
||||
run_configuration_test "custom_env" "ansible_buildah_extra_env={'CUSTOM_BUILD': 'value', 'DEBUG': 'true'}" "$@"
|
||||
|
||||
# Test 8: Verify plugin identification
|
||||
echo "Test 8: Plugin identification verification"
|
||||
ANSIBLE_VERBOSITY=4 run_ansible "$@" | tee check_log
|
||||
${SUDO:-} grep -q "Using buildah connection from collection" check_log
|
||||
${SUDO:-} rm -f check_log
|
||||
|
||||
# Test 9: Error handling with invalid executable
|
||||
echo "Test 9: Error handling test"
|
||||
set +o pipefail
|
||||
ANSIBLE_BUILDAH_EXECUTABLE=fakebuildah run_ansible "$@" 2>&1 | grep "Could not find fakebuildah in PATH"
|
||||
test_result=$?
|
||||
set -o pipefail
|
||||
|
||||
if [ $test_result -eq 0 ]; then
|
||||
echo "Error handling test passed"
|
||||
else
|
||||
echo "Error handling test failed - error message not found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Test 10: Performance test with multiple operations
|
||||
echo "Test 10: Performance test"
|
||||
time run_ansible "$@" > /tmp/buildah_performance_test.log 2>&1
|
||||
echo "Performance test completed - check /tmp/buildah_performance_test.log for timing"
|
||||
|
||||
echo "Test 11: Missing buildah container exec"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_exec.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 12: Buildah removed between exec"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_removed_between_exec.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 13: Buildah put/fetch on missing container"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_put_fetch.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 14: Buildah stdin on missing container"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_stdin.yml -i "test_connection.inventory"
|
||||
|
||||
echo "=== All Enhanced Buildah Connection Tests Completed Successfully ==="
|
||||
|
|
@ -0,0 +1,209 @@
|
|||
---
|
||||
# Advanced Buildah Connection Plugin Tests
|
||||
# Tests new features and configuration options in the rewritten plugin
|
||||
|
||||
- hosts: "{{ target_hosts }}"
|
||||
gather_facts: false
|
||||
serial: 1
|
||||
tasks:
|
||||
|
||||
### Test basic buildah functionality
|
||||
|
||||
- name: Test basic command execution
|
||||
raw: echo "Testing enhanced buildah connection"
|
||||
register: basic_test
|
||||
|
||||
- name: Verify basic command output
|
||||
assert:
|
||||
that:
|
||||
- "'Testing enhanced buildah connection' in basic_test.stdout"
|
||||
|
||||
### Test environment variables injection
|
||||
|
||||
- name: Test environment variable injection
|
||||
raw: printenv BUILD_VAR
|
||||
register: env_test
|
||||
vars:
|
||||
ansible_buildah_extra_env:
|
||||
BUILD_VAR: "build_value"
|
||||
CONTAINER_TYPE: "buildah"
|
||||
|
||||
- name: Verify environment variables were set
|
||||
assert:
|
||||
that:
|
||||
- "'build_value' in env_test.stdout"
|
||||
|
||||
### Test timeout configuration
|
||||
|
||||
- name: Test command timeout with quick command
|
||||
raw: sh -c 'sleep 0.1 && echo "Quick buildah command completed"'
|
||||
register: quick_command
|
||||
vars:
|
||||
ansible_buildah_timeout: 10
|
||||
|
||||
- name: Verify quick command succeeded
|
||||
assert:
|
||||
that:
|
||||
- "'Quick buildah command completed' in quick_command.stdout"
|
||||
|
||||
### Test working directory functionality
|
||||
|
||||
- name: Test working directory setting
|
||||
raw: pwd
|
||||
register: workdir_test
|
||||
vars:
|
||||
ansible_buildah_working_directory: "/tmp"
|
||||
|
||||
- name: Create test file in working directory
|
||||
raw: sh -c 'echo "buildah test content" > test_buildah_file.txt'
|
||||
vars:
|
||||
ansible_buildah_working_directory: "/tmp"
|
||||
|
||||
- name: Verify file was created in working directory
|
||||
raw: cat /tmp/test_buildah_file.txt
|
||||
register: file_content
|
||||
|
||||
- name: Verify file content
|
||||
assert:
|
||||
that:
|
||||
- "'buildah test content' in file_content.stdout"
|
||||
|
||||
### Test file operations with mount detection
|
||||
|
||||
- name: Create test file locally
|
||||
copy:
|
||||
content: "Buildah test file content with mount detection"
|
||||
dest: /tmp/buildah_test_file
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Copy file with mount detection enabled
|
||||
copy:
|
||||
src: /tmp/buildah_test_file
|
||||
dest: /tmp/remote_buildah_test
|
||||
vars:
|
||||
ansible_buildah_mount_detection: true
|
||||
|
||||
- name: Verify file was copied
|
||||
raw: cat /tmp/remote_buildah_test
|
||||
register: mount_test
|
||||
|
||||
- name: Verify file content
|
||||
assert:
|
||||
that:
|
||||
- "'Buildah test file content with mount detection' in mount_test.stdout"
|
||||
|
||||
### Test different user contexts
|
||||
|
||||
- name: Test command execution with root user
|
||||
raw: whoami
|
||||
register: user_test
|
||||
vars:
|
||||
ansible_user: root
|
||||
|
||||
- name: Verify user context (may be root or container default)
|
||||
debug:
|
||||
msg: "Current user: {{ user_test.stdout.strip() }}"
|
||||
|
||||
### Test retry mechanism
|
||||
|
||||
- name: Test retry mechanism with valid command
|
||||
raw: echo "Buildah retry test successful"
|
||||
register: retry_test
|
||||
vars:
|
||||
ansible_buildah_retries: 2
|
||||
|
||||
- name: Verify retry test succeeded
|
||||
assert:
|
||||
that:
|
||||
- "'Buildah retry test successful' in retry_test.stdout"
|
||||
|
||||
### Test container building scenarios
|
||||
|
||||
- name: Install package in container (basic build operation)
|
||||
raw: sh -c 'which apk >/dev/null && apk add --no-cache curl || true'
|
||||
register: package_install
|
||||
ignore_errors: true
|
||||
|
||||
- name: Test that package installation succeeded
|
||||
debug:
|
||||
msg: "Package installation completed: {{ package_install.rc }}"
|
||||
when: package_install is defined
|
||||
|
||||
### Test Unicode and special characters
|
||||
|
||||
- name: Test unicode command output
|
||||
raw: echo "Buildah测试中文字符"
|
||||
register: unicode_test
|
||||
|
||||
- name: Verify unicode output
|
||||
assert:
|
||||
that:
|
||||
- "'Buildah测试中文字符' in unicode_test.stdout"
|
||||
|
||||
### Test connection robustness with multiple commands
|
||||
|
||||
- name: Test connection robustness with multiple commands
|
||||
raw: echo "Buildah command {{ item }}"
|
||||
register: multiple_commands
|
||||
loop: [1, 2, 3, 4, 5]
|
||||
|
||||
- name: Verify all commands executed successfully
|
||||
assert:
|
||||
that:
|
||||
- multiple_commands.results | length == 5
|
||||
- "'Buildah command 1' in multiple_commands.results[0].stdout"
|
||||
- "'Buildah command 5' in multiple_commands.results[4].stdout"
|
||||
|
||||
### Test complex shell operations
|
||||
|
||||
- name: Test complex shell command with pipes
|
||||
raw: sh -c 'echo "buildah test data" | wc -w'
|
||||
register: complex_shell
|
||||
|
||||
- name: Verify complex shell operation
|
||||
assert:
|
||||
that:
|
||||
- complex_shell.stdout.strip() | int == 3
|
||||
|
||||
### Test container inspection capabilities
|
||||
|
||||
- name: Test container info retrieval
|
||||
raw: echo $HOSTNAME
|
||||
register: hostname_test
|
||||
|
||||
- name: Verify hostname is set
|
||||
assert:
|
||||
that:
|
||||
- hostname_test.stdout.strip() | length > 0
|
||||
|
||||
### Test file system operations
|
||||
|
||||
- name: Create directory structure
|
||||
raw: mkdir -p /tmp/buildah_test/dir1 /tmp/buildah_test/dir2
|
||||
|
||||
- name: Create files in directory structure
|
||||
raw: sh -c 'echo "{{ item }}" > /tmp/buildah_test/dir{{ item }}/file{{ item }}.txt'
|
||||
loop: [1, 2]
|
||||
|
||||
- name: List created files
|
||||
raw: sh -c 'find /tmp/buildah_test -name "*.txt" | sort'
|
||||
register: file_list
|
||||
|
||||
- name: Verify file structure
|
||||
assert:
|
||||
that:
|
||||
- "'file1.txt' in file_list.stdout"
|
||||
- "'file2.txt' in file_list.stdout"
|
||||
|
||||
### Cleanup
|
||||
|
||||
- name: Clean up test files in container
|
||||
raw: rm -rf /tmp/buildah_test /tmp/remote_buildah_test /tmp/test_buildah_file.txt
|
||||
ignore_errors: true
|
||||
|
||||
- name: Clean up local test files
|
||||
file:
|
||||
path: /tmp/buildah_test_file
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
ignore_errors: true
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
[buildah_advanced]
|
||||
buildah-container
|
||||
|
||||
[buildah_advanced:vars]
|
||||
ansible_host=buildah-container
|
||||
ansible_connection=containers.podman.buildah
|
||||
ansible_ssh_pipelining=true
|
||||
|
||||
# Test different configurations
|
||||
# Basic configuration with timeout
|
||||
ansible_buildah_timeout=30
|
||||
ansible_buildah_retries=3
|
||||
|
||||
# Mount detection enabled by default
|
||||
ansible_buildah_mount_detection=true
|
||||
ansible_buildah_ignore_mount_errors=true
|
||||
|
||||
# Additional environment variables
|
||||
ansible_buildah_extra_env={"BUILDAH_TESTING": "true", "BUILD_MODE": "test"}
|
||||
|
||||
# Auto-commit disabled for testing
|
||||
ansible_buildah_auto_commit=false
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
- name: Define a missing Buildah host dynamically
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Add a missing buildah container host
|
||||
add_host:
|
||||
name: missing_buildah_host
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: ci-missing-buildah
|
||||
|
||||
- name: Exec on non-existent buildah container should raise ContainerNotFoundError
|
||||
hosts: missing_buildah_host
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Try exec on missing container
|
||||
raw: echo hi
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert ContainerNotFoundError surfaced
|
||||
assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
- name: Buildah put/fetch on missing container
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: ci-missing-buildah
|
||||
tasks:
|
||||
- name: Put should fail
|
||||
copy:
|
||||
content: abc
|
||||
dest: /root/a.txt
|
||||
register: r_put
|
||||
ignore_errors: true
|
||||
|
||||
- name: Fetch should fail
|
||||
fetch:
|
||||
src: /etc/os-release
|
||||
dest: /tmp/osr
|
||||
flat: true
|
||||
register: r_fetch
|
||||
ignore_errors: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- r_put is failed
|
||||
- r_put.msg is search("Container .* not found")
|
||||
- r_fetch is failed
|
||||
- r_fetch.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
- name: Buildah stdin path on missing container
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: ci-missing-buildah
|
||||
tasks:
|
||||
- name: Cat with stdin should raise ContainerNotFoundError
|
||||
raw: cat -n
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
- name: Buildah container removed between tasks
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
wk: ci-bu-wk
|
||||
tasks:
|
||||
- name: Create working container
|
||||
shell: buildah from --name {{ wk }} alpine:latest
|
||||
|
||||
- name: First exec via buildah connection
|
||||
vars:
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: "{{ wk }}"
|
||||
raw: uname -a
|
||||
|
||||
- name: Remove working container
|
||||
shell: buildah rm -f {{ wk }}
|
||||
changed_when: true
|
||||
|
||||
- name: Second exec should raise ContainerNotFoundError
|
||||
vars:
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: "{{ wk }}"
|
||||
raw: echo later
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -19,7 +19,7 @@ ANSIBLE_VERBOSITY=4 ANSIBLE_REMOTE_TMP="/tmp" ANSIBLE_REMOTE_USER="1000" run_ans
|
|||
${SUDO:-} grep -q "Using podman connection from collection" check_log
|
||||
${SUDO:-} rm -f check_log
|
||||
set +o pipefail
|
||||
ANSIBLE_PODMAN_EXECUTABLE=fakepodman run_ansible "$@" 2>&1 | grep "fakepodman command not found in PATH"
|
||||
ANSIBLE_PODMAN_EXECUTABLE=fakepodman run_ansible "$@" 2>&1 | grep "Could not find fakepodman in PATH"
|
||||
set -o pipefail
|
||||
ANSIBLE_PODMAN_EXECUTABLE=fakepodman run_ansible "$@" && {
|
||||
echo "Playbook with fakepodman should fail!"
|
||||
|
|
|
|||
92
tests/integration/targets/connection_podman_advanced/runme.sh
Executable file
92
tests/integration/targets/connection_podman_advanced/runme.sh
Executable file
|
|
@ -0,0 +1,92 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
set -o pipefail
|
||||
set -eux
|
||||
|
||||
# Enhanced Podman Connection Plugin Tests
|
||||
# Tests for new features and configuration options
|
||||
|
||||
function run_ansible {
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_advanced_features.yml -i "test_connection.inventory" \
|
||||
-e target_hosts="podman_advanced" \
|
||||
"$@"
|
||||
}
|
||||
|
||||
function run_configuration_test {
|
||||
local config_name="$1"
|
||||
local extra_vars="$2"
|
||||
echo "Testing configuration: $config_name"
|
||||
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_advanced_features.yml -i "test_connection.inventory" \
|
||||
-e target_hosts="podman_advanced" \
|
||||
-e "$extra_vars" \
|
||||
"$@"
|
||||
}
|
||||
|
||||
echo "=== Running Enhanced Podman Connection Tests ==="
|
||||
|
||||
# Create a container
|
||||
${SUDO} podman run -d --name "podman-container" python:3.10-alpine sleep 1d
|
||||
|
||||
# Test 1: Basic functionality with new features
|
||||
echo "Test 1: Basic advanced features"
|
||||
run_ansible "$@"
|
||||
|
||||
# Test 2: Mount detection disabled
|
||||
echo "Test 2: Mount detection disabled"
|
||||
run_configuration_test "mount_disabled" "ansible_podman_mount_detection=false" "$@"
|
||||
|
||||
# Test 3: Different timeout settings
|
||||
echo "Test 3: Short timeout"
|
||||
run_configuration_test "short_timeout" "ansible_podman_timeout=5" "$@"
|
||||
|
||||
# Test 4: Different retry settings
|
||||
echo "Test 4: More retries"
|
||||
run_configuration_test "more_retries" "ansible_podman_retries=5" "$@"
|
||||
|
||||
# Test 5: Different user context
|
||||
echo "Test 5: Root user context"
|
||||
run_configuration_test "root_user" "ansible_user=root" "$@"
|
||||
|
||||
# Test 6: Custom environment variables
|
||||
echo "Test 6: Custom environment variables"
|
||||
run_configuration_test "custom_env" "ansible_podman_extra_env={'CUSTOM_TEST': 'value', 'DEBUG': 'true'}" "$@"
|
||||
|
||||
# Test 7: Verify plugin identification
|
||||
echo "Test 7: Plugin identification verification"
|
||||
ANSIBLE_VERBOSITY=4 run_ansible "$@" | tee check_log
|
||||
${SUDO:-} grep -q "Using podman connection from collection" check_log
|
||||
${SUDO:-} rm -f check_log
|
||||
|
||||
# Test 8: Error handling with invalid executable
|
||||
echo "Test 8: Error handling test"
|
||||
set +o pipefail
|
||||
ANSIBLE_PODMAN_EXECUTABLE=fakepodman run_ansible "$@" 2>&1 | grep "Could not find fakepodman in PATH"
|
||||
test_result=$?
|
||||
set -o pipefail
|
||||
|
||||
if [ $test_result -eq 0 ]; then
|
||||
echo "Error handling test passed"
|
||||
else
|
||||
echo "Error handling test failed - error message not found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Test 9: Performance test with multiple operations
|
||||
echo "Test 9: Performance test"
|
||||
time run_ansible "$@" > /tmp/performance_test.log 2>&1
|
||||
echo "Performance test completed - check /tmp/performance_test.log for timing"
|
||||
|
||||
echo "Test 10: Missing container exec"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_exec.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 11: Removed between exec"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_removed_between_exec.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 12: Missing container put"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_put.yml -i "test_connection.inventory"
|
||||
|
||||
echo "Test 13: Missing container fetch"
|
||||
${SUDO:-} ${ANSIBLECMD:-ansible-playbook} test_missing_container_fetch.yml -i "test_connection.inventory"
|
||||
|
||||
echo "=== All Enhanced Podman Connection Tests Completed Successfully ==="
|
||||
|
|
@ -0,0 +1,248 @@
|
|||
---
|
||||
# Advanced Podman Connection Plugin Tests
|
||||
# Tests new features and configuration options in the rewritten plugin
|
||||
|
||||
- hosts: "{{ target_hosts }}"
|
||||
gather_facts: false
|
||||
serial: 1
|
||||
tasks:
|
||||
|
||||
### Test new configuration options
|
||||
|
||||
- name: Test basic command execution
|
||||
raw: echo "Testing enhanced podman connection"
|
||||
register: basic_test
|
||||
|
||||
- name: Verify basic command output
|
||||
assert:
|
||||
that:
|
||||
- "'Testing enhanced podman connection' in basic_test.stdout"
|
||||
|
||||
### Test environment variables injection
|
||||
|
||||
- name: Test environment variable injection
|
||||
raw: printenv TEST_VAR
|
||||
register: env_test
|
||||
vars:
|
||||
ansible_podman_extra_env:
|
||||
TEST_VAR: "custom_value"
|
||||
ANOTHER_VAR: "another_value"
|
||||
|
||||
- name: Verify environment variables were set
|
||||
assert:
|
||||
that:
|
||||
- "'custom_value' in env_test.stdout"
|
||||
|
||||
### Test timeout configuration
|
||||
|
||||
- name: Test command timeout with quick command
|
||||
raw: sh -c 'sleep 0.1 && echo "Quick command completed"'
|
||||
register: quick_command
|
||||
vars:
|
||||
ansible_podman_timeout: 5
|
||||
|
||||
- name: Verify quick command succeeded
|
||||
assert:
|
||||
that:
|
||||
- "'Quick command completed' in quick_command.stdout"
|
||||
|
||||
### Test retry mechanism with valid command
|
||||
|
||||
- name: Test retry mechanism with initially failing but eventually succeeding command
|
||||
raw: echo "Retry test successful"
|
||||
register: retry_test
|
||||
vars:
|
||||
ansible_podman_retries: 2
|
||||
|
||||
- name: Verify retry test succeeded
|
||||
assert:
|
||||
that:
|
||||
- "'Retry test successful' in retry_test.stdout"
|
||||
|
||||
### Test file operations with mount detection
|
||||
|
||||
- name: Create test file locally
|
||||
copy:
|
||||
content: "Test file content with mount detection enabled"
|
||||
dest: /tmp/test_mount_file
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Copy file with mount detection enabled
|
||||
copy:
|
||||
src: /tmp/test_mount_file
|
||||
dest: /tmp/remote_mount_test
|
||||
vars:
|
||||
ansible_podman_mount_detection: true
|
||||
|
||||
- name: Verify file was copied
|
||||
raw: cat /tmp/remote_mount_test
|
||||
register: mount_test
|
||||
|
||||
- name: Verify file content
|
||||
assert:
|
||||
that:
|
||||
- "'Test file content with mount detection enabled' in mount_test.stdout"
|
||||
|
||||
- name: Fetch file with mount detection
|
||||
fetch:
|
||||
src: /tmp/remote_mount_test
|
||||
dest: /tmp/fetched_mount_test
|
||||
flat: true
|
||||
vars:
|
||||
ansible_podman_mount_detection: true
|
||||
|
||||
- name: Verify fetched file content
|
||||
command:
|
||||
cmd: cat /tmp/fetched_mount_test
|
||||
register: fetched_content
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Verify fetched file content is correct
|
||||
assert:
|
||||
that:
|
||||
- "'Test file content with mount detection enabled' in fetched_content.stdout"
|
||||
|
||||
### Test file operations with mount detection disabled
|
||||
|
||||
- name: Copy file with mount detection disabled
|
||||
copy:
|
||||
src: /tmp/test_mount_file
|
||||
dest: /tmp/remote_no_mount_test
|
||||
vars:
|
||||
ansible_podman_mount_detection: false
|
||||
|
||||
- name: Verify file was copied without mount
|
||||
raw: cat /tmp/remote_no_mount_test
|
||||
register: no_mount_test
|
||||
|
||||
- name: Verify file content without mount
|
||||
assert:
|
||||
that:
|
||||
- "'Test file content with mount detection enabled' in no_mount_test.stdout"
|
||||
|
||||
### Test user specification
|
||||
|
||||
- name: Test command execution with specific user
|
||||
raw: whoami
|
||||
register: user_test
|
||||
vars:
|
||||
ansible_user: root
|
||||
|
||||
- name: Verify user context
|
||||
assert:
|
||||
that:
|
||||
- "'root' in user_test.stdout"
|
||||
|
||||
### Test large file transfer
|
||||
|
||||
- name: Create large test file locally
|
||||
command:
|
||||
cmd: head -c 1M /dev/zero
|
||||
register: large_file_content
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Write large file locally
|
||||
copy:
|
||||
content: "{{ large_file_content.stdout }}"
|
||||
dest: /tmp/large_test_file
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Copy large file to container
|
||||
copy:
|
||||
src: /tmp/large_test_file
|
||||
dest: /tmp/remote_large_file
|
||||
|
||||
- name: Verify large file size
|
||||
raw: wc -c /tmp/remote_large_file | cut -d' ' -f1
|
||||
register: large_file_size
|
||||
|
||||
- name: Verify large file was copied correctly
|
||||
assert:
|
||||
that:
|
||||
- large_file_size.stdout | int >= 1000000
|
||||
|
||||
### Test Unicode and special characters
|
||||
|
||||
- name: Test unicode command output
|
||||
raw: echo "测试中文字符"
|
||||
register: unicode_test
|
||||
|
||||
- name: Verify unicode output
|
||||
assert:
|
||||
that:
|
||||
- "'测试中文字符' in unicode_test.stdout"
|
||||
|
||||
- name: Create unicode filename test
|
||||
copy:
|
||||
content: "Unicode filename test content"
|
||||
dest: "/tmp/测试文件.txt"
|
||||
|
||||
- name: Verify unicode file was created
|
||||
raw: cat "/tmp/测试文件.txt"
|
||||
register: unicode_file_test
|
||||
|
||||
- name: Verify unicode file content
|
||||
assert:
|
||||
that:
|
||||
- "'Unicode filename test content' in unicode_file_test.stdout"
|
||||
|
||||
### Test connection recovery and error handling
|
||||
|
||||
- name: Test connection robustness with multiple commands
|
||||
raw: echo "Command {{ item }}"
|
||||
register: multiple_commands
|
||||
loop: [1, 2, 3, 4, 5]
|
||||
|
||||
- name: Verify all commands executed successfully
|
||||
assert:
|
||||
that:
|
||||
- multiple_commands.results | length == 5
|
||||
- "'Command 1' in multiple_commands.results[0].stdout"
|
||||
- "'Command 5' in multiple_commands.results[4].stdout"
|
||||
|
||||
### Test complex shell operations
|
||||
|
||||
- name: Test complex shell command with pipes and redirects
|
||||
raw: sh -c 'echo "test data" | wc -c | tr -d "\n"'
|
||||
register: complex_shell
|
||||
|
||||
- name: Verify complex shell operation
|
||||
assert:
|
||||
that:
|
||||
- complex_shell.stdout | int == 10
|
||||
|
||||
### Test working directory
|
||||
|
||||
- name: Test working directory commands
|
||||
raw: pwd
|
||||
register: pwd_test
|
||||
|
||||
- name: Create directory and test relative path
|
||||
raw: sh -c 'mkdir -p /tmp/test_workdir && cd /tmp/test_workdir && pwd'
|
||||
register: workdir_test
|
||||
|
||||
- name: Verify working directory operations
|
||||
assert:
|
||||
that:
|
||||
- "'/tmp/test_workdir' in workdir_test.stdout"
|
||||
|
||||
### Cleanup
|
||||
|
||||
- name: Clean up test files
|
||||
raw: rm -f /tmp/remote_mount_test /tmp/remote_no_mount_test /tmp/remote_large_file /tmp/测试文件.txt
|
||||
ignore_errors: true
|
||||
|
||||
- name: Clean up test directory
|
||||
raw: rm -rf /tmp/test_workdir
|
||||
ignore_errors: true
|
||||
|
||||
- name: Clean up local test files
|
||||
file:
|
||||
path: "{{ item }}"
|
||||
state: absent
|
||||
loop:
|
||||
- /tmp/test_mount_file
|
||||
- /tmp/fetched_mount_test
|
||||
- /tmp/large_test_file
|
||||
delegate_to: localhost
|
||||
ignore_errors: true
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
[podman_advanced]
|
||||
podman-container
|
||||
|
||||
[podman_advanced:vars]
|
||||
ansible_host=podman-container
|
||||
ansible_connection=containers.podman.podman
|
||||
ansible_python_interpreter=/usr/local/bin/python
|
||||
|
||||
# Test different configurations
|
||||
# Basic configuration with timeout
|
||||
ansible_podman_timeout=30
|
||||
ansible_podman_retries=3
|
||||
|
||||
# Mount detection enabled by default
|
||||
ansible_podman_mount_detection=true
|
||||
ansible_podman_ignore_mount_errors=true
|
||||
|
||||
# Additional environment variables
|
||||
ansible_podman_extra_env={"TESTING": "true", "PLUGIN_VERSION": "2.0"}
|
||||
|
||||
# Connection caching and performance
|
||||
ansible_podman_timeout=15
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
- name: Define a missing Podman host dynamically
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Add a missing container host
|
||||
add_host:
|
||||
name: missing_podman_host
|
||||
ansible_connection: containers.podman.podman
|
||||
ansible_host: ci-missing-podman
|
||||
|
||||
- name: Exec on non-existent container should raise ContainerNotFoundError
|
||||
hosts: missing_podman_host
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Try exec on missing container
|
||||
raw: id -u
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert ContainerNotFoundError surfaced
|
||||
assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
- name: Fetch from missing Podman container
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
ansible_host: ci-missing-podman
|
||||
tasks:
|
||||
- name: Fetch should raise ContainerNotFoundError
|
||||
fetch:
|
||||
src: /etc/os-release
|
||||
dest: /tmp/os-release
|
||||
flat: true
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert ContainerNotFoundError surfaced
|
||||
assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
- name: Put file to missing Podman container
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
ansible_host: ci-missing-podman
|
||||
tasks:
|
||||
- name: Create temp file on controller
|
||||
copy:
|
||||
content: podman-put-test
|
||||
dest: /tmp/podman-put-test.txt
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Put file should raise ContainerNotFoundError
|
||||
copy:
|
||||
src: /tmp/podman-put-test.txt
|
||||
dest: /root/put-here.txt
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert ContainerNotFoundError surfaced
|
||||
assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
- name: Removed between exec for Podman
|
||||
hosts: podman_advanced
|
||||
gather_facts: false
|
||||
vars:
|
||||
ansible_connection: containers.podman.podman
|
||||
tasks:
|
||||
- name: First exec works
|
||||
raw: uname -s
|
||||
|
||||
- name: Remove this container from host
|
||||
delegate_to: localhost
|
||||
become: false
|
||||
shell: podman rm -f {{ inventory_hostname }}
|
||||
changed_when: true
|
||||
|
||||
- name: Second exec should fail with ContainerNotFoundError
|
||||
raw: echo hello
|
||||
register: r
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert ContainerNotFoundError surfaced
|
||||
assert:
|
||||
that:
|
||||
- r is failed
|
||||
- r.msg is search("Container .* not found")
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_buildah_advanced/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/podman_play/tasks/files/multi-yaml.yml yamllint!skip
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue