mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-27 13:53:03 +00:00
95e2add65b
Helm template add name and disable hook SUMMARY This PR adds "disable_hook" and "name" (NAME of the release) as optional arguments to the helm_template module. It contains the rest of my planned work towards #313. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/helm_template.py changelogs/fragments/313-helm-template-add-support-for-name-and-disablehook.yml tests/unit/modules/test_helm_template.py integration/targets/helm/tasks/tests_chart.yml ADDITIONAL INFORMATION The PR contains unit tests and an integration test for the new parameters added in this and the previous PR. I limited the execution of the integration test to the local test chart, because the testing of the "show_only" parameter requires a known chart structure. As I think I do not have to test the workings of "helm template ..." itself, I hope this is sufficient. Please adjust / comment as necessary. Reviewed-by: Mike Graves <mgraves@redhat.com>
173 lines
6.2 KiB
Python
173 lines
6.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright: (c) 2020, Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
import argparse
|
|
|
|
from ansible_collections.kubernetes.core.plugins.modules.helm_template import template
|
|
|
|
|
|
def test_template_with_release_values_and_values_files():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
parser.add_argument("-f", action="append")
|
|
|
|
rv = {"v1": {"enabled": True}}
|
|
vf = ["values1.yml", "values2.yml"]
|
|
mytemplate = template(
|
|
cmd=helm_cmd, chart_ref=my_chart_ref, release_values=rv, values_files=vf
|
|
)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
|
|
# helm_template writes release_values to temporary file with changing name
|
|
# these tests should insure
|
|
# - correct order values_files
|
|
# - unknown being included as last
|
|
assert args.f[0] == "values1.yml"
|
|
assert args.f[1] == "values2.yml"
|
|
assert len(args.f) == 3
|
|
|
|
|
|
def test_template_with_one_show_only_template():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
parser.add_argument("-f", action="append")
|
|
parser.add_argument("-s", action="append")
|
|
|
|
rv = {"revision": "1-13-0", "revisionTags": ["canary"]}
|
|
so_string = "templates/revision-tags.yaml"
|
|
so = [so_string]
|
|
mytemplate = template(
|
|
cmd=helm_cmd, chart_ref=my_chart_ref, show_only=so, release_values=rv
|
|
)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
print(mytemplate)
|
|
print(args)
|
|
|
|
assert len(args.f) == 1
|
|
assert len(args.s) == 1
|
|
assert args.s[0] == so_string
|
|
|
|
|
|
def test_template_with_two_show_only_templates():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
parser.add_argument("-f", action="append")
|
|
parser.add_argument("-s", action="append")
|
|
|
|
rv = {"revision": "1-13-0", "revisionTags": ["canary"]}
|
|
so_string_1 = "templates/revision-tags.yaml"
|
|
so_string_2 = "templates/some-dummy-template.yaml"
|
|
so = [so_string_1, so_string_2]
|
|
mytemplate = template(
|
|
cmd=helm_cmd, chart_ref=my_chart_ref, show_only=so, release_values=rv
|
|
)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
|
|
assert len(args.f) == 1
|
|
assert len(args.s) == 2
|
|
assert args.s[0] == so_string_1
|
|
assert args.s[1] == so_string_2
|
|
|
|
|
|
def test_template_with_release_namespace():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
parser.add_argument("-n", action="append")
|
|
|
|
ns = "istio-ingress-canary"
|
|
mytemplate = template(cmd=helm_cmd, chart_ref=my_chart_ref, release_namespace=ns)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
|
|
assert len(args.n) == 1
|
|
assert args.n[0] == ns
|
|
|
|
|
|
def test_template_with_name():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
release_name = "mytestrelease"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
|
|
mytemplate = template(
|
|
cmd=helm_cmd, chart_ref=my_chart_ref, release_name=release_name
|
|
)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
|
|
assert args.NAME == release_name
|
|
|
|
|
|
def test_template_with_disablehook():
|
|
my_chart_ref = "testref"
|
|
helm_cmd = "helm"
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument("cmd")
|
|
parser.add_argument("template")
|
|
# to "simulate" helm template options, include two optional parameters NAME and CHART.
|
|
# if parsed string contains only one parameter, the value will be passed
|
|
# to CHART and NAME will be set to default value "release-name" as in helm template
|
|
parser.add_argument("NAME", nargs="?", default="release-name")
|
|
parser.add_argument("CHART", nargs="+")
|
|
parser.add_argument("--no-hooks", dest="no_hooks", action="store_true")
|
|
parser.set_defaults(no_hooks=False)
|
|
|
|
mytemplate = template(cmd=helm_cmd, chart_ref=my_chart_ref, disable_hook=True)
|
|
|
|
args, unknown = parser.parse_known_args(mytemplate.split())
|
|
|
|
assert args.no_hooks is True
|