mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
Moving ConnectionInformation -> PlayContext
Also making PlayContext a child class of the Playbook Base class, which gives it access to all of the FieldAttribute code to ensure field values are correctly typed after post_validation Fixes #11381
This commit is contained in:
parent
919aaa5c42
commit
e64989beb4
36 changed files with 477 additions and 459 deletions
|
@ -1,156 +0,0 @@
|
|||
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
||||
#
|
||||
# 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
|
||||
|
||||
import pwd
|
||||
import os
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.compat.tests.mock import patch, MagicMock
|
||||
|
||||
from ansible import constants as C
|
||||
from ansible.cli import CLI
|
||||
from ansible.errors import AnsibleError, AnsibleParserError
|
||||
from ansible.executor.connection_info import ConnectionInformation
|
||||
|
||||
from units.mock.loader import DictDataLoader
|
||||
|
||||
class TestConnectionInformation(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self._parser = CLI.base_parser(
|
||||
runas_opts = True,
|
||||
meta_opts = True,
|
||||
runtask_opts = True,
|
||||
vault_opts = True,
|
||||
async_opts = True,
|
||||
connect_opts = True,
|
||||
subset_opts = True,
|
||||
check_opts = True,
|
||||
diff_opts = True,
|
||||
)
|
||||
|
||||
def tearDown(self):
|
||||
pass
|
||||
|
||||
def test_connection_info(self):
|
||||
(options, args) = self._parser.parse_args(['-vv', '--check'])
|
||||
conn_info = ConnectionInformation(options=options)
|
||||
self.assertEqual(conn_info.connection, 'smart')
|
||||
self.assertEqual(conn_info.remote_addr, None)
|
||||
self.assertEqual(conn_info.remote_user, pwd.getpwuid(os.geteuid())[0])
|
||||
self.assertEqual(conn_info.password, '')
|
||||
self.assertEqual(conn_info.port, None)
|
||||
self.assertEqual(conn_info.private_key_file, C.DEFAULT_PRIVATE_KEY_FILE)
|
||||
self.assertEqual(conn_info.timeout, C.DEFAULT_TIMEOUT)
|
||||
self.assertEqual(conn_info.shell, None)
|
||||
self.assertEqual(conn_info.verbosity, 2)
|
||||
self.assertEqual(conn_info.check_mode, True)
|
||||
self.assertEqual(conn_info.no_log, False)
|
||||
|
||||
mock_play = MagicMock()
|
||||
mock_play.connection = 'mock'
|
||||
mock_play.remote_user = 'mock'
|
||||
mock_play.port = 1234
|
||||
mock_play.become = True
|
||||
mock_play.become_method = 'mock'
|
||||
mock_play.become_user = 'mockroot'
|
||||
mock_play.no_log = True
|
||||
mock_play.environment = dict(mock='mockenv')
|
||||
|
||||
conn_info = ConnectionInformation(play=mock_play, options=options)
|
||||
self.assertEqual(conn_info.connection, 'mock')
|
||||
self.assertEqual(conn_info.remote_user, 'mock')
|
||||
self.assertEqual(conn_info.password, '')
|
||||
self.assertEqual(conn_info.port, 1234)
|
||||
self.assertEqual(conn_info.no_log, True)
|
||||
self.assertEqual(conn_info.environment, dict(mock="mockenv"))
|
||||
self.assertEqual(conn_info.become, True)
|
||||
self.assertEqual(conn_info.become_method, "mock")
|
||||
self.assertEqual(conn_info.become_user, "mockroot")
|
||||
|
||||
mock_task = MagicMock()
|
||||
mock_task.connection = 'mocktask'
|
||||
mock_task.remote_user = 'mocktask'
|
||||
mock_task.become = True
|
||||
mock_task.become_method = 'mocktask'
|
||||
mock_task.become_user = 'mocktaskroot'
|
||||
mock_task.become_pass = 'mocktaskpass'
|
||||
mock_task.no_log = False
|
||||
mock_task.environment = dict(mock='mocktaskenv')
|
||||
|
||||
mock_host = MagicMock()
|
||||
mock_host.get_vars.return_value = dict(
|
||||
ansible_connection = 'mock_inventory',
|
||||
ansible_ssh_port = 4321,
|
||||
)
|
||||
|
||||
conn_info = ConnectionInformation(play=mock_play, options=options)
|
||||
conn_info = conn_info.set_task_and_host_override(task=mock_task, host=mock_host)
|
||||
self.assertEqual(conn_info.connection, 'mock_inventory')
|
||||
self.assertEqual(conn_info.remote_user, 'mocktask')
|
||||
self.assertEqual(conn_info.port, 4321)
|
||||
self.assertEqual(conn_info.no_log, False)
|
||||
self.assertEqual(conn_info.environment, dict(mock="mocktaskenv"))
|
||||
self.assertEqual(conn_info.become, True)
|
||||
self.assertEqual(conn_info.become_method, "mocktask")
|
||||
self.assertEqual(conn_info.become_user, "mocktaskroot")
|
||||
self.assertEqual(conn_info.become_pass, "mocktaskpass")
|
||||
|
||||
def test_connection_info_make_become_cmd(self):
|
||||
(options, args) = self._parser.parse_args([])
|
||||
conn_info = ConnectionInformation(options=options)
|
||||
|
||||
default_cmd = "/bin/foo"
|
||||
default_exe = "/bin/bash"
|
||||
sudo_exe = C.DEFAULT_SUDO_EXE
|
||||
sudo_flags = C.DEFAULT_SUDO_FLAGS
|
||||
su_exe = C.DEFAULT_SU_EXE
|
||||
su_flags = C.DEFAULT_SU_FLAGS
|
||||
pbrun_exe = 'pbrun'
|
||||
pbrun_flags = ''
|
||||
pfexec_exe = 'pfexec'
|
||||
pfexec_flags = ''
|
||||
|
||||
cmd = conn_info.make_become_cmd(cmd=default_cmd, executable=default_exe)
|
||||
self.assertEqual(cmd, default_cmd)
|
||||
|
||||
conn_info.become = True
|
||||
conn_info.become_user = 'foo'
|
||||
|
||||
conn_info.become_method = 'sudo'
|
||||
cmd = conn_info.make_become_cmd(cmd=default_cmd, executable="/bin/bash")
|
||||
self.assertEqual(cmd, """%s -c '%s -k && %s %s -S -p "%s" -u %s %s -c '"'"'echo %s; %s'"'"''""" % (default_exe, sudo_exe, sudo_exe, sudo_flags, conn_info.prompt, conn_info.become_user, default_exe, conn_info.success_key, default_cmd))
|
||||
|
||||
conn_info.become_method = 'su'
|
||||
cmd = conn_info.make_become_cmd(cmd=default_cmd, executable="/bin/bash")
|
||||
self.assertEqual(cmd, """%s -c '%s %s -c "%s -c '"'"'echo %s; %s'"'"'"'""" % (default_exe, su_exe, conn_info.become_user, default_exe, conn_info.success_key, default_cmd))
|
||||
|
||||
conn_info.become_method = 'pbrun'
|
||||
cmd = conn_info.make_become_cmd(cmd=default_cmd, executable="/bin/bash")
|
||||
self.assertEqual(cmd, """%s -c '%s -b %s -u %s '"'"'echo %s; %s'"'"''""" % (default_exe, pbrun_exe, pbrun_flags, conn_info.become_user, conn_info.success_key, default_cmd))
|
||||
|
||||
conn_info.become_method = 'pfexec'
|
||||
cmd = conn_info.make_become_cmd(cmd=default_cmd, executable="/bin/bash")
|
||||
self.assertEqual(cmd, """%s -c '%s %s "'"'"'echo %s; %s'"'"'"'""" % (default_exe, pfexec_exe, pfexec_flags, conn_info.success_key, default_cmd))
|
||||
|
||||
conn_info.become_method = 'bad'
|
||||
self.assertRaises(AnsibleError, conn_info.make_become_cmd, cmd=default_cmd, executable="/bin/bash")
|
||||
|
|
@ -23,9 +23,9 @@ from ansible.compat.tests import unittest
|
|||
from ansible.compat.tests.mock import patch, MagicMock
|
||||
|
||||
from ansible.errors import AnsibleError, AnsibleParserError
|
||||
from ansible.executor.connection_info import ConnectionInformation
|
||||
from ansible.executor.play_iterator import PlayIterator
|
||||
from ansible.playbook import Playbook
|
||||
from ansible.playbook.play_context import PlayContext
|
||||
|
||||
from units.mock.loader import DictDataLoader
|
||||
|
||||
|
@ -68,12 +68,12 @@ class TestPlayIterator(unittest.TestCase):
|
|||
inventory.get_hosts.return_value = hosts
|
||||
inventory.filter_hosts.return_value = hosts
|
||||
|
||||
connection_info = ConnectionInformation(play=p._entries[0])
|
||||
play_context = PlayContext(play=p._entries[0])
|
||||
|
||||
itr = PlayIterator(
|
||||
inventory=inventory,
|
||||
play=p._entries[0],
|
||||
connection_info=connection_info,
|
||||
play_context=play_context,
|
||||
all_vars=dict(),
|
||||
)
|
||||
|
||||
|
|
|
@ -23,8 +23,8 @@ from ansible.compat.tests import unittest
|
|||
from ansible.compat.tests.mock import patch, MagicMock
|
||||
|
||||
from ansible.errors import AnsibleError, AnsibleParserError
|
||||
from ansible.executor.connection_info import ConnectionInformation
|
||||
from ansible.executor.task_executor import TaskExecutor
|
||||
from ansible.playbook.play_context import PlayContext
|
||||
from ansible.plugins import action_loader
|
||||
|
||||
from units.mock.loader import DictDataLoader
|
||||
|
@ -41,7 +41,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
fake_loader = DictDataLoader({})
|
||||
mock_host = MagicMock()
|
||||
mock_task = MagicMock()
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
mock_shared_loader = MagicMock()
|
||||
new_stdin = None
|
||||
job_vars = dict()
|
||||
|
@ -49,7 +49,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = mock_shared_loader,
|
||||
|
@ -63,7 +63,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task = MagicMock()
|
||||
mock_task._role._role_path = '/path/to/role/foo'
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
|
||||
mock_shared_loader = MagicMock()
|
||||
|
||||
|
@ -74,7 +74,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = mock_shared_loader,
|
||||
|
@ -104,7 +104,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task.loop = 'items'
|
||||
mock_task.loop_args = ['a', 'b', 'c']
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
|
||||
mock_shared_loader = MagicMock()
|
||||
|
||||
|
@ -115,7 +115,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = mock_shared_loader,
|
||||
|
@ -138,7 +138,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task = MagicMock()
|
||||
mock_task.copy.side_effect = _copy
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
|
||||
mock_shared_loader = MagicMock()
|
||||
|
||||
|
@ -149,7 +149,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = mock_shared_loader,
|
||||
|
@ -180,7 +180,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task = MagicMock()
|
||||
mock_task.evaluate_conditional.side_effect = _evaluate_conditional
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
|
||||
mock_shared_loader = None
|
||||
|
||||
|
@ -191,7 +191,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = mock_shared_loader,
|
||||
|
@ -220,9 +220,9 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task.failed_when = None
|
||||
mock_task.post_validate.return_value = None
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_conn_info.post_validate.return_value = None
|
||||
mock_conn_info.update_vars.return_value = None
|
||||
mock_play_context = MagicMock()
|
||||
mock_play_context.post_validate.return_value = None
|
||||
mock_play_context.update_vars.return_value = None
|
||||
|
||||
mock_connection = MagicMock()
|
||||
mock_connection.set_host_overrides.return_value = None
|
||||
|
@ -238,7 +238,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = shared_loader,
|
||||
|
@ -275,7 +275,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task.async = 3
|
||||
mock_task.poll = 1
|
||||
|
||||
mock_conn_info = MagicMock()
|
||||
mock_play_context = MagicMock()
|
||||
|
||||
mock_connection = MagicMock()
|
||||
|
||||
|
@ -289,7 +289,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
host = mock_host,
|
||||
task = mock_task,
|
||||
job_vars = job_vars,
|
||||
connection_info = mock_conn_info,
|
||||
play_context = mock_play_context,
|
||||
new_stdin = new_stdin,
|
||||
loader = fake_loader,
|
||||
shared_loader_obj = shared_loader,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue