Build option for DockerCompose (#168)

* build option for compose

* if condition for adding build command only

* test build causes --build arg to be added to docker-compose up call

* satisfy flake8

* readability change

* separate subprocess method, and fast (but weaker) test of compose with --build

* hardcode name of method in object mock to satisfy review request

* remove attribute test

* Use more refactorable method name, remove now unused compose conext variable, make test py 3.6 compatible.

* add back compose.build check

Co-authored-by: Alex Loosley <[email protected]>
Co-authored-by: Till Hoffmann <[email protected]>

Author: 3 people

testcontainers/compose.py

@@ -60,12 +60,14 @@ def __init__(
             filepath,
             compose_file_name="docker-compose.yml",
             pull=False,
+            build=False,
             env_file=None):
         self.filepath = filepath
         self.compose_file_names = compose_file_name if isinstance(
             compose_file_name, (list, tuple)
         ) else [compose_file_name]
         self.pull = pull
+        self.build = build
         self.env_file = env_file
 
     def __enter__(self):
@@ -86,14 +88,17 @@ def docker_compose_command(self):
     def start(self):
         if self.pull:
             pull_cmd = self.docker_compose_command() + ['pull']
-            subprocess.call(pull_cmd, cwd=self.filepath)
+            self._call_command(cmd=pull_cmd)
 
         up_cmd = self.docker_compose_command() + ['up', '-d']
-        subprocess.call(up_cmd, cwd=self.filepath)
+        if self.build:
+            up_cmd.append('--build')
+
+        self._call_command(cmd=up_cmd)
 
     def stop(self):
         down_cmd = self.docker_compose_command() + ['down', '-v']
-        subprocess.call(down_cmd, cwd=self.filepath)
+        self._call_command(cmd=down_cmd)
 
     def get_logs(self):
         logs_cmd = self.docker_compose_command() + ["logs"]
@@ -120,6 +125,11 @@ def _get_service_info(self, service, port):
                                     .format(port, service))
         return result
 
+    def _call_command(self, cmd, filepath=None):
+        if filepath is None:
+            filepath = self.filepath
+        subprocess.call(cmd, cwd=filepath)
+
     @wait_container_is_ready(requests.exceptions.ConnectionError)
     def wait_for(self, url):
         requests.get(url)

tests/test_docker_compose.py

@@ -1,3 +1,5 @@
+from unittest.mock import patch
+
 import pytest
 import subprocess
 
@@ -23,6 +25,18 @@ def test_can_pull_images_before_spawning_service_via_compose():
         assert port == "4444"
 
 
+def test_can_build_images_before_spawning_service_via_compose():
+    with patch.object(DockerCompose, "_call_command") as call_mock:
+        with DockerCompose("tests", build=True) as compose:
+            ...
+
+    assert compose.build
+    docker_compose_cmd = call_mock.call_args_list[0][1]["cmd"]
+    assert "docker-compose" in docker_compose_cmd
+    assert "up" in docker_compose_cmd
+    assert "--build" in docker_compose_cmd
+
+
 def test_can_throw_exception_if_no_port_exposed():
     with DockerCompose("tests") as compose:
         with pytest.raises(NoSuchPortExposed):