Merge pull request #676 from redhatci/template-dir

add the copy_and_render role

Author: fredericlepied

.ansible-lint

@@ -15,6 +15,7 @@ exclude_paths:
   - plugins
   - hack
   - tests
+  - roles/**/molecule
 
 skip_list:
   - var-naming[no-role-prefix]

.github/workflows/pr.yml

@@ -114,7 +114,7 @@ jobs:
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
 
       # Fail when new errors appear
-      - name: Run ansible-test sanity/units
+      - name: Run ansible-test sanity/units/integration
         run: |
           set -x
           # Prefer using podman over docker

.gitignore

@@ -1,4 +1,5 @@
 *.tar.gz
 roles/**/.linted
+tests/integration/inventory
 tests/output
 __pycache__

CONTRIBUTING.md

@@ -62,7 +62,7 @@ The collection has multiple CI pipelines that run on every PR:
 
 - PR pipeline: [`.github/workflows/pr.yml`](../.github/workflows/pr.yml) that runs the sanity tests and Ansible lint. It fails if there is any regression. It also runs a check on the PR Dependencies (`Depends-On:` lines in the commit message) to make sure that the dependencies are merged before the PR. Tests can be run locally:
   - For Ansible lint tests, run [`./hack/ansible-lint.sh -d`](hack/ansible-lint.sh).
-  - For Sanity and Unit tests, run [`./hack/run_ansible_test.sh`](hack/run_ansible_test.sh).
+  - For Sanity, Integration and Unit tests, run [`./hack/run_ansible_test.sh`](hack/run_ansible_test.sh).
   - For Doc checks, run [`./hack/check_doc.sh`](hack/check_doc.sh).
   - For version checks, run [`./hack/check_version.sh`](hack/check_version.sh).
 - DCI BOS2 pipeline: [`.github/workflows/dci.yml`](../.github/workflows/dci.yml) that runs a DCI job to test the collection in a virtual environment at the BOS2 Telco Partner CI lab. It is triggered only when a change is modifying files in the `/roles/` directory.

README.md

@@ -55,6 +55,7 @@ Name | Description
 [redhatci.ocp.create_vms](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/create_vms/README.md) | Provisions libvirt network, storage pools and the KVM Nodes.
 [redhatci.ocp.create_helmchart](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/create_helmchart/README.md) | Creation of a Helm Chart certification project
 [redhatci.ocp.create_pr](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/create_pr/README.md) | Pull-Request handling for helm chart certification and operator bundle certification.
+[redhatci.ocp.copy_and_render](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/copy_and_render/README.md) | Copies files and subdirectories from a source dir to a target dir, then renders and replaces all Jinja2 .j2 templates
 [redhatci.ocp.deploy_cr](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/deploy_cr/README.md) | Deploys a custom resource
 [redhatci.ocp.deprecated_api](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/deprecated_api/README.md) | Extracts deprecated API calls in a cluster
 [redhatci.ocp.destroy_vms](https://github.com/redhatci/ansible-collection-redhatci-ocp/blob/main/roles/destroy_vms/README.md) | Destroys libvirt network, storage pools and the KVM Nodes and the network bridge connection.

ansible-collection-redhatci-ocp.spec

@@ -3,7 +3,7 @@
 %global forgeurl https://github.com/%{org}/%{repo}
 
 Name:           %{repo}
-Version:        2.4.EPOCH
+Version:        2.5.EPOCH
 Release:        VERS%{?dist}
 Summary:        Red Hat OCP CI Collection for Ansible
 
@@ -54,6 +54,9 @@ find -type f ! -executable -name '*.py' -print -exec sed -i -e '1{\@^#!.*@d}' '{
 
 
 %changelog
+* Mon May 26 2025 Frederic Lepied <[email protected]> - 2.5.EPOCH-VERS
+- New role copy_and_render
+
 * Tue May 20 2025 Tony Garcia <[email protected]> - 2.4.EPOCH-VERS
 - Version bump for role updates - acm.utils
 

galaxy.yml

@@ -9,7 +9,7 @@ name: ocp
 # Always leave patch version as .0
 # Patch version is replaced from commit date in UNIX epoch format
 # example: 1.3.2147483647
-version: 2.4.0
+version: 2.5.0
 
 # The path to the Markdown (.md) readme file.
 readme: README.md

hack/run_ansible_test.sh

@@ -28,19 +28,21 @@ trap 'git checkout -- "$branch"' EXIT
 git fetch --unshallow origin main || :
 
 # extract all the supported python versions from the error message, excluding 3.5
-EXCLUDE="--exclude hack/ --exclude plugins/modules/nmcli.py"
+EXCLUDE="--exclude tests/ --exclude hack/ --exclude plugins/modules/nmcli.py"
 PY_VERS=$(ansible-test sanity $EXCLUDE --verbose --docker --python 1.0 --color --coverage --failure-ok 2>&1 |
   grep -Po "invalid.*?\K'3.*\d'" |
   tr -d ,\' |
   sed -e 's/3.5 //g')
 for version in $PY_VERS; do
   ansible-test sanity $EXCLUDE --verbose --docker --python $version --color --coverage --failure-ok
   ansible-test units --verbose --docker --python $version --color --coverage || :
+  ansible-test integration --verbose --docker --python $version --color --coverage || :
 done 2> >(tee -a branch.output >&2)
 git checkout origin/main
 for version in $PY_VERS; do
   ansible-test sanity $EXCLUDE --verbose --docker --python $version --color --coverage --failure-ok
   ansible-test units --verbose --docker --python $version --color --coverage || :
+  ansible-test integration --verbose --docker --python $version --color --coverage || :
 done 2> main.output 1>/dev/null
 for key in branch main; do
   grep -E "((ERROR|FATAL):|FAILED )" "$key.output" |

roles/copy_and_render/README.md

@@ -0,0 +1,27 @@
+# copy_and_render
+
+Role to copy files and subdirectories from a source directory to a target directory, then render and replace all Jinja2 `.j2` templates.
+
+Role Variables:
+
+`car_source_dir` (string, required): Source directory on the control machine containing files and `.j2` templates.
+`car_target_dir` (string, required): Destination directory on the remote host where files will be copied and templates rendered.
+
+Example Playbook:
+
+```yaml
+- hosts: all
+  roles:
+    - role: copy_and_render
+      vars:
+        car_source_dir: "/path/to/source"
+        car_target_dir: "/path/to/target"
+```
+
+Requirements:
+
+- Ansible 2.9 or higher
+
+License:
+
+Apache-2.0

roles/copy_and_render/tasks/main.yml

@@ -0,0 +1,38 @@
+---
+
+- name: Validate that car_source_dir and car_target_dir are set
+  ansible.builtin.assert:
+    that:
+      - car_source_dir is defined
+      - car_source_dir | length > 0
+      - car_target_dir is defined
+      - car_target_dir | length > 0
+    fail_msg: "Both car_source_dir and car_target_dir must be defined and non-empty"
+
+- name: Copy files and subdirectories from source to target
+  ansible.builtin.copy:
+    src: "{{ car_source_dir | regex_replace('/$', '') }}/"
+    dest: "{{ car_target_dir }}"
+    mode: '0644'
+
+- name: Find Jinja2 template files
+  ansible.builtin.find:
+    paths: "{{ car_source_dir }}"
+    patterns: "*.j2"
+    file_type: file
+  register: _car_j2_templates
+
+- name: Render Jinja2 templates to target directory
+  ansible.builtin.template:
+    src: "{{ item.path }}"
+    dest: "{{ car_target_dir }}/{{ item.path | basename | regex_replace('\\.j2$', '') }}"
+    mode: '0644'
+  loop: "{{ _car_j2_templates.files }}"
+
+- name: Remove original .j2 template files from target directory
+  ansible.builtin.file:
+    path: "{{ car_target_dir }}/{{ item.path | basename }}"
+    state: absent
+  loop: "{{ _car_j2_templates.files }}"
+
+...