[Docker] Support for adding directories to tarball
--
MOS_MIGRATED_REVID=103527154
diff --git a/tools/build_defs/docker/archive.py b/tools/build_defs/docker/archive.py
index 5985622..0ddf18a 100644
--- a/tools/build_defs/docker/archive.py
+++ b/tools/build_defs/docker/archive.py
@@ -95,6 +95,9 @@
class TarFileWriter(object):
"""A wrapper to write tar files."""
+ class Error(Exception):
+ pass
+
def __init__(self, name):
self.tar = tarfile.open(name=name, mode='w')
@@ -104,6 +107,49 @@
def __exit__(self, t, v, traceback):
self.close()
+ def add_dir(self, name, path, uid=0, gid=0, uname='', gname='',
+ mtime=0, mode=None, depth=100):
+ """Recursively add a directory.
+
+ Args:
+ name: the destination path of the directory to add.
+ path: the path of the directory to add.
+ uid: owner user identifier.
+ gid: owner group identifier.
+ uname: owner user names.
+ gname: owner group names.
+ mtime: modification time to put in the archive.
+ mode: unix permission mode of the file, default 0644 (0755).
+ depth: maximum depth to recurse in to avoid infinite loops
+ with cyclic mounts.
+
+ Raises:
+ TarFileWriter.Error: when the recursion depth has exceeded the
+ `depth` argument.
+ """
+ if not name.startswith('.') and not name.startswith('/'):
+ name = './' + name
+ if os.path.isdir(path):
+ # Remove trailing '/' (index -1 => last character)
+ if name[-1] == '/':
+ name = name[:-1]
+ self.add_file(name + '/', tarfile.DIRTYPE, uid=uid, gid=gid,
+ uname=uname, gname=gname, mtime=mtime, mode=mode)
+ if depth <= 0:
+ raise self.Error('Recursion depth exceeded, probably in '
+ 'an infinite directory loop.')
+ # Iterate over the sorted list of file so we get a deterministic result.
+ filelist = os.listdir(path)
+ filelist.sort()
+ for f in filelist:
+ new_name = os.path.join(name, f)
+ new_path = os.path.join(path, f)
+ self.add_dir(new_name, new_path, uid, gid, uname, gname, mtime,
+ mode, depth-1)
+ else:
+ self.add_file(name, tarfile.REGTYPE, file_content=path, uid=uid, gid=gid,
+ uname=uname, gname=gname, mtime=mtime, mode=mode)
+
def add_file(self, name, kind=tarfile.REGTYPE, content=None, link=None,
file_content=None, uid=0, gid=0, uname='', gname='', mtime=0,
mode=None):
@@ -123,6 +169,10 @@
mtime: modification time to put in the archive.
mode: unix permission mode of the file, default 0644 (0755).
"""
+ if file_content and os.path.isdir(file_content):
+ # Recurse into directory
+ self.add_dir(name, file_content, uid, gid, uname, gname, mtime, mode)
+ return
if not name.startswith('.') and not name.startswith('/'):
name = './' + name
tarinfo = tarfile.TarInfo(name)
diff --git a/tools/build_defs/docker/archive_test.py b/tools/build_defs/docker/archive_test.py
index 4db32b5..7f0a254 100644
--- a/tools/build_defs/docker/archive_test.py
+++ b/tools/build_defs/docker/archive_test.py
@@ -153,10 +153,32 @@
self.assertSimpleFileContent(["./a", "./ab"])
self.assertSimpleFileContent(["./a", "./b", "./ab"])
+ def testAddDir(self):
+ # For some strange reason, ending slash is stripped by the test
+ content = [
+ {"name": "."},
+ {"name": "./a"},
+ {"name": "./a/b", "data": "ab"},
+ {"name": "./a/c"},
+ {"name": "./a/c/d", "data": "acd"},
+ ]
+ tempdir = os.path.join(os.environ["TEST_TMPDIR"], "test_dir")
+ # Iterate over the `content` array to create the directory
+ # structure it describes.
+ for c in content:
+ if "data" in c:
+ p = os.path.join(tempdir, c["name"][2:])
+ os.makedirs(os.path.dirname(p))
+ with open(p, "w") as f:
+ f.write(c["data"])
+ with archive.TarFileWriter(self.tempfile) as f:
+ f.add_dir("./", tempdir)
+ self.assertTarFileContent(self.tempfile, content)
+
def testMergeTar(self):
content = [
{"name": "./a", "data": "a"},
- {"name": "./ab", "data": "ab"}
+ {"name": "./ab", "data": "ab"},
]
for ext in ["", ".gz", ".bz2", ".xz"]:
with archive.TarFileWriter(self.tempfile) as f:
