From da2c87ce0d3546edc068137d0a1279605bc377a4 Mon Sep 17 00:00:00 2001
From: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Date: Sat, 25 May 2024 07:59:00 +1200
Subject: [PATCH] fix test helper handling of rc (#8387)

* fix test helper handling of rc

* fix side_effect logic for rc != 0

* fix side_effect func + sanity tests

* fix ignore files

* fix code

* revamp the generator for run_command calls returns in testcase

* remove unused import

* Update tests/sanity/ignore-2.18.txt

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update tests/sanity/ignore-2.17.txt

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
---
 tests/sanity/ignore-2.17.txt                  |  1 +
 tests/sanity/ignore-2.18.txt                  |  1 +
 tests/unit/plugins/modules/helper.py          | 20 +++++++++++++------
 .../plugins/modules/test_django_command.yaml  |  2 --
 4 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/tests/sanity/ignore-2.17.txt b/tests/sanity/ignore-2.17.txt
index 7479d6bafe..806c4c5fcf 100644
--- a/tests/sanity/ignore-2.17.txt
+++ b/tests/sanity/ignore-2.17.txt
@@ -11,4 +11,5 @@ plugins/modules/udm_user.py import-3.12  # Uses deprecated stdlib library 'crypt
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/module_utils/univention_umc.py pylint:use-yield-from  # suggested construct does not work with Python 2
 tests/unit/compat/mock.py pylint:use-yield-from  # suggested construct does not work with Python 2
+tests/unit/plugins/modules/helper.py pylint:use-yield-from  # suggested construct does not work with Python 2
 tests/unit/plugins/modules/test_gio_mime.yaml no-smart-quotes
diff --git a/tests/sanity/ignore-2.18.txt b/tests/sanity/ignore-2.18.txt
index 7479d6bafe..806c4c5fcf 100644
--- a/tests/sanity/ignore-2.18.txt
+++ b/tests/sanity/ignore-2.18.txt
@@ -11,4 +11,5 @@ plugins/modules/udm_user.py import-3.12  # Uses deprecated stdlib library 'crypt
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/module_utils/univention_umc.py pylint:use-yield-from  # suggested construct does not work with Python 2
 tests/unit/compat/mock.py pylint:use-yield-from  # suggested construct does not work with Python 2
+tests/unit/plugins/modules/helper.py pylint:use-yield-from  # suggested construct does not work with Python 2
 tests/unit/plugins/modules/test_gio_mime.yaml no-smart-quotes
diff --git a/tests/unit/plugins/modules/helper.py b/tests/unit/plugins/modules/helper.py
index 1ffa19aad4..e012980afe 100644
--- a/tests/unit/plugins/modules/helper.py
+++ b/tests/unit/plugins/modules/helper.py
@@ -9,7 +9,6 @@ __metaclass__ = type
 import sys
 import json
 from collections import namedtuple
-from itertools import chain, repeat
 
 import pytest
 import yaml
@@ -76,12 +75,21 @@ class _RunCmdContext(_BaseContext):
         self.mock_run_cmd = self._make_mock_run_cmd()
 
     def _make_mock_run_cmd(self):
-        call_results = [(x.rc, x.out, x.err) for x in self.run_cmd_calls]
-        error_call_results = (123,
-                              "OUT: testcase has not enough run_command calls",
-                              "ERR: testcase has not enough run_command calls")
+        def _results():
+            for result in [(x.rc, x.out, x.err) for x in self.run_cmd_calls]:
+                yield result
+            raise Exception("testcase has not enough run_command calls")
+
+        results = _results()
+
+        def side_effect(self_, **kwargs):
+            result = next(results)
+            if kwargs.get("check_rc", False) and result[0] != 0:
+                raise Exception("rc = {0}".format(result[0]))
+            return result
+
         mock_run_command = self.mocker.patch('ansible.module_utils.basic.AnsibleModule.run_command',
-                                             side_effect=chain(call_results, repeat(error_call_results)))
+                                             side_effect=side_effect)
         return mock_run_command
 
     def check_results(self, results):
diff --git a/tests/unit/plugins/modules/test_django_command.yaml b/tests/unit/plugins/modules/test_django_command.yaml
index 9fe9b419f9..046dd87f03 100644
--- a/tests/unit/plugins/modules/test_django_command.yaml
+++ b/tests/unit/plugins/modules/test_django_command.yaml
@@ -30,8 +30,6 @@
     settings: whatever.settings
   output:
     failed: true
-  flags:
-    xfail: not seem to be failing as it should
   run_command_calls:
     - command: [/testbin/python, -m, django, check, --no-color, --settings=whatever.settings, babaloo, yaba, daba, doo]
       environ: *env-def