pyinfra 3.3.1__py2.py3-none-any.whl → 3.4.1__py2.py3-none-any.whl

tests/test_api/test_api_operations.py

@@ -426,32 +426,31 @@ class TestNestedOperationsApi(PatchSSHTestCase):
 
         somehost = inventory.get_host("somehost")
 
-        ctx_state.set(state)
-        ctx_host.set(somehost)
-
         pyinfra.is_cli = True
 
-        try:
-            outer_result = server.shell(commands="echo outer")
-            assert outer_result._combined_output is None
+        with ctx_state.use(state):
+            with ctx_host.use(somehost):
+                try:
+                    outer_result = server.shell(commands="echo outer")
+                    assert outer_result._combined_output is None
 
-            def callback():
-                inner_result = server.shell(commands="echo inner")
-                assert inner_result._combined_output is not None
+                    def callback():
+                        inner_result = server.shell(commands="echo inner")
+                        assert inner_result._combined_output is not None
 
-            python.call(function=callback)
+                    python.call(function=callback)
 
-            assert len(state.get_op_order()) == 2
+                    assert len(state.get_op_order()) == 2
 
-            run_ops(state)
+                    run_ops(state)
 
-            assert len(state.get_op_order()) == 3
-            assert state.results[somehost].success_ops == 3
-            assert outer_result._combined_output is not None
+                    assert len(state.get_op_order()) == 3
+                    assert state.results[somehost].success_ops == 3
+                    assert outer_result._combined_output is not None
 
-            disconnect_all(state)
-        finally:
-            pyinfra.is_cli = False
+                    disconnect_all(state)
+                finally:
+                    pyinfra.is_cli = False
 
 
 class TestOperationFailures(PatchSSHTestCase):
@@ -519,40 +518,40 @@ class TestOperationOrdering(PatchSSHTestCase):
         state.current_deploy_filename = __file__
 
         pyinfra.is_cli = True
-        ctx_state.set(state)
 
-        # Add op to both hosts
-        for name in ("anotherhost", "somehost"):
-            ctx_host.set(inventory.get_host(name))
-            server.shell("echo hi")  # note this is called twice but on *the same line*
+        with ctx_state.use(state):
+            # Add op to both hosts
+            for name in ("anotherhost", "somehost"):
+                with ctx_host.use(inventory.get_host(name)):
+                    server.shell("echo hi")  # note this is called twice but on *the same line*
 
-        # Add op to just the second host - using the context modules such that
-        # it replicates a deploy file.
-        ctx_host.set(inventory.get_host("anotherhost"))
-        first_context_hash = server.user("anotherhost_user")._hash
+            # Add op to just the second host - using the context modules such that
+            # it replicates a deploy file.
+            ctx_host.set(inventory.get_host("anotherhost"))
+            first_context_hash = server.user("anotherhost_user")._hash
 
-        # Add op to just the first host - using the context modules such that
-        # it replicates a deploy file.
-        ctx_host.set(inventory.get_host("somehost"))
-        second_context_hash = server.user("somehost_user")._hash
+            # Add op to just the first host - using the context modules such that
+            # it replicates a deploy file.
+            ctx_host.set(inventory.get_host("somehost"))
+            second_context_hash = server.user("somehost_user")._hash
 
-        ctx_state.reset()
-        ctx_host.reset()
+            ctx_state.reset()
+            ctx_host.reset()
 
-        pyinfra.is_cli = False
+            pyinfra.is_cli = False
 
-        print(state.ops)
-        # Ensure there are two ops
-        op_order = state.get_op_order()
-        assert len(op_order) == 3
+            print(state.ops)
+            # Ensure there are two ops
+            op_order = state.get_op_order()
+            assert len(op_order) == 3
 
-        # And that the two ops above were called in the expected order
-        assert op_order[1] == first_context_hash
-        assert op_order[2] == second_context_hash
+            # And that the two ops above were called in the expected order
+            assert op_order[1] == first_context_hash
+            assert op_order[2] == second_context_hash
 
