From de2c05c3061b348ec8c757a3654aa5b73be8d90d Mon Sep 17 00:00:00 2001
From: Steve Brasier <33413598+sjpb@users.noreply.github.com>
Date: Tue, 20 Feb 2024 16:45:10 +0000
Subject: [PATCH] make ondemand and ondemand_dex package installs idempotent
 (#217)

* make ondemand and ondemand_dex package installs idempotent

* fix tests for upgrade behaviour change
---
 README.md                          | 10 +++-------
 defaults/main/install.yml          |  7 ++-----
 molecule/upgrade/converge.yml      |  2 ++
 molecule/upgrade/vars/converge.yml |  1 +
 tasks/install-package.yml          | 12 ++++++------
 5 files changed, 14 insertions(+), 18 deletions(-)
 create mode 100644 molecule/upgrade/vars/converge.yml

diff --git a/README.md b/README.md
index 4f7faa9..20ba410 100644
--- a/README.md
+++ b/README.md
@@ -40,13 +40,9 @@ new features to _this role_.
 
 ## Installing a specific version
 
-`ondemand_package` defaults to `latest` meaning this will install the latest version on the versioned
-yum/deb repository. For example, it'll install the latest version, 2.0.20 from the versioned 2.0 yum
-repo.
-
-We use `ondemand_package` for the `name` paramter of the [ansible yum](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/yum_module.html)
-so you can speicify a specific version with `ondemand-2.0.20` or use the comparison operators
-ansible supports.
+The `ondemand_package` variable controls the version of the rpm/dep package installed. The default value of `ondemand` will install the latest version from the relevant repository, but will not upgrade an
+existing installation. You can install a specific version using the full package name (e.g. `ondemand-3.0.3`) or use the comparison operators supported by the `name` parameter of the ansible [yum](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/yum_module.html)
+or [apt](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/apt_module.html) modules. Use `latest` to upgrade an existing installation.
 
 ### Installing from latest or nightly
 
diff --git a/defaults/main/install.yml b/defaults/main/install.yml
index 301d0e8..b6bc3c6 100644
--- a/defaults/main/install.yml
+++ b/defaults/main/install.yml
@@ -24,7 +24,7 @@ rpm_repo_key: "https://yum.osc.edu/ondemand/RPM-GPG-KEY-ondemand"
 deb_repo_key: "https://apt.osc.edu/ondemand/DEB-GPG-KEY-ondemand"
 deb_repo_key_id: "4B72FE2B92D31755"
 
-ondemand_package: "ondemand"
+ondemand_package: "ondemand" # Idempotent. Use `latest` to upgrade, or full package name or comparison operators.
 ondemand_package_excludes: []
 
 # OSC's repo rpm isn't signed
@@ -36,10 +36,7 @@ ood_use_exiting_repo_file: false
 
 # flip this flag if you want to install the ondemand-dex RPM
 install_ondemand_dex: false
-# This will default to latest ondemand-dex package if install_ondemand_dex
-# is set to true, to control the version installed add the version of the 
-# package to install (ondemand-dex-2.32.0)
-ondemand_dex_package: ondemand-dex
+ondemand_dex_package: ondemand-dex # behaviour as for ondemand_package
 
 # needed for testing. no reason to change these in production.
 disable_htcacheclean: false
diff --git a/molecule/upgrade/converge.yml b/molecule/upgrade/converge.yml
index b96a5ce..e6c9b5f 100644
--- a/molecule/upgrade/converge.yml
+++ b/molecule/upgrade/converge.yml
@@ -3,3 +3,5 @@
   hosts: default
   roles:
     - role: ood-ansible
+  vars_files:
+    - vars/converge.yml
\ No newline at end of file
diff --git a/molecule/upgrade/vars/converge.yml b/molecule/upgrade/vars/converge.yml
new file mode 100644
index 0000000..0f47995
--- /dev/null
+++ b/molecule/upgrade/vars/converge.yml
@@ -0,0 +1 @@
+ondemand_package: 'latest'
diff --git a/tasks/install-package.yml b/tasks/install-package.yml
index 7dd4080..dd1a56c 100644
--- a/tasks/install-package.yml
+++ b/tasks/install-package.yml
@@ -74,21 +74,21 @@
 
 - name: Install Open Ondemand (RHEL)
   ansible.builtin.yum:
-    name:  "{{ ondemand_package }}"
-    state: "{% if ondemand_package == 'ondemand' %}latest{% else %}present{% endif %}"
+    name:  "{{ 'ondemand' if ondemand_package == 'latest' else ondemand_package }}"
+    state: "{{ 'latest' if ondemand_package == 'latest' else 'present' }}"
     update_cache: true
     exclude: "{{ ondemand_package_excludes | default([]) }}"
   when: ansible_os_family == "RedHat"
 
 - name: Install Open Ondemand (Debian)
   ansible.builtin.apt:
-    name: "{{ ondemand_package }}"
-    state: "{% if ondemand_package == 'ondemand' %}latest{% else %}present{% endif %}"
+    name:  "{{ 'ondemand' if ondemand_package == 'latest' else ondemand_package }}"
+    state: "{{ 'latest' if ondemand_package == 'latest' else 'present' }}"
     update_cache: true
   when: ansible_os_family == "Debian"
 
 - name: Install ondemand-dex
   ansible.builtin.package:
-    name: "{{ ondemand_dex_package }}"
-    state: "{% if ondemand_dex_package == 'ondemand-dex' %}latest{% else %}present{% endif %}"
+    name: "{{ 'ondemand-dex' if ondemand_dex_package == 'latest' else ondemand-dex }}"
+    state: "{{ 'latest' if ondemand_dex_package == 'latest' else 'present' }}"
   when: install_ondemand_dex