[PR #5755/b49bf081 backport][stable-4] ModuleHelper - fix bug when ad…

…justing conflicting output (#5756)

ModuleHelper - fix bug when adjusting conflicting output (#5755)

* ModuleHelper - fix bug when adjusting conflicting output

* add changelog fragment

* remove commented test code

(cherry picked from commit b49bf08)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

changelogs/fragments/5755-mh-fix-output-conflict.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - ModuleHelper - fix bug when adjusting the name of reserved output variables (https://github.com/ansible-collections/community.general/pull/5755).

plugins/module_utils/mh/module_helper.py

@@ -70,7 +70,7 @@ def output(self):
             vars_diff = self.vars.diff() or {}
             result['diff'] = dict_merge(dict(diff), vars_diff)
 
-        for varname in result:
+        for varname in list(result):
             if varname in self._output_conflict_list:
                 result["_" + varname] = result[varname]
                 del result[varname]

tests/integration/targets/module_helper/library/msimple.py

@@ -34,12 +34,13 @@
 
 
 class MSimple(ModuleHelper):
-    output_params = ('a', 'b', 'c')
+    output_params = ('a', 'b', 'c', 'm')
     module = dict(
         argument_spec=dict(
             a=dict(type='int', default=0),
             b=dict(type='str'),
             c=dict(type='str'),
+            m=dict(type='str'),
         ),
         supports_check_mode=True,
     )
@@ -64,6 +65,9 @@ def __run__(self):
             self.vars['c'] = str(self.vars.c) * 2
         self.process_a3_bc()
 
+        if self.vars.m:
+            self.vars.msg = self.vars.m
+
 
 def main():
     msimple = MSimple()

tests/integration/targets/module_helper/tasks/main.yml

@@ -2,6 +2,7 @@
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 - include_tasks: msimple.yml
+- include_tasks: msimple_output_conflict.yml
 - include_tasks: mdepfail.yml
 - include_tasks: mstate.yml
 - include_tasks: msimpleda.yml

tests/integration/targets/module_helper/tasks/msimple_output_conflict.yml

@@ -0,0 +1,31 @@
+# Copyright (c) 2023, Alexei Znamensky
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: test msimple (set a=80)
+  msimple:
+    a: 80
+  register: simple1
+
+- name: assert simple1
+  assert:
+    that:
+      - simple1.a == 80
+      - simple1.abc == "abc"
+      - simple1 is not changed
+      - simple1.value is none
+
+- name: test msimple 2
+  msimple:
+    a: 80
+    m: a message in a bottle
+  register: simple2
+
+- name: assert simple2
+  assert:
+    that:
+      - simple1.a == 80
+      - simple1.abc == "abc"
+      - simple1 is not changed
+      - simple1.value is none
+      - 'simple2._msg == "a message in a bottle"'