From b91af7ff728efc8ac62668bad123bd512316dad0 Mon Sep 17 00:00:00 2001
From: Rich Megginson <rmeggins@redhat.com>
Date: Tue, 14 Nov 2023 10:50:54 -0700
Subject: [PATCH] feat: support for ostree systems

Feature: Allow running and testing the role with ostree managed nodes.

Reason: We have users who want to use the role to manage ostree
systems.

Result: Users can use the role to manage ostree managed nodes.
Signed-off-by: Rich Megginson <rmeggins@redhat.com>
---
 .ansible-lint                         |   2 +
 .ostree/README.md                     |   3 +
 .ostree/get_ostree_data.sh            | 123 ++++++++++++++++++++++++++
 .ostree/packages-runtime.txt          |   2 +
 .ostree/packages-testing-CentOS-7.txt |   3 +
 .ostree/packages-testing-CentOS-8.txt |   3 +
 .ostree/packages-testing-CentOS-9.txt |   3 +
 .ostree/packages-testing-Fedora.txt   |   3 +
 .ostree/packages-testing-RedHat-7.txt |   3 +
 .ostree/packages-testing-RedHat-8.txt |   3 +
 .ostree/packages-testing-RedHat-9.txt |   3 +
 .sanity-ansible-ignore-2.12.txt       |   1 +
 .sanity-ansible-ignore-2.13.txt       |   1 +
 .sanity-ansible-ignore-2.14.txt       |   1 +
 .sanity-ansible-ignore-2.15.txt       |   1 +
 .sanity-ansible-ignore-2.9.txt        |   1 +
 README-ostree.md                      |  66 ++++++++++++++
 README.md                             |  13 +++
 meta/collection-requirements.yml      |   5 ++
 tasks/set_vars.yml                    |  18 ++++
 tests/tasks/setup.yml                 |  18 ++++
 tests/tests_all_options.yml           |  21 ++++-
 22 files changed, 296 insertions(+), 1 deletion(-)
 create mode 100644 .ostree/README.md
 create mode 100755 .ostree/get_ostree_data.sh
 create mode 100644 .ostree/packages-runtime.txt
 create mode 100644 .ostree/packages-testing-CentOS-7.txt
 create mode 100644 .ostree/packages-testing-CentOS-8.txt
 create mode 100644 .ostree/packages-testing-CentOS-9.txt
 create mode 100644 .ostree/packages-testing-Fedora.txt
 create mode 100644 .ostree/packages-testing-RedHat-7.txt
 create mode 100644 .ostree/packages-testing-RedHat-8.txt
 create mode 100644 .ostree/packages-testing-RedHat-9.txt
 create mode 100644 .sanity-ansible-ignore-2.12.txt
 create mode 100644 .sanity-ansible-ignore-2.13.txt
 create mode 100644 .sanity-ansible-ignore-2.14.txt
 create mode 100644 .sanity-ansible-ignore-2.15.txt
 create mode 100644 .sanity-ansible-ignore-2.9.txt
 create mode 100644 README-ostree.md
 create mode 100644 meta/collection-requirements.yml

diff --git a/.ansible-lint b/.ansible-lint
index c3b2561..f61d187 100644
--- a/.ansible-lint
+++ b/.ansible-lint
@@ -22,3 +22,5 @@ exclude_paths:
   - examples/roles/
 mock_roles:
   - linux-system-roles.ssh
+mock_modules:
+  - ansible.utils.update_fact
diff --git a/.ostree/README.md b/.ostree/README.md
new file mode 100644
index 0000000..f5e6931
--- /dev/null
+++ b/.ostree/README.md
@@ -0,0 +1,3 @@
+*NOTE*: The `*.txt` files are used by `get_ostree_data.sh` to create the lists
+of packages, and to find other system roles used by this role.  DO NOT use them
+directly.
diff --git a/.ostree/get_ostree_data.sh b/.ostree/get_ostree_data.sh
new file mode 100755
index 0000000..7c32524
--- /dev/null
+++ b/.ostree/get_ostree_data.sh
@@ -0,0 +1,123 @@
+#!/bin/bash
+
+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
+    cat <<EOF
+Usage: $0 packages [runtime|testing] DISTRO-MAJOR[.MINOR] [json|yaml|raw|toml]
+The script will use the packages and roles files in $ostree_dir to
+construct the list of packages needed to build the ostree image.  The script
+will output the list of packages in the given format
+- json is a JSON list like ["pkg1","pkg2",....,"pkgN"]
+- yaml is the YAML list format
+- raw is the list of packages, one per line
+- toml is a list of [[packages]] elements as in https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#creating-an-image-builder-blueprint-for-a-rhel-for-edge-image-using-the-command-line-interface_composing-a-rhel-for-edge-image-using-image-builder-command-line
+The DISTRO-MAJOR.MINOR is the same format used by Ansible for distribution e.g. CentOS-8, RedHat-8.9, etc.
+EOF
+    exit 1
+fi
+category="$1"
+pkgtype="$2"
+distro_ver="$3"
+format="$4"
+pkgtypes=("$pkgtype")
+if [ "$pkgtype" = testing ]; then
+    pkgtypes+=(runtime)
+fi
+
+get_rolepath() {
+    local ostree_dir role rolesdir roles_parent_dir
+    ostree_dir="$1"
+    role="$2"
+    roles_parent_dir="$(dirname "$(dirname "$ostree_dir")")"
+    rolesdir="$roles_parent_dir/$role/.ostree"
+    # assumes collection format
+    if [ -d "$rolesdir" ]; then
+        echo "$rolesdir"
+        return 0
+    fi
+    # assumes legacy role format like linux-system-roles.$role/
+    for rolesdir in "$roles_parent_dir"/*-system-roles."$role"/.ostree; do
+        if [ -d "$rolesdir" ]; then
+          echo "$rolesdir"
+          return 0
+        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
+        done
+    fi
+    return 1
+}
+
+get_packages() {
+    local ostree_dir pkgtype pkgfile rolefile
+    ostree_dir="$1"
+    for pkgtype in "${pkgtypes[@]}"; do
+        for suff in "" "-$distro" "-${distro}-${major_ver}" "-${distro}-${ver}"; do
+            pkgfile="$ostree_dir/packages-${pkgtype}${suff}.txt"
+            if [ -f "$pkgfile" ]; then
+                cat "$pkgfile"
+            fi
+        done
+        rolefile="$ostree_dir/roles-${pkgtype}.txt"
+        if [ -f "$rolefile" ]; then
+            local roles role rolepath
+            roles="$(cat "$rolefile")"
+            for role in $roles; do
+                rolepath="$(get_rolepath "$ostree_dir" "$role")"
+                get_packages "$rolepath"
+            done
+        fi
+    done | sort -u
+}
+
+format_packages_json() {
+    local comma pkgs pkg
+    comma=""
+    pkgs="["
+    while read -r pkg; do
+        pkgs="${pkgs}${comma}\"${pkg}\""
+        comma=,
+    done
+    pkgs="${pkgs}]"
+    echo "$pkgs"
+}
+
+format_packages_raw() {
+    cat
+}
+
+format_packages_yaml() {
+    while read -r pkg; do
+        echo "- $pkg"
+    done
+}
+
+format_packages_toml() {
+    while read -r pkg; do
+        echo "[[packages]]"
+        echo "name = \"$pkg\""
+        echo "version = \"*\""
+    done
+}
+
+distro="${distro_ver%%-*}"
+ver="${distro_ver##*-}"
+if [[ "$ver" =~ ^([0-9]*) ]]; then
+    major_ver="${BASH_REMATCH[1]}"
+else
+    echo ERROR: cannot parse major version number from version "$ver"
+    exit 1
+fi
+
+"get_$category" "$ostree_dir" | "format_${category}_$format"
diff --git a/.ostree/packages-runtime.txt b/.ostree/packages-runtime.txt
new file mode 100644
index 0000000..73e4a88
--- /dev/null
+++ b/.ostree/packages-runtime.txt
@@ -0,0 +1,2 @@
+openssh
+openssh-clients
diff --git a/.ostree/packages-testing-CentOS-7.txt b/.ostree/packages-testing-CentOS-7.txt
new file mode 100644
index 0000000..ecb4961
--- /dev/null
+++ b/.ostree/packages-testing-CentOS-7.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-ldap
diff --git a/.ostree/packages-testing-CentOS-8.txt b/.ostree/packages-testing-CentOS-8.txt
new file mode 100644
index 0000000..ecb4961
--- /dev/null
+++ b/.ostree/packages-testing-CentOS-8.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-ldap
diff --git a/.ostree/packages-testing-CentOS-9.txt b/.ostree/packages-testing-CentOS-9.txt
new file mode 100644
index 0000000..55473b1
--- /dev/null
+++ b/.ostree/packages-testing-CentOS-9.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-keycat
diff --git a/.ostree/packages-testing-Fedora.txt b/.ostree/packages-testing-Fedora.txt
new file mode 100644
index 0000000..55473b1
--- /dev/null
+++ b/.ostree/packages-testing-Fedora.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-keycat
diff --git a/.ostree/packages-testing-RedHat-7.txt b/.ostree/packages-testing-RedHat-7.txt
new file mode 100644
index 0000000..ecb4961
--- /dev/null
+++ b/.ostree/packages-testing-RedHat-7.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-ldap
diff --git a/.ostree/packages-testing-RedHat-8.txt b/.ostree/packages-testing-RedHat-8.txt
new file mode 100644
index 0000000..ecb4961
--- /dev/null
+++ b/.ostree/packages-testing-RedHat-8.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-ldap
diff --git a/.ostree/packages-testing-RedHat-9.txt b/.ostree/packages-testing-RedHat-9.txt
new file mode 100644
index 0000000..55473b1
--- /dev/null
+++ b/.ostree/packages-testing-RedHat-9.txt
@@ -0,0 +1,3 @@
+bash
+man-db
+openssh-keycat
diff --git a/.sanity-ansible-ignore-2.12.txt b/.sanity-ansible-ignore-2.12.txt
new file mode 100644
index 0000000..5e90238
--- /dev/null
+++ b/.sanity-ansible-ignore-2.12.txt
@@ -0,0 +1 @@
+roles/ssh/.ostree/get_ostree_data.sh shebang!skip
diff --git a/.sanity-ansible-ignore-2.13.txt b/.sanity-ansible-ignore-2.13.txt
new file mode 100644
index 0000000..5e90238
--- /dev/null
+++ b/.sanity-ansible-ignore-2.13.txt
@@ -0,0 +1 @@
+roles/ssh/.ostree/get_ostree_data.sh shebang!skip
diff --git a/.sanity-ansible-ignore-2.14.txt b/.sanity-ansible-ignore-2.14.txt
new file mode 100644
index 0000000..5e90238
--- /dev/null
+++ b/.sanity-ansible-ignore-2.14.txt
@@ -0,0 +1 @@
+roles/ssh/.ostree/get_ostree_data.sh shebang!skip
diff --git a/.sanity-ansible-ignore-2.15.txt b/.sanity-ansible-ignore-2.15.txt
new file mode 100644
index 0000000..5e90238
--- /dev/null
+++ b/.sanity-ansible-ignore-2.15.txt
@@ -0,0 +1 @@
+roles/ssh/.ostree/get_ostree_data.sh shebang!skip
diff --git a/.sanity-ansible-ignore-2.9.txt b/.sanity-ansible-ignore-2.9.txt
new file mode 100644
index 0000000..5e90238
--- /dev/null
+++ b/.sanity-ansible-ignore-2.9.txt
@@ -0,0 +1 @@
+roles/ssh/.ostree/get_ostree_data.sh shebang!skip
diff --git a/README-ostree.md b/README-ostree.md
new file mode 100644
index 0000000..a9f0185
--- /dev/null
+++ b/README-ostree.md
@@ -0,0 +1,66 @@
+# rpm-ostree
+
+The role supports running on [rpm-ostree](https://coreos.github.io/rpm-ostree/)
+systems. The primary issue is that the `/usr` filesystem is read-only, and the
+role cannot install packages. Instead, it will just verify that the necessary
+packages and any other `/usr` files are pre-installed. The role will change the
+package manager to one that is compatible with `rpm-ostree` systems.
+
+## Building
+
+To build an ostree image for a particular operating system distribution and
+version, use the script `.ostree/get_ostree_data.sh` to get the list of
+packages. If the role uses other system roles, then the script will include the
+packages for the other roles in the list it outputs.  The list of packages will
+be sorted in alphanumeric order.
+
+Usage:
+
+```bash
+.ostree/get_ostree_data.sh packages runtime DISTRO-VERSION FORMAT
+```
+
+`DISTRO-VERSION` is in the format that Ansible uses for `ansible_distribution`
+and `ansible_distribution_version` - for example, `Fedora-38`, `CentOS-8`,
+`RedHat-9.4`
+
+`FORMAT` is one of `toml`, `json`, `yaml`, `raw`
+
+* `toml` - each package in a TOML `[[packages]]` element
+
+```toml
+[[packages]]
+name = "package-a"
+version = "*"
+[[packages]]
+name = "package-b"
+version = "*"
+...
+```
+
+* `yaml` - a YAML list of packages
+
+```yaml
+- package-a
+- package-b
+...
+```
+
+* `json` - a JSON list of packages
+
+```json
+["package-a","package-b",...]
+```
+
+* `raw` - a plain text list of packages, one per line
+
+```bash
+package-a
+package-b
+...
+```
+
+What format you choose depends on which image builder you are using.  For
+example, if you are using something based on
+[osbuild-composer](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#creating-an-image-builder-blueprint-for-a-rhel-for-edge-image-using-the-command-line-interface_composing-a-rhel-for-edge-image-using-image-builder-command-line),
+you will probably want to use the `toml` output format.
diff --git a/README.md b/README.md
index f6f4533..0b7a5c9 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,15 @@ supported by ansible. The role was tested on:
 * Debian
 * Ubuntu
 
+### Collection requirements
+
+In order to manage `rpm-ostree` systems, the role requires modules from external
+collections.  Use the following command to install them:
+
+```bash
+ansible-galaxy collection install -vv -r meta/collection-requirements.yml
+```
+
 ## Role Variables
 
 By default, the role should not modify the system configuration and generate
@@ -122,6 +131,10 @@ somebody. The last line disables X11 forwarding.
 
 More examples are in the [`examples/`](examples) directory.
 
+## rpm-ostree
+
+See README-ostree.md
+
 ## License
 
 LGPLv3, see the file LICENSE for more information.
diff --git a/meta/collection-requirements.yml b/meta/collection-requirements.yml
new file mode 100644
index 0000000..4f4842b
--- /dev/null
+++ b/meta/collection-requirements.yml
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: MIT
+---
+collections:
+  - ansible.posix
+  - ansible.utils
diff --git a/tasks/set_vars.yml b/tasks/set_vars.yml
index a765d4a..82f8b22 100644
--- a/tasks/set_vars.yml
+++ b/tasks/set_vars.yml
@@ -5,6 +5,24 @@
   when: __ssh_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
+  block:
+    - name: Check if system is ostree
+      stat:
+        path: "{{ ostree_booted_file }}"
+      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 platform/version specific variables
   include_vars: "{{ __vars_file }}"
   loop:
diff --git a/tests/tasks/setup.yml b/tests/tasks/setup.yml
index 9b6cd6d..c16a4d7 100644
--- a/tests/tasks/setup.yml
+++ b/tests/tasks/setup.yml
@@ -4,6 +4,24 @@
     gather_subset: min
   when: "'os_family' 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
+  block:
+    - name: Check if system is ostree
+      stat:
+        path: "{{ ostree_booted_file }}"
+      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: Make sure openssh is installed before creating backup
   vars:
     __ssh_test_packages: >-
diff --git a/tests/tests_all_options.yml b/tests/tests_all_options.yml
index 402198b..34c8829 100644
--- a/tests/tests_all_options.yml
+++ b/tests/tests_all_options.yml
@@ -22,10 +22,29 @@
       when: >
         ansible_facts['os_family'] != 'RedHat'
 
+    - 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
+      block:
+        - name: Check if system is ostree
+          stat:
+            path: "{{ ostree_booted_file }}"
+          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: Make sure manual pages and bash are installed
       package:
         name:
-          - man
+          - "{{ (ansible_facts['os_family'] == 'RedHat') |
+                ternary('man-db', 'man') }}"
           - bash
           - "{{ ssh_test_package }}"
         state: present