2016-06-01 06:25:14 +02:00
|
|
|
#!/usr/bin/env python2
|
|
|
|
#
|
|
|
|
# Docker controlling module
|
|
|
|
#
|
|
|
|
# Copyright (c) 2016 Red Hat Inc.
|
|
|
|
#
|
|
|
|
# Authors:
|
|
|
|
# Fam Zheng <famz@redhat.com>
|
|
|
|
#
|
|
|
|
# This work is licensed under the terms of the GNU GPL, version 2
|
|
|
|
# or (at your option) any later version. See the COPYING file in
|
|
|
|
# the top-level directory.
|
|
|
|
|
2018-06-08 14:29:43 +02:00
|
|
|
from __future__ import print_function
|
2016-06-01 06:25:14 +02:00
|
|
|
import os
|
|
|
|
import sys
|
2017-08-25 17:57:31 +02:00
|
|
|
sys.path.append(os.path.join(os.path.dirname(__file__),
|
|
|
|
'..', '..', 'scripts'))
|
|
|
|
import argparse
|
2016-06-01 06:25:14 +02:00
|
|
|
import subprocess
|
|
|
|
import json
|
|
|
|
import hashlib
|
|
|
|
import atexit
|
|
|
|
import uuid
|
|
|
|
import tempfile
|
2016-07-19 15:20:37 +02:00
|
|
|
import re
|
2016-09-21 05:49:27 +02:00
|
|
|
import signal
|
2016-07-19 15:20:40 +02:00
|
|
|
from tarfile import TarFile, TarInfo
|
2018-06-20 16:45:42 +02:00
|
|
|
try:
|
|
|
|
from StringIO import StringIO
|
|
|
|
except ImportError:
|
|
|
|
from io import StringIO
|
2016-07-19 15:20:36 +02:00
|
|
|
from shutil import copy, rmtree
|
2017-02-20 11:51:36 +01:00
|
|
|
from pwd import getpwuid
|
2016-06-01 06:25:14 +02:00
|
|
|
|
2016-09-06 22:05:44 +02:00
|
|
|
|
2017-03-06 21:55:20 +01:00
|
|
|
FILTERED_ENV_NAMES = ['ftp_proxy', 'http_proxy', 'https_proxy']
|
|
|
|
|
|
|
|
|
2016-09-06 22:05:44 +02:00
|
|
|
DEVNULL = open(os.devnull, 'wb')
|
|
|
|
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
def _text_checksum(text):
|
|
|
|
"""Calculate a digest string unique to the text content"""
|
|
|
|
return hashlib.sha1(text).hexdigest()
|
|
|
|
|
2017-06-02 20:56:09 +02:00
|
|
|
def _file_checksum(filename):
|
|
|
|
return _text_checksum(open(filename, 'rb').read())
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
def _guess_docker_command():
|
|
|
|
""" Guess a working docker command or raise exception if not found"""
|
|
|
|
commands = [["docker"], ["sudo", "-n", "docker"]]
|
|
|
|
for cmd in commands:
|
docker: Handle exceptions when looking for docker command
When trying to run docker tests on a host without the docker
command, we get the following Python backtrace:
$ make docker-test-quick@centos6 V=1
.../qemu/tests/docker/docker.py build qemu:centos6 .../qemu/tests/docker/dockerfiles/centos6.docker
Traceback (most recent call last):
File ".../qemu/tests/docker/docker.py", line 339, in <module>
sys.exit(main())
File ".../qemu/tests/docker/docker.py", line 336, in main
return args.cmdobj.run(args, argv)
File ".../qemu/tests/docker/docker.py", line 231, in run
dkr = Docker()
File ".../qemu/tests/docker/docker.py", line 98, in __init__
self._command = _guess_docker_command()
File ".../qemu/tests/docker/docker.py", line 41, in _guess_docker_command
stdout=DEVNULL, stderr=DEVNULL) == 0:
File "/usr/lib64/python2.7/subprocess.py", line 523, in call
return Popen(*popenargs, **kwargs).wait()
File "/usr/lib64/python2.7/subprocess.py", line 711, in __init__
errread, errwrite)
File "/usr/lib64/python2.7/subprocess.py", line 1343, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory
.../qemu/tests/docker/Makefile.include:47: recipe for target 'docker-image-centos6' failed
make: *** [docker-image-centos6] Error 1
Change _guess_docker_command() to handle OSError exceptions
raised by subprocess.call(), so we will keep looking for other
commands and print a better error message.
New output will be:
$ make docker-test-quick@centos6 V=1
.../qemu/tests/docker/docker.py build qemu:centos6 .../qemu/tests/docker/dockerfiles/centos6.docker
Traceback (most recent call last):
File ".../qemu/tests/docker/docker.py", line 343, in <module>
sys.exit(main())
File ".../qemu/tests/docker/docker.py", line 340, in main
return args.cmdobj.run(args, argv)
File ".../qemu/tests/docker/docker.py", line 235, in run
dkr = Docker()
File ".../qemu/tests/docker/docker.py", line 102, in __init__
self._command = _guess_docker_command()
File ".../qemu/tests/docker/docker.py", line 49, in _guess_docker_command
commands_txt)
Exception: Cannot find working docker command. Tried:
docker
sudo -n docker
.../qemu/tests/docker/Makefile.include:47: recipe for target 'docker-image-centos6' failed
make: *** [docker-image-centos6] Error 1
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Message-Id: <1474369559-16903-1-git-send-email-ehabkost@redhat.com>
[exceptions.OSError -> OSError and drop the import. - Fam]
Signed-off-by: Fam Zheng <famz@redhat.com>
2016-09-20 13:05:59 +02:00
|
|
|
try:
|
2018-06-18 12:14:40 +02:00
|
|
|
# docker version will return the client details in stdout
|
|
|
|
# but still report a status of 1 if it can't contact the daemon
|
|
|
|
if subprocess.call(cmd + ["version"],
|
docker: Handle exceptions when looking for docker command
When trying to run docker tests on a host without the docker
command, we get the following Python backtrace:
$ make docker-test-quick@centos6 V=1
.../qemu/tests/docker/docker.py build qemu:centos6 .../qemu/tests/docker/dockerfiles/centos6.docker
Traceback (most recent call last):
File ".../qemu/tests/docker/docker.py", line 339, in <module>
sys.exit(main())
File ".../qemu/tests/docker/docker.py", line 336, in main
return args.cmdobj.run(args, argv)
File ".../qemu/tests/docker/docker.py", line 231, in run
dkr = Docker()
File ".../qemu/tests/docker/docker.py", line 98, in __init__
self._command = _guess_docker_command()
File ".../qemu/tests/docker/docker.py", line 41, in _guess_docker_command
stdout=DEVNULL, stderr=DEVNULL) == 0:
File "/usr/lib64/python2.7/subprocess.py", line 523, in call
return Popen(*popenargs, **kwargs).wait()
File "/usr/lib64/python2.7/subprocess.py", line 711, in __init__
errread, errwrite)
File "/usr/lib64/python2.7/subprocess.py", line 1343, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory
.../qemu/tests/docker/Makefile.include:47: recipe for target 'docker-image-centos6' failed
make: *** [docker-image-centos6] Error 1
Change _guess_docker_command() to handle OSError exceptions
raised by subprocess.call(), so we will keep looking for other
commands and print a better error message.
New output will be:
$ make docker-test-quick@centos6 V=1
.../qemu/tests/docker/docker.py build qemu:centos6 .../qemu/tests/docker/dockerfiles/centos6.docker
Traceback (most recent call last):
File ".../qemu/tests/docker/docker.py", line 343, in <module>
sys.exit(main())
File ".../qemu/tests/docker/docker.py", line 340, in main
return args.cmdobj.run(args, argv)
File ".../qemu/tests/docker/docker.py", line 235, in run
dkr = Docker()
File ".../qemu/tests/docker/docker.py", line 102, in __init__
self._command = _guess_docker_command()
File ".../qemu/tests/docker/docker.py", line 49, in _guess_docker_command
commands_txt)
Exception: Cannot find working docker command. Tried:
docker
sudo -n docker
.../qemu/tests/docker/Makefile.include:47: recipe for target 'docker-image-centos6' failed
make: *** [docker-image-centos6] Error 1
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Message-Id: <1474369559-16903-1-git-send-email-ehabkost@redhat.com>
[exceptions.OSError -> OSError and drop the import. - Fam]
Signed-off-by: Fam Zheng <famz@redhat.com>
2016-09-20 13:05:59 +02:00
|
|
|
stdout=DEVNULL, stderr=DEVNULL) == 0:
|
|
|
|
return cmd
|
|
|
|
except OSError:
|
|
|
|
pass
|
2016-06-01 06:25:14 +02:00
|
|
|
commands_txt = "\n".join([" " + " ".join(x) for x in commands])
|
|
|
|
raise Exception("Cannot find working docker command. Tried:\n%s" % \
|
|
|
|
commands_txt)
|
|
|
|
|
2017-06-02 20:56:07 +02:00
|
|
|
def _copy_with_mkdir(src, root_dir, sub_path='.'):
|
2016-07-19 15:20:37 +02:00
|
|
|
"""Copy src into root_dir, creating sub_path as needed."""
|
|
|
|
dest_dir = os.path.normpath("%s/%s" % (root_dir, sub_path))
|
|
|
|
try:
|
|
|
|
os.makedirs(dest_dir)
|
|
|
|
except OSError:
|
|
|
|
# we can safely ignore already created directories
|
|
|
|
pass
|
|
|
|
|
|
|
|
dest_file = "%s/%s" % (dest_dir, os.path.basename(src))
|
|
|
|
copy(src, dest_file)
|
|
|
|
|
|
|
|
|
|
|
|
def _get_so_libs(executable):
|
|
|
|
"""Return a list of libraries associated with an executable.
|
|
|
|
|
|
|
|
The paths may be symbolic links which would need to be resolved to
|
|
|
|
ensure theright data is copied."""
|
|
|
|
|
|
|
|
libs = []
|
|
|
|
ldd_re = re.compile(r"(/.*/)(\S*)")
|
|
|
|
try:
|
|
|
|
ldd_output = subprocess.check_output(["ldd", executable])
|
|
|
|
for line in ldd_output.split("\n"):
|
|
|
|
search = ldd_re.search(line)
|
|
|
|
if search and len(search.groups()) == 2:
|
|
|
|
so_path = search.groups()[0]
|
|
|
|
so_lib = search.groups()[1]
|
|
|
|
libs.append("%s/%s" % (so_path, so_lib))
|
|
|
|
except subprocess.CalledProcessError:
|
2018-06-08 14:29:43 +02:00
|
|
|
print("%s had no associated libraries (static build?)" % (executable))
|
2016-07-19 15:20:37 +02:00
|
|
|
|
|
|
|
return libs
|
|
|
|
|
|
|
|
def _copy_binary_with_libs(src, dest_dir):
|
|
|
|
"""Copy a binary executable and all its dependant libraries.
|
|
|
|
|
|
|
|
This does rely on the host file-system being fairly multi-arch
|
|
|
|
aware so the file don't clash with the guests layout."""
|
|
|
|
|
|
|
|
_copy_with_mkdir(src, dest_dir, "/usr/bin")
|
|
|
|
|
|
|
|
libs = _get_so_libs(src)
|
|
|
|
if libs:
|
|
|
|
for l in libs:
|
|
|
|
so_path = os.path.dirname(l)
|
|
|
|
_copy_with_mkdir(l , dest_dir, so_path)
|
|
|
|
|
docker: Improved image checksum
When a base image locally defined by QEMU, such as in the debian images,
is updated, the dockerfile checksum mechanism in docker.py still skips
updating the derived image, because it only looks at the literal content
of the dockerfile, without considering changes to the base image.
For example we have a recent fix e58c1f9b35e81 that fixed
debian-win64-cross by updating its base image, debian8-mxe, but due to
above "feature" of docker.py the image in question is automatically NOT
rebuilt unless you add NOCACHE=1. It is noticed on Shippable:
https://app.shippable.com/github/qemu/qemu/runs/541/2/console
because after the fix is merged, the error still occurs, and the log
shows the container image is, as explained above, not updated.
This is because at the time docker.py was written, there wasn't any
dependencies between QEMU's docker images.
Now improve this to preprocess any "FROM qemu:*" directives in the
dockerfiles while doing checksum, and inline the base image's dockerfile
content, recursively. This ensures any changes on the depended _QEMU_
images are taken into account.
This means for external images that we expect to retrieve from docker
registries, we still do it as before. It is not perfect, because
registry images can get updated too. Technically we could substitute the
image name with its hex ID as obtained with $(docker images $IMAGE
--format="{{.Id}}"), but --format is not supported by RHEL 7, so leave
it for now.
Reported-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Signed-off-by: Fam Zheng <famz@redhat.com>
Message-Id: <20171103131229.4737-1-famz@redhat.com>
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Fam Zheng <famz@redhat.com>
2017-11-03 14:12:29 +01:00
|
|
|
def _read_qemu_dockerfile(img_name):
|
|
|
|
df = os.path.join(os.path.dirname(__file__), "dockerfiles",
|
|
|
|
img_name + ".docker")
|
|
|
|
return open(df, "r").read()
|
|
|
|
|
|
|
|
def _dockerfile_preprocess(df):
|
|
|
|
out = ""
|
|
|
|
for l in df.splitlines():
|
|
|
|
if len(l.strip()) == 0 or l.startswith("#"):
|
|
|
|
continue
|
|
|
|
from_pref = "FROM qemu:"
|
|
|
|
if l.startswith(from_pref):
|
|
|
|
# TODO: Alternatively we could replace this line with "FROM $ID"
|
|
|
|
# where $ID is the image's hex id obtained with
|
|
|
|
# $ docker images $IMAGE --format="{{.Id}}"
|
|
|
|
# but unfortunately that's not supported by RHEL 7.
|
|
|
|
inlining = _read_qemu_dockerfile(l[len(from_pref):])
|
|
|
|
out += _dockerfile_preprocess(inlining)
|
|
|
|
continue
|
|
|
|
out += l + "\n"
|
|
|
|
return out
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
class Docker(object):
|
|
|
|
""" Running Docker commands """
|
|
|
|
def __init__(self):
|
|
|
|
self._command = _guess_docker_command()
|
|
|
|
self._instances = []
|
|
|
|
atexit.register(self._kill_instances)
|
2016-09-21 05:49:27 +02:00
|
|
|
signal.signal(signal.SIGTERM, self._kill_instances)
|
|
|
|
signal.signal(signal.SIGHUP, self._kill_instances)
|
2016-06-01 06:25:14 +02:00
|
|
|
|
2017-07-12 09:55:27 +02:00
|
|
|
def _do(self, cmd, quiet=True, **kwargs):
|
2016-06-01 06:25:14 +02:00
|
|
|
if quiet:
|
2016-09-06 22:05:44 +02:00
|
|
|
kwargs["stdout"] = DEVNULL
|
2016-06-01 06:25:14 +02:00
|
|
|
return subprocess.call(self._command + cmd, **kwargs)
|
|
|
|
|
2017-07-12 09:55:28 +02:00
|
|
|
def _do_check(self, cmd, quiet=True, **kwargs):
|
|
|
|
if quiet:
|
|
|
|
kwargs["stdout"] = DEVNULL
|
|
|
|
return subprocess.check_call(self._command + cmd, **kwargs)
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
def _do_kill_instances(self, only_known, only_active=True):
|
|
|
|
cmd = ["ps", "-q"]
|
|
|
|
if not only_active:
|
|
|
|
cmd.append("-a")
|
|
|
|
for i in self._output(cmd).split():
|
|
|
|
resp = self._output(["inspect", i])
|
|
|
|
labels = json.loads(resp)[0]["Config"]["Labels"]
|
|
|
|
active = json.loads(resp)[0]["State"]["Running"]
|
|
|
|
if not labels:
|
|
|
|
continue
|
|
|
|
instance_uuid = labels.get("com.qemu.instance.uuid", None)
|
|
|
|
if not instance_uuid:
|
|
|
|
continue
|
|
|
|
if only_known and instance_uuid not in self._instances:
|
|
|
|
continue
|
2018-06-08 14:29:43 +02:00
|
|
|
print("Terminating", i)
|
2016-06-01 06:25:14 +02:00
|
|
|
if active:
|
|
|
|
self._do(["kill", i])
|
|
|
|
self._do(["rm", i])
|
|
|
|
|
|
|
|
def clean(self):
|
|
|
|
self._do_kill_instances(False, False)
|
|
|
|
return 0
|
|
|
|
|
2016-09-21 05:49:27 +02:00
|
|
|
def _kill_instances(self, *args, **kwargs):
|
2016-06-01 06:25:14 +02:00
|
|
|
return self._do_kill_instances(True)
|
|
|
|
|
|
|
|
def _output(self, cmd, **kwargs):
|
|
|
|
return subprocess.check_output(self._command + cmd,
|
|
|
|
stderr=subprocess.STDOUT,
|
|
|
|
**kwargs)
|
|
|
|
|
|
|
|
def get_image_dockerfile_checksum(self, tag):
|
|
|
|
resp = self._output(["inspect", tag])
|
|
|
|
labels = json.loads(resp)[0]["Config"].get("Labels", {})
|
|
|
|
return labels.get("com.qemu.dockerfile-checksum", "")
|
|
|
|
|
2017-02-20 11:51:36 +01:00
|
|
|
def build_image(self, tag, docker_dir, dockerfile,
|
2017-06-02 20:56:09 +02:00
|
|
|
quiet=True, user=False, argv=None, extra_files_cksum=[]):
|
2016-06-01 06:25:14 +02:00
|
|
|
if argv == None:
|
|
|
|
argv = []
|
|
|
|
|
2016-07-19 15:20:36 +02:00
|
|
|
tmp_df = tempfile.NamedTemporaryFile(dir=docker_dir, suffix=".docker")
|
2016-06-01 06:25:14 +02:00
|
|
|
tmp_df.write(dockerfile)
|
|
|
|
|
2017-02-20 11:51:36 +01:00
|
|
|
if user:
|
|
|
|
uid = os.getuid()
|
|
|
|
uname = getpwuid(uid).pw_name
|
|
|
|
tmp_df.write("\n")
|
|
|
|
tmp_df.write("RUN id %s 2>/dev/null || useradd -u %d -U %s" %
|
|
|
|
(uname, uid, uname))
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
tmp_df.write("\n")
|
|
|
|
tmp_df.write("LABEL com.qemu.dockerfile-checksum=%s" %
|
2017-06-02 20:56:09 +02:00
|
|
|
_text_checksum("\n".join([dockerfile] +
|
|
|
|
extra_files_cksum)))
|
2016-06-01 06:25:14 +02:00
|
|
|
tmp_df.flush()
|
2016-07-19 15:20:36 +02:00
|
|
|
|
2017-07-12 09:55:28 +02:00
|
|
|
self._do_check(["build", "-t", tag, "-f", tmp_df.name] + argv + \
|
|
|
|
[docker_dir],
|
|
|
|
quiet=quiet)
|
2016-06-01 06:25:14 +02:00
|
|
|
|
2016-07-19 15:20:40 +02:00
|
|
|
def update_image(self, tag, tarball, quiet=True):
|
|
|
|
"Update a tagged image using "
|
|
|
|
|
2017-07-12 09:55:28 +02:00
|
|
|
self._do_check(["build", "-t", tag, "-"], quiet=quiet, stdin=tarball)
|
2016-07-19 15:20:40 +02:00
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
def image_matches_dockerfile(self, tag, dockerfile):
|
|
|
|
try:
|
|
|
|
checksum = self.get_image_dockerfile_checksum(tag)
|
|
|
|
except Exception:
|
|
|
|
return False
|
docker: Improved image checksum
When a base image locally defined by QEMU, such as in the debian images,
is updated, the dockerfile checksum mechanism in docker.py still skips
updating the derived image, because it only looks at the literal content
of the dockerfile, without considering changes to the base image.
For example we have a recent fix e58c1f9b35e81 that fixed
debian-win64-cross by updating its base image, debian8-mxe, but due to
above "feature" of docker.py the image in question is automatically NOT
rebuilt unless you add NOCACHE=1. It is noticed on Shippable:
https://app.shippable.com/github/qemu/qemu/runs/541/2/console
because after the fix is merged, the error still occurs, and the log
shows the container image is, as explained above, not updated.
This is because at the time docker.py was written, there wasn't any
dependencies between QEMU's docker images.
Now improve this to preprocess any "FROM qemu:*" directives in the
dockerfiles while doing checksum, and inline the base image's dockerfile
content, recursively. This ensures any changes on the depended _QEMU_
images are taken into account.
This means for external images that we expect to retrieve from docker
registries, we still do it as before. It is not perfect, because
registry images can get updated too. Technically we could substitute the
image name with its hex ID as obtained with $(docker images $IMAGE
--format="{{.Id}}"), but --format is not supported by RHEL 7, so leave
it for now.
Reported-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Signed-off-by: Fam Zheng <famz@redhat.com>
Message-Id: <20171103131229.4737-1-famz@redhat.com>
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Fam Zheng <famz@redhat.com>
2017-11-03 14:12:29 +01:00
|
|
|
return checksum == _text_checksum(_dockerfile_preprocess(dockerfile))
|
2016-06-01 06:25:14 +02:00
|
|
|
|
|
|
|
def run(self, cmd, keep, quiet):
|
|
|
|
label = uuid.uuid1().hex
|
|
|
|
if not keep:
|
|
|
|
self._instances.append(label)
|
2017-07-12 09:55:28 +02:00
|
|
|
ret = self._do_check(["run", "--label",
|
|
|
|
"com.qemu.instance.uuid=" + label] + cmd,
|
|
|
|
quiet=quiet)
|
2016-06-01 06:25:14 +02:00
|
|
|
if not keep:
|
|
|
|
self._instances.remove(label)
|
|
|
|
return ret
|
|
|
|
|
2016-07-19 15:20:43 +02:00
|
|
|
def command(self, cmd, argv, quiet):
|
|
|
|
return self._do([cmd] + argv, quiet=quiet)
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
class SubCommand(object):
|
|
|
|
"""A SubCommand template base class"""
|
|
|
|
name = None # Subcommand name
|
|
|
|
def shared_args(self, parser):
|
|
|
|
parser.add_argument("--quiet", action="store_true",
|
|
|
|
help="Run quietly unless an error occured")
|
|
|
|
|
|
|
|
def args(self, parser):
|
|
|
|
"""Setup argument parser"""
|
|
|
|
pass
|
|
|
|
def run(self, args, argv):
|
|
|
|
"""Run command.
|
|
|
|
args: parsed argument by argument parser.
|
|
|
|
argv: remaining arguments from sys.argv.
|
|
|
|
"""
|
|
|
|
pass
|
|
|
|
|
|
|
|
class RunCommand(SubCommand):
|
|
|
|
"""Invoke docker run and take care of cleaning up"""
|
|
|
|
name = "run"
|
|
|
|
def args(self, parser):
|
|
|
|
parser.add_argument("--keep", action="store_true",
|
|
|
|
help="Don't remove image when command completes")
|
|
|
|
def run(self, args, argv):
|
|
|
|
return Docker().run(argv, args.keep, quiet=args.quiet)
|
|
|
|
|
|
|
|
class BuildCommand(SubCommand):
|
|
|
|
""" Build docker image out of a dockerfile. Arguments: <tag> <dockerfile>"""
|
|
|
|
name = "build"
|
|
|
|
def args(self, parser):
|
2016-07-19 15:20:37 +02:00
|
|
|
parser.add_argument("--include-executable", "-e",
|
|
|
|
help="""Specify a binary that will be copied to the
|
|
|
|
container together with all its dependent
|
|
|
|
libraries""")
|
2017-06-02 20:56:08 +02:00
|
|
|
parser.add_argument("--extra-files", "-f", nargs='*',
|
|
|
|
help="""Specify files that will be copied in the
|
|
|
|
Docker image, fulfilling the ADD directive from the
|
|
|
|
Dockerfile""")
|
2017-02-20 11:51:36 +01:00
|
|
|
parser.add_argument("--add-current-user", "-u", dest="user",
|
|
|
|
action="store_true",
|
|
|
|
help="Add the current user to image's passwd")
|
2016-06-01 06:25:14 +02:00
|
|
|
parser.add_argument("tag",
|
|
|
|
help="Image Tag")
|
|
|
|
parser.add_argument("dockerfile",
|
|
|
|
help="Dockerfile name")
|
|
|
|
|
|
|
|
def run(self, args, argv):
|
|
|
|
dockerfile = open(args.dockerfile, "rb").read()
|
|
|
|
tag = args.tag
|
|
|
|
|
|
|
|
dkr = Docker()
|
2017-07-25 15:34:23 +02:00
|
|
|
if "--no-cache" not in argv and \
|
|
|
|
dkr.image_matches_dockerfile(tag, dockerfile):
|
2016-06-01 06:25:14 +02:00
|
|
|
if not args.quiet:
|
2018-06-08 14:29:43 +02:00
|
|
|
print("Image is up to date.")
|
2016-07-19 15:20:36 +02:00
|
|
|
else:
|
|
|
|
# Create a docker context directory for the build
|
|
|
|
docker_dir = tempfile.mkdtemp(prefix="docker_build")
|
|
|
|
|
2016-07-19 15:20:38 +02:00
|
|
|
# Is there a .pre file to run in the build context?
|
|
|
|
docker_pre = os.path.splitext(args.dockerfile)[0]+".pre"
|
|
|
|
if os.path.exists(docker_pre):
|
2016-09-06 22:05:51 +02:00
|
|
|
stdout = DEVNULL if args.quiet else None
|
2016-07-19 15:20:38 +02:00
|
|
|
rc = subprocess.call(os.path.realpath(docker_pre),
|
2016-09-06 22:05:51 +02:00
|
|
|
cwd=docker_dir, stdout=stdout)
|
2016-07-19 15:20:38 +02:00
|
|
|
if rc == 3:
|
2018-06-08 14:29:43 +02:00
|
|
|
print("Skip")
|
2016-07-19 15:20:38 +02:00
|
|
|
return 0
|
|
|
|
elif rc != 0:
|
2018-06-08 14:29:43 +02:00
|
|
|
print("%s exited with code %d" % (docker_pre, rc))
|
2016-07-19 15:20:38 +02:00
|
|
|
return 1
|
|
|
|
|
2017-06-02 20:56:08 +02:00
|
|
|
# Copy any extra files into the Docker context. These can be
|
|
|
|
# included by the use of the ADD directive in the Dockerfile.
|
2017-06-02 20:56:09 +02:00
|
|
|
cksum = []
|
2016-07-19 15:20:37 +02:00
|
|
|
if args.include_executable:
|
2017-06-02 20:56:09 +02:00
|
|
|
# FIXME: there is no checksum of this executable and the linked
|
|
|
|
# libraries, once the image built any change of this executable
|
|
|
|
# or any library won't trigger another build.
|
2017-06-02 20:56:08 +02:00
|
|
|
_copy_binary_with_libs(args.include_executable, docker_dir)
|
|
|
|
for filename in args.extra_files or []:
|
|
|
|
_copy_with_mkdir(filename, docker_dir)
|
2017-06-02 20:56:09 +02:00
|
|
|
cksum += [_file_checksum(filename)]
|
2016-07-19 15:20:37 +02:00
|
|
|
|
2017-03-06 21:55:20 +01:00
|
|
|
argv += ["--build-arg=" + k.lower() + "=" + v
|
|
|
|
for k, v in os.environ.iteritems()
|
|
|
|
if k.lower() in FILTERED_ENV_NAMES]
|
2016-07-19 15:20:36 +02:00
|
|
|
dkr.build_image(tag, docker_dir, dockerfile,
|
2017-06-02 20:56:09 +02:00
|
|
|
quiet=args.quiet, user=args.user, argv=argv,
|
|
|
|
extra_files_cksum=cksum)
|
2016-07-19 15:20:36 +02:00
|
|
|
|
|
|
|
rmtree(docker_dir)
|
2016-06-01 06:25:14 +02:00
|
|
|
|
|
|
|
return 0
|
|
|
|
|
2016-07-19 15:20:40 +02:00
|
|
|
class UpdateCommand(SubCommand):
|
|
|
|
""" Update a docker image with new executables. Arguments: <tag> <executable>"""
|
|
|
|
name = "update"
|
|
|
|
def args(self, parser):
|
|
|
|
parser.add_argument("tag",
|
|
|
|
help="Image Tag")
|
|
|
|
parser.add_argument("executable",
|
|
|
|
help="Executable to copy")
|
|
|
|
|
|
|
|
def run(self, args, argv):
|
|
|
|
# Create a temporary tarball with our whole build context and
|
|
|
|
# dockerfile for the update
|
|
|
|
tmp = tempfile.NamedTemporaryFile(suffix="dckr.tar.gz")
|
|
|
|
tmp_tar = TarFile(fileobj=tmp, mode='w')
|
|
|
|
|
|
|
|
# Add the executable to the tarball
|
|
|
|
bn = os.path.basename(args.executable)
|
|
|
|
ff = "/usr/bin/%s" % bn
|
|
|
|
tmp_tar.add(args.executable, arcname=ff)
|
|
|
|
|
|
|
|
# Add any associated libraries
|
|
|
|
libs = _get_so_libs(args.executable)
|
|
|
|
if libs:
|
|
|
|
for l in libs:
|
|
|
|
tmp_tar.add(os.path.realpath(l), arcname=l)
|
|
|
|
|
|
|
|
# Create a Docker buildfile
|
|
|
|
df = StringIO()
|
|
|
|
df.write("FROM %s\n" % args.tag)
|
|
|
|
df.write("ADD . /\n")
|
|
|
|
df.seek(0)
|
|
|
|
|
|
|
|
df_tar = TarInfo(name="Dockerfile")
|
|
|
|
df_tar.size = len(df.buf)
|
|
|
|
tmp_tar.addfile(df_tar, fileobj=df)
|
|
|
|
|
|
|
|
tmp_tar.close()
|
|
|
|
|
|
|
|
# reset the file pointers
|
|
|
|
tmp.flush()
|
|
|
|
tmp.seek(0)
|
|
|
|
|
|
|
|
# Run the build with our tarball context
|
|
|
|
dkr = Docker()
|
|
|
|
dkr.update_image(args.tag, tmp, quiet=args.quiet)
|
|
|
|
|
|
|
|
return 0
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
class CleanCommand(SubCommand):
|
|
|
|
"""Clean up docker instances"""
|
|
|
|
name = "clean"
|
|
|
|
def run(self, args, argv):
|
|
|
|
Docker().clean()
|
|
|
|
return 0
|
|
|
|
|
2016-07-19 15:20:43 +02:00
|
|
|
class ImagesCommand(SubCommand):
|
|
|
|
"""Run "docker images" command"""
|
|
|
|
name = "images"
|
|
|
|
def run(self, args, argv):
|
|
|
|
return Docker().command("images", argv, args.quiet)
|
|
|
|
|
2018-05-10 11:45:55 +02:00
|
|
|
|
|
|
|
class ProbeCommand(SubCommand):
|
|
|
|
"""Probe if we can run docker automatically"""
|
|
|
|
name = "probe"
|
|
|
|
|
|
|
|
def run(self, args, argv):
|
|
|
|
try:
|
|
|
|
docker = Docker()
|
|
|
|
if docker._command[0] == "docker":
|
2018-06-08 14:29:43 +02:00
|
|
|
print("yes")
|
2018-05-10 11:45:55 +02:00
|
|
|
elif docker._command[0] == "sudo":
|
2018-06-08 14:29:43 +02:00
|
|
|
print("sudo")
|
2018-05-10 11:45:55 +02:00
|
|
|
except Exception:
|
2018-06-08 14:29:43 +02:00
|
|
|
print("no")
|
2018-05-10 11:45:55 +02:00
|
|
|
|
|
|
|
return
|
|
|
|
|
|
|
|
|
2018-04-12 17:49:11 +02:00
|
|
|
class CcCommand(SubCommand):
|
|
|
|
"""Compile sources with cc in images"""
|
|
|
|
name = "cc"
|
|
|
|
|
|
|
|
def args(self, parser):
|
|
|
|
parser.add_argument("--image", "-i", required=True,
|
|
|
|
help="The docker image in which to run cc")
|
2018-04-12 18:18:12 +02:00
|
|
|
parser.add_argument("--cc", default="cc",
|
|
|
|
help="The compiler executable to call")
|
2018-04-06 17:23:26 +02:00
|
|
|
parser.add_argument("--user",
|
|
|
|
help="The user-id to run under")
|
2018-04-12 17:49:11 +02:00
|
|
|
parser.add_argument("--source-path", "-s", nargs="*", dest="paths",
|
|
|
|
help="""Extra paths to (ro) mount into container for
|
|
|
|
reading sources""")
|
|
|
|
|
|
|
|
def run(self, args, argv):
|
|
|
|
if argv and argv[0] == "--":
|
|
|
|
argv = argv[1:]
|
|
|
|
cwd = os.getcwd()
|
|
|
|
cmd = ["--rm", "-w", cwd,
|
|
|
|
"-v", "%s:%s:rw" % (cwd, cwd)]
|
|
|
|
if args.paths:
|
|
|
|
for p in args.paths:
|
|
|
|
cmd += ["-v", "%s:%s:ro,z" % (p, p)]
|
2018-04-06 17:23:26 +02:00
|
|
|
if args.user:
|
|
|
|
cmd += ["-u", args.user]
|
2018-04-12 18:18:12 +02:00
|
|
|
cmd += [args.image, args.cc]
|
2018-04-12 17:49:11 +02:00
|
|
|
cmd += argv
|
|
|
|
return Docker().command("run", cmd, args.quiet)
|
|
|
|
|
|
|
|
|
2016-06-01 06:25:14 +02:00
|
|
|
def main():
|
|
|
|
parser = argparse.ArgumentParser(description="A Docker helper",
|
|
|
|
usage="%s <subcommand> ..." % os.path.basename(sys.argv[0]))
|
|
|
|
subparsers = parser.add_subparsers(title="subcommands", help=None)
|
|
|
|
for cls in SubCommand.__subclasses__():
|
|
|
|
cmd = cls()
|
|
|
|
subp = subparsers.add_parser(cmd.name, help=cmd.__doc__)
|
|
|
|
cmd.shared_args(subp)
|
|
|
|
cmd.args(subp)
|
|
|
|
subp.set_defaults(cmdobj=cmd)
|
|
|
|
args, argv = parser.parse_known_args()
|
|
|
|
return args.cmdobj.run(args, argv)
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
sys.exit(main())
|