pyinfra 3.3__py2.py3-none-any.whl → 3.4__py2.py3-none-any.whl

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"