Merge pull request #579 from GladysNalvarte/expose_cpu

Exposes CPU limit

Author: betatim

repo2docker/app.py

@@ -97,6 +97,28 @@ def _default_log_level(self):
         """
     )
 
+    extra_build_kwargs = Dict(
+        {},
+        help="""
+        extra kwargs to limit CPU quota when building a docker image.
+        Dictionary that allows the user to set the desired runtime flag
+        to configure the amount of access to CPU resources your container has.
+        Reference https://docs.docker.com/config/containers/resource_constraints/#cpu
+        """,
+        config=True
+    )
+
+    extra_run_kwargs = Dict(
+        {},
+        help="""
+        extra kwargs to limit CPU quota when running a docker image.
+        Dictionary that allows the user to set the desired runtime flag
+        to configure the amount of access to CPU resources your container has.
+        Reference https://docs.docker.com/config/containers/resource_constraints/#cpu
+        """,
+        config=True
+    )
+
     default_buildpack = Any(
         PythonBuildPack,
         config=True,
@@ -499,15 +521,19 @@ def start_container(self):
                     'mode': 'rw'
                 }
 
-        container = client.containers.run(
-            self.output_image_spec,
+        run_kwargs = dict(
             publish_all_ports=self.all_ports,
             ports=ports,
             detach=True,
             command=run_cmd,
             volumes=container_volumes,
             environment=self.environment
         )
+
+        run_kwargs.update(self.extra_run_kwargs)
+
+        container = client.containers.run(self.output_image_spec, **run_kwargs)
+
         while container.status == 'created':
             time.sleep(0.5)
             container.reload()
@@ -636,15 +662,16 @@ def build(self):
                                                     self.output_image_spec,
                                                     self.build_memory_limit,
                                                     build_args,
-                                                    self.cache_from):
+                                                    self.cache_from,
+                                                    self.extra_build_kwargs):
                         if 'stream' in l:
                             self.log.info(l['stream'],
                                           extra=dict(phase='building'))
                         elif 'error' in l:
                             self.log.info(l['error'], extra=dict(phase='failure'))
                             raise docker.errors.BuildError(l['error'], build_log='')
                         elif 'status' in l:
-                                self.log.info('Fetching base image...\r',
+                            self.log.info('Fetching base image...\r',
                                               extra=dict(phase='building'))
                         else:
                             self.log.info(json.dumps(l),

repo2docker/buildpacks/base.py

@@ -9,6 +9,8 @@
 import sys
 import xml.etree.ElementTree as ET
 
+from traitlets import Dict
+
 TEMPLATE = r"""
 FROM buildpack-deps:bionic
 
@@ -463,7 +465,7 @@ def render(self):
             appendix=self.appendix,
         )
 
-    def build(self, client, image_spec, memory_limit, build_args, cache_from):
+    def build(self, client, image_spec, memory_limit, build_args, cache_from, extra_build_kwargs):
         tarf = io.BytesIO()
         tar = tarfile.open(fileobj=tarf, mode='w')
         dockerfile_tarinfo = tarfile.TarInfo("Dockerfile")
@@ -503,17 +505,22 @@ def _filter_tar(tar):
         }
         if memory_limit:
             limits['memory'] = memory_limit
-        for line in client.build(
-                fileobj=tarf,
-                tag=image_spec,
-                custom_context=True,
-                buildargs=build_args,
-                decode=True,
-                forcerm=True,
-                rm=True,
-                container_limits=limits,
-                cache_from=cache_from
-        ):
+
+        build_kwargs = dict(
+            fileobj=tarf,
+            tag=image_spec,
+            custom_context=True,
+            buildargs=build_args,
+            decode=True,
+            forcerm=True,
+            rm=True,
+            container_limits=limits,
+            cache_from=cache_from,
+        )
+
+        build_kwargs.update(extra_build_kwargs)
+
+        for line in client.build(**build_kwargs):
             yield line
 
 

repo2docker/buildpacks/docker.py

@@ -19,7 +19,7 @@ def render(self):
         with open(Dockerfile) as f:
             return f.read()
 
-    def build(self, client, image_spec, memory_limit, build_args, cache_from):
+    def build(self, client, image_spec, memory_limit, build_args, cache_from, extra_build_kwargs):
         """Build a Docker image based on the Dockerfile in the source repo."""
         limits = {
             # Always disable memory swap for building, since mostly
@@ -28,15 +28,20 @@ def build(self, client, image_spec, memory_limit, build_args, cache_from):
         }
         if memory_limit:
             limits['memory'] = memory_limit
-        for line in client.build(
-                path=os.getcwd(),
-                dockerfile=self.binder_path(self.dockerfile),
-                tag=image_spec,
-                buildargs=build_args,
-                decode=True,
-                forcerm=True,
-                rm=True,
-                container_limits=limits,
-                cache_from=cache_from
-        ):
+
+        build_kwargs = dict(
+            path=os.getcwd(),
+            dockerfile=self.binder_path(self.dockerfile),
+            tag=image_spec,
+            buildargs=build_args,
+            decode=True,
+            forcerm=True,
+            rm=True,
+            container_limits=limits,
+            cache_from=cache_from
+        )
+
+        build_kwargs.update(extra_build_kwargs)
+
+        for line in client.build(**build_kwargs):
             yield line

repo2docker/buildpacks/legacy/__init__.py

@@ -76,14 +76,14 @@ def get_build_script_files(self):
 
         This currently adds a frozen set of Python requirements to the dict
         of files.
-         
+
         """
         return {
             'legacy/root.frozen.yml': '/tmp/root.frozen.yml',
             'legacy/python3.frozen.yml': '/tmp/python3.frozen.yml',
         }
-            
-    def build(self, client, image_spec, memory_limit, build_args, cache_from):
+
+    def build(self, client, image_spec, memory_limit, build_args, cache_from, extra_build_kwargs):
         """Build a legacy Docker image."""
         with open(self.dockerfile, 'w') as f:
             f.write(self.render())
@@ -94,7 +94,7 @@ def build(self, client, image_spec, memory_limit, build_args, cache_from):
                 env_file,
             )
             shutil.copy(src_path, env_file)
-        return super().build(client, image_spec, memory_limit, build_args, cache_from)
+        return super().build(client, image_spec, memory_limit, build_args, cache_from, extra_build_kwargs)
 
     def detect(self):
         """Check if current repo should be built with the Legacy BuildPack.

tests/unit/test_app.py

@@ -1,6 +1,7 @@
 from tempfile import TemporaryDirectory
 from unittest.mock import patch
 
+import docker
 import escapism
 
 from repo2docker.app import Repo2Docker
@@ -72,3 +73,32 @@ def test_local_dir_image_name(repo_with_content):
     assert app.output_image_spec.startswith(
         'r2d' + escapism.escape(upstream, escape_char='-').lower()
     )
+
+
+def test_build_kwargs(repo_with_content):
+    upstream, sha1 = repo_with_content
+    argv = [upstream]
+    app = make_r2d(argv)
+    app.extra_build_kwargs = {'somekey': "somevalue"}
+
+    with patch.object(docker.APIClient, 'build') as builds:
+        builds.return_value = []
+        app.build()
+    builds.assert_called_once()
+    args, kwargs = builds.call_args
+    assert 'somekey' in kwargs
+    assert kwargs['somekey'] == "somevalue"
+
+
+def test_run_kwargs(repo_with_content):
+    upstream, sha1 = repo_with_content
+    argv = [upstream]
+    app = make_r2d(argv)
+    app.extra_run_kwargs = {'somekey': "somevalue"}
+
+    with patch.object(docker.DockerClient, 'containers') as containers:
+        app.start_container()
+    containers.run.assert_called_once()
+    args, kwargs = containers.run.call_args
+    assert 'somekey' in kwargs
+    assert kwargs['somekey'] == "somevalue"

tests/unit/test_cache_from.py

@@ -17,10 +17,11 @@ def test_cache_from_base(tmpdir):
     fake_log_value = {'stream': 'fake'}
     fake_client = MagicMock(spec=docker.APIClient)
     fake_client.build.return_value = iter([fake_log_value])
+    extra_build_kwargs = {'somekey': 'somevalue'}
 
     # Test base image build pack
     tmpdir.chdir()
-    for line in BaseImage().build(fake_client, 'image-2', '1Gi', {}, cache_from):
+    for line in BaseImage().build(fake_client, 'image-2', '1Gi', {}, cache_from, extra_build_kwargs):
         assert line == fake_log_value
     called_args, called_kwargs = fake_client.build.call_args
     assert 'cache_from' in called_kwargs
@@ -36,13 +37,14 @@ def test_cache_from_docker(tmpdir):
     fake_log_value = {'stream': 'fake'}
     fake_client = MagicMock(spec=docker.APIClient)
     fake_client.build.return_value = iter([fake_log_value])
-
+    extra_build_kwargs = {'somekey': 'somevalue'}
     tmpdir.chdir()
+
     # test dockerfile
     with tmpdir.join("Dockerfile").open('w') as f:
         f.write('FROM scratch\n')
 
-    for line in DockerBuildPack().build(fake_client, 'image-2', '1Gi', {}, cache_from):
+    for line in DockerBuildPack().build(fake_client, 'image-2', '1Gi', {}, cache_from, extra_build_kwargs):
         assert line == fake_log_value
     called_args, called_kwargs = fake_client.build.call_args
     assert 'cache_from' in called_kwargs
@@ -57,12 +59,13 @@ def test_cache_from_legacy(tmpdir):
     fake_log_value = {'stream': 'fake'}
     fake_client = MagicMock(spec=docker.APIClient)
     fake_client.build.return_value = iter([fake_log_value])
+    extra_build_kwargs = {'somekey': 'somevalue'}
 
     # Test legacy docker image
     with tmpdir.join("Dockerfile").open('w') as f:
         f.write('FROM andrewosh/binder-base\n')
 
-    for line in LegacyBinderDockerBuildPack().build(fake_client, 'image-2', '1Gi', {}, cache_from):
+    for line in LegacyBinderDockerBuildPack().build(fake_client, 'image-2', '1Gi', {}, cache_from, extra_build_kwargs):
         assert line == fake_log_value
     called_args, called_kwargs = fake_client.build.call_args
     assert 'cache_from' in called_kwargs