diff mbox

[v2,2/3] tests/docker/docker.py: support --include-executable

Message ID 1465403752-30348-3-git-send-email-alex.bennee@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

Alex Bennée June 8, 2016, 4:35 p.m. UTC
When passed the path to a binary we copy it and any linked libraries
into the docker build context. These can then be included by a
dockerfile with the line:

  # Copy all of context into container
  ADD . /

This is mainly intended for setting up foreign architecture docker
images which use qemu-$arch to do cross-architecture linux-user
execution. It also relies on the host and guest file-system following
reasonable multi-arch layouts so the copied libraries don't clash with
the guest ones.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
v2
  - change name of option
  - require full path to executable
  - clean-up the copy code
---
 tests/docker/docker.py | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

Comments

Fam Zheng June 12, 2016, 6:47 a.m. UTC | #1
On Wed, 06/08 17:35, Alex Bennée wrote:
> When passed the path to a binary we copy it and any linked libraries
> into the docker build context. These can then be included by a
> dockerfile with the line:
> 
>   # Copy all of context into container
>   ADD . /
> 
> This is mainly intended for setting up foreign architecture docker
> images which use qemu-$arch to do cross-architecture linux-user
> execution. It also relies on the host and guest file-system following
> reasonable multi-arch layouts so the copied libraries don't clash with
> the guest ones.
> 
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> 
> ---
> v2
>   - change name of option
>   - require full path to executable
>   - clean-up the copy code
> ---
>  tests/docker/docker.py | 42 ++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 42 insertions(+)
> 
> diff --git a/tests/docker/docker.py b/tests/docker/docker.py
> index ae40bb3..ed6fa45 100755
> --- a/tests/docker/docker.py
> +++ b/tests/docker/docker.py
> @@ -20,6 +20,7 @@ import atexit
>  import uuid
>  import argparse
>  import tempfile
> +import re
>  from shutil import copy, rmtree
>  
>  def _text_checksum(text):
> @@ -38,6 +39,38 @@ def _guess_docker_command():
>      raise Exception("Cannot find working docker command. Tried:\n%s" % \
>                      commands_txt)
>  
> +def _copy_with_mkdir(src, root_dir, sub_path):
> +    """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:
> +        print "%s already created" % (dest_dir)

Is this error necessary? If it doesn't hurt (i.e. multiple libraries are copied
into it), I think we can safely say "pass". Or, add "if not
os.path.isdir(dest_dir):" above os.makedirs.

> +
> +    dest_file = "%s/%s" % (dest_dir, os.path.basename(src))
> +    copy(src, dest_file)
> +
> +
> +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")
> +
> +    # do ldd bit here
> +    ldd_re = re.compile(r"(/.*/)(\S*)")
> +    ldd_output = subprocess.check_output(["ldd", src])
> +    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]
> +            _copy_with_mkdir("%s/%s" % (so_path, so_lib),
> +                             dest_dir, so_path)
> +
> +
>  class Docker(object):
>      """ Running Docker commands """
>      def __init__(self):
> @@ -151,6 +184,10 @@ class BuildCommand(SubCommand):
>      """ Build docker image out of a dockerfile. Arguments: <tag> <dockerfile>"""
>      name = "build"
>      def args(self, parser):
> +        parser.add_argument("--include-executable", "-e",
> +                            help="""Specify a binary that will be copied to the
> +                            container together with all its dependent
> +                            libraries""")
>          parser.add_argument("tag",
>                              help="Image Tag")
>          parser.add_argument("dockerfile",
> @@ -168,6 +205,11 @@ class BuildCommand(SubCommand):
>              # Create a docker context directory for the build
>              docker_dir = tempfile.mkdtemp(prefix="docker_build")
>  
> +            # Do we include a extra binary?

s/a extra/an extra/

> +            if args.include_executable:
> +                _copy_binary_with_libs(args.include_executable,
> +                                       docker_dir)
> +
>              dkr.build_image(tag, docker_dir, dockerfile,
>                              quiet=args.quiet, argv=argv)
>  
> -- 
> 2.7.4
>
Alex Bennée June 13, 2016, 9:24 a.m. UTC | #2
Fam Zheng <famz@redhat.com> writes:

> On Wed, 06/08 17:35, Alex Bennée wrote:
>> When passed the path to a binary we copy it and any linked libraries
>> into the docker build context. These can then be included by a
>> dockerfile with the line:
>>
>>   # Copy all of context into container
>>   ADD . /
>>
>> This is mainly intended for setting up foreign architecture docker
>> images which use qemu-$arch to do cross-architecture linux-user
>> execution. It also relies on the host and guest file-system following
>> reasonable multi-arch layouts so the copied libraries don't clash with
>> the guest ones.
>>
>> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
>>
>> ---
>> v2
>>   - change name of option
>>   - require full path to executable
>>   - clean-up the copy code
>> ---
>>  tests/docker/docker.py | 42 ++++++++++++++++++++++++++++++++++++++++++
>>  1 file changed, 42 insertions(+)
>>
>> diff --git a/tests/docker/docker.py b/tests/docker/docker.py
>> index ae40bb3..ed6fa45 100755
>> --- a/tests/docker/docker.py
>> +++ b/tests/docker/docker.py
>> @@ -20,6 +20,7 @@ import atexit
>>  import uuid
>>  import argparse
>>  import tempfile
>> +import re
>>  from shutil import copy, rmtree
>>
>>  def _text_checksum(text):
>> @@ -38,6 +39,38 @@ def _guess_docker_command():
>>      raise Exception("Cannot find working docker command. Tried:\n%s" % \
>>                      commands_txt)
>>
>> +def _copy_with_mkdir(src, root_dir, sub_path):
>> +    """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:
>> +        print "%s already created" % (dest_dir)
>
> Is this error necessary? If it doesn't hurt (i.e. multiple libraries are copied
> into it), I think we can safely say "pass". Or, add "if not
> os.path.isdir(dest_dir):" above os.makedirs.


