mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
7713202d9b
* Big revamp in xfconf.py
- added plugin/module_utils/module_helper.py
- scaffold class for writing modules, beyond standard AnsibleModule
- automatic capture of exceptions
- easier dependency testing
- StateMixin to easily handle different behaviours for 'state' param
- CmdMixin to easily run external commands
- adapted test_xfconf.py
- the args for run_command are now lists instead of a string
- value and previous_value were not being tested before (because xfconf wasn't filling results - see below)
- added more tests: setting value to previous_value, getting non-existent property
- rewritten xfconf module, keeping the same results
- original module posted results as ansible_facts, this version still does it for compatibility, but also adds to the module result
* Added suggestions from the PR
* Added russoz as maintainer for the module_utils/module_helper.py file
* Formatting using printf-style requires special treatment
Strings not containing substitution tokens must work as well.
* Tidied up variables in module definition
* Tests with ArgFormat and DependencyCtxMgr
* pytest parameters must be in the same order, it seems
* improved testing for the DependencyCtxMgr
* fixed test for older pythons
* Moved changed property to improve readability
* Added testcase for state: absent and adjusted xfconf after it
* Fixed param name environ_update in run_command()
* added changelog fragment
* fixed tests after run_command param change
(cherry picked from commit e3fcc7de2a)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
351 lines
14 KiB
Python
351 lines
14 KiB
Python
# Author: Alexei Znamensky (russoz@gmail.com)
|
|
# Largely adapted from test_redhat_subscription by
|
|
# Jiri Hnidek (jhnidek@redhat.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 xfconf
|
|
|
|
import pytest
|
|
|
|
TESTED_MODULE = xfconf.__name__
|
|
|
|
|
|
@pytest.fixture
|
|
def patch_xfconf(mocker):
|
|
"""
|
|
Function used for mocking some parts of redhat_subscribtion module
|
|
"""
|
|
mocker.patch('ansible_collections.community.general.plugins.module_utils.module_helper.AnsibleModule.get_bin_path',
|
|
return_value='/testbin/xfconf-query')
|
|
|
|
|
|
@pytest.mark.parametrize('patch_ansible_module', [{}], indirect=['patch_ansible_module'])
|
|
@pytest.mark.usefixtures('patch_ansible_module')
|
|
def test_without_required_parameters(capfd, patch_xfconf):
|
|
"""
|
|
Failure must occurs when all parameters are missing
|
|
"""
|
|
with pytest.raises(SystemExit):
|
|
xfconf.main()
|
|
out, err = capfd.readouterr()
|
|
results = json.loads(out)
|
|
assert results['failed']
|
|
assert 'missing required arguments' in results['msg']
|
|
|
|
|
|
TEST_CASES = [
|
|
[
|
|
{'channel': 'xfwm4', 'property': '/general/inactive_opacity', 'state': 'get'},
|
|
{
|
|
'id': 'test_simple_property_get',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/inactive_opacity'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '100\n', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': '100',
|
|
'value': '100',
|
|
}
|
|
],
|
|
[
|
|
{'channel': 'xfwm4', 'property': '/general/i_dont_exist', 'state': 'get'},
|
|
{
|
|
'id': 'test_simple_property_get_nonexistent',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/i_dont_exist'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(1, '', 'Property "/general/i_dont_exist" does not exist on channel "xfwm4".\n',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': None,
|
|
'value': None,
|
|
}
|
|
],
|
|
[
|
|
{'channel': 'xfwm4', 'property': '/general/workspace_names', 'state': 'get'},
|
|
{
|
|
'id': 'test_property_get_array',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'Value is an array with 3 items:\n\nMain\nWork\nTmp\n', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': ['Main', 'Work', 'Tmp'],
|
|
'value': ['Main', 'Work', 'Tmp'],
|
|
},
|
|
],
|
|
[
|
|
{'channel': 'xfwm4', 'property': '/general/use_compositing', 'state': 'get'},
|
|
{
|
|
'id': 'test_property_get_bool',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/use_compositing'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'true', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': 'true',
|
|
'value': 'true',
|
|
},
|
|
],
|
|
[
|
|
{'channel': 'xfwm4', 'property': '/general/use_compositing', 'state': 'get'},
|
|
{
|
|
'id': 'test_property_get_bool_false',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/use_compositing'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'false', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': 'false',
|
|
'value': 'false',
|
|
},
|
|
],
|
|
[
|
|
{
|
|
'channel': 'xfwm4',
|
|
'property': '/general/inactive_opacity',
|
|
'state': 'present',
|
|
'value_type': 'int',
|
|
'value': 90,
|
|
},
|
|
{
|
|
'id': 'test_property_set_property',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/inactive_opacity'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '100\n', '',),
|
|
),
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/inactive_opacity',
|
|
'--create', '--type', 'int', '--set', '90'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '', '',),
|
|
),
|
|
],
|
|
'changed': True,
|
|
'previous_value': '100',
|
|
'value': '90',
|
|
},
|
|
],
|
|
[
|
|
{
|
|
'channel': 'xfwm4',
|
|
'property': '/general/inactive_opacity',
|
|
'state': 'present',
|
|
'value_type': 'int',
|
|
'value': 90,
|
|
},
|
|
{
|
|
'id': 'test_property_set_property_same_value',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/inactive_opacity'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '90\n', '',),
|
|
),
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/inactive_opacity',
|
|
'--create', '--type', 'int', '--set', '90'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': '90',
|
|
'value': '90',
|
|
},
|
|
],
|
|
[
|
|
{
|
|
'channel': 'xfwm4',
|
|
'property': '/general/workspace_names',
|
|
'state': 'present',
|
|
'value_type': 'string',
|
|
'value': ['A', 'B', 'C'],
|
|
},
|
|
{
|
|
'id': 'test_property_set_array',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'Value is an array with 3 items:\n\nMain\nWork\nTmp\n', '',),
|
|
),
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names',
|
|
'--create', '--force-array', '--type', 'string', '--set', 'A', '--type', 'string', '--set', 'B',
|
|
'--type', 'string', '--set', 'C'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '', '',),
|
|
),
|
|
],
|
|
'changed': True,
|
|
'previous_value': ['Main', 'Work', 'Tmp'],
|
|
'value': ['A', 'B', 'C'],
|
|
},
|
|
],
|
|
[
|
|
{
|
|
'channel': 'xfwm4',
|
|
'property': '/general/workspace_names',
|
|
'state': 'present',
|
|
'value_type': 'string',
|
|
'value': ['A', 'B', 'C'],
|
|
},
|
|
{
|
|
'id': 'test_property_set_array_to_same_value',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'Value is an array with 3 items:\n\nA\nB\nC\n', '',),
|
|
),
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names',
|
|
'--create', '--force-array', '--type', 'string', '--set', 'A', '--type', 'string', '--set', 'B',
|
|
'--type', 'string', '--set', 'C'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '', '',),
|
|
),
|
|
],
|
|
'changed': False,
|
|
'previous_value': ['A', 'B', 'C'],
|
|
'value': ['A', 'B', 'C'],
|
|
},
|
|
],
|
|
[
|
|
{
|
|
'channel': 'xfwm4',
|
|
'property': '/general/workspace_names',
|
|
'state': 'absent',
|
|
},
|
|
{
|
|
'id': 'test_property_reset_value',
|
|
'run_command.calls': [
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, 'Value is an array with 3 items:\n\nA\nB\nC\n', '',),
|
|
),
|
|
(
|
|
# Calling of following command will be asserted
|
|
['/testbin/xfconf-query', '--channel', 'xfwm4', '--property', '/general/workspace_names',
|
|
'--reset'],
|
|
# Was return code checked?
|
|
{'environ_update': {'LANGUAGE': 'C'}, 'check_rc': False},
|
|
# Mock of returned code, stdout and stderr
|
|
(0, '', '',),
|
|
),
|
|
],
|
|
'changed': True,
|
|
'previous_value': ['A', 'B', 'C'],
|
|
'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_xfconf(mocker, capfd, patch_xfconf, 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.module_helper.AnsibleModule.run_command',
|
|
side_effect=call_results)
|
|
|
|
# Try to run test case
|
|
with pytest.raises(SystemExit):
|
|
xfconf.main()
|
|
|
|
out, err = capfd.readouterr()
|
|
results = json.loads(out)
|
|
print("testcase =\n%s" % testcase)
|
|
print("results =\n%s" % results)
|
|
assert 'changed' in results
|
|
assert results['changed'] == testcase['changed']
|
|
if 'msg' in results:
|
|
assert results.get('msg') == testcase['msg']
|
|
if 'value' in results:
|
|
assert results['value'] == testcase['value']
|
|
if 'previous_value' in results:
|
|
assert results['previous_value'] == testcase['previous_value']
|
|
|
|
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
|