-        # Ensure somehost has two ops and anotherhost only has the one
-        assert len(state.ops[inventory.get_host("somehost")]) == 2
-        assert len(state.ops[inventory.get_host("anotherhost")]) == 2
+            # Ensure somehost has two ops and anotherhost only has the one
+            assert len(state.ops[inventory.get_host("somehost")]) == 2
+            assert len(state.ops[inventory.get_host("anotherhost")]) == 2
 
     # In API mode, pyinfra *overrides* the line numbers such that whenever an
     # operation or deploy is added it is simply appended. This makes sense as

tests/test_cli/test_cli.py

@@ -10,10 +10,10 @@ from .util import run_cli
 class TestCliEagerFlags(TestCase):
     def test_print_help(self):
         result = run_cli("--version")
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
         result = run_cli("--help")
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
 
 class TestOperationCli(PatchSSHTestCase):
@@ -22,7 +22,7 @@ class TestOperationCli(PatchSSHTestCase):
             path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "not_a_module.shell",
         )
-        assert result.exit_code == 1, result.stdout
+        assert result.exit_code == 1, result.stderr
         assert "No such module: not_a_module"
 
     def test_invalid_operation_function(self):
@@ -30,7 +30,7 @@ class TestOperationCli(PatchSSHTestCase):
             path.join("tests", "test_cli", "deploy", "inventories", "inventory.py"),
             "server.not_an_operation",
         )
-        assert result.exit_code == 1, result.stdout
+        assert result.exit_code == 1, result.stderr
         assert "No such operation: server.not_an_operation"
 
     def test_deploy_operation(self):
