diff options
| -rw-r--r-- | doc/man/scons.1 | 60 | ||||
| -rw-r--r-- | src/CHANGES.txt | 2 | ||||
| -rw-r--r-- | src/engine/MANIFEST.in | 3 | ||||
| -rw-r--r-- | src/engine/SCons/Tool/__init__.py | 7 | ||||
| -rw-r--r-- | src/engine/SCons/Tool/tar.py | 2 | ||||
| -rw-r--r-- | src/engine/SCons/Tool/zip.py | 88 | ||||
| -rw-r--r-- | test/TAR.py | 43 | ||||
| -rw-r--r-- | test/ZIP.py | 150 |
8 files changed, 344 insertions, 11 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1 index e96f1508..dd4b548d 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -1309,6 +1309,57 @@ be specified using the .B Depends method of a construction environment (see below). +.IP Tar +Builds a tar archive of the specified files +and/or directories. +Unlike most builders, +the +.B Tar +builder may be called multiple times +for a given target; +each additional call +adds to the list of entries +that will be built into the archive. + +.ES +env.Tar('src.tar', 'src') + +# Create the stuff.tar file. +env.Tar('stuff', ['subdir1', 'subdir2']) +# Also add "another" to the stuff.tar file. +env.Tar('stuff', 'another') + +# Set TARFLAGS to create a gzip-filtered archive. +env = Environment(TARFLAGS = '-c -z') +env.Tar('foo.tar.gz', 'foo') + +# Also set the suffix to .tgz. +env = Environment(TARFLAGS = '-c -z', + TARSUFFIX = '.tgz') +env.Tar('foo') +.EE + +.IP Zip +Builds a zip archive of the specified files +and/or directories. +Unlike most builders, +the +.B Zip +builder may be called multiple times +for a given target; +each additional call +adds to the list of entries +that will be built into the archive. + +.ES +env.Zip('src.zip', 'src') + +# Create the stuff.zip file. +env.Zip('stuff', ['subdir1', 'subdir2']) +# Also add "another" to the stuff.tar file. +env.Zip('stuff', 'another') +.EE + .SS Other Construction Environment Methods Additional construction environment methods include: @@ -2597,6 +2648,15 @@ to generate a source file. .IP YACCFLAGS General options passed to the parser generator. +.IP ZIP +The zip compression and file packaging utility. + +.IP ZIPCOM +The command line used to call the zip utility. + +.IP ZIPFLAGS +General options passed to the zip utility. + .LP Construction variables can be retrieved and set using the .B Dictionary diff --git a/src/CHANGES.txt b/src/CHANGES.txt index d83561b6..97e60b64 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -35,6 +35,8 @@ RELEASE 0.12 - XXX - Make TARGET, TARGETS, SOURCE and SOURCES reserved variable names and warn if the user tries to set them in a construction environment. + - Add support for Tar and Zip files. + RELEASE 0.11 - Tue, 11 Feb 2003 05:24:33 -0600 diff --git a/src/engine/MANIFEST.in b/src/engine/MANIFEST.in index 592e676c..0759d8cb 100644 --- a/src/engine/MANIFEST.in +++ b/src/engine/MANIFEST.in @@ -55,9 +55,9 @@ SCons/Tool/mslib.py SCons/Tool/mslink.py SCons/Tool/msvc.py SCons/Tool/nasm.py -SCons/Tool/Perforce.py SCons/Tool/pdflatex.py SCons/Tool/pdftex.py +SCons/Tool/Perforce.py SCons/Tool/PharLapCommon.py SCons/Tool/RCS.py SCons/Tool/SCCS.py @@ -70,5 +70,6 @@ SCons/Tool/Subversion.py SCons/Tool/tar.py SCons/Tool/tex.py SCons/Tool/yacc.py +SCons/Tool/zip.py SCons/Util.py SCons/Warnings.py diff --git a/src/engine/SCons/Tool/__init__.py b/src/engine/SCons/Tool/__init__.py index b6b7f9e1..a5db5bf8 100644 --- a/src/engine/SCons/Tool/__init__.py +++ b/src/engine/SCons/Tool/__init__.py @@ -202,10 +202,11 @@ def tool_list(platform, env): other_tools = FindAllTools(['BitKeeper', 'CVS', 'dvipdf', 'dvips', - 'latex', 'lex', 'Perforce', - 'pdflatex', 'pdftex', + 'latex', 'lex', + 'pdflatex', 'pdftex', 'Perforce', 'RCS', 'SCCS', 'Subversion', - 'tar', 'tex', 'yacc'], env) + 'tar', 'tex', 'yacc', 'zip'], + env) tools = ([linker, c_compiler, cxx_compiler, fortran_compiler, assembler, ar] diff --git a/src/engine/SCons/Tool/tar.py b/src/engine/SCons/Tool/tar.py index 460eec68..6692d57b 100644 --- a/src/engine/SCons/Tool/tar.py +++ b/src/engine/SCons/Tool/tar.py @@ -37,7 +37,7 @@ import SCons.Builder import SCons.Node.FS import SCons.Util -tars = ['gtar', 'tar'] +tars = ['tar', 'gtar'] TarBuilder = SCons.Builder.Builder(action = '$TARCOM', source_factory = SCons.Node.FS.default_fs.Entry, diff --git a/src/engine/SCons/Tool/zip.py b/src/engine/SCons/Tool/zip.py new file mode 100644 index 00000000..f4a8a28b --- /dev/null +++ b/src/engine/SCons/Tool/zip.py @@ -0,0 +1,88 @@ +"""SCons.Tool.zip + +Tool-specific initialization for zip. + +There normally shouldn't be any need to import this module directly. +It will usually be imported through the generic SCons.Tool.Tool() +selection method. + +""" + +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +import os.path + +import SCons.Builder +import SCons.Node.FS +import SCons.Util + +try: + import zipfile + + def zip(target, source, env): + def visit(arg, dirname, names): + for name in names: + path = os.path.join(dirname, name) + if os.path.isfile(path): + arg.write(path) + zf = zipfile.ZipFile(str(target[0]), 'w') + for s in source: + if os.path.isdir(str(s)): + os.path.walk(str(s), visit, zf) + else: + zf.write(str(s)) + zf.close() + + internal_zip = 1 + +except ImportError: + zip = "$ZIP $ZIPFLAGS $( ${TARGET.abspath} $) $SOURCES" + + internal_zip = 0 + +zipAction = SCons.Action.Action(zip) + +ZipBuilder = SCons.Builder.Builder(action = '$ZIPCOM', + source_factory = SCons.Node.FS.default_fs.Entry, + suffix = '$ZIPSUFFIX', + multi = 1) + + +def generate(env, platform): + """Add Builders and construction variables for zip to an Environment.""" + try: + bld = env['BUILDERS']['Zip'] + except KeyError: + bld = ZipBuilder + env['BUILDERS']['Zip'] = bld + + env['ZIP'] = 'zip' + env['ZIPFLAGS'] = '' + env['ZIPCOM'] = zipAction + env['ZIPSUFFIX'] = '.zip' + +def exists(env): + return internal_zip or env.Detect('zip') diff --git a/test/TAR.py b/test/TAR.py index d5d4b8eb..669bd0f5 100644 --- a/test/TAR.py +++ b/test/TAR.py @@ -97,18 +97,27 @@ os.system(string.join(sys.argv[1:], " ")) foo = Environment() tar = foo.Dictionary('TAR') bar = Environment(TAR = r'%s wrapper.py ' + tar) +f3 = Environment(TARFLAGS = '-c -z', TARSUFFIX = '.tar.gz') +f4 = Environment(TARFLAGS = '-c -z', TARSUFFIX = '.tgz') +f5 = Environment(TARFLAGS = '-c -z') foo.Tar(target = 'foo.tar', source = ['file10', 'file11']) foo.Tar(target = 'foo.tar', source = 'file12') bar.Tar(target = 'bar.tar', source = ['file13', 'file14']) bar.Tar(target = 'bar.tar', source = 'file15') +f3.Tar(target = 'f3', source = 'file16') +f3.Tar(target = 'f3', source = ['file17', 'file18']) +f4.Tar(target = 'f4', source = 'file19') +f4.Tar(target = 'f4', source = ['file20', 'file21']) +f5.Tar(target = 'f5.tgz', source = 'file22') +f5.Tar(target = 'f5.tgz', source = ['file23', 'file24']) """ % python) - test.write('file10', "file10\n") - test.write('file11', "file11\n") - test.write('file12', "file12\n") - test.write('file13', "file13\n") - test.write('file14', "file14\n") - test.write('file15', "file15\n") + for f in ['file10', 'file11', 'file12', + 'file13', 'file14', 'file15', + 'file16', 'file17', 'file18', + 'file19', 'file20', 'file21', + 'file22', 'file23', 'file24']: + test.write(f, f + "\n") test.run(arguments = 'foo.tar', stderr = None) @@ -122,10 +131,32 @@ bar.Tar(target = 'bar.tar', source = 'file15') test.fail_test(not os.path.exists(test.workpath('bar.tar'))) + test.run(arguments = '.', stderr = None) + + test.fail_test(os.path.exists(test.workpath('f3.tar'))) + test.fail_test(not os.path.exists(test.workpath('f3.tar.gz'))) + + test.fail_test(os.path.exists(test.workpath('f4.tar'))) + test.fail_test(os.path.exists(test.workpath('f4.tar.gz'))) + test.fail_test(not os.path.exists(test.workpath('f4.tgz'))) + + test.fail_test(os.path.exists(test.workpath('f5.tar'))) + test.fail_test(os.path.exists(test.workpath('f5.tar.gz'))) + test.fail_test(not os.path.exists(test.workpath('f5.tgz'))) + test.run(program = tar, arguments = "-t -f foo.tar", stderr = None) test.fail_test(test.stdout() != "file10\nfile11\nfile12\n") test.run(program = tar, arguments = "-t -f bar.tar", stderr = None) test.fail_test(test.stdout() != "file13\nfile14\nfile15\n") + test.run(program = tar, arguments = "-t -z -f f3.tar.gz", stderr = None) + test.fail_test(test.stdout() != "file16\nfile17\nfile18\n") + + test.run(program = tar, arguments = "-t -z -f f4.tgz", stderr = None) + test.fail_test(test.stdout() != "file19\nfile20\nfile21\n") + + test.run(program = tar, arguments = "-t -z -f f5.tgz", stderr = None) + test.fail_test(test.stdout() != "file22\nfile23\nfile24\n") + test.pass_test() diff --git a/test/ZIP.py b/test/ZIP.py new file mode 100644 index 00000000..3ba6a23e --- /dev/null +++ b/test/ZIP.py @@ -0,0 +1,150 @@ +#!/usr/bin/env python +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +import os +import os.path +import string +import sys +import TestSCons + +python = TestSCons.python + +test = TestSCons.TestSCons() + +test.subdir('sub1') + +test.write('myzip.py', r"""\ +import os +import os.path +import sys +def process(outfile, name): + if os.path.isdir(name): + for entry in os.listdir(name): + process(outfile, os.path.join(name, entry)) + else: + outfile.write(open(name, 'rb').read()) +outfile = open(sys.argv[1], 'wb') +for infile in sys.argv[2:]: + process(outfile, infile) +outfile.close() +sys.exit(0) +""") + +test.write('SConstruct', """ +env = Environment(tools = ['zip'], + ZIPCOM = r'%s myzip.py $TARGET $SOURCES') +env.Zip(target = 'aaa.zip', source = ['file1', 'file2']) +env.Zip(target = 'aaa.zip', source = 'file3') +env.Zip(target = 'bbb', source = 'sub1') +env.Zip(target = 'bbb', source = 'file4') +""" % python) + +test.write('file1', "file1\n") +test.write('file2', "file2\n") +test.write('file3', "file3\n") +test.write('file4', "file4\n") + +test.write(['sub1', 'file5'], "sub1/file5\n") +test.write(['sub1', 'file6'], "sub1/file6\n") + +test.run(arguments = 'aaa.zip', stderr = None) + +test.fail_test(test.read('aaa.zip') != "file1\nfile2\nfile3\n") + +test.run(arguments = 'bbb.zip', stderr = None) + +test.fail_test(test.read('bbb.zip') != "sub1/file5\nsub1/file6\nfile4\n") + +try: + import zipfile + zip = 1 + + def files(fname): + zf = zipfile.ZipFile(fname, 'r') + return map(lambda x: x.filename, zf.infolist()) + +except ImportError: + zip = test.detect('ZIP', 'zip') + unzip = test.where_is('unzip') + + def files(fname, test=test, unzip=unzip): + test.run(program = unzip, arguments = "-l -qq %s" % fname) + lines = string.split(test.stdout(), "\n")[:-1] + def lastword(line): + return string.split(line)[-1] + return map(lastword, lines) + +if zip: + + marker_out = string.replace(test.workpath('marker.out'), '\\', '\\\\') + + test.write('SConstruct', """\ +def marker(target, source, env): + open(r'%s', 'wb').write("marker\\n") +import types +f1 = Environment() +zipcom = f1.Dictionary('ZIPCOM') +if not type(zipcom) is types.ListType: + zipcom = [zipcom] +f2 = Environment(ZIPCOM = [Action(marker)] + zipcom) +f3 = Environment(ZIPSUFFIX = '.xyzzy') +f1.Zip(target = 'f1.zip', source = ['file10', 'file11']) +f1.Zip(target = 'f1.zip', source = 'file12') +f2.Zip(target = 'f2.zip', source = ['file13', 'file14']) +f2.Zip(target = 'f2.zip', source = 'file15') +f3.Zip(target = 'f3', source = 'file16') +f3.Zip(target = 'f3', source = ['file17', 'file18']) +""" % marker_out) + + for f in ['file10', 'file11', 'file12', + 'file13', 'file14', 'file15', + 'file16', 'file17', 'file18']: + test.write(f, f + "\n") + + test.run(arguments = 'f1.zip', stderr = None) + + test.fail_test(os.path.exists(test.workpath('marker.out'))) + + test.fail_test(not os.path.exists(test.workpath('f1.zip'))) + + test.run(arguments = 'f2.zip', stderr = None) + + test.fail_test(test.read('marker.out') != 'marker\n') + + test.fail_test(not os.path.exists(test.workpath('f2.zip'))) + + test.run(arguments = '.', stderr = None) + + test.fail_test(os.path.exists(test.workpath('f3.zip'))) + test.fail_test(not os.path.exists(test.workpath('f3.xyzzy'))) + + test.fail_test(files("f1.zip") != ['file10', 'file11', 'file12']) + + test.fail_test(files("f2.zip") != ['file13', 'file14', 'file15']) + + test.fail_test(files("f3.xyzzy") != ['file16', 'file17', 'file18']) + +test.pass_test() |