Add option to run with podman-py API

Add Podman API support for podman_container and podman_container_info
modules using podman-py module.

Signed-off-by: Sagi Shnaidman <[email protected]>

.github/workflows/podman_container_api.yml

@@ -0,0 +1,118 @@
+name: Podman API container
+
+on:
+  push:
+    paths:
+      - '.github/workflows/podman_container_api.yml'
+      - 'ci/*.yml'
+      - 'ci/run_containers_tests.sh'
+      - 'ci/playbooks/containers/podman_container_api.yml'
+      #- 'plugins/modules/podman_container.py'
+      - 'plugins/module_utils/podman/podman_container_lib.py'
+      - 'plugins/module_utils/podman/podman_api.py'
+      - 'plugins/module_utils/podman/common.py'
+      - 'tests/integration/targets/podman_container_api/**'
+    branches:
+      - master
+  pull_request:
+    paths:
+      - '.github/workflows/podman_container_api.yml'
+      - 'ci/*.yml'
+      - 'ci/run_containers_tests.sh'
+      - 'ci/playbooks/containers/podman_container_api.yml'
+      #- 'plugins/modules/podman_container.py'
+      - 'plugins/module_utils/podman/podman_container_lib.py'
+      - 'plugins/module_utils/podman/podman_api.py'
+      - 'plugins/module_utils/podman/common.py'
+      - 'tests/integration/targets/podman_container_api/**'
+  schedule:
+    - cron: 4 0 * * *  # Run daily at 0:03 UTC
+
+jobs:
+
+  test_podman_container_api:
+    name: Podman API container ${{ matrix.ansible-version }}-${{ matrix.os || 'ubuntu-22.04' }}
+    runs-on: ${{ matrix.os || 'ubuntu-22.04' }}
+    defaults:
+      run:
+        shell: bash
+    strategy:
+      fail-fast: false
+      matrix:
+        ansible-version:
+          - ansible<2.10
+          - git+https://github.com/ansible/[email protected]
+          - git+https://github.com/ansible/ansible.git@devel
+        os:
+          - ubuntu-22.04
+        python-version:
+          - "3.10"
+
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip and display Python and PIP versions
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python*-wheel python*-yaml
+          python -m pip install --upgrade pip
+          python -V
+          pip --version
+
+      - name: Set up pip cache
+        uses: actions/cache@v3
+        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: python3 -m pip install --user --force-reinstall --upgrade '${{ matrix.ansible-version }}'
+
+      - name: Build and install the collection tarball
+        run: |
+          export PATH=~/.local/bin:$PATH
+
+          echo "Run ansible version"
+          command -v ansible
+          ansible --version
+          rm -rf /tmp/just_new_collection
+          ~/.local/bin/ansible-galaxy collection build --output-path /tmp/just_new_collection --force
+          ~/.local/bin/ansible-galaxy collection install -vvv --force /tmp/just_new_collection/*.tar.gz
+
+      - name: Run collection tests for podman container API
+        run: |
+          export PATH=~/.local/bin:$PATH
+
+          if [[ '${{ matrix.ansible-version }}'  == 'git+https://github.com/ansible/ansible.git@devel' ]]; then
+            export ANSIBLE_CONFIG=$(pwd)/ci/ansible-dev.cfg
+          elif [[ '${{ matrix.ansible-version }}'  == 'ansible<2.10' ]]; then
+            export ANSIBLE_CONFIG=$(pwd)/ci/ansible-2.9.cfg
+          fi
+          python3 -m pip install --user -r requirements.txt
+          podman system service --time=0 unix:///tmp/podman.sock &
+          sudo podman system service --time=0 unix:///tmp/root-podman.sock &
+
+          echo $ANSIBLE_CONFIG
+          command -v ansible-playbook
+          pip --version
+          python --version
+          ansible-playbook --version
+
+          ansible-playbook -vv ci/playbooks/pre.yml \
+          -e host=localhost \
+          -i localhost, \
+          -e ansible_connection=local \
+          -e setup_python=false
+
+          TEST2RUN=podman_container_api ./ci/run_containers_tests.sh
+        shell: bash

bindep.txt

@@ -0,0 +1 @@
+podman

ci/playbooks/containers/podman_container_api.yml

@@ -0,0 +1,12 @@
+---
+- hosts: all
+  gather_facts: true
+  module_defaults:
+    containers.podman.podman_container:
+      podman_socket: unix:///tmp/podman.sock
+  tasks:
+    - include_role:
+        name: podman_container_api
+      vars:
+        idem_image: idempotency_test
+        ansible_python_interpreter: "{{ _ansible_python_interpreter }}"

plugins/module_utils/podman/common.py

@@ -18,6 +18,13 @@
         raise_from(ImportError('To use this plugin or module with ansible-core'
                                ' < 2.11, you need to use Python < 3.12 with '
                                'distutils.version present'), exc)
+try:
+    import requests  # pylint: disable=unused-import
+    from .podman_api import PodmanAPIClient
+    HAS_REQUESTS = True
+except ImportError:
+    PodmanAPIClient = object
+    HAS_REQUESTS = False
 
 ARGUMENTS_OPTS_DICT = {
     '--attach': ['--attach', '-a'],
@@ -422,3 +429,13 @@ def diff_generic(params, info_config, module_arg, cmd_arg, boolean_type=False):
     else:
         before = ",".join(sorted(before)) if len(before) > 1 else before[0]
     return before, after
+class PodmanAPI:
+    def __init__(self, module, module_params):
+        if module_params.get('podman_socket') and not HAS_REQUESTS:
+            module.fail_json(
+                msg="Requests module is not installed while socket was provided!")
+        self.client = PodmanAPIClient(module_params.get('podman_socket'))
+        try:
+            self.client.version()
+        except Exception as api_error:
+            module.fail_json(msg="Podman API error: %s" % str(api_error))