OK.


>
>> +
>> +    dest_file = "%s/%s" % (dest_dir, os.path.basename(src))
>> +    copy(src, dest_file)
>> +
>> +
>> +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")
>> +
>> +    # do ldd bit here
>> +    ldd_re = re.compile(r"(/.*/)(\S*)")
>> +    ldd_output = subprocess.check_output(["ldd", src])
>> +    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]
>> +            _copy_with_mkdir("%s/%s" % (so_path, so_lib),
>> +                             dest_dir, so_path)
>> +
>> +
>>  class Docker(object):
>>      """ Running Docker commands """
>>      def __init__(self):
>> @@ -151,6 +184,10 @@ class BuildCommand(SubCommand):
>>      """ Build docker image out of a dockerfile. Arguments: <tag> <dockerfile>"""
>>      name = "build"
>>      def args(self, parser):
>> +        parser.add_argument("--include-executable", "-e",
>> +                            help="""Specify a binary that will be copied to the
>> +                            container together with all its dependent
>> +                            libraries""")
>>          parser.add_argument("tag",
>>                              help="Image Tag")
>>          parser.add_argument("dockerfile",
>> @@ -168,6 +205,11 @@ class BuildCommand(SubCommand):
>>              # Create a docker context directory for the build
>>              docker_dir = tempfile.mkdtemp(prefix="docker_build")
>>
>> +            # Do we include a extra binary?
>
> s/a extra/an extra/

OK

>
>> +            if args.include_executable:
>> +                _copy_binary_with_libs(args.include_executable,
>> +                                       docker_dir)
>> +
>>              dkr.build_image(tag, docker_dir, dockerfile,
>>                              quiet=args.quiet, argv=argv)
>>
>> --
>> 2.7.4
>>

Thanks

--
Alex Bennée
Riku Voipio June 13, 2016, 12:24 p.m. UTC | #3
On 8 June 2016 at 19:35, Alex Bennée <alex.bennee@linaro.org> wrote:
> When passed the path to a binary we copy it and any linked libraries
> into the docker build context. These can then be included by a
> dockerfile with the line:
>
>   # Copy all of context into container
>   ADD . /
>
> This is mainly intended for setting up foreign architecture docker
> images which use qemu-$arch to do cross-architecture linux-user
> execution. It also relies on the host and guest file-system following
> reasonable multi-arch layouts so the copied libraries don't clash with
> the guest ones.
>
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
>
> ---
> v2
>   - change name of option
>   - require full path to executable
>   - clean-up the copy code
> ---
>  tests/docker/docker.py | 42 ++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 42 insertions(+)
>
> diff --git a/tests/docker/docker.py b/tests/docker/docker.py
> index ae40bb3..ed6fa45 100755
> --- a/tests/docker/docker.py
> +++ b/tests/docker/docker.py
> @@ -20,6 +20,7 @@ import atexit
>  import uuid
>  import argparse
>  import tempfile
> +import re
>  from shutil import copy, rmtree
>
>  def _text_checksum(text):
> @@ -38,6 +39,38 @@ def _guess_docker_command():
>      raise Exception("Cannot find working docker command. Tried:\n%s" % \
>                      commands_txt)
>
> +def _copy_with_mkdir(src, root_dir, sub_path):
> +    """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:
> +        print "%s already created" % (dest_dir)
> +
> +    dest_file = "%s/%s" % (dest_dir, os.path.basename(src))
> +    copy(src, dest_file)
> +
> +
> +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")
> +
> +    # do ldd bit here
> +    ldd_re = re.compile(r"(/.*/)(\S*)")
> +    ldd_output = subprocess.check_output(["ldd", src])

This fails if qemu-user has been built as --static. I think we can
just try, catch and continue.

> +    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]
> +            _copy_with_mkdir("%s/%s" % (so_path, so_lib),
> +                             dest_dir, so_path)
> +
> +
>  class Docker(object):
>      """ Running Docker commands """
>      def __init__(self):
> @@ -151,6 +184,10 @@ class BuildCommand(SubCommand):
>      """ Build docker image out of a dockerfile. Arguments: <tag> <dockerfile>"""
>      name = "build"
>      def args(self, parser):
> +        parser.add_argument("--include-executable", "-e",
> +                            help="""Specify a binary that will be copied to the
> +                            container together with all its dependent
> +                            libraries""")
>          parser.add_argument("tag",
>                              help="Image Tag")
>          parser.add_argument("dockerfile",
> @@ -168,6 +205,11 @@ class BuildCommand(SubCommand):
>              # Create a docker context directory for the build
>              docker_dir = tempfile.mkdtemp(prefix="docker_build")
>
> +            # Do we include a extra binary?
> +            if args.include_executable:
> +                _copy_binary_with_libs(args.include_executable,
> +                                       docker_dir)
> +
>              dkr.build_image(tag, docker_dir, dockerfile,
>                              quiet=args.quiet, argv=argv)
>
> --
> 2.7.4
>
diff mbox

Patch

diff --git a/tests/docker/docker.py b/tests/docker/docker.py
index ae40bb3..ed6fa45 100755
--- a/tests/docker/docker.py
+++ b/tests/docker/docker.py
@@ -20,6 +20,7 @@  import atexit
 import uuid
 import argparse
 import tempfile
+import re
 from shutil import copy, rmtree
 
 def _text_checksum(text):
@@ -38,6 +39,38 @@  def _guess_docker_command():
     raise Exception("Cannot find working docker command. Tried:\n%s" % \
                     commands_txt)
 
+def _copy_with_mkdir(src, root_dir, sub_path):
+    """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:
+        print "%s already created" % (dest_dir)
+
+    dest_file = "%s/%s" % (dest_dir, os.path.basename(src))
+    copy(src, dest_file)
+
+
+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")
+
+    # do ldd bit here
+    ldd_re = re.compile(r"(/.*/)(\S*)")
+    ldd_output = subprocess.check_output(["ldd", src])
+    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]
+            _copy_with_mkdir("%s/%s" % (so_path, so_lib),
+                             dest_dir, so_path)
+
+
 class Docker(object):
     """ Running Docker commands """
     def __init__(self):
@@ -151,6 +184,10 @@  class BuildCommand(SubCommand):
     """ Build docker image out of a dockerfile. Arguments: <tag> <dockerfile>"""
     name = "build"
     def args(self, parser):
+        parser.add_argument("--include-executable", "-e",
+                            help="""Specify a binary that will be copied to the
+                            container together with all its dependent
+                            libraries""")
         parser.add_argument("tag",
                             help="Image Tag")
         parser.add_argument("dockerfile",
@@ -168,6 +205,11 @@  class BuildCommand(SubCommand):
             # Create a docker context directory for the build
             docker_dir = tempfile.mkdtemp(prefix="docker_build")
 
+            # Do we include a extra binary?
+            if args.include_executable:
+                _copy_binary_with_libs(args.include_executable,
+                                       docker_dir)
+
             dkr.build_image(tag, docker_dir, dockerfile,
                             quiet=args.quiet, argv=argv)