mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 22:50:20 +00:00
feat(helm): add cleanup_on_fail option (#1206)
* feat(helm): add cleanup_on_fail option atomic rolls back to the last successful revision but can leave behind resources the failed upgrade created; helm accepts both flags together so the rollback also drops those orphans. Rejected with replace=true, since that deploys via helm install, which has no --cleanup-on-fail. No version gate: the flag exists in helm 3.0.0, the module's minimum, and was not renamed in v4. * refactor(tests): share helm command-building test helpers The new cleanup_on_fail tests copied setUp and _run_with_version verbatim from the atomic tests, which SonarQube flagged as duplication on new code. Extract both to module level so the two classes share them. Scoped to the classes involved in that duplication; the other test classes in this file keep their own fixtures. * test(helm): align cleanup_on_fail assertions with review feedback Adjust the Helm unit tests to assert the expected flags for cleanup_on_fail on Helm v3 and v4, matching the behavior clarified in review feedback. Co-authored-by: abikouo <abikouo@users.noreply.github.com> --------- Co-authored-by: abikouo <abikouo@users.noreply.github.com>
This commit is contained in:
co-authored by
abikouo
parent
ec8942dd90
commit
d4ef10fc80
@@ -23,6 +23,48 @@ from ansible_collections.kubernetes.core.tests.unit.utils.ansible_module_mock im
|
||||
set_module_args,
|
||||
)
|
||||
|
||||
CHART_INFO = {
|
||||
"apiVersion": "v2",
|
||||
"appVersion": "default",
|
||||
"description": "A chart used in molecule tests",
|
||||
"name": "test-chart",
|
||||
"type": "application",
|
||||
"version": "0.1.0",
|
||||
}
|
||||
|
||||
|
||||
def patch_ansible_module(test_case):
|
||||
"""Patch AnsibleModule's exit/fail/bin-path hooks for the duration of test_case."""
|
||||
mock_module_helper = patch.multiple(
|
||||
basic.AnsibleModule,
|
||||
exit_json=exit_json,
|
||||
fail_json=fail_json,
|
||||
get_bin_path=get_bin_path,
|
||||
)
|
||||
mock_module_helper.start()
|
||||
test_case.addCleanup(mock_module_helper.stop)
|
||||
|
||||
|
||||
def deploy_command_for_version(args, helm_version):
|
||||
"""Run helm.main() against a mocked helm of helm_version and return its command.
|
||||
|
||||
Only the fresh-install path is mocked, so the caller sees the command built by
|
||||
deploy(). Failures raised by the module (AnsibleFailJson) propagate to the test.
|
||||
"""
|
||||
set_module_args(args)
|
||||
helm.get_release_status = MagicMock(return_value=None)
|
||||
helm.fetch_chart_info = MagicMock(return_value=CHART_INFO)
|
||||
with patch.object(
|
||||
helm.AnsibleHelmModule, "get_helm_version", return_value=helm_version
|
||||
):
|
||||
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
||||
mock_run_command.return_value = (0, "configuration updated", "")
|
||||
try:
|
||||
helm.main()
|
||||
except AnsibleExitJson as exc:
|
||||
return exc.args[0]["command"]
|
||||
raise AssertionError("helm.main() did not exit successfully")
|
||||
|
||||
|
||||
class TestDependencyUpdateWithoutChartRepoUrlOption(unittest.TestCase):
|
||||
def setUp(self):
|
||||
@@ -716,39 +758,10 @@ class TestAtomicFlagHelmVersion(unittest.TestCase):
|
||||
"""Helm v4 renamed '--atomic' to '--rollback-on-failure' (issue #1143)."""
|
||||
|
||||
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()
|
||||
self.addCleanup(self.mock_module_helper.stop)
|
||||
|
||||
self.chart_info = {
|
||||
"apiVersion": "v2",
|
||||
"appVersion": "default",
|
||||
"description": "A chart used in molecule tests",
|
||||
"name": "test-chart",
|
||||
"type": "application",
|
||||
"version": "0.1.0",
|
||||
}
|
||||
|
||||
def _run_with_version(self, args, helm_version):
|
||||
set_module_args(args)
|
||||
helm.get_release_status = MagicMock(return_value=None)
|
||||
helm.fetch_chart_info = MagicMock(return_value=self.chart_info)
|
||||
with patch.object(
|
||||
helm.AnsibleHelmModule, "get_helm_version", return_value=helm_version
|
||||
):
|
||||
with patch.object(basic.AnsibleModule, "run_command") as mock_run_command:
|
||||
mock_run_command.return_value = (0, "configuration updated", "")
|
||||
with self.assertRaises(AnsibleExitJson) as result:
|
||||
helm.main()
|
||||
return result.exception.args[0]["command"]
|
||||
patch_ansible_module(self)
|
||||
|
||||
def test_atomic_uses_atomic_flag_on_helm_v3(self):
|
||||
command = self._run_with_version(
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
@@ -761,7 +774,7 @@ class TestAtomicFlagHelmVersion(unittest.TestCase):
|
||||
assert "--rollback-on-failure" not in command
|
||||
|
||||
def test_atomic_uses_rollback_on_failure_on_helm_v4(self):
|
||||
command = self._run_with_version(
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
@@ -775,7 +788,7 @@ class TestAtomicFlagHelmVersion(unittest.TestCase):
|
||||
|
||||
def test_atomic_with_replace_uses_rollback_on_failure_on_helm_v4(self):
|
||||
# 'replace' uses 'helm install', where '--atomic' is removed in v4.
|
||||
command = self._run_with_version(
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
@@ -788,3 +801,92 @@ class TestAtomicFlagHelmVersion(unittest.TestCase):
|
||||
assert " install " in command
|
||||
assert "--rollback-on-failure" in command
|
||||
assert "--atomic" not in command
|
||||
|
||||
|
||||
class TestCleanupOnFail(unittest.TestCase):
|
||||
"""'--cleanup-on-fail' is upgrade-only and unchanged in Helm v4 (issue #1198)."""
|
||||
|
||||
def setUp(self):
|
||||
patch_ansible_module(self)
|
||||
|
||||
def test_cleanup_on_fail_not_set_by_default(self):
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
},
|
||||
"3.17.0",
|
||||
)
|
||||
assert "--cleanup-on-fail" not in command
|
||||
|
||||
def test_cleanup_on_fail_on_helm_v3(self):
|
||||
# '--cleanup-on-fail' exists since helm 3.0.0, the module-wide minimum.
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
"cleanup_on_fail": True,
|
||||
},
|
||||
"3.0.0",
|
||||
)
|
||||
assert " upgrade -i" in command
|
||||
assert "--cleanup-on-fail" in command
|
||||
|
||||
def test_cleanup_on_fail_keeps_same_flag_on_helm_v4(self):
|
||||
# Unlike '--atomic', the flag was not renamed in Helm v4.
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
"cleanup_on_fail": True,
|
||||
},
|
||||
"4.0.0",
|
||||
)
|
||||
assert "--cleanup-on-fail" in command
|
||||
|
||||
def test_cleanup_on_fail_combines_with_atomic_on_helm_v3(self):
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
"atomic": True,
|
||||
"cleanup_on_fail": True,
|
||||
},
|
||||
"3.17.0",
|
||||
)
|
||||
assert "--atomic" in command
|
||||
assert "--rollback-on-failure" not in command
|
||||
assert "--cleanup-on-fail" in command
|
||||
|
||||
def test_cleanup_on_fail_combines_with_atomic_on_helm_v4(self):
|
||||
command = deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
"atomic": True,
|
||||
"cleanup_on_fail": True,
|
||||
},
|
||||
"4.0.0",
|
||||
)
|
||||
assert "--rollback-on-failure" in command
|
||||
assert "--atomic" not in command
|
||||
assert "--cleanup-on-fail" in command
|
||||
|
||||
def test_cleanup_on_fail_with_replace_fails(self):
|
||||
# 'replace' deploys via 'helm install', which has no '--cleanup-on-fail'.
|
||||
with self.assertRaises(AnsibleFailJson):
|
||||
deploy_command_for_version(
|
||||
{
|
||||
"release_name": "test",
|
||||
"release_namespace": "test",
|
||||
"chart_ref": "chart1",
|
||||
"cleanup_on_fail": True,
|
||||
"replace": True,
|
||||
},
|
||||
"3.17.0",
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user