@@ -40,7 +40,7 @@ class TestOperationCli(PatchSSHTestCase):
             "server.shell",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_deploy_operation_with_all(self):
         result = run_cli(
@@ -49,7 +49,7 @@ class TestOperationCli(PatchSSHTestCase):
             "server.shell",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_deploy_operation_json_args(self):
         result = run_cli(
@@ -58,7 +58,7 @@ class TestOperationCli(PatchSSHTestCase):
             "server.shell",
             '[["echo hi"], {}]',
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
 
 class TestFactCli(PatchSSHTestCase):
@@ -68,8 +68,8 @@ class TestFactCli(PatchSSHTestCase):
             "fact",
             "server.Os",
         )
-        assert result.exit_code == 0, result.stdout
-        assert '"somehost": null' in result.stdout
+        assert result.exit_code == 0, result.stderr
+        assert '"somehost": null' in result.stderr
 
     def test_get_fact_with_kwargs(self):
         result = run_cli(
@@ -78,8 +78,8 @@ class TestFactCli(PatchSSHTestCase):
             "files.File",
             "path=.",
         )
-        assert result.exit_code == 0, result.stdout
-        assert '"somehost": null' in result.stdout
+        assert result.exit_code == 0, result.stderr
+        assert '"somehost": null' in result.stderr
 
 
 class TestExecCli(PatchSSHTestCase):
@@ -90,7 +90,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_exec_command_with_options(self):
         result = run_cli(
@@ -108,7 +108,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_exec_command_with_serial(self):
         result = run_cli(
@@ -118,7 +118,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_exec_command_with_no_wait(self):
         result = run_cli(
@@ -128,7 +128,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_exec_command_with_debug_operations(self):
         result = run_cli(
@@ -138,7 +138,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
     def test_exec_command_with_debug_facts(self):
         result = run_cli(
@@ -148,7 +148,7 @@ class TestExecCli(PatchSSHTestCase):
             "--",
             "echo hi",
         )
-        assert result.exit_code == 0, result.stdout
+        assert result.exit_code == 0, result.stderr
 
 
 class TestDirectMainExecution(PatchSSHTestCase):

tests/test_cli/test_cli_inventory.py

@@ -80,7 +80,7 @@ class TestCliInventory(PatchSSHTestCase):
         assert result.exit_code == 0, result.stdout
         assert (
             'Ignoring variable "_hosts" in inventory file since it starts with a leading underscore'
-            in result.stdout
+            in result.stderr
         )
         assert inventory.hosts == {}
 
@@ -97,9 +97,9 @@ class TestCliInventory(PatchSSHTestCase):
         )
 
         assert result.exit_code == 0, result.stdout
-        assert 'Ignoring variable "dict_hosts" in inventory file' in result.stdout, result.stdout
+        assert 'Ignoring variable "dict_hosts" in inventory file' in result.stderr, result.stdout
         assert (
-            'Ignoring variable "generator_hosts" in inventory file' in result.stdout
+            'Ignoring variable "generator_hosts" in inventory file' in result.stderr
         ), result.stdout
         assert inventory.hosts == {}
 
@@ -115,5 +115,5 @@ class TestCliInventory(PatchSSHTestCase):
         )
 
         assert result.exit_code == 0, result.stdout
-        assert 'Ignoring host group "issue_662"' in result.stdout, result.stdout
+        assert 'Ignoring host group "issue_662"' in result.stderr, result.stdout
         assert inventory.hosts == {}

tests/test_cli/test_context_objects.py

@@ -5,8 +5,8 @@ from pyinfra.api import Host, Inventory
 from pyinfra.context import ctx_host, ctx_inventory
 
 
-def _create_host():
-    return Host(None, None, None, None)
+def _create_host(name: str = "host"):
+    return Host(name, Inventory(([name], {})), None, None)
 
 
 class TestHostContextObject(TestCase):
@@ -15,44 +15,44 @@ class TestHostContextObject(TestCase):
 
     def test_context_host_eq(self):
         host_obj = _create_host()
-        ctx_host.set(host_obj)
-        assert host == host_obj
+        with ctx_host.use(host_obj):
+            assert host == host_obj
 
     def test_context_host_repr(self):
-        host_obj = _create_host()
-        ctx_host.set(host_obj)
-        assert repr(host) == "ContextObject(Host):Host(None)"
+        host_obj = _create_host("somehost")
+        with ctx_host.use(host_obj):
+            assert repr(host) == "ContextObject(Host):Host(somehost)"
 
     def test_context_host_str(self):
         host_obj = _create_host()
-        ctx_host.set(host_obj)
-        assert str(host_obj) == "None"
+        with ctx_host.use(host_obj):
+            assert str(host_obj) == "host"
 
     def test_context_host_attr(self):
         host_obj = _create_host()
-        ctx_host.set(host_obj)
 
         with self.assertRaises(AttributeError):
             host_obj.hello
 
-        setattr(host, "hello", "world")
-        assert host_obj.hello == host.hello
+        with ctx_host.use(host_obj):
+            setattr(host, "hello", "world")
+            assert host_obj.hello == host.hello
 
     def test_context_host_class_attr(self):
         host_obj = _create_host()
-        ctx_host.set(host_obj)
-        assert ctx_host.isset() is True
 
-        with self.assertRaises(AttributeError):
-            host_obj.hello
+        with ctx_host.use(host_obj):
+            assert ctx_host.isset() is True
+
+            with self.assertRaises(AttributeError):
+                host_obj.hello
 
-        setattr(Host, "hello", "class_world")
-        setattr(host_obj, "hello", "instance_world")
+            setattr(Host, "hello", "class_world")
+            setattr(host_obj, "hello", "instance_world")
 
-        assert host.hello == host.hello
+            assert host.hello == host.hello
 
         # Reset and check fallback to class variable
-        ctx_host.reset()
         assert ctx_host.isset() is False
         assert host.hello == "class_world"
 
@@ -60,14 +60,14 @@ class TestHostContextObject(TestCase):
 class TestInventoryContextObject(TestCase):
     def test_context_inventory_len(self):
         inventory_obj = Inventory(("host", "anotherhost"))
-        ctx_inventory.set(inventory_obj)
-        assert ctx_inventory.isset() is True
 
-        assert len(inventory) == len(inventory_obj)
+        with ctx_inventory.use(inventory_obj):
+            assert ctx_inventory.isset() is True
+            assert len(inventory) == len(inventory_obj)
 
     def test_context_inventory_iter(self):
         inventory_obj = Inventory(("host", "anotherhost"))
-        ctx_inventory.set(inventory_obj)
-        assert ctx_inventory.isset() is True
 
-        assert list(iter(inventory)) == list(iter(inventory_obj))
+        with ctx_inventory.use(inventory_obj):
+            assert ctx_inventory.isset() is True
+            assert list(iter(inventory)) == list(iter(inventory_obj))

tests/test_connectors/test_docker.py

@@ -11,26 +11,13 @@ from pyinfra.connectors.util import make_unix_command
 from ..util import make_inventory
 
 
-def fake_docker_shell(command, splitlines=None):
-    if command == "docker run -d not-an-image tail -f /dev/null":
-        return ["containerid"]
-
-    if command == "docker commit containerid":
-        return ["sha256:blahsomerandomstringdata"]
+class TestContainerConnector(TestCase):
+    # we use this class as a template to prevent the decorators from being invoked twice on
+    # the podman test class (since it needs to override fake_docker_shell)
+    __test__ = False  # this class should not be tested.
+    cli_cmd = "docker"
+    connector_name = "docker"
 
-    if command == "docker rm -f containerid":
-        return []
-
-    raise PyinfraError("Invalid command: {0}".format(command))
-
-
-@patch("pyinfra.connectors.docker.local.shell", fake_docker_shell)
-@patch("pyinfra.connectors.docker.mkstemp", lambda: (None, "__tempfile__"))
-@patch("pyinfra.connectors.docker.os.remove", lambda f: None)
-@patch("pyinfra.connectors.docker.os.close", lambda f: None)
-@patch("pyinfra.connectors.docker.open", mock_open(read_data="test!"), create=True)
-@patch("pyinfra.api.util.open", mock_open(read_data="test!"), create=True)
-class TestDockerConnector(TestCase):
     def setUp(self):
         self.fake_popen_patch = patch("pyinfra.connectors.util.Popen")
         self.fake_popen_mock = self.fake_popen_patch.start()
@@ -40,46 +27,46 @@ class TestDockerConnector(TestCase):
 
     def test_missing_image(self):
         with self.assertRaises(InventoryError):
-            make_inventory(hosts=("@docker",))
+            make_inventory(hosts=(f"@{self.connector_name}",))
 
     def test_user_provided_container_id(self):
         inventory = make_inventory(
-            hosts=(("@docker/not-an-image", {"docker_container_id": "abc"}),),
+            hosts=((f"@{self.connector_name}/not-an-image", {"docker_container_id": "abc"}),),
         )
         State(inventory, Config())
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
         assert host.data.docker_container_id == "abc"
 
     def test_connect_all(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         state = State(inventory, Config())
         connect_all(state)
         assert len(state.active_hosts) == 1
 
     def test_connect_all_error(self):
-        inventory = make_inventory(hosts=("@docker/a-broken-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/a-broken-image",))
         state = State(inventory, Config())
 
         with self.assertRaises(PyinfraError):
             connect_all(state)
 
     def test_connect_disconnect_host(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         state = State(inventory, Config())
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect(reason=True)
         assert len(state.active_hosts) == 0
         host.disconnect()
 
     def test_run_shell_command(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
         command = "echo hi"
         self.fake_popen_mock().returncode = 0
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
         out = host.run_shell_command(
             command,
@@ -92,7 +79,7 @@ class TestDockerConnector(TestCase):
 
         command = make_unix_command(command).get_raw_value()
         command = shlex.quote(command)
-        docker_command = "docker exec -it containerid sh -c {0}".format(command)
+        docker_command = f"{self.cli_cmd} exec -it containerid sh -c {command}"
         shell_command = make_unix_command(docker_command).get_raw_value()
 
         self.fake_popen_mock.assert_called_with(
@@ -104,34 +91,34 @@ class TestDockerConnector(TestCase):
         )
 
     def test_run_shell_command_success_exit_codes(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
         command = "echo hi"
         self.fake_popen_mock().returncode = 1
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
         out = host.run_shell_command(command, _success_exit_codes=[1])
         assert out[0] is True
 
     def test_run_shell_command_error(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         state = State(inventory, Config())
 
         command = "echo hi"
         self.fake_popen_mock().returncode = 1
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect(state)
         out = host.run_shell_command(command)
         assert out[0] is False
 
     def test_put_file(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
 
         fake_process = MagicMock(returncode=0)
@@ -140,7 +127,7 @@ class TestDockerConnector(TestCase):
         host.put_file("not-a-file", "not-another-file", print_output=True)
 
         self.fake_popen_mock.assert_called_with(
-            "sh -c 'docker cp __tempfile__ containerid:not-another-file'",
+            f"sh -c '{self.cli_cmd} cp __tempfile__ containerid:not-another-file'",
             shell=True,
             stdout=PIPE,
             stderr=PIPE,
@@ -148,10 +135,10 @@ class TestDockerConnector(TestCase):
         )
 
     def test_put_file_error(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
 
         fake_process = MagicMock(returncode=1)
@@ -161,10 +148,10 @@ class TestDockerConnector(TestCase):
             host.put_file("not-a-file", "not-another-file", print_output=True)
 
     def test_get_file(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
 
         fake_process = MagicMock(returncode=0)
@@ -173,7 +160,7 @@ class TestDockerConnector(TestCase):
         host.get_file("not-a-file", "not-another-file", print_output=True)
 
         self.fake_popen_mock.assert_called_with(
-            "sh -c 'docker cp containerid:not-a-file __tempfile__'",
+            f"sh -c '{self.cli_cmd} cp containerid:not-a-file __tempfile__'",
             shell=True,
             stdout=PIPE,
             stderr=PIPE,
@@ -181,10 +168,10 @@ class TestDockerConnector(TestCase):
         )
 
     def test_get_file_error(self):
-        inventory = make_inventory(hosts=("@docker/not-an-image",))
+        inventory = make_inventory(hosts=(f"@{self.connector_name}/not-an-image",))
         State(inventory, Config())
 
-        host = inventory.get_host("@docker/not-an-image")
+        host = inventory.get_host(f"@{self.connector_name}/not-an-image")
         host.connect()
 
         fake_process = MagicMock(returncode=1)
@@ -192,3 +179,56 @@ class TestDockerConnector(TestCase):
 
         with self.assertRaises(IOError):
             host.get_file("not-a-file", "not-another-file", print_output=True)
+
+
+# Reuse the container testing code for docker and podman
+
+
+def fake_docker_shell(command, splitlines=None):
+    if command == "docker run -d not-an-image tail -f /dev/null":
+        return ["containerid"]
+
+    if command == "docker commit containerid":
+        return ["sha256:blahsomerandomstringdata"]
+
+    if command == "docker rm -f containerid":
+        return []
+
+    raise PyinfraError("Invalid command: {0}".format(command))
+
+
+@patch("pyinfra.connectors.docker.local.shell", fake_docker_shell)
+@patch("pyinfra.connectors.docker.mkstemp", lambda: (None, "__tempfile__"))
+@patch("pyinfra.connectors.docker.os.remove", lambda f: None)
+@patch("pyinfra.connectors.docker.os.close", lambda f: None)
+@patch("pyinfra.connectors.docker.open", mock_open(read_data="test!"), create=True)
+@patch("pyinfra.api.util.open", mock_open(read_data="test!"), create=True)
+class TestDocker2Connector(TestContainerConnector):
+    __test__ = True
+    cli_cmd = "docker"
+    connector_name = "docker"
+
+
+def fake_podman_shell(command, splitlines=None):
+    if command == "podman run -d not-an-image tail -f /dev/null":
+        return ["containerid"]
+
+    if command == "podman commit containerid":
+        return ["sha256:blahsomerandomstringdata"]
+
+    if command == "podman rm -f containerid":
+        return []
+
+    raise PyinfraError("Invalid command: {0}".format(command))
+
+
+@patch("pyinfra.connectors.docker.local.shell", fake_podman_shell)
+@patch("pyinfra.connectors.docker.mkstemp", lambda: (None, "__tempfile__"))
+@patch("pyinfra.connectors.docker.os.remove", lambda f: None)
+@patch("pyinfra.connectors.docker.os.close", lambda f: None)
+@patch("pyinfra.connectors.docker.open", mock_open(read_data="test!"), create=True)
+@patch("pyinfra.api.util.open", mock_open(read_data="test!"), create=True)
+class TestPodmanConnector(TestContainerConnector):
+    __test__ = True
+    cli_cmd = "podman"
+    connector_name = "podman"