unit test helper: big revamp (#8894)

* initial commit

* multiple changes:

- TestCaseContext fixture no longer need to autouse=True
- Helper.from_module() allows extra param to specify yaml file
- test_django_check: adjusted .py and .yaml

* set fixtures per testcase

* set fixtures per testcase

* rollback to original state

* patch_ansible_module fixture

- now it works not only in parametrized functions but also directly with args

* tests/unit/plugins/modules/helper.py

- improved encapsulation, class Helper no longer knows details about test cases
- test functions no longer parametrized, that allows using test case fixtures per test function
- renamed 'context' to 'mock'

* enable Helper.from_list(), better param name 'ansible_module'

* adjusted test fiels to new helper

* remove unnecessary .license file

* fix bracket

* fix reference name

* Update tests/unit/plugins/modules/helper.py

Co-authored-by: Felix Fontein <[email protected]>

* revert to parametrized test func instead of multiple funcs

---------

Co-authored-by: Felix Fontein <[email protected]>

tests/unit/plugins/modules/conftest.py

@@ -16,22 +16,34 @@
 from ansible_collections.community.general.plugins.module_utils import deps
 
 
-@pytest.fixture
-def patch_ansible_module(request, mocker):
-    if isinstance(request.param, string_types):
-        args = request.param
-    elif isinstance(request.param, MutableMapping):
-        if 'ANSIBLE_MODULE_ARGS' not in request.param:
-            request.param = {'ANSIBLE_MODULE_ARGS': request.param}
-        if '_ansible_remote_tmp' not in request.param['ANSIBLE_MODULE_ARGS']:
-            request.param['ANSIBLE_MODULE_ARGS']['_ansible_remote_tmp'] = '/tmp'
-        if '_ansible_keep_remote_files' not in request.param['ANSIBLE_MODULE_ARGS']:
-            request.param['ANSIBLE_MODULE_ARGS']['_ansible_keep_remote_files'] = False
-        args = json.dumps(request.param)
+def fix_ansible_args(args):
+    if isinstance(args, string_types):
+        return args
+
+    if isinstance(args, MutableMapping):
+        if 'ANSIBLE_MODULE_ARGS' not in args:
+            args = {'ANSIBLE_MODULE_ARGS': args}
+        if '_ansible_remote_tmp' not in args['ANSIBLE_MODULE_ARGS']:
+            args['ANSIBLE_MODULE_ARGS']['_ansible_remote_tmp'] = '/tmp'
+        if '_ansible_keep_remote_files' not in args['ANSIBLE_MODULE_ARGS']:
+            args['ANSIBLE_MODULE_ARGS']['_ansible_keep_remote_files'] = False
+        args = json.dumps(args)
+        return args
+
     else:
         raise Exception('Malformed data to the patch_ansible_module pytest fixture')
 
-    mocker.patch('ansible.module_utils.basic._ANSIBLE_ARGS', to_bytes(args))
+
+@pytest.fixture
+def patch_ansible_module(request, mocker):
+    if hasattr(request, "param"):
+        args = fix_ansible_args(request.param)
+        mocker.patch('ansible.module_utils.basic._ANSIBLE_ARGS', to_bytes(args))
+    else:
+        def _patch(args):
+            args = fix_ansible_args(args)
+            mocker.patch('ansible.module_utils.basic._ANSIBLE_ARGS', to_bytes(args))
+        return _patch
 
 
 @pytest.fixture(autouse=True)