community.general/tests/unit/plugins/modules/system/test_xfconf.py

# -*- coding: utf-8 -*-
# Author: Alexei Znamensky (russoz@gmail.com)
# Largely adapted from test_redhat_subscription by
# Jiri Hnidek (jhnidek@redhat.com)
#
# Copyright (c) Alexei Znamensky (russoz@gmail.com)
# Copyright (c) Jiri Hnidek (jhnidek@redhat.com)
#
# 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

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_subscription module
    """
    mocker.patch('ansible_collections.community.general.plugins.module_utils.mh.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': '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', 'LC_ALL': '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', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, '', '',),
                ),
            ],
            'changed': True,
            'previous_value': '100',
            'value_type': 'int',
            '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', 'LC_ALL': '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', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, '', '',),
                ),
            ],
            'changed': False,
            'previous_value': '90',
            'value_type': 'int',
            'value': '90',
        },
    ],
    [
        {
            'channel': 'xfce4-session',
            'property': '/general/SaveOnExit',
            'state': 'present',
            'value_type': 'bool',
            'value': False,
        },
        {
            'id': 'test_property_set_property_bool_false',
            'run_command.calls': [
                (
                    # Calling of following command will be asserted
                    ['/testbin/xfconf-query', '--channel', 'xfce4-session', '--property', '/general/SaveOnExit'],
                    # Was return code checked?
                    {'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, 'true\n', '',),
                ),
                (
                    # Calling of following command will be asserted
                    ['/testbin/xfconf-query', '--channel', 'xfce4-session', '--property', '/general/SaveOnExit',
                     '--create', '--type', 'bool', '--set', 'false'],
                    # Was return code checked?
                    {'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, 'false\n', '',),
                ),
            ],
            'changed': True,
            'previous_value': 'true',
            'value_type': 'bool',
            'value': 'False',
        },
    ],
    [
        {
            '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', 'LC_ALL': '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', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, '', '',),
                ),
            ],
            'changed': True,
            'previous_value': ['Main', 'Work', 'Tmp'],
            'value_type': ['str', 'str', 'str'],
            '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', 'LC_ALL': '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', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, '', '',),
                ),
            ],
            'changed': False,
            'previous_value': ['A', 'B', 'C'],
            'value_type': ['str', 'str', 'str'],
            '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', 'LC_ALL': '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', 'LC_ALL': 'C'}, 'check_rc': False},
                    # Mock of returned code, stdout and stderr
                    (0, '', '',),
                ),
            ],
            'changed': True,
            'previous_value': ['A', 'B', 'C'],
            'value_type': None,
            '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.module_utils.basic.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']

    for test_result in ('channel', 'property'):
        assert test_result in results, "'{0}' not found in {1}".format(test_result, results)
        assert results[test_result] == results['invocation']['module_args'][test_result], \
            "'{0}': '{1}' != '{2}'".format(test_result, results[test_result], results['invocation']['module_args'][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

        expected_cmd, dummy, expected_res = testcase['run_command.calls'][-1]
        assert results['cmd'] == expected_cmd
        assert results['stdout'] == expected_res[1]
        assert results['stderr'] == expected_res[2]

    for conditional_test_result in ('msg', 'value', 'previous_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])