mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-27 13:53:03 +00:00
13791ec7bf
SUMMARY Helm v4 is a major version with backward-incompatible changes, including to the flags and output of the Helm CLI and to the SDK. This version is currently not supported in the kubernetes.core. This PR is related to #1038 and is a short-term solution to mark compatibility explicitly ISSUE TYPE Bugfix Pull Request Docs Pull Request COMPONENT NAME helm helm_template helm_info helm_repository helm_pull helm_registry_auth helm_plugin helm_plugin_info ADDITIONAL INFORMATION Added `validate_helm_version()`` method to AnsibleHelmModule that enforces version constraint >=3.0.0,<4.0.0. Fails fast with clear error message: "Helm version must be >=3.0.0,<4.0.0, current version is {version}" Some modules (i.e. helm_registry_auth) technically is compatible with Helm v4, but validation was added to all helm modules. Partially coauthored by GitHub Copilot with Claude Sonnet 4 model. Addresses issue #1038 Reviewed-by: GomathiselviS <gomathiselvi@gmail.com> Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua> Reviewed-by: Mike Graves <mgraves@redhat.com> Reviewed-by: Alina Buzachis Reviewed-by: Bianca Henderson <beeankha@gmail.com>
551 lines
22 KiB
Python
551 lines
22 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright: (c) 2021, 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 unittest
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from ansible.module_utils import basic
|
|
from ansible_collections.kubernetes.core.plugins.modules import helm
|
|
from ansible_collections.kubernetes.core.tests.unit.utils.ansible_module_mock import (
|
|
AnsibleExitJson,
|
|
AnsibleFailJson,
|
|
exit_json,
|
|
fail_json,
|
|
get_bin_path,
|
|
set_module_args,
|
|
)
|
|
|
|
|
|
class TestDependencyUpdateWithoutChartRepoUrlOption(unittest.TestCase):
|
|
def setUp(self):
|
|
self.mock_module_helper = patch.multiple(
|
|
basic.AnsibleModule,
|
|
exit_json=exit_json,
|
|
fail_json=fail_json,
|
|
get_bin_path=get_bin_path,
|
|
)
|
|
self.mock_module_helper.start()
|
|
|
|
# Stop the patch after test execution
|
|
# like tearDown but executed also when the setup failed
|
|
self.addCleanup(self.mock_module_helper.stop)
|
|
|
|
self.chart_info_without_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
}
|
|
|
|
self.chart_info_with_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
"dependencies": [
|
|
{
|
|
"name": "test",
|
|
"version": "0.1.0",
|
|
"repository": "file://../test-chart",
|
|
}
|
|
],
|
|
}
|
|
|
|
def test_module_fail_when_required_args_missing(self):
|
|
with self.assertRaises(AnsibleFailJson):
|
|
set_module_args({})
|
|
helm.main()
|
|
|
|
def test_dependency_update_option_not_defined(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "/tmp/path",
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
helm.run_dep_update = MagicMock()
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
helm.run_dep_update.assert_not_called()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
|
|
def test_dependency_update_option_false(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "/tmp/path",
|
|
"dependency_update": False,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
helm.run_dep_update = MagicMock()
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
helm.run_dep_update.assert_not_called()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
|
|
def test_dependency_update_option_true(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "/tmp/path",
|
|
"dependency_update": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_with_dep)
|
|
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with patch.object(basic.AnsibleModule, "warn") as mock_warn:
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
mock_warn.assert_not_called()
|
|
# Check calls include the actual helm command (after version check)
|
|
assert any(
|
|
"/usr/bin/helm upgrade -i --reset-values test '/tmp/path'" in str(call)
|
|
for call in mock_run_command.call_args_list
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
|
|
def test_dependency_update_option_true_without_dependencies_block(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "/tmp/path",
|
|
"dependency_update": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with patch.object(basic.AnsibleModule, "warn") as mock_warn:
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
mock_warn.assert_called_once()
|
|
# Check calls include the actual helm command (after version check)
|
|
assert any(
|
|
"/usr/bin/helm upgrade -i --reset-values test '/tmp/path'" in str(call)
|
|
for call in mock_run_command.call_args_list
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test '/tmp/path'"
|
|
)
|
|
|
|
|
|
class TestDependencyUpdateWithChartRepoUrlOption(unittest.TestCase):
|
|
def setUp(self):
|
|
self.mock_module_helper = patch.multiple(
|
|
basic.AnsibleModule,
|
|
exit_json=exit_json,
|
|
fail_json=fail_json,
|
|
get_bin_path=get_bin_path,
|
|
)
|
|
self.mock_module_helper.start()
|
|
|
|
# Stop the patch after test execution
|
|
# like tearDown but executed also when the setup failed
|
|
self.addCleanup(self.mock_module_helper.stop)
|
|
|
|
self.chart_info_without_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
}
|
|
|
|
self.chart_info_with_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
"dependencies": [
|
|
{
|
|
"name": "test",
|
|
"version": "0.1.0",
|
|
"repository": "file://../test-chart",
|
|
}
|
|
],
|
|
}
|
|
|
|
def test_dependency_update_option_not_defined(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "chart1",
|
|
"chart_repo_url": "http://repo.example/charts",
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test 'chart1'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test 'chart1'"
|
|
)
|
|
|
|
def test_dependency_update_option_False(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "chart1",
|
|
"chart_repo_url": "http://repo.example/charts",
|
|
"dependency_update": False,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test 'chart1'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test 'chart1'"
|
|
)
|
|
|
|
def test_dependency_update_option_True_and_replace_option_disabled(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "chart1",
|
|
"chart_repo_url": "http://repo.example/charts",
|
|
"dependency_update": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_with_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleFailJson) as result:
|
|
helm.main()
|
|
# mock_run_command.assert_called_once_with('/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test chart1',
|
|
# environ_update={'HELM_NAMESPACE': 'test'})
|
|
assert result.exception.args[0]["msg"] == (
|
|
"'--dependency-update' hasn't been supported yet with 'helm upgrade'. "
|
|
"Please use 'helm install' instead by adding 'replace' option"
|
|
)
|
|
assert result.exception.args[0]["failed"]
|
|
|
|
def test_dependency_update_option_True_and_replace_option_enabled(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "chart1",
|
|
"chart_repo_url": "http://repo.example/charts",
|
|
"dependency_update": True,
|
|
"replace": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts install --dependency-update --replace test 'chart1'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm --repo=http://repo.example/charts install --dependency-update --replace test 'chart1'"
|
|
)
|
|
|
|
|
|
class TestDependencyUpdateWithChartRefIsUrl(unittest.TestCase):
|
|
def setUp(self):
|
|
self.mock_module_helper = patch.multiple(
|
|
basic.AnsibleModule,
|
|
exit_json=exit_json,
|
|
fail_json=fail_json,
|
|
get_bin_path=get_bin_path,
|
|
)
|
|
self.mock_module_helper.start()
|
|
|
|
# Stop the patch after test execution
|
|
# like tearDown but executed also when the setup failed
|
|
self.addCleanup(self.mock_module_helper.stop)
|
|
|
|
self.chart_info_without_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
}
|
|
|
|
self.chart_info_with_dep = {
|
|
"apiVersion": "v2",
|
|
"appVersion": "default",
|
|
"description": "A chart used in molecule tests",
|
|
"name": "test-chart",
|
|
"type": "application",
|
|
"version": "0.1.0",
|
|
"dependencies": [
|
|
{
|
|
"name": "test",
|
|
"version": "0.1.0",
|
|
"repository": "file://../test-chart",
|
|
}
|
|
],
|
|
}
|
|
|
|
def test_dependency_update_option_not_defined(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "http://repo.example/charts/application.tgz",
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm upgrade -i --reset-values test 'http://repo.example/charts/application.tgz'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test 'http://repo.example/charts/application.tgz'"
|
|
)
|
|
|
|
def test_dependency_update_option_False(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "http://repo.example/charts/application.tgz",
|
|
"dependency_update": False,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm upgrade -i --reset-values test 'http://repo.example/charts/application.tgz'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm upgrade -i --reset-values test 'http://repo.example/charts/application.tgz'"
|
|
)
|
|
|
|
def test_dependency_update_option_True_and_replace_option_disabled(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "http://repo.example/charts/application.tgz",
|
|
"dependency_update": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_with_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleFailJson) as result:
|
|
helm.main()
|
|
# mock_run_command.assert_called_once_with('/usr/bin/helm --repo=http://repo.example/charts upgrade -i --reset-values test chart1',
|
|
# environ_update={'HELM_NAMESPACE': 'test'})
|
|
assert result.exception.args[0]["msg"] == (
|
|
"'--dependency-update' hasn't been supported yet with 'helm upgrade'. "
|
|
"Please use 'helm install' instead by adding 'replace' option"
|
|
)
|
|
assert result.exception.args[0]["failed"]
|
|
|
|
def test_dependency_update_option_True_and_replace_option_enabled(self):
|
|
set_module_args(
|
|
{
|
|
"release_name": "test",
|
|
"release_namespace": "test",
|
|
"chart_ref": "http://repo.example/charts/application.tgz",
|
|
"dependency_update": True,
|
|
"replace": True,
|
|
}
|
|
)
|
|
helm.get_release_status = MagicMock(return_value=None)
|
|
helm.fetch_chart_info = MagicMock(return_value=self.chart_info_without_dep)
|
|
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
|
# Mock responses: first call is helm version, second is the actual command
|
|
mock_run_command.side_effect = [
|
|
(
|
|
0,
|
|
'version.BuildInfo{Version:"v3.10.0", GitCommit:"", GoVersion:"go1.18"}',
|
|
"",
|
|
),
|
|
(0, "configuration updated", ""),
|
|
]
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
helm.main()
|
|
# Check the last call (actual helm command, after version check)
|
|
assert (
|
|
mock_run_command.call_args_list[-1][0][0]
|
|
== "/usr/bin/helm install --dependency-update --replace test 'http://repo.example/charts/application.tgz'"
|
|
)
|
|
assert (
|
|
result.exception.args[0]["command"]
|
|
== "/usr/bin/helm install --dependency-update --replace test 'http://repo.example/charts/application.tgz'"
|
|
)
|