ansible/test/units/plugins/action/test_action.py

# (c) 2015, Florian Apolloner <florian@apolloner.eu>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.

# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type


from ansible import constants as C
from ansible.compat.tests import unittest
from ansible.compat.tests.mock import Mock
from ansible.playbook.play_context import PlayContext
from ansible.plugins.action import ActionBase


class TestActionBase(unittest.TestCase):

    def test_sudo_only_if_user_differs(self):
        play_context = PlayContext()
        action_base = ActionBase(None, None, play_context, None, None, None)
        action_base._connection = Mock(exec_command=Mock(return_value=(0, '', '')))

        play_context.become = True
        play_context.become_user = play_context.remote_user = 'root'
        play_context.make_become_cmd = Mock(return_value='CMD')

        action_base._low_level_execute_command('ECHO', sudoable=True)
        play_context.make_become_cmd.assert_not_called()

        play_context.remote_user = 'apo'
        action_base._low_level_execute_command('ECHO', sudoable=True)
        play_context.make_become_cmd.assert_called_once_with('ECHO', executable=None)

        play_context.make_become_cmd.reset_mock()

        become_allow_same_user = C.BECOME_ALLOW_SAME_USER
        C.BECOME_ALLOW_SAME_USER = True
        try:
            play_context.remote_user = 'root'
            action_base._low_level_execute_command('ECHO SAME', sudoable=True)
            play_context.make_become_cmd.assert_called_once_with('ECHO SAME', executable=None)
        finally:
            C.BECOME_ALLOW_SAME_USER = become_allow_same_user
Added a test to ensure that sudo is only used if remote and become user difer. 9 years ago			`# (c) 2015, Florian Apolloner <florian@apolloner.eu>`
			`#`
			`# This file is part of Ansible`
			`#`
			`# Ansible is free software: you can redistribute it and/or modify`
			`# it under the terms of the GNU General Public License as published by`
			`# the Free Software Foundation, either version 3 of the License, or`
			`# (at your option) any later version.`
			`#`
			`# Ansible is distributed in the hope that it will be useful,`
			`# but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`# GNU General Public License for more details.`
			`#`
			`# You should have received a copy of the GNU General Public License`
			`# along with Ansible. If not, see <http://www.gnu.org/licenses/>.`

			`# Make coding more python3-ish`
			`from __future__ import (absolute_import, division, print_function)`
			`__metaclass__ = type`


Ported over #7158 to support SELinux context switches. 9 years ago			`from ansible import constants as C`
Added a test to ensure that sudo is only used if remote and become user difer. 9 years ago			`from ansible.compat.tests import unittest`
			`from ansible.compat.tests.mock import Mock`
			`from ansible.playbook.play_context import PlayContext`
			`from ansible.plugins.action import ActionBase`


			`class TestActionBase(unittest.TestCase):`

			`def test_sudo_only_if_user_differs(self):`
			`play_context = PlayContext()`
			`action_base = ActionBase(None, None, play_context, None, None, None)`
remove the stdin return value from connection plugin exec_command() methods The value was useless -- unused by the callers and always hardcoded to the empty string. 9 years ago			`action_base._connection = Mock(exec_command=Mock(return_value=(0, '', '')))`
Added a test to ensure that sudo is only used if remote and become user difer. 9 years ago
			`play_context.become = True`
			`play_context.become_user = play_context.remote_user = 'root'`
			`play_context.make_become_cmd = Mock(return_value='CMD')`

Remove tmp as a parameter to the connection plugins There doesn't appear to be anything that actually uses tmp_path in the connection plugins so we don't need to pass that in to exec_command. That change also means that we don't need to pass tmp_path around in many places in the action plugins any more. there may be more cleanup that can be done there as well (the action plugin's public run() method takes tmp as a keyword arg but that may not be necessary). As a sideeffect of this patch, some potential problems with chmod and the patch, assemble, copy, and template modules has been fixed (those modules called _remote_chmod() with the wrong order for their parameters. Removing the tmp parameter fixed them.) 9 years ago			`action_base._low_level_execute_command('ECHO', sudoable=True)`
Added a test to ensure that sudo is only used if remote and become user difer. 9 years ago			`play_context.make_become_cmd.assert_not_called()`

			`play_context.remote_user = 'apo'`
Remove tmp as a parameter to the connection plugins There doesn't appear to be anything that actually uses tmp_path in the connection plugins so we don't need to pass that in to exec_command. That change also means that we don't need to pass tmp_path around in many places in the action plugins any more. there may be more cleanup that can be done there as well (the action plugin's public run() method takes tmp as a keyword arg but that may not be necessary). As a sideeffect of this patch, some potential problems with chmod and the patch, assemble, copy, and template modules has been fixed (those modules called _remote_chmod() with the wrong order for their parameters. Removing the tmp parameter fixed them.) 9 years ago			`action_base._low_level_execute_command('ECHO', sudoable=True)`
Added a test to ensure that sudo is only used if remote and become user difer. 9 years ago			`play_context.make_become_cmd.assert_called_once_with('ECHO', executable=None)`
Ported over #7158 to support SELinux context switches. 9 years ago
			`play_context.make_become_cmd.reset_mock()`

			`become_allow_same_user = C.BECOME_ALLOW_SAME_USER`
			`C.BECOME_ALLOW_SAME_USER = True`
			`try:`
			`play_context.remote_user = 'root'`
Remove tmp as a parameter to the connection plugins There doesn't appear to be anything that actually uses tmp_path in the connection plugins so we don't need to pass that in to exec_command. That change also means that we don't need to pass tmp_path around in many places in the action plugins any more. there may be more cleanup that can be done there as well (the action plugin's public run() method takes tmp as a keyword arg but that may not be necessary). As a sideeffect of this patch, some potential problems with chmod and the patch, assemble, copy, and template modules has been fixed (those modules called _remote_chmod() with the wrong order for their parameters. Removing the tmp parameter fixed them.) 9 years ago			`action_base._low_level_execute_command('ECHO SAME', sudoable=True)`
Ported over #7158 to support SELinux context switches. 9 years ago			`play_context.make_become_cmd.assert_called_once_with('ECHO SAME', executable=None)`
			`finally:`
			`C.BECOME_ALLOW_SAME_USER = become_allow_same_user`