refactor: improve support for ostree systems

.ansible-lint

@@ -22,5 +22,3 @@ exclude_paths:
   - examples/roles/
 mock_roles:
   - linux-system-roles.ha_cluster
-mock_modules:
-  - ansible.utils.update_fact

.ostree/get_ostree_data.sh

@@ -2,7 +2,6 @@
 
 set -euo pipefail
 
-role_collection_dir="${ROLE_COLLECTION_DIR:-fedora/linux_system_roles}"
 ostree_dir="${OSTREE_DIR:-"$(dirname "$(realpath "$0")")"}"
 
 if [ -z "${4:-}" ] || [ "${1:-}" = help ] || [ "${1:-}" = -h ]; then
@@ -29,7 +28,7 @@ if [ "$pkgtype" = testing ]; then
 fi
 
 get_rolepath() {
-    local ostree_dir role rolesdir roles_parent_dir
+    local ostree_dir role rolesdir roles_parent_dir coll_path pth
     ostree_dir="$1"
     role="$2"
     roles_parent_dir="$(dirname "$(dirname "$ostree_dir")")"
@@ -47,16 +46,22 @@ get_rolepath() {
         fi
     done
     # look elsewhere
-    if [ -n "${ANSIBLE_COLLECTIONS_PATHS:-}" ]; then
-        for pth in ${ANSIBLE_COLLECTIONS_PATHS//:/ }; do
-            rolesdir="$pth/ansible_collections/$role_collection_dir/roles/$role/.ostree"
-            if [ -d "$rolesdir" ]; then
-                echo "$rolesdir"
-                return 0
-            fi
+    coll_path="${ANSIBLE_COLLECTIONS_PATH:-}"
+    if [ -z "$coll_path" ]; then
+        coll_path="${ANSIBLE_COLLECTIONS_PATHS:-}"
+    fi
+    if [ -n "${coll_path}" ]; then
+        for pth in ${coll_path//:/ }; do
+            for rolesdir in "$pth"/ansible_collections/*/*_system_roles/roles/"$role"/.ostree; do
+                if [ -d "$rolesdir" ]; then
+                    echo "$rolesdir"
+                    return 0
+                fi
+            done
         done
     fi
-    return 1
+    1>&2 echo ERROR - could not find role "$role" - please use ANSIBLE_COLLECTIONS_PATH
+    exit 2
 }
 
 get_packages() {
@@ -75,6 +80,10 @@ get_packages() {
             roles="$(cat "$rolefile")"
             for role in $roles; do
                 rolepath="$(get_rolepath "$ostree_dir" "$role")"
+                if [ -z "$rolepath" ]; then
+                    1>&2 echo ERROR - could not find role "$role" - please use ANSIBLE_COLLECTIONS_PATH
+                    exit 2
+                fi
                 get_packages "$rolepath"
             done
         fi

README.md

@@ -40,7 +40,8 @@ If the `ha_cluster` is a role from the `fedora.linux_system_roles`
 collection or from the Fedora RPM package, the requirement is already
 satisfied.
 
-Otherwise, please run the following command line to install the collection.
+If you need to manage `rpm-ostree` systems, you will need to install additional
+collections.  Please run the following command line to install the collections.
 
 ```bash
 ansible-galaxy collection install -r meta/collection-requirements.yml
@@ -1854,6 +1855,10 @@ Note that you cannot run a quorum device on a cluster node.
     - linux-system-roles.ha_cluster
 ```
 
+## rpm-ostree
+
+See README-ostree.md
+
 ## License
 
 MIT

meta/collection-requirements.yml

@@ -2,6 +2,5 @@
 ---
 collections:
   - ansible.posix
-  - ansible.utils
   - community.general
   - fedora.linux_system_roles

tasks/enable-package-repositories.yml

@@ -26,4 +26,4 @@
   when:
     - ha_cluster_enable_repos
     - __ha_cluster_enable_repo_tasks_file is defined
-    - ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
+    - not __ha_cluster_is_ostree | d(false)

tasks/main.yml

@@ -15,6 +15,8 @@
       +
       ha_cluster_extra_packages }}"
     state: present
+    use: "{{ (__ha_cluster_is_ostree | d(false)) |
+             ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
 
 - name: Check and prepare role variables
   include_tasks: shell_{{ ha_cluster_pacemaker_shell }}/check-and-prepare-role-variables.yml  # yamllint disable-line rule:line-length
@@ -49,6 +51,8 @@
           ha_cluster_fence_agent_packages
         }}"
         state: present
+        use: "{{ (__ha_cluster_is_ostree | d(false)) |
+                 ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
 
     - name: Configure firewall
       include_tasks: firewall.yml

tasks/set_vars.yml

@@ -5,23 +5,17 @@
   when: __ha_cluster_required_facts |
     difference(ansible_facts.keys() | list) | length > 0
 
-- name: Ensure correct package manager for ostree systems
-  vars:
-    ostree_pkg_mgr: ansible.posix.rhel_rpm_ostree
-    ostree_booted_file: /run/ostree-booted
-  when: ansible_facts.pkg_mgr | d("") != ostree_pkg_mgr
+- name: Determine if system is ostree and set flag
+  when: not __ha_cluster_is_ostree is defined
   block:
     - name: Check if system is ostree
       stat:
-        path: "{{ ostree_booted_file }}"
+        path: /run/ostree-booted
       register: __ostree_booted_stat
 
-    - name: Set package manager to use for ostree
-      ansible.utils.update_fact:
-        updates:
-          - path: ansible_facts.pkg_mgr
-            value: "{{ ostree_pkg_mgr }}"
-      when: __ostree_booted_stat.stat.exists
+    - name: Set flag to indicate system is ostree
+      set_fact:
+        __ha_cluster_is_ostree: "{{ __ostree_booted_stat.stat.exists }}"
 
 - name: Set platform/version specific variables
   include_vars: "{{ __vars_file }}"

tasks/test_cleanup_qnetd.yml

@@ -11,10 +11,10 @@
     name:
       - corosync-qnetd
     state: absent
-  when: ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
+  when: not __ha_cluster_is_ostree | d(false)
 
 - name: Make sure qnetd config files are not present
   file:
     path: /etc/corosync/qnetd
     state: absent
-  when: ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
+  when: not __ha_cluster_is_ostree | d(false)

tasks/test_setup.yml

@@ -16,23 +16,17 @@
     gather_subset: min
   when: "'distribution' not in ansible_facts"
 
-- name: Ensure correct package manager for ostree systems
-  vars:
-    ostree_pkg_mgr: ansible.posix.rhel_rpm_ostree
-    ostree_booted_file: /run/ostree-booted
-  when: ansible_facts.pkg_mgr | d("") != ostree_pkg_mgr
+- name: Determine if system is ostree and set flag
+  when: not __ha_cluster_is_ostree is defined
   block:
     - name: Check if system is ostree
       stat:
-        path: "{{ ostree_booted_file }}"
+        path: /run/ostree-booted
       register: __ostree_booted_stat
 
-    - name: Set package manager to use for ostree
-      ansible.utils.update_fact:
-        updates:
-          - path: ansible_facts.pkg_mgr
-            value: "{{ ostree_pkg_mgr }}"
-      when: __ostree_booted_stat.stat.exists
+    - name: Set flag to indicate system is ostree
+      set_fact:
+        __ha_cluster_is_ostree: "{{ __ostree_booted_stat.stat.exists }}"
 
 # Test systems may not have repositories available through subscriptions
 - name: Do not try to enable RHEL repositories
@@ -53,5 +47,5 @@
           grep "^$username" /usr/lib/passwd >> /etc/passwd
       fi
     done
-  when: ansible_facts.pkg_mgr | d() == "ansible.posix.rhel_rpm_ostree"
+  when: __ha_cluster_is_ostree | d(false)
   changed_when: true

tasks/test_setup_qnetd.yml

@@ -12,6 +12,8 @@
       - corosync-qnetd
       - pcs
     state: present
+    use: "{{ (__ha_cluster_is_ostree | d(false)) |
+             ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
 
 - name: Set up qnetd
   command:

tests/tasks/fixture_psks.yml

@@ -19,6 +19,8 @@
       package:
         name: openssl
         state: present
+        use: "{{ (__ha_cluster_is_ostree | d(false)) |
+                 ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
       when: "'openssl' not in ansible_facts.packages"
 
     - name: Generate a self signed pcsd cert and the pcsd key

tests/tests_cluster_basic_custom_fence_agents.yml

@@ -17,11 +17,14 @@
             name: linux-system-roles.ha_cluster
             tasks_from: test_setup.yml
 
+        - name: Skip test on ostree systems
+          meta: end_host
+          when: __ha_cluster_is_ostree | d(false)
+
         - name: Ensure fence-agents-all is not installed
           package:
             name: fence-agents-all
             state: absent
-          when: ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
 
         - name: Run HA Cluster role
           include_role:
@@ -30,14 +33,12 @@
 
         - name: Get packages status
           package_facts:
-          when: ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
 
         - name: Check installed fence-agents packages
           assert:
             that:
               - "'fence-agents-all' not in ansible_facts.packages"
               - "'fence-agents-ipmilan' in ansible_facts.packages"
-          when: ansible_facts.pkg_mgr | d() != "ansible.posix.rhel_rpm_ostree"
 
         - name: Check cluster status
           include_tasks: tasks/assert_cluster_running.yml

tests/tests_cluster_basic_custom_packages.yml

@@ -20,7 +20,7 @@
 
         - name: Skip test on ostree systems
           meta: end_host
-          when: ansible_facts.pkg_mgr | d() == "ansible.posix.rhel_rpm_ostree"
+          when: __ha_cluster_is_ostree | d(false)
 
         - name: Ensure extra package is not installed
           package:

tests/tests_qdevice_tls_kaptb_options.yml

@@ -13,29 +13,25 @@
             (ansible_play_hosts_all | length == 1)
             | ternary('localhost', ansible_play_hosts[0]) }}"
 
-    - name: Ensure correct package manager for ostree systems
-      vars:
-        ostree_pkg_mgr: ansible.posix.rhel_rpm_ostree
-        ostree_booted_file: /run/ostree-booted
-      when: ansible_facts.pkg_mgr | d("") != ostree_pkg_mgr
+    - name: Determine if system is ostree and set flag
+      when: not __ha_cluster_is_ostree is defined
       block:
         - name: Check if system is ostree
           stat:
-            path: "{{ ostree_booted_file }}"
+            path: /run/ostree-booted
           register: __ostree_booted_stat
 
-        - name: Set package manager to use for ostree
-          ansible.utils.update_fact:
-            updates:
-              - path: ansible_facts.pkg_mgr
-                value: "{{ ostree_pkg_mgr }}"
-          when: __ostree_booted_stat.stat.exists
+        - name: Set flag to indicate system is ostree
+          set_fact:
+            __ha_cluster_is_ostree: "{{ __ostree_booted_stat.stat.exists }}"
 
     # Install pcs so we can detect whether it supports tls and kaptb options
     - name: Install pcs
       package:
         name: pcs
         state: present
+        use: "{{ (__ha_cluster_is_ostree | d(false)) |
+                 ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
 
     - name: Fetch versions of cluster components
       include_tasks: tasks/fetch_versions.yml