diff --git a/changelogs/fragments/20260917-runner-warnings-module-warn.yaml b/changelogs/fragments/20260917-runner-warnings-module-warn.yaml new file mode 100644 index 00000000..ae84b347 --- /dev/null +++ b/changelogs/fragments/20260917-runner-warnings-module-warn.yaml @@ -0,0 +1,4 @@ +--- +bugfixes: + - k8s, k8s_service - emit warnings through ``AnsibleModule.warn`` instead of putting them in the result dict that is unpacked into ``exit_json``/``fail_json``. Passing ``warnings`` that way is deprecated since ansible-core 2.19 and will be removed in 2.23, so every run that produced a warning (for example the "No meaningful diff was generated" hint, warnings returned by the Kubernetes API, or ``validate`` findings) also emitted a deprecation warning (https://github.com/ansible-collections/kubernetes.core/pull/1267). + - k8s - warnings raised while processing a multi-document manifest are now shown to the user. They were previously nested under ``result.results[*].warnings``, where ansible-core never picked them up, so they were silently dropped whenever more than one resource was processed (https://github.com/ansible-collections/kubernetes.core/pull/1267). diff --git a/plugins/module_utils/k8s/runner.py b/plugins/module_utils/k8s/runner.py index ade87d57..be73d966 100644 --- a/plugins/module_utils/k8s/runner.py +++ b/plugins/module_utils/k8s/runner.py @@ -92,10 +92,10 @@ def run_module(module) -> None: for definition in definitions: result = {"changed": False, "result": {}} - warnings = [] if module.params.get("validate") is not None: - warnings = validate(client, module, definition) + for warning in validate(client, module, definition): + module.warn(warning) try: result = perform_action(svc, definition, module.params) @@ -109,16 +109,12 @@ def run_module(module) -> None: except AttributeError: pass error["msg"] = to_native(e) - if warnings: - error.setdefault("warnings", []).extend(warnings) if module.params.get("continue_on_error"): result["error"] = error else: module.fail_json(**error) - if warnings: - result.setdefault("warnings", []).extend(warnings) changed |= result["changed"] results.append(result) @@ -177,7 +173,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict: result["method"] = "apply" elif not existing: if state == "patched": - result.setdefault("warnings", []).append( + svc.module.warn( "resource 'kind={kind},name={name}' was not found but will not be " "created as 'state' parameter has been set to '{state}'".format( kind=kind, name=definition["metadata"].get("name"), state=state @@ -194,8 +190,8 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict: instance, warnings = svc.update(resource, definition, existing) result["method"] = "update" - if warnings: - result["warnings"] = warnings + for warning in warnings: + svc.module.warn(warning) # If needed, wait and/or create diff success = True @@ -217,7 +213,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict: existing = {} match, diffs = diff_objects(existing, instance, hidden_fields) if match and diffs: - result.setdefault("warnings", []).append( + svc.module.warn( "No meaningful diff was generated, but the API may not be idempotent " "(only metadata.generation or metadata.resourceVersion were changed)" ) diff --git a/tests/unit/module_utils/test_runner.py b/tests/unit/module_utils/test_runner.py index 5a7637b3..0ff00853 100644 --- a/tests/unit/module_utils/test_runner.py +++ b/tests/unit/module_utils/test_runner.py @@ -29,9 +29,21 @@ definition = { modified_def = deepcopy(definition) modified_def["metadata"]["labels"]["environment"] = "testing" +# Differs from the above only in metadata.resourceVersion, which diff_objects() +# treats as a match while still producing a diff. +versioned_def = deepcopy(definition) +versioned_def["metadata"]["resourceVersion"] = "1" +rereconciled_def = deepcopy(definition) +rereconciled_def["metadata"]["resourceVersion"] = "2" + +NO_MEANINGFUL_DIFF = ( + "No meaningful diff was generated, but the API may not be idempotent " + "(only metadata.generation or metadata.resourceVersion were changed)" +) + @pytest.mark.parametrize( - "action, params, existing, instance_warnings, expected", + "action, params, existing, instance_warnings, expected, expected_warnings", [ ( "delete", @@ -39,6 +51,7 @@ modified_def["metadata"]["labels"]["environment"] = "testing" {}, {}, {"changed": False, "method": "delete", "result": {}}, + [], ), ( "delete", @@ -46,6 +59,7 @@ modified_def["metadata"]["labels"]["environment"] = "testing" definition, {"kind": "Status"}, {"changed": True, "method": "delete", "result": {"kind": "Status"}}, + [], ), ( "apply", @@ -53,31 +67,25 @@ modified_def["metadata"]["labels"]["environment"] = "testing" {}, (definition, []), {"changed": True, "method": "apply", "result": definition}, + [], ), ( "apply", {"apply": "yes"}, {}, (definition, ["test warning"]), - { - "changed": True, - "method": "apply", - "result": definition, - "warnings": ["test warning"], - }, + {"changed": True, "method": "apply", "result": definition}, + ["test warning"], ), ( "create", {"state": "patched"}, {}, ({}, []), - { - "changed": False, - "result": {}, - "warnings": [ - "resource 'kind=Pod,name=foo' was not found but will not be created as 'state' parameter has been set to 'patched'" - ], - }, + {"changed": False, "result": {}}, + [ + "resource 'kind=Pod,name=foo' was not found but will not be created as 'state' parameter has been set to 'patched'" + ], ), ( "create", @@ -85,18 +93,15 @@ modified_def["metadata"]["labels"]["environment"] = "testing" {}, (definition, []), {"changed": True, "method": "create", "result": definition}, + [], ), ( "create", {}, {}, (definition, ["test warning"]), - { - "changed": True, - "method": "create", - "result": definition, - "warnings": ["test warning"], - }, + {"changed": True, "method": "create", "result": definition}, + ["test warning"], ), ( "replace", @@ -104,6 +109,7 @@ modified_def["metadata"]["labels"]["environment"] = "testing" definition, (definition, []), {"changed": False, "method": "replace", "result": definition}, + [], ), ( "replace", @@ -111,18 +117,15 @@ modified_def["metadata"]["labels"]["environment"] = "testing" definition, (modified_def, []), {"changed": True, "method": "replace", "result": modified_def}, + [], ), ( "replace", {"force": "yes"}, definition, (modified_def, ["test warning"]), - { - "changed": True, - "method": "replace", - "result": modified_def, - "warnings": ["test warning"], - }, + {"changed": True, "method": "replace", "result": modified_def}, + ["test warning"], ), ( "update", @@ -130,6 +133,7 @@ modified_def["metadata"]["labels"]["environment"] = "testing" definition, (definition, []), {"changed": False, "method": "update", "result": definition}, + [], ), ( "update", @@ -137,18 +141,31 @@ modified_def["metadata"]["labels"]["environment"] = "testing" definition, (modified_def, []), {"changed": True, "method": "update", "result": modified_def}, + [], ), ( "update", {}, definition, (modified_def, ["test warning"]), - { - "changed": True, - "method": "update", - "result": modified_def, - "warnings": ["test warning"], - }, + {"changed": True, "method": "update", "result": modified_def}, + ["test warning"], + ), + ( + "update", + {}, + versioned_def, + (rereconciled_def, []), + {"changed": False, "method": "update", "result": rereconciled_def}, + [NO_MEANINGFUL_DIFF], + ), + ( + "update", + {}, + versioned_def, + (rereconciled_def, ["test warning"]), + {"changed": False, "method": "update", "result": rereconciled_def}, + ["test warning", NO_MEANINGFUL_DIFF], ), ( "create", @@ -159,6 +176,7 @@ modified_def["metadata"]["labels"]["environment"] = "testing" "changed": False, "msg": "resource 'kind=Pod,name=foo,namespace=foo' filtered by label_selectors.", }, + [], ), ( "create", @@ -166,10 +184,13 @@ modified_def["metadata"]["labels"]["environment"] = "testing" {}, (definition, []), {"changed": True, "method": "create", "result": definition}, + [], ), ], ) -def test_perform_action(action, params, existing, instance_warnings, expected): +def test_perform_action( + action, params, existing, instance_warnings, expected, expected_warnings +): svc = Mock() svc.find_resource.return_value = Mock( kind=definition["kind"], group_version=definition["apiVersion"] @@ -180,3 +201,10 @@ def test_perform_action(action, params, existing, instance_warnings, expected): result = perform_action(svc, definition, params) assert expected.items() <= result.items() + + # Warnings must be emitted through AnsibleModule.warn, never smuggled into the + # result dict: run_module()/k8s_service unpack that dict into exit_json(), and + # passing `warnings` to exit_json() is deprecated since ansible-core 2.19 + # (https://github.com/ansible-collections/kubernetes.core/issues/1264). + assert "warnings" not in result + assert [c.args[0] for c in svc.module.warn.call_args_list] == expected_warnings