Merge pull request #165 from shanejbrown/convert-to-python-on-whales-part1

Replace stop/start with python-on-whales

Author: shanejbrown

buildrunner/docker/runner.py

@@ -23,9 +23,11 @@
 from docker.utils import compare_version
 from retry import retry
 import docker.errors
+import python_on_whales
 import six
 import timeout_decorator
 
+from buildrunner.config import BuildRunnerConfig
 from buildrunner.docker import (
     new_client,
     force_remove_container,
@@ -131,6 +133,10 @@ def __init__(self, image_config, dockerd_url=None, log=None):
             if log:
                 log.write("\nImage pulled successfully\n")
 
+        self.use_docker_py = (
+            BuildRunnerConfig.get_instance().run_config.use_legacy_builder
+        )
+
     def start(
         self,
         shell="/bin/sh",
@@ -236,7 +242,10 @@ def start(
 
         # start the container
         self.container = self.docker_client.create_container(self.image_name, **kwargs)
-        self.docker_client.start(self.container["Id"])
+        if self.use_docker_py:
+            self.docker_client.start(self.container["Id"])
+        else:
+            python_on_whales.docker.start(self.container["Id"])
 
         # run any supplied provisioners
         if provisioners:
@@ -254,10 +263,13 @@ def stop(self):
         Stop the backing Docker container.
         """
         if self.container:
-            self.docker_client.stop(
-                self.container["Id"],
-                timeout=0,
-            )
+            if self.use_docker_py:
+                self.docker_client.stop(
+                    self.container["Id"],
+                    timeout=0,
+                )
+            else:
+                python_on_whales.docker.stop(self.container["Id"], time=0)
 
     def cleanup(self):
         """

tests/test_caching.py

@@ -34,14 +34,19 @@ def fixture_setup_runner():
         "docker.io/ubuntu:19.04",
         pull_image=False,
     )
-    runner = DockerRunner(
-        image_config=image_config,
-    )
-    runner.start(working_dir="/root")
+    with mock.patch(
+        "buildrunner.docker.runner.BuildRunnerConfig.get_instance"
+    ) as mock_build_runner_config:
+        #  Set to use docker-py to be used over python on whales
+        mock_build_runner_config.run_config.use_legacy_builder.return_value = True
+        runner = DockerRunner(
+            image_config=image_config,
+        )
+        runner.start(working_dir="/root")
 
-    yield runner
+        yield runner
 
-    runner.cleanup()
+        runner.cleanup()
 
 
 @pytest.fixture(name="log_output")