gconftool2_info: new module (#4743)

* gconftool2_info: new module * fixed imports * fixed docs for gconftool2_info * fixed docs for gconftool2_info * minor adjustment in docs * added tests * adjustments
2025-07-08 14:20:04 -07:00 · 2022-06-04 19:13:53 +12:00 · 2022-06-04 19:13:53 +12:00 · 49836bb484
commit 49836bb484
parent be69f95f63
5 changed files with 210 additions and 0 deletions
--- a/tests/unit/plugins/modules/system/test_gconftool2_info.py
+++ b/tests/unit/plugins/modules/system/test_gconftool2_info.py
@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+# Author: Alexei Znamensky (russoz@gmail.com)
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import json
+
+from ansible_collections.community.general.plugins.modules.system import gconftool2_info
+
+import pytest
+
+TESTED_MODULE = gconftool2_info.__name__
+
+
+@pytest.fixture
+def patch_gconftool2_info(mocker):
+    """
+    Function used for mocking some parts of redhat_subscribtion module
+    """
+    mocker.patch('ansible_collections.community.general.plugins.module_utils.mh.module_helper.AnsibleModule.get_bin_path',
+                 return_value='/testbin/gconftool-2')
+
+
+TEST_CASES = [
+    [
+        {'key': '/desktop/gnome/background/picture_filename'},
+        {
+            'id': 'test_simple_element_get',
+            'run_command.calls': [
+                (
+                    # Calling of following command will be asserted
+                    ['/testbin/gconftool-2', '--get', '/desktop/gnome/background/picture_filename'],
+                    # Was return code checked?
+                    {'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': True},
+                    # Mock of returned code, stdout and stderr
+                    (0, '100\n', '',),
+                ),
+            ],
+            'value': '100',
+        }
+    ],
+    [
+        {'key': '/desktop/gnome/background/picture_filename'},
+        {
+            'id': 'test_simple_element_get_not_found',
+            'run_command.calls': [
+                (
+                    # Calling of following command will be asserted
+                    ['/testbin/gconftool-2', '--get', '/desktop/gnome/background/picture_filename'],
+                    # Was return code checked?
+                    {'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': True},
+                    # Mock of returned code, stdout and stderr
+                    (0, '', "No value set for `/desktop/gnome/background/picture_filename'\n",),
+                ),
+            ],
+            'value': None,
+        }
+    ],
+]
+TEST_CASES_IDS = [item[1]['id'] for item in TEST_CASES]
+
+
+@pytest.mark.parametrize('patch_ansible_module, testcase',
+                         TEST_CASES,
+                         ids=TEST_CASES_IDS,
+                         indirect=['patch_ansible_module'])
+@pytest.mark.usefixtures('patch_ansible_module')
+def test_gconftool2_info(mocker, capfd, patch_gconftool2_info, testcase):
+    """
+    Run unit tests for test cases listen in TEST_CASES
+    """
+
+    # Mock function used for running commands first
+    call_results = [item[2] for item in testcase['run_command.calls']]
+    mock_run_command = mocker.patch(
+        'ansible_collections.community.general.plugins.module_utils.mh.module_helper.AnsibleModule.run_command',
+        side_effect=call_results)
+
+    # Try to run test case
+    with pytest.raises(SystemExit):
+        gconftool2_info.main()
+
+    out, err = capfd.readouterr()
+    results = json.loads(out)
+    print("testcase =\n%s" % testcase)
+    print("results =\n%s" % results)
+
+    for conditional_test_result in ('value',):
+        if conditional_test_result in testcase:
+            assert conditional_test_result in results, "'{0}' not found in {1}".format(conditional_test_result, results)
+            assert results[conditional_test_result] == testcase[conditional_test_result], \
+                "'{0}': '{1}' != '{2}'".format(conditional_test_result, results[conditional_test_result], testcase[conditional_test_result])
+
+    assert mock_run_command.call_count == len(testcase['run_command.calls'])
+    if mock_run_command.call_count:
+        call_args_list = [(item[0][0], item[1]) for item in mock_run_command.call_args_list]
+        expected_call_args_list = [(item[0], item[1]) for item in testcase['run_command.calls']]
+        print("call args list =\n%s" % call_args_list)
+        print("expected args list =\n%s" % expected_call_args_list)
+        assert call_args_list == expected_call_args_list