From 8a1a4804a56a469c32aaa1c3b1310383b3befa54 Mon Sep 17 00:00:00 2001 From: Gary Oberbrunner Date: Sat, 20 Apr 2013 13:03:01 -0400 Subject: Added tests for ZIPROOT, and tweaked the ZIPROOT doc a bit. Also cleaned up the ZIP tests by assuming that python has the zipfile module, which has been true since python 1.6. --- src/engine/SCons/Tool/zip.py | 4 +- src/engine/SCons/Tool/zip.xml | 14 ++++- test/ZIP/ZIP.py | 142 +++++++++++++++++------------------------- test/ZIP/ZIPROOT.py | 98 +++++++++++++++++++++++++++++ 4 files changed, 170 insertions(+), 88 deletions(-) create mode 100644 test/ZIP/ZIPROOT.py diff --git a/src/engine/SCons/Tool/zip.py b/src/engine/SCons/Tool/zip.py index 1cfe541..2613bfc 100644 --- a/src/engine/SCons/Tool/zip.py +++ b/src/engine/SCons/Tool/zip.py @@ -57,9 +57,9 @@ if internal_zip: for fname in filenames: path = os.path.join(dirpath, fname) if os.path.isfile(path): - zf.write(path, os.path.relpath(path, env.get('ZIPROOT', ''))) + zf.write(path, os.path.relpath(path, str(env.get('ZIPROOT', '')))) else: - zf.write(str(s), os.path.relpath(str(s), env.get('ZIPROOT', ''))) + zf.write(str(s), os.path.relpath(str(s), str(env.get('ZIPROOT', '')))) zf.close() else: zipcompression = 0 diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml index 85b3d52..c2b8026 100644 --- a/src/engine/SCons/Tool/zip.xml +++ b/src/engine/SCons/Tool/zip.xml @@ -110,6 +110,18 @@ The suffix used for zip file names. -An optional zip root directory (default empty). +An optional zip root directory (default empty). The filenames stored +in the zip file will be relative to this directory, if given. +Otherwise the filenames are relative to the current directory of the +command. +For instance: + +env = Environment() +env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1') + +will produce a zip file foo.zip +containing a file with the name +subdir2/file1 rather than +subdir1/subdir2/file1. diff --git a/test/ZIP/ZIP.py b/test/ZIP/ZIP.py index ece64af..af2450b 100644 --- a/test/ZIP/ZIP.py +++ b/test/ZIP/ZIP.py @@ -36,37 +36,31 @@ test = TestSCons.TestSCons() try: import zipfile except ImportError: - zip = test.where_is('zip') - if not zip: - x = "Python version has no 'ziplib' module nor 'zip' utility; skipping tests.\n" - test.skip_test(x) + x = "Python version has no 'ziplib' module; skipping tests.\n" + test.skip_test(x) + +def zipfile_contains(zipfilename, names): + """Returns True if zipfilename contains all the names, False otherwise.""" + zf=zipfile.ZipFile(zipfilename, 'r') + if type(names)==type(''): + names=[names] + for name in names: + try: + info=zf.getinfo(name) + except KeyError, e: # name not found + zf.close() + return False + return True + +def zipfile_files(fname): + """Returns all the filenames in zip file fname.""" + zf = zipfile.ZipFile(fname, 'r') + return [x.filename for x in zf.infolist()] test.subdir('sub1') -test.write('myzip.py', r"""\ -import os -import os.path -import sys -def process(outfile, name): - if os.path.isdir(name): - ## TODO 2.4: the next three lines can be replaced by - #for entry in sorted(os.listdir(name)): - list = os.listdir(name) - list.sort() - for entry in list: - 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'%(_python_)s myzip.py $TARGET $SOURCES') +env = Environment(tools = ['zip']) env.Zip(target = 'aaa.zip', source = ['file1', 'file2']) env.Zip(target = 'aaa.zip', source = 'file3') env.Zip(target = 'bbb', source = 'sub1') @@ -83,38 +77,19 @@ 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.must_exist('aaa.zip') +test.fail_test(not zipfile_contains('aaa.zip', ['file1', 'file2', 'file3'])) test.run(arguments = 'bbb.zip', stderr = None) -test.fail_test(test.read('bbb.zip') != "sub1/file5\nsub1/file6\nfile4\n") +test.must_exist('bbb.zip') +test.fail_test(not zipfile_contains('bbb.zip', ['sub1/file5', 'sub1/file6', 'file4'])) -try: - import zipfile - internal_zip = 1 - zip = 1 - - def files(fname): - zf = zipfile.ZipFile(fname, 'r') - return [x.filename for x in zf.infolist()] - -except ImportError: - internal_zip = 0 - 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 = test.stdout().split("\n")[:-1] - def lastword(line): - return line.split()[-1] - return list(map(lastword, lines)) +marker_out = test.workpath('marker.out').replace('\\', '\\\\') -if zip: - - marker_out = test.workpath('marker.out').replace('\\', '\\\\') - - test.write('SConstruct', """\ +test.write('SConstruct', """\ def marker(target, source, env): open(r'%s', 'wb').write("marker\\n") f1 = Environment() @@ -129,53 +104,50 @@ 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']) -try: - import zipfile - sources = ['file10', 'file11', 'file12', 'file13', 'file14', 'file15'] - f1.Zip(target = 'f4.zip', source = sources) - f1.Zip(target = 'f4stored.zip', source = sources, - ZIPCOMPRESSION = zipfile.ZIP_STORED) - f1.Zip(target = 'f4deflated.zip', source = sources, - ZIPCOMPRESSION = zipfile.ZIP_DEFLATED) -except ImportError: - pass + +import zipfile +sources = ['file10', 'file11', 'file12', 'file13', 'file14', 'file15'] +f1.Zip(target = 'f4.zip', source = sources) +f1.Zip(target = 'f4stored.zip', source = sources, + ZIPCOMPRESSION = zipfile.ZIP_STORED) +f1.Zip(target = 'f4deflated.zip', source = sources, + ZIPCOMPRESSION = zipfile.ZIP_DEFLATED) """ % marker_out) - for f in ['file10', 'file11', 'file12', - 'file13', 'file14', 'file15', - 'file16', 'file17', 'file18']: - test.write(f, f + "\n") +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.run(arguments = 'f1.zip', stderr = None) - test.fail_test(os.path.exists(test.workpath('marker.out'))) +test.fail_test(os.path.exists(test.workpath('marker.out'))) - test.fail_test(not os.path.exists(test.workpath('f1.zip'))) +test.fail_test(not os.path.exists(test.workpath('f1.zip'))) - test.run(arguments = 'f2.zip', stderr = None) +test.run(arguments = 'f2.zip', stderr = None) - test.fail_test(test.read('marker.out') != 'marker\n') +test.fail_test(test.read('marker.out') != 'marker\n') - test.fail_test(not os.path.exists(test.workpath('f2.zip'))) +test.fail_test(not os.path.exists(test.workpath('f2.zip'))) - test.run(arguments = '.', stderr = None) +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(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(zipfile_files("f1.zip") != ['file10', 'file11', 'file12']) - test.fail_test(files("f2.zip") != ['file13', 'file14', 'file15']) +test.fail_test(zipfile_files("f2.zip") != ['file13', 'file14', 'file15']) - test.fail_test(files("f3.xyzzy") != ['file16', 'file17', 'file18']) +test.fail_test(zipfile_files("f3.xyzzy") != ['file16', 'file17', 'file18']) - if internal_zip: - f4_size = os.stat('f4.zip')[stat.ST_SIZE] - f4stored_size = os.stat('f4stored.zip')[stat.ST_SIZE] - f4deflated_size = os.stat('f4deflated.zip')[stat.ST_SIZE] +f4_size = os.stat('f4.zip')[stat.ST_SIZE] +f4stored_size = os.stat('f4stored.zip')[stat.ST_SIZE] +f4deflated_size = os.stat('f4deflated.zip')[stat.ST_SIZE] - test.fail_test(f4_size != f4deflated_size) - test.fail_test(f4stored_size == f4deflated_size) +test.fail_test(f4_size != f4deflated_size) +test.fail_test(f4stored_size == f4deflated_size) test.pass_test() diff --git a/test/ZIP/ZIPROOT.py b/test/ZIP/ZIPROOT.py new file mode 100644 index 0000000..96747a7 --- /dev/null +++ b/test/ZIP/ZIPROOT.py @@ -0,0 +1,98 @@ +#!/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 stat + +import TestSCons + +_python_ = TestSCons._python_ + +test = TestSCons.TestSCons() + +import zipfile + +def zipfile_contains(zipfilename, names): + """Returns True if zipfilename contains all the names, False otherwise.""" + zf=zipfile.ZipFile(zipfilename, 'r') + if type(names)==type(''): + names=[names] + for name in names: + try: + info=zf.getinfo(name) + except KeyError, e: # name not found + zf.close() + return False + return True + +def zipfile_files(fname): + """Returns all the filenames in zip file fname.""" + zf = zipfile.ZipFile(fname, 'r') + return [x.filename for x in zf.infolist()] + +test.subdir('sub1') +test.subdir(['sub1', 'sub2']) + +test.write('SConstruct', """ +env = Environment(tools = ['zip']) +env.Zip(target = 'aaa.zip', source = ['sub1/file1'], ZIPROOT='sub1') +env.Zip(target = 'bbb.zip', source = ['sub1/file2', 'sub1/sub2/file2'], ZIPROOT='sub1') +""" % locals()) + +test.write(['sub1', 'file1'], "file1\n") +test.write(['sub1', 'file2'], "file2a\n") +test.write(['sub1', 'sub2', 'file2'], "file2b\n") + +test.run(arguments = 'aaa.zip', stderr = None) + +test.must_exist('aaa.zip') + +# TEST: Zip file should contain 'file1', not 'sub1/file1', because of ZIPROOT. +zf=zipfile.ZipFile('aaa.zip', 'r') +test.fail_test(zf.testzip() is not None) +zf.close() + +files=zipfile_files('aaa.zip') +test.fail_test(zipfile_files('aaa.zip') != ['file1'], + message='Zip file aaa.zip has wrong files: %s'%repr(files)) + +### + +test.run(arguments = 'bbb.zip', stderr = None) + +test.must_exist('bbb.zip') + +# TEST: Zip file should contain 'sub2/file2', not 'sub1/sub2/file2', because of ZIPROOT. +zf=zipfile.ZipFile('bbb.zip', 'r') +test.fail_test(zf.testzip() is not None) +zf.close() + +files=zipfile_files('bbb.zip') +test.fail_test(zipfile_files('bbb.zip') != ['file2', 'sub2/file2'], + message='Zip file bbb.zip has wrong files: %s'%repr(files)) + + +test.pass_test() -- cgit v0.12