add reset_then_reuse_values support to helm module (#802) (#917)

This is a backport of PR #802 as merged into main (00699ac).
SUMMARY
Starting with version 3.14.0, Helm supports --reset-then-reuse-values. As discussed on the original PR. This greatly improves on --reuse-values as it allows to avoid templates errors when new features are added to an upgraded chart.
Closes #803
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
helm
ADDITIONAL INFORMATION
This PR is greatly 'inspired' by #575 and because I wasn't sure how I could provide additional tests for it, I actually copied those build previously for --reuse-values (as it is an improvement on this feature.

Reviewed-by: Bianca Henderson <beeankha@gmail.com>

tests/integration/targets/helm_diff/tasks/main.yml

@@ -10,7 +10,7 @@
         binary_path: "{{ helm_binary }}"
         state: present
         plugin_path: https://github.com/databus23/helm-diff
-        plugin_version: 3.4.0
+        plugin_version: 3.9.13
 
     - name: Copy test chart
       copy:
@@ -324,3 +324,5 @@
       ignore_errors: true
 
 - include_tasks: reuse_values.yml
+
+- include_tasks: reset_then_reuse_values.yml

tests/integration/targets/helm_diff/tasks/reset_then_reuse_values.yml

@@ -0,0 +1,189 @@
+---
+- name: Create temporary directory for helm chart
+  tempfile:
+    suffix: .helm
+    state: directory
+  register: helm_dir
+
+- name: Test helm diff functionality
+  vars:
+    test_chart_path: "{{ helm_dir.path }}/test-chart-reuse-values"
+    test_release_name: "myrelease"
+
+  block:
+    - name: Install helm diff
+      kubernetes.core.helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        state: present
+        plugin_path: https://github.com/databus23/helm-diff
+        plugin_version: 3.9.14
+
+    - name: Copy test chart
+      ansible.builtin.copy:
+        src: "test-chart-reuse-values"
+        dest: "{{ helm_dir.path }}"
+
+    - name: Delete existing namespace
+      kubernetes.core.k8s:
+        state: absent
+        wait: true
+        kind: Namespace
+        name: "{{ helm_namespace }}"
+      ignore_errors: true
+
+    - name: Create helm release
+      kubernetes.core.helm:
+        state: present
+        binary_path: "{{ helm_binary }}"
+        chart_ref: "{{ test_chart_path }}"
+        release_name: "{{ test_release_name }}"
+        release_namespace: "{{ helm_namespace }}"
+        create_namespace: true
+        release_values:
+          ansible_version: devel
+          phase: ci
+        wait: true
+
+    - name: Upgrade helm release (reset_values=false and reuse_values=false and reset_then_reuse_values=true)
+      kubernetes.core.helm:
+        binary_path: "{{ helm_binary }}"
+        chart_ref: "{{ test_chart_path }}"
+        reset_values: false
+        reuse_values: false
+        reset_then_reuse_values: true
+        release_name: "{{ test_release_name }}"
+        release_namespace: "{{ helm_namespace }}"
+        values:
+          ansible_version: devel
+      register: helm_upgrade
+
+    - name: Ensure task did not reported change
+      assert:
+        that:
+          - helm_upgrade is not changed
+
+    - name: Upgrade helm release (reset_then_reuse_values=true with default value for reset_values and reuse_values=false)
+      kubernetes.core.helm:
+        binary_path: "{{ helm_binary }}"
+        chart_ref: "{{ test_chart_path }}"
+        reuse_values: false
+        reset_then_reuse_values: true
+        release_name: "{{ test_release_name }}"
+        release_namespace: "{{ helm_namespace }}"
+        values:
+          ansible_version: devel
+      register: helm_upgrade
+
+    - name: Ensure task reported change
+      assert:
+        that:
+          - helm_upgrade is changed
+
+    # Delete helm and helm diff to install older version
+    - name: Uninstall helm diff
+      helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        state: absent
+        plugin_name: diff
+      ignore_errors: true
+
+    - name: Delete Helm folders
+      file:
+        path: /tmp/helm/
+        state: absent
+
+    - name: Init Helm folders
+      file:
+        path: /tmp/helm
+        state: directory
+
+    - name: Set Helm old version
+      set_fact:
+        helm_archive_name: "helm-v3.8.0-linux-amd64.tar.gz"
+        helm_diff_old_version: "3.8.0"
+
+    - name: Unarchive Helm binary
+      unarchive:
+        src: "https://get.helm.sh/{{ helm_archive_name | default(helm_default_archive_name) }}"
+        dest: /tmp/helm/
+        remote_src: yes
+      retries: 10
+      delay: 5
+      register: result
+      until: result is not failed
+
+    - name: Upgrade helm release (with reset_then_reuse_values=true)
+      kubernetes.core.helm:
+        binary_path: "{{ helm_binary }}"
+        chart_ref: "{{ test_chart_path }}"
+        reuse_values: false
+        reset_then_reuse_values: true
+        release_name: "{{ test_release_name }}"
+        release_namespace: "{{ helm_namespace }}"
+        values:
+          ansible_version: test
+      register: helm_upgrade
+      ignore_errors: true
+
+    - name: Debug
+      debug:
+        var: helm_upgrade
+
+    - name: Ensure warning for Helm version
+      assert:
+        that:
+          - helm_upgrade is failed
+          - '"reset_then_reuse_values requires helm >= 3.14.0, current version is" in helm_upgrade.msg'
+
+    - name: Install helm diff
+      helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        state: present
+        plugin_path: https://github.com/databus23/helm-diff
+        plugin_version: "{{ helm_diff_old_version }}"
+
+    - name: Upgrade helm release (with reset_then_reuse_values=true)
+      kubernetes.core.helm:
+        binary_path: "{{ helm_binary }}"
+        chart_ref: "{{ test_chart_path }}"
+        reuse_values: false
+        reset_then_reuse_values: true
+        release_name: "{{ test_release_name }}"
+        release_namespace: "{{ helm_namespace }}"
+        values:
+          ansible_version: devel
+      register: helm_upgrade
+      ignore_errors: true
+
+    - name: Debug
+      debug:
+        var: helm_upgrade
+
+    - name: Ensure warning for Helm Diff version
+      assert:
+        that:
+          - helm_upgrade is failed
+          - '"reset_then_reuse_values requires helm diff >= 3.9.12, current version is" in helm_upgrade.msg'
+
+  always:
+    - name: Remove temporary directory
+      file:
+        path: "{{ helm_dir.path }}"
+        state: absent
+      ignore_errors: true
+
+    - name: Uninstall helm diff
+      kubernetes.core.helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        state: absent
+        plugin_name: diff
+      ignore_errors: true
+
+    - name: Remove helm namespace
+      kubernetes.core.k8s:
+        api_version: v1
+        kind: Namespace
+        name: "{{ helm_namespace }}"
+        state: absent
+        wait: true
+      ignore_errors: true

tests/integration/targets/helm_diff/tasks/reuse_values.yml

@@ -90,4 +90,5 @@
         kind: Namespace
         name: "{{ helm_namespace }}"
         state: absent
+        wait: true
       ignore_errors: true