helm - add support for in-memory kubeconfig (#497)

helm - add support for in-memory kubeconfig

SUMMARY

closes #492

ISSUE TYPE


Feature Pull Request

Reviewed-by: Mike Graves <mgraves@redhat.com>
Reviewed-by: Bikouo Aubin <None>

tests/integration/targets/helm/defaults/main.yml

@@ -26,3 +26,4 @@ test_namespace:
   - "helm-local-path-002"
   - "helm-local-path-003"
   - "helm-dep"
+  - "helm-kubeconfig"

tests/integration/targets/helm/tasks/run_test.yml

@@ -43,6 +43,9 @@
 - name: Test Skip CRDS feature in helm chart install
   include_tasks: test_crds.yml
 
+- name: Test in-memory kubeconfig
+  include_tasks: tests_in_memory_kubeconfig.yml
+
 - name: Clean helm install
   file:
     path: "{{ item }}"

tests/integration/targets/helm/tasks/tests_in_memory_kubeconfig.yml

@@ -0,0 +1,164 @@
+---
+- set_fact:
+    custom_kubeconfig_path: "~/.kube/customconfig"
+    default_kubeconfig_path: "~/.kube/config"
+    helm_in_mem_kubeconf_ns: "{{ test_namespace[11] }}"
+
+- block:
+    - name: Copy default kubeconfig
+      copy:
+        remote_src: true
+        src: "{{ default_kubeconfig_path }}"
+        dest: "{{ custom_kubeconfig_path }}"
+
+    - name: Delete default kubeconfig
+      file:
+        path: "{{ default_kubeconfig_path }}"
+        state: absent
+
+    - set_fact:
+        custom_kubeconfig: "{{ lookup('file', custom_kubeconfig_path) | from_yaml }}"
+      no_log: true
+
+    # helm_plugin and helm_plugin_info
+    - name: Install subenv plugin
+      helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        kubeconfig: "{{ custom_kubeconfig }}"
+        state: present
+        plugin_path: https://github.com/hydeenoble/helm-subenv
+      register: plugin
+
+    - assert:
+        that:
+          - plugin is changed
+
+    - name: Gather info about all plugin
+      helm_plugin_info:
+        binary_path: "{{ helm_binary }}"
+        kubeconfig: "{{ custom_kubeconfig }}"
+      register: plugin_info
+
+    - assert:
+        that:
+          - '"plugin_list" in plugin_info'
+          - plugin_info.plugin_list != []
+
+    # helm_repository, helm, helm_info
+    - name: Add test_bitnami chart repository
+      helm_repository:
+        binary_path: "{{ helm_binary }}"
+        name: test_bitnami
+        kubeconfig: "{{ custom_kubeconfig }}"
+        repo_url: https://charts.bitnami.com/bitnami
+      register: repository
+
+    - name: Assert that repository was added
+      assert:
+        that:
+          - repository is changed
+
+    - name: Install chart from repository added before
+      helm:
+        binary_path: "{{ helm_binary }}"
+        name: rabbitmq
+        chart_ref: test_bitnami/rabbitmq
+        namespace: "{{ helm_in_mem_kubeconf_ns }}"
+        update_repo_cache: true
+        kubeconfig: "{{ custom_kubeconfig }}"
+        create_namespace: true
+      register: deploy
+
+    - name: Assert chart was successfully deployed
+      assert:
+        that:
+          - deploy is changed
+
+    - name: Get chart content
+      helm_info:
+        binary_path: "{{ helm_binary }}"
+        kubeconfig: "{{ custom_kubeconfig }}"
+        name: "rabbitmq"
+        namespace: "{{ helm_in_mem_kubeconf_ns }}"
+      register: chart_info
+
+    - name: Assert chart was successfully deployed
+      assert:
+        that:
+          - '"status" in chart_info'
+          - chart_info.status.status is defined
+          - chart_info.status.status == "deployed"
+
+    - name: Remove chart
+      helm:
+        binary_path: "{{ helm_binary }}"
+        name: rabbitmq
+        namespace: "{{ helm_in_mem_kubeconf_ns }}"
+        kubeconfig: "{{ custom_kubeconfig }}"
+        state: absent
+      register: remove_chart
+
+    - name: Assert chart was successfully removed
+      assert:
+        that:
+          - remove_chart is changed
+
+    - name: Get chart content
+      helm_info:
+        binary_path: "{{ helm_binary }}"
+        kubeconfig: "{{ custom_kubeconfig }}"
+        name: "rabbitmq"
+        namespace: "{{ helm_in_mem_kubeconf_ns }}"
+      register: chart_info
+
+    - name: Assert chart was successfully deployed
+      assert:
+        that:
+          - '"status" not in chart_info'
+
+    - name: Remove chart repository
+      helm_repository:
+        binary_path: "{{ helm_binary }}"
+        name: test_bitnami
+        kubeconfig: "{{ custom_kubeconfig }}"
+        state: absent
+      register: remove
+
+    - name: Assert that repository was removed
+      assert:
+        that:
+          - remove is changed
+
+  always:
+    - name: Return kubeconfig
+      copy:
+        remote_src: true
+        src: "{{ custom_kubeconfig_path }}"
+        dest: "{{ default_kubeconfig_path }}"
+      ignore_errors: true
+
+    - name: Delete custom config
+      file:
+        path: "{{ custom_kubeconfig_path }}"
+        state: absent
+      ignore_errors: true
+
+    - name: Remove subenv plugin
+      helm_plugin:
+        binary_path: "{{ helm_binary }}"
+        plugin_name: subenv
+        state: absent
+      ignore_errors: true
+
+    - name: Delete namespace
+      k8s:
+        kind: Namespace
+        name: "{{ helm_in_mem_kubeconf_ns }}"
+      ignore_errors: true
+
+    - name: Delete helm repository
+      helm_repository:
+        binary_path: "{{ helm_binary }}"
+        name: test_bitnami
+        state: absent
+      ignore_errors: true

tests/unit/module_utils/test_helm.py

@@ -7,8 +7,9 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 import os.path
-
 import yaml
+import tempfile
+import json
 
 
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
@@ -31,11 +32,22 @@ class MockedModule:
         }
 
         self.r = {}
+        self.files_to_delete = []
 
     def run_command(self, command, environ_update=None):
         self.r = {"command": command, "environ_update": environ_update}
         return 0, "", ""
 
+    def add_cleanup_file(self, file_path):
+        self.files_to_delete.append(file_path)
+
+    def do_cleanup_files(self):
+        for file in self.files_to_delete:
+            try:
+                os.remove(file)
+            except Exception:
+                pass
+
 
 def test_write_temp_kubeconfig_server_only():
     file_name = write_temp_kubeconfig("ff")
@@ -97,4 +109,60 @@ def test_run_helm_with_params():
     assert module.r["environ_update"]["HELM_KUBETOKEN"] == "my-api-key"
     assert module.r["environ_update"]["HELM_NAMESPACE"] == "a-release-namespace"
     assert module.r["environ_update"]["KUBECONFIG"]
-    assert not os.path.exists(module.r["environ_update"]["KUBECONFIG"])
+    assert os.path.exists(module.r["environ_update"]["KUBECONFIG"])
+    module.do_cleanup_files()
+
+
+def test_run_helm_with_kubeconfig():
+
+    custom_config = {
+        "apiVersion": "v1",
+        "clusters": [
+            {
+                "cluster": {
+                    "certificate-authority-data": "LS0tLS1CRUdJTiBDRV",
+                    "server": "https://api.cluster.testing:6443",
+                },
+                "name": "api-cluster-testing:6443",
+            }
+        ],
+        "contexts": [
+            {
+                "context": {
+                    "cluster": "api-cluster-testing:6443",
+                    "namespace": "default",
+                    "user": "kubeadmin",
+                },
+                "name": "context-1",
+            }
+        ],
+        "current-context": "context-1",
+        "kind": "Config",
+        "users": [
+            {
+                "name": "developer",
+                "user": {"token": "sha256~jbIvVieBC_8W6Pb-iH5vqC_BvvPHIxQMxUPLDnYvHYM"},
+            }
+        ],
+    }
+
+    # kubeconfig defined as path
+    _fd, tmpfile_name = tempfile.mkstemp()
+    with os.fdopen(_fd, "w") as fp:
+        yaml.dump(custom_config, fp)
+
+    k1_module = MockedModule()
+    k1_module.params = {"kubeconfig": tmpfile_name}
+    run_helm(k1_module, "helm foo")
+    assert k1_module.r["environ_update"] == {"KUBECONFIG": tmpfile_name}
+    os.remove(tmpfile_name)
+
+    # kubeconfig defined as string
+    k2_module = MockedModule()
+    k2_module.params = {"kubeconfig": custom_config}
+    run_helm(k2_module, "helm foo")
+
+    assert os.path.exists(k2_module.r["environ_update"]["KUBECONFIG"])
+    with open(k2_module.r["environ_update"]["KUBECONFIG"]) as f:
+        assert json.loads(f.read()) == custom_config
+    k2_module.do_cleanup_files()