summaryrefslogtreecommitdiff
path: root/compose/service.py
diff options
context:
space:
mode:
authorNao YONASHIRO <yonashiro@r.recruit.co.jp>2019-03-15 20:22:14 +0900
committerUlysses Souza <ulysses.souza@docker.com>2019-08-28 17:24:14 +0200
commitcacbcccc0c68bfcd33f4707bd388b1441523c521 (patch)
tree0605f25d41bfdc972d2299519353f962bebc2ebd /compose/service.py
parent4cfa622de88b781448da64578794ec8958fb3cc7 (diff)
Add support to CLI build
This includes can be enabled by setting the env var `COMPOSE_NATIVE_BUILDER=1`. Signed-off-by: Nao YONASHIRO <yonashiro@r.recruit.co.jp> Signed-off-by: Ulysses Souza <ulysses.souza@docker.com>
Diffstat (limited to 'compose/service.py')
-rw-r--r--compose/service.py135
1 files changed, 130 insertions, 5 deletions
diff --git a/compose/service.py b/compose/service.py
index 0db35438..9457bfd2 100644
--- a/compose/service.py
+++ b/compose/service.py
@@ -2,10 +2,13 @@ from __future__ import absolute_import
from __future__ import unicode_literals
import itertools
+import json
import logging
import os
import re
+import subprocess
import sys
+import tempfile
from collections import namedtuple
from collections import OrderedDict
from operator import attrgetter
@@ -338,9 +341,9 @@ class Service(object):
raise OperationFailedError("Cannot create container for service %s: %s" %
(self.name, ex.explanation))
- def ensure_image_exists(self, do_build=BuildAction.none, silent=False):
+ def ensure_image_exists(self, do_build=BuildAction.none, silent=False, cli=False):
if self.can_be_built() and do_build == BuildAction.force:
- self.build()
+ self.build(cli=cli)
return
try:
@@ -356,7 +359,7 @@ class Service(object):
if do_build == BuildAction.skip:
raise NeedsBuildError(self)
- self.build()
+ self.build(cli=cli)
log.warning(
"Image for service {} was built because it did not already exist. To "
"rebuild this image you must use `docker-compose build` or "
@@ -1049,7 +1052,7 @@ class Service(object):
return [build_spec(secret) for secret in self.secrets]
def build(self, no_cache=False, pull=False, force_rm=False, memory=None, build_args_override=None,
- gzip=False, rm=True, silent=False):
+ gzip=False, rm=True, silent=False, cli=False):
output_stream = open(os.devnull, 'w')
if not silent:
output_stream = sys.stdout
@@ -1070,7 +1073,8 @@ class Service(object):
'Impossible to perform platform-targeted builds for API version < 1.35'
)
- build_output = self.client.build(
+ build_image = self.client.build if not cli else cli_build
+ build_output = build_image(
path=path,
tag=self.image_name,
rm=rm,
@@ -1701,3 +1705,124 @@ def rewrite_build_path(path):
path = WINDOWS_LONGPATH_PREFIX + os.path.normpath(path)
return path
+
+
+def cli_build(path, tag=None, quiet=False, fileobj=None,
+ nocache=False, rm=False, timeout=None,
+ custom_context=False, encoding=None, pull=False,
+ forcerm=False, dockerfile=None, container_limits=None,
+ decode=False, buildargs=None, gzip=False, shmsize=None,
+ labels=None, cache_from=None, target=None, network_mode=None,
+ squash=None, extra_hosts=None, platform=None, isolation=None,
+ use_config_proxy=True):
+ """
+ Args:
+ path (str): Path to the directory containing the Dockerfile
+ buildargs (dict): A dictionary of build arguments
+ cache_from (:py:class:`list`): A list of images used for build
+ cache resolution
+ container_limits (dict): A dictionary of limits applied to each
+ container created by the build process. Valid keys:
+ - memory (int): set memory limit for build
+ - memswap (int): Total memory (memory + swap), -1 to disable
+ swap
+ - cpushares (int): CPU shares (relative weight)
+ - cpusetcpus (str): CPUs in which to allow execution, e.g.,
+ ``"0-3"``, ``"0,1"``
+ custom_context (bool): Optional if using ``fileobj``
+ decode (bool): If set to ``True``, the returned stream will be
+ decoded into dicts on the fly. Default ``False``
+ dockerfile (str): path within the build context to the Dockerfile
+ encoding (str): The encoding for a stream. Set to ``gzip`` for
+ compressing
+ extra_hosts (dict): Extra hosts to add to /etc/hosts in building
+ containers, as a mapping of hostname to IP address.
+ fileobj: A file object to use as the Dockerfile. (Or a file-like
+ object)
+ forcerm (bool): Always remove intermediate containers, even after
+ unsuccessful builds
+ isolation (str): Isolation technology used during build.
+ Default: `None`.
+ labels (dict): A dictionary of labels to set on the image
+ network_mode (str): networking mode for the run commands during
+ build
+ nocache (bool): Don't use the cache when set to ``True``
+ platform (str): Platform in the format ``os[/arch[/variant]]``
+ pull (bool): Downloads any updates to the FROM image in Dockerfiles
+ quiet (bool): Whether to return the status
+ rm (bool): Remove intermediate containers. The ``docker build``
+ command now defaults to ``--rm=true``, but we have kept the old
+ default of `False` to preserve backward compatibility
+ shmsize (int): Size of `/dev/shm` in bytes. The size must be
+ greater than 0. If omitted the system uses 64MB
+ squash (bool): Squash the resulting images layers into a
+ single layer.
+ tag (str): A tag to add to the final image
+ target (str): Name of the build-stage to build in a multi-stage
+ Dockerfile
+ timeout (int): HTTP timeout
+ use_config_proxy (bool): If ``True``, and if the docker client
+ configuration file (``~/.docker/config.json`` by default)
+ contains a proxy configuration, the corresponding environment
+ variables will be set in the container being built.
+ Returns:
+ A generator for the build output.
+ """
+ if dockerfile:
+ dockerfile = os.path.join(path, dockerfile)
+ iidfile = tempfile.mktemp()
+
+ command_builder = _CommandBuilder()
+ command_builder.add_params("--build-arg", buildargs)
+ command_builder.add_arg("--file", dockerfile)
+ command_builder.add_flag("--force-rm", forcerm)
+ command_builder.add_arg("--memory", container_limits.get("memory"))
+ command_builder.add_flag("--no-cache", nocache)
+ command_builder.add_flag("--pull", pull)
+ command_builder.add_arg("--iidfile", iidfile)
+ args = command_builder.build([path])
+
+ magic_word = "Successfully built "
+ appear = False
+ with subprocess.Popen(args, stdout=subprocess.PIPE, universal_newlines=True) as p:
+ while True:
+ line = p.stdout.readline()
+ if not line:
+ break
+ if line.startswith(magic_word):
+ appear = True
+ yield json.dumps({"stream": line})
+
+ with open(iidfile) as f:
+ line = f.readline()
+ image_id = line.split(":")[1].strip()
+ os.remove(iidfile)
+
+ if not appear:
+ yield json.dumps({"stream": "{}{}\n".format(magic_word, image_id)})
+
+
+class _CommandBuilder(object):
+ def __init__(self):
+ self._args = ["docker", "build"]
+
+ def add_arg(self, name, value):
+ if value:
+ self._args.extend([name, str(value)])
+
+ def add_flag(self, name, flag):
+ if flag:
+ self._args.extend([name])
+
+ def add_params(self, name, params):
+ if params:
+ for key, val in params.items():
+ self._args.extend([name, "{}={}".format(key, val)])
+
+ def add_list(self, name, values):
+ if values:
+ for val in values:
+ self._args.extend([name, val])
+
+ def build(self, args):
+ return self._args + args