pyinfra 2.9.1__py2.py3-none-any.whl → 3.0__py2.py3-none-any.whl

tests/test_cli/test_cli.py

@@ -1,7 +1,6 @@
 from os import path
 from unittest import TestCase
 
-from pyinfra.context import ctx_state
 from pyinfra_cli.main import _main
 
 from ..paramiko_util import PatchSSHTestCase
@@ -17,23 +16,10 @@ class TestCliEagerFlags(TestCase):
         assert result.exit_code == 0, result.stdout
 
 
-class TestDeployCli(PatchSSHTestCase):
-    def setUp(self):
-        ctx_state.reset()
-
-    def test_invalid_deploy(self):
-        result = run_cli(
-            "@local",
-            "not-a-file.py",
-        )
-        assert result.exit_code == 1, result.stdout
-        assert "No deploy file: not-a-file.py" in result.stdout
-
-
 class TestOperationCli(PatchSSHTestCase):
     def test_invalid_operation_module(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "not_a_module.shell",
         )
         assert result.exit_code == 1, result.stdout
@@ -41,7 +27,7 @@ class TestOperationCli(PatchSSHTestCase):
 
     def test_invalid_operation_function(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "server.not_an_operation",
         )
         assert result.exit_code == 1, result.stdout
@@ -49,7 +35,8 @@ class TestOperationCli(PatchSSHTestCase):
 
     def test_deploy_operation(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            "-y",
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "server.shell",
             "echo hi",
         )
@@ -57,7 +44,8 @@ class TestOperationCli(PatchSSHTestCase):
 
     def test_deploy_operation_with_all(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventory_all.py"),
+            "-y",
+            path.join("tests", "test_cli", "deploy", "inventory_all.py"),
             "server.shell",
             "echo hi",
         )
@@ -65,7 +53,8 @@ class TestOperationCli(PatchSSHTestCase):
 
     def test_deploy_operation_json_args(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventory_all.py"),
+            "-y",
+            path.join("tests", "test_cli", "deploy", "inventory_all.py"),
             "server.shell",
             '[["echo hi"], {}]',
         )
@@ -75,7 +64,7 @@ class TestOperationCli(PatchSSHTestCase):
 class TestFactCli(PatchSSHTestCase):
     def test_get_fact(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "fact",
             "server.Os",
         )
@@ -84,7 +73,7 @@ class TestFactCli(PatchSSHTestCase):
 
     def test_get_fact_with_kwargs(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "fact",
             "files.File",
             "path=.",
@@ -92,29 +81,11 @@ class TestFactCli(PatchSSHTestCase):
         assert result.exit_code == 0, result.stdout
         assert '"somehost": null' in result.stdout
 
-    def test_invalid_fact_module(self):
-        result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
-            "fact",
-            "not_a_module.NotAFact",
-        )
-        assert result.exit_code == 1, result.stdout
-        assert "No such module: pyinfra.facts.not_a_module" in result.stdout
-
-    def test_invalid_fact_class(self):
-        result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
-            "fact",
-            "server.NotAFact",
-        )
-        assert result.exit_code == 1, result.stdout
-        assert "No such attribute in module pyinfra.facts.server: NotAFact" in result.stdout
-
 
 class TestExecCli(PatchSSHTestCase):
     def test_exec_command(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--",
             "echo hi",
@@ -123,7 +94,7 @@ class TestExecCli(PatchSSHTestCase):
 
     def test_exec_command_with_options(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--sudo",
             "--sudo-user",
@@ -141,7 +112,7 @@ class TestExecCli(PatchSSHTestCase):
 
     def test_exec_command_with_serial(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--serial",
             "--",
@@ -151,7 +122,7 @@ class TestExecCli(PatchSSHTestCase):
 
     def test_exec_command_with_no_wait(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--no-wait",
             "--",
@@ -161,7 +132,7 @@ class TestExecCli(PatchSSHTestCase):
 
     def test_exec_command_with_debug_operations(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--debug-operations",
             "--",
@@ -171,7 +142,7 @@ class TestExecCli(PatchSSHTestCase):
 
     def test_exec_command_with_debug_facts(self):
         result = run_cli(
-            path.join("tests", "deploy", "inventories", "inventory.py"),
+            path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "exec",
             "--debug-facts",
             "--",
@@ -206,18 +177,16 @@ class TestDirectMainExecution(PatchSSHTestCase):
                 parallel=None,
                 fail_percent=0,
                 dry=False,
+                yes=True,
                 limit=None,
                 no_wait=False,
                 serial=False,
-                winrm_username=None,
-                winrm_password=None,
-                winrm_port=None,
-                winrm_transport=None,
                 shell_executable=None,
                 quiet=False,
                 data=tuple(),
                 debug=False,
                 debug_facts=False,
+                debug_all=False,
                 debug_operations=False,
                 config_filename="config.py",
             )

tests/test_cli/test_cli_deploy.py

@@ -1,32 +1,22 @@
 from os import path
 from random import shuffle
 
-from pyinfra import inventory, state
+from pyinfra import state
 from pyinfra.context import ctx_state
 
 from ..paramiko_util import PatchSSHTestCase
 from .util import run_cli
 
 
-class TestCliDeploy(PatchSSHTestCase):
-    def test_interdependent_deploy(self):
-        ctx_state.reset()
-
-        result = run_cli(
-            "somehost",
-            path.join("tests", "deploy", "deploy_interdependent.py"),
-            f'--chdir={path.join("tests", "deploy")}',
+class TestCliDeployState(PatchSSHTestCase):
+    def _run_cli(self, hosts, filename):
+        return run_cli(
+            "-y",
+            ",".join(hosts),
+            path.join("tests", "test_cli", "deploy", filename),
+            f'--chdir={path.join("tests", "test_cli", "deploy")}',
         )
-        assert result.exit_code == 0, result.stdout
-
-        # Check every operation had commands/changes - this ensures that each
-        # combo (add/remove/add) always had changes.
-        for host, ops in state.ops.items():
-            for _, op in ops.items():
-                assert len(op["commands"]) > 0
 
-
-class TestCliDeployState(PatchSSHTestCase):
     def _assert_op_data(self, correct_op_name_and_host_names):
         op_order = state.get_op_order()
 
@@ -40,7 +30,7 @@ class TestCliDeployState(PatchSSHTestCase):
             op_hash = op_order[i]
             op_meta = state.op_meta[op_hash]
 
-            assert list(op_meta["names"])[0] == correct_op_name
+            assert list(op_meta.names)[0] == correct_op_name
 
             for host in state.inventory:
                 if correct_host_names is True or host.name in correct_host_names:
@@ -92,11 +82,7 @@ class TestCliDeployState(PatchSSHTestCase):
             hosts = ["somehost", "anotherhost", "someotherhost"]
             shuffle(hosts)
 
-            result = run_cli(
-                ",".join(hosts),
-                path.join("tests", "deploy", "deploy.py"),
-                f'--chdir={path.join("tests", "deploy")}',
-            )
+            result = self._run_cli(hosts, "deploy.py")
             assert result.exit_code == 0, result.stdout
 
             self._assert_op_data(correct_op_name_and_host_names)
@@ -121,19 +107,7 @@ class TestCliDeployState(PatchSSHTestCase):
             hosts = ["somehost", "anotherhost", "someotherhost"]
             shuffle(hosts)
 
-            result = run_cli(
-                ",".join(hosts),
-                path.join("tests", "deploy", "deploy_random.py"),
-                f'--chdir={path.join("tests", "deploy")}',
-            )
+            result = self._run_cli(hosts, "deploy_random.py")
             assert result.exit_code == 0, result.stdout
 
             self._assert_op_data(correct_op_name_and_host_names)
-
-            for hostname, expected_fact_count in (
-                ("somehost", 2),
-                ("anotherhost", 0),
-                ("someotherhost", 1),
-            ):
-                host = inventory.get_host(hostname)
-                assert len(host.facts) == expected_fact_count

tests/test_cli/test_cli_exceptions.py

@@ -1,34 +1,27 @@
+import sys
+from os import path
 from unittest import TestCase
 
+import pytest
 from click.testing import CliRunner
 
-from pyinfra_cli.exceptions import CliError
+from pyinfra.api import OperationError
+from pyinfra.api.exceptions import ArgumentTypeError
+from pyinfra_cli.exceptions import CliError, UnexpectedExternalError, WrappedError
 from pyinfra_cli.main import cli
 
+from .util import run_cli
+
 
 class TestCliExceptions(TestCase):
     @classmethod
     def setUpClass(cls):
-        cls.test_cli = CliRunner()
-        cls.old_cli_show = CliError.show
-
-    @classmethod
-    def tearDownClass(cls):
-        CliError.show = cls.old_cli_show
-
-    def setUp(self):
-        self.exception = None
-        CliError.show = lambda e: self.capture_cli_error(e)
-
-    def capture_cli_error(self, e):
-        self.exception = e
-        self.old_cli_show()
+        cls.runner = CliRunner()
 
     def assert_cli_exception(self, args, message):
-        self.test_cli.invoke(cli, args)
-
-        self.assertIsInstance(self.exception, CliError)
-        assert self.exception.message == message
+        result = self.runner.invoke(cli, args, standalone_mode=False)
+        self.assertIsInstance(result.exception, CliError)
+        assert getattr(result.exception, "message") == message
 
     def test_bad_deploy_file(self):
         self.assert_cli_exception(
@@ -53,3 +46,41 @@ class TestCliExceptions(TestCase):
             ["my-server.net", "fact", "server.NotAFact"],
             "No such attribute in module pyinfra.facts.server: NotAFact",
         )
+
+
+class TestCliDeployExceptions(TestCase):
+    def _run_cli(self, hosts, filename):
+        return run_cli(
+            "-y",
+            ",".join(hosts),
+            path.join("tests", "test_cli", "deploy_fails", filename),
+            f'--chdir={path.join("tests", "test_cli", "deploy_fails")}',
+        )
+
+    def test_invalid_argument_type(self):
+        result = self._run_cli(["@local"], "invalid_argument_type.py")
+        assert isinstance(result.exception, WrappedError)
+        assert isinstance(result.exception.exception, ArgumentTypeError)
+        assert (
+            result.exception.exception.args[0]
+            == "Invalid argument `_sudo`:: None is not an instance of bool"
+        )
+
+    def test_invalid_operation_arg(self):
+        result = self._run_cli(["@local"], "invalid_operation_arg.py")
+        assert isinstance(result.exception, UnexpectedExternalError)
+        assert isinstance(result.exception.exception, TypeError)
+        assert result.exception.filename == "invalid_operation_arg.py"
+        assert result.exception.exception.args[0] == "missing a required argument: 'commands'"
+
+    @pytest.mark.skipif(
+        sys.platform.startswith("win"),
+        reason="The operation is not compatible with Windows",
+    )
+    def test_operation_error(self):
+        result = self._run_cli(["@local"], "operation_error.py")
+        assert isinstance(result.exception, WrappedError)
+        assert isinstance(result.exception.exception, OperationError)
+        assert (
+            result.exception.exception.args[0] == "operation_error.py exists and is not a directory"
+        )

tests/test_cli/util.py

@@ -10,7 +10,7 @@ def run_cli(*arguments):
     cwd = getcwd()
     pyinfra.is_cli = True
     runner = CliRunner()
-    result = runner.invoke(cli, arguments)
+    result = runner.invoke(cli, arguments, standalone_mode=False)
     pyinfra.is_cli = False
     chdir(cwd)
     return result

tests/test_connectors/test_chroot.py

@@ -63,11 +63,11 @@ class TestChrootConnector(TestCase):
         self.fake_popen_mock().returncode = 0
         out = host.run_shell_command(
             command,
-            stdin="hello",
-            get_pty=True,
+            _stdin="hello",
+            _get_pty=True,
             print_output=True,
         )
-        assert len(out) == 3
+        assert len(out) == 2
         assert out[0] is True
 
         command = make_unix_command(command).get_raw_value()
@@ -93,8 +93,8 @@ class TestChrootConnector(TestCase):
         command = "echo hoi"
         self.fake_popen_mock().returncode = 1
 
-        out = host.run_shell_command(command, success_exit_codes=[1])
-        assert len(out) == 3
+        out = host.run_shell_command(command, _success_exit_codes=[1])
+        assert len(out) == 2
         assert out[0] is True
 
     def test_run_shell_command_error(self):
@@ -108,7 +108,7 @@ class TestChrootConnector(TestCase):
         self.fake_popen_mock().returncode = 1
 
         out = host.run_shell_command(command)
-        assert len(out) == 3
+        assert len(out) == 2
         assert out[0] is False
 
     def test_put_file(self):

tests/test_connectors/test_docker.py

@@ -83,11 +83,11 @@ class TestDockerConnector(TestCase):
         host.connect()
         out = host.run_shell_command(
             command,
-            stdin="hello",
-            get_pty=True,
+            _stdin="hello",
+            _get_pty=True,
             print_output=True,
         )
-        assert len(out) == 3
+        assert len(out) == 2
         assert out[0] is True
 
         command = make_unix_command(command).get_raw_value()
@@ -112,7 +112,7 @@ class TestDockerConnector(TestCase):
 
         host = inventory.get_host("@docker/not-an-image")
         host.connect()
-        out = host.run_shell_command(command, success_exit_codes=[1])
+        out = host.run_shell_command(command, _success_exit_codes=[1])
         assert out[0] is True
 
     def test_run_shell_command_error(self):

tests/test_connectors/test_dockerssh.py

@@ -7,47 +7,40 @@ from unittest.mock import MagicMock, mock_open, patch
 from pyinfra.api import Config, State
 from pyinfra.api.connect import connect_all
 from pyinfra.api.exceptions import InventoryError, PyinfraError
-from pyinfra.connectors.util import make_unix_command
+from pyinfra.connectors.util import CommandOutput, OutputLine, make_unix_command
 
 from ..util import make_inventory
 
 
 def fake_ssh_docker_shell(
-    state,
-    host,
+    self,
     command,
-    get_pty=False,
-    timeout=None,
-    stdin=None,
-    success_exit_codes=None,
     print_output=False,
     print_input=False,
-    return_combined_output=False,
-    use_sudo_password=False,
     **command_kwargs,
 ):
-    if host.data.ssh_hostname not in ("somehost", "anotherhost"):
-        raise PyinfraError("Invalid host", host.data.ssh_hostname)
+    if str(command) == "docker run -d not-an-image tail -f /dev/null":
+        return (True, CommandOutput([OutputLine("stdout", "containerid")]))
 
-    if command == "docker run -d not-an-image tail -f /dev/null":
-        return (True, ["containerid"], [])
+    if str(command) == "docker commit containerid":
+        return (True, CommandOutput([OutputLine("stdout", "sha256:blahsomerandomstringdata")]))
 
-    if command == "docker commit containerid":
-        return (True, ["sha256:blahsomerandomstringdata"], [])
-
-    if command == "docker rm -f containerid":
-        return (True, [], [])
+    if str(command) == "docker rm -f containerid":
+        return (True, CommandOutput([]))
 
     if str(command).startswith("rm -f"):
-        return (True, [], [])
+        return (True, CommandOutput([]))
+
+    if "$TMPDIR" in str(command):
+        return (True, CommandOutput([]))
 
     # This is a bit messy. But it's easier than trying to swap out a mock
     # when it needs to be used...
     if fake_ssh_docker_shell.custom_command:
-        custom_command, status, stdout, stderr = fake_ssh_docker_shell.custom_command
+        custom_command, status, output = fake_ssh_docker_shell.custom_command
         if str(command) == custom_command:
             fake_ssh_docker_shell.ran_custom_command = True
-            return (status, stdout, stderr)
+            return (status, output)
 
     raise PyinfraError("Invalid Command: {0}".format(command))
 
@@ -59,8 +52,8 @@ def get_docker_command(command):
     return docker_command
 
 
-@patch("pyinfra.connectors.ssh.connect", MagicMock())
-@patch("pyinfra.connectors.ssh.run_shell_command", fake_ssh_docker_shell)
+@patch("pyinfra.connectors.ssh.SSHConnector.connect", MagicMock())
+@patch("pyinfra.connectors.ssh.SSHConnector.run_shell_command", fake_ssh_docker_shell)
 @patch("pyinfra.api.util.open", mock_open(read_data="test!"), create=True)
 class TestDockerSSHConnector(TestCase):
     def setUp(self):
@@ -122,17 +115,17 @@ class TestDockerSSHConnector(TestCase):
 
         command = "echo hi"
 
-        fake_ssh_docker_shell.custom_command = [get_docker_command(command), True, [], []]
+        fake_ssh_docker_shell.custom_command = [get_docker_command(command), True, []]
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
         host.connect()
         out = host.run_shell_command(
             command,
-            stdin="hello",
-            get_pty=True,
+            _stdin="hello",
+            _get_pty=True,
             print_output=True,
         )
-        assert len(out) == 3
+        assert len(out) == 2
         assert out[0] is True
         assert fake_ssh_docker_shell.ran_custom_command
 
@@ -141,47 +134,46 @@ class TestDockerSSHConnector(TestCase):
         state = State(inventory, Config())
 
         command = "echo hi"
-        fake_ssh_docker_shell.custom_command = [get_docker_command(command), False, [], []]
+        fake_ssh_docker_shell.custom_command = [get_docker_command(command), False, []]
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
         host.connect(state)
-        out = host.run_shell_command(command, get_pty=True)
+        out = host.run_shell_command(command, _get_pty=True)
         assert out[0] is False
         assert fake_ssh_docker_shell.ran_custom_command
 
     @patch("pyinfra.connectors.dockerssh.mkstemp", lambda: (None, "local_tempfile"))
     @patch("pyinfra.connectors.docker.os.close", lambda f: None)
-    @patch("pyinfra.connectors.dockerssh.ssh.put_file")
+    @patch("pyinfra.connectors.ssh.SSHConnector.put_file")
     def test_put_file(self, fake_put_file):
         fake_ssh_docker_shell.custom_command = [
             "docker cp remote_tempfile containerid:not-another-file",
             True,
             [],
-            [],
         ]
 
         inventory = make_inventory(hosts=("@dockerssh/somehost:not-an-image",))
-        state = State(inventory, Config())
-        state.get_temp_filename = lambda _: "remote_tempfile"
+        State(inventory, Config())
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
+        host.get_temp_filename = lambda _: "remote_tempfile"
         host.connect()
 
         host.put_file("not-a-file", "not-another-file", print_output=True)
 
         # ensure copy from local to remote host
-        fake_put_file.assert_called_with(state, host, "local_tempfile", "remote_tempfile")
+        fake_put_file.assert_called_with("local_tempfile", "remote_tempfile")
 
         # ensure copy from remote host to remote docker container
         assert fake_ssh_docker_shell.ran_custom_command
 
-    @patch("pyinfra.connectors.dockerssh.ssh.put_file")
+    @patch("pyinfra.connectors.ssh.SSHConnector.put_file")
     def test_put_file_error(self, fake_put_file):
         inventory = make_inventory(hosts=("@dockerssh/somehost:not-an-image",))
-        state = State(inventory, Config())
-        state.get_temp_filename = lambda _: "remote_tempfile"
+        State(inventory, Config())
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
+        host.get_temp_filename = lambda _: "remote_tempfile"
         host.connect()
 
         # SSH error
@@ -193,8 +185,7 @@ class TestDockerSSHConnector(TestCase):
         fake_ssh_docker_shell.custom_command = [
             "docker cp remote_tempfile containerid:not-another-file",
             False,
-            [],
-            ["docker error"],
+            CommandOutput([OutputLine("stderr", "docker error")]),
         ]
         fake_put_file.return_value = True
 
@@ -202,44 +193,42 @@ class TestDockerSSHConnector(TestCase):
             host.put_file("not-a-file", "not-another-file", print_output=True)
         assert str(e.exception) == "docker error"
 
-    @patch("pyinfra.connectors.dockerssh.ssh.get_file")
+    @patch("pyinfra.connectors.ssh.SSHConnector.get_file")
     def test_get_file(self, fake_get_file):
         fake_ssh_docker_shell.custom_command = [
             "docker cp containerid:not-a-file remote_tempfile",
             True,
             [],
-            [],
         ]
 
         inventory = make_inventory(hosts=("@dockerssh/somehost:not-an-image",))
-        state = State(inventory, Config())
-        state.get_temp_filename = lambda _: "remote_tempfile"
+        State(inventory, Config())
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
+        host.get_temp_filename = lambda _: "remote_tempfile"
         host.connect()
 
         host.get_file("not-a-file", "not-another-file", print_output=True)
 
         # ensure copy from local to remote host
-        fake_get_file.assert_called_with(state, host, "remote_tempfile", "not-another-file")
+        fake_get_file.assert_called_with("remote_tempfile", "not-another-file")
 
         # ensure copy from remote host to remote docker container
         assert fake_ssh_docker_shell.ran_custom_command
 
-    @patch("pyinfra.connectors.dockerssh.ssh.get_file")
+    @patch("pyinfra.connectors.ssh.SSHConnector.get_file")
     def test_get_file_error(self, fake_get_file):
         fake_ssh_docker_shell.custom_command = [
             "docker cp containerid:not-a-file remote_tempfile",
             False,
-            [],
-            ["docker error"],
+            CommandOutput([OutputLine("stderr", "docker error")]),
         ]
 
         inventory = make_inventory(hosts=("@dockerssh/somehost:not-an-image",))
-        state = State(inventory, Config())
-        state.get_temp_filename = lambda _: "remote_tempfile"
+        State(inventory, Config())
 
         host = inventory.get_host("@dockerssh/somehost:not-an-image")
+        host.get_temp_filename = lambda _: "remote_tempfile"
         host.connect()
 
         fake_get_file.return_value = True
@@ -253,7 +242,6 @@ class TestDockerSSHConnector(TestCase):
             "docker cp containerid:not-a-file remote_tempfile",
             True,
             [],
-            [],
         ]
         fake_get_file.return_value = False
         with self.assertRaises(IOError) as ex: