Add CacheDir support.

4 files changed, 429 insertions, 22 deletions

diff --git a/test/CacheDir.py b/test/CacheDir.py
new file mode 100644
index 0000000..ffe7444
--- /dev/null
+++ b/test/CacheDir.py
@@ -0,0 +1,130 @@
+#!/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__"
+
+"""
+Test retrieving derived files from a CacheDir.
+"""
+
+import os.path
+import shutil
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.subdir('cache', 'src')
+
+test.write(['src', 'SConstruct'], """
+def cat(env, source, target):
+    target = str(target[0])
+    open('cat.out', 'ab').write(target + "\\n")
+    source = map(str, source)
+    f = open(target, "wb")
+    for src in source:
+        f.write(open(src, "rb").read())
+    f.close()
+env = Environment(BUILDERS={'Cat':Builder(action=cat)})
+env.Cat('aaa.out', 'aaa.in')
+env.Cat('bbb.out', 'bbb.in')
+env.Cat('ccc.out', 'ccc.in')
+env.Cat('all', ['aaa.out', 'bbb.out', 'ccc.out'])
+CacheDir(r'%s')
+""" % test.workpath('cache'))
+
+test.write(['src', 'aaa.in'], "aaa.in\n")
+test.write(['src', 'bbb.in'], "bbb.in\n")
+test.write(['src', 'ccc.in'], "ccc.in\n")
+
+# Verify that a normal build works correctly, and clean up.
+# This should populate the cache with our derived files.
+test.run(chdir = 'src', arguments = '.')
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
+
+# Verify that we now retrieve the derived files from cache,
+# not rebuild them.  Then clean up.
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+# Verify that rebuilding with -n reports that everything was retrieved
+# from the cache, but that nothing really was.
+test.run(chdir = 'src', arguments = '-n .', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(os.path.exists(test.workpath('src', 'aaa.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'bbb.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'ccc.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'all')))
+
+# Verify that rebuilding with -s retrieves everything from the cache
+# even though it doesn't report anything.
+test.run(chdir = 'src', arguments = '-s .', stdout = "")
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+# Verify that updating one input file builds its derived file and
+# dependency but that the other files are retrieved from cache.
+test.write(['src', 'bbb.in'], "bbb.in 2\n")
+
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+cat("bbb.out", "bbb.in")
+Retrieved `ccc.out' from cache
+cat("all", ["aaa.out", "bbb.out", "ccc.out"])
+"""))
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in 2\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "bbb.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+# All done.
+test.pass_test()
diff --git a/test/option--cd.py b/test/option--cd.py
index 0f83bd3..e68256b 100644
--- a/test/option--cd.py
+++ b/test/option--cd.py
@@ -24,19 +24,106 @@
 
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
+"""
+Test the --cache-disable option when retrieving derived files from a
+CacheDir.
+"""
+
+import os.path
+import shutil
+
 import TestSCons
-import string
-import sys
 
 test = TestSCons.TestSCons()
 
-test.write('SConstruct', "")
+test.subdir('cache', 'src')
+
+test.write(['src', 'SConstruct'], """
+def cat(env, source, target):
+    target = str(target[0])
+    open('cat.out', 'ab').write(target + "\\n")
+    source = map(str, source)
+    f = open(target, "wb")
+    for src in source:
+        f.write(open(src, "rb").read())
+    f.close()
+env = Environment(BUILDERS={'Cat':Builder(action=cat)})
+env.Cat('aaa.out', 'aaa.in')
+env.Cat('bbb.out', 'bbb.in')
+env.Cat('ccc.out', 'ccc.in')
+env.Cat('all', ['aaa.out', 'bbb.out', 'ccc.out'])
+CacheDir(r'%s')
+""" % test.workpath('cache'))
+
+test.write(['src', 'aaa.in'], "aaa.in\n")
+test.write(['src', 'bbb.in'], "bbb.in\n")
+test.write(['src', 'ccc.in'], "ccc.in\n")
+
+# Verify that a normal build works correctly, and clean up.
+# This should populate the cache with our derived files.
+test.run(chdir = 'src', arguments = '.')
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
+
+# Verify that we now retrieve the derived files from cache,
+# not rebuild them.  Then clean up.
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+# Verify that when run with --cache-disable, we rebuild the files even
+# though they're available from the cache.  Then clean up.
+test.run(chdir = 'src',
+         arguments = '--cache-disable .',
+         stdout = test.wrap_stdout("""\
+cat("aaa.out", "aaa.in")
+cat("bbb.out", "bbb.in")
+cat("ccc.out", "ccc.in")
+cat("all", ["aaa.out", "bbb.out", "ccc.out"])
+"""))
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
+
+# Verify that when run with --no-cache, we rebuild the files even
+# though they're available from the cache.  Then clean up.
+test.run(chdir = 'src',
+         arguments = '--no-cache .',
+         stdout = test.wrap_stdout("""\
+cat("aaa.out", "aaa.in")
+cat("bbb.out", "bbb.in")
+cat("ccc.out", "ccc.in")
+cat("all", ["aaa.out", "bbb.out", "ccc.out"])
+"""))
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
 
-test.run(arguments = '--cache-disable .',
-	 stderr = "Warning:  the --cache-disable option is not yet implemented\n")
+test.up_to_date(chdir = 'src', arguments = '.')
 
-test.run(arguments = '--no-cache .',
-	 stderr = "Warning:  the --no-cache option is not yet implemented\n")
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
 
+# All done.
 test.pass_test()
- 
diff --git a/test/option--cf.py b/test/option--cf.py
index 94e1fdb..47847d4 100644
--- a/test/option--cf.py
+++ b/test/option--cf.py
@@ -24,19 +24,100 @@
 
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
+"""
+Test populating a CacheDir with the --cache-force option.
+"""
+
+import os.path
+import shutil
+
 import TestSCons
-import string
-import sys
 
 test = TestSCons.TestSCons()
 
-test.write('SConstruct', "")
+test.subdir('cache', 'src')
+
+test.write(['src', 'SConstruct'], """
+def cat(env, source, target):
+    target = str(target[0])
+    open('cat.out', 'ab').write(target + "\\n")
+    source = map(str, source)
+    f = open(target, "wb")
+    for src in source:
+        f.write(open(src, "rb").read())
+    f.close()
+env = Environment(BUILDERS={'Cat':Builder(action=cat)})
+env.Cat('aaa.out', 'aaa.in')
+env.Cat('bbb.out', 'bbb.in')
+env.Cat('ccc.out', 'ccc.in')
+env.Cat('all', ['aaa.out', 'bbb.out', 'ccc.out'])
+CacheDir(r'%s')
+""" % test.workpath('cache'))
+
+test.write(['src', 'aaa.in'], "aaa.in\n")
+test.write(['src', 'bbb.in'], "bbb.in\n")
+test.write(['src', 'ccc.in'], "ccc.in\n")
+
+# Verify that a normal build works correctly, and clean up.
+# This should populate the cache with our derived files.
+test.run(chdir = 'src', arguments = '.')
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
+
+# Verify that we now retrieve the derived files from cache,
+# not rebuild them.  DO NOT CLEAN UP.
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+# Blow away and recreate the CacheDir, then verify that --cache-force
+# repopulates the cache with the local built targets.  DO NOT CLEAN UP.
+shutil.rmtree(test.workpath('cache'))
+test.subdir('cache')
+
+test.run(chdir = 'src', arguments = '--cache-force .')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+# Blow away and recreate the CacheDir, then verify that --cache-populate
+# repopulates the cache with the local built targets.  DO NOT CLEAN UP.
+shutil.rmtree(test.workpath('cache'))
+test.subdir('cache')
+
+test.run(chdir = 'src', arguments = '--cache-populate .')
+
+test.run(chdir = 'src', arguments = '-c .')
 
-test.run(arguments = '--cache-force .',
-	 stderr = "Warning:  the --cache-force option is not yet implemented\n")
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
 
-test.run(arguments = '--cache-populate .',
-	 stderr = "Warning:  the --cache-populate option is not yet implemented\n")
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
 
+# All done.
 test.pass_test()
- 
diff --git a/test/option--cs.py b/test/option--cs.py
index 1ed6eb4..ff1b221 100644
--- a/test/option--cs.py
+++ b/test/option--cs.py
@@ -24,16 +24,125 @@
 
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
+"""
+Test printing build actions when using the --cache-show option and
+retrieving derived files from a CacheDir.
+"""
+
+import os.path
+import shutil
+
 import TestSCons
-import string
-import sys
+
+python = TestSCons.python
 
 test = TestSCons.TestSCons()
 
-test.write('SConstruct', "")
+test.subdir('cache', 'src')
+
+test.write(['src', 'build.py'], r"""
+import sys
+open('cat.out', 'ab').write(sys.argv[1] + "\n")
+file = open(sys.argv[1], 'wb')
+for src in sys.argv[2:]:
+    file.write(open(src, 'rb').read())
+file.close()
+""")
+
+test.write(['src', 'SConstruct'], """
+def cat(env, source, target):
+    target = str(target[0])
+    open('cat.out', 'ab').write(target + "\\n")
+    source = map(str, source)
+    f = open(target, "wb")
+    for src in source:
+        f.write(open(src, "rb").read())
+    f.close()
+env = Environment(BUILDERS={'Internal':Builder(action=cat),
+                            'External':Builder(action='%s build.py $TARGET $SOURCES')})
+env.External('aaa.out', 'aaa.in')
+env.External('bbb.out', 'bbb.in')
+env.Internal('ccc.out', 'ccc.in')
+env.Internal('all', ['aaa.out', 'bbb.out', 'ccc.out'])
+CacheDir(r'%s')
+""" % (python, test.workpath('cache')))
+
+test.write(['src', 'aaa.in'], "aaa.in\n")
+test.write(['src', 'bbb.in'], "bbb.in\n")
+test.write(['src', 'ccc.in'], "ccc.in\n")
+
+# Verify that a normal build works correctly, and clean up.
+# This should populate the cache with our derived files.
+test.run(chdir = 'src', arguments = '.')
+
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+
+test.fail_test(test.read(['src', 'cat.out']) != "aaa.out\nbbb.out\nccc.out\nall\n")
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+test.unlink(['src', 'cat.out'])
+
+# Verify that we now retrieve the derived files from cache,
+# not rebuild them.  Then clean up.
+test.run(chdir = 'src', arguments = '.', stdout = test.wrap_stdout("""\
+Retrieved `aaa.out' from cache
+Retrieved `bbb.out' from cache
+Retrieved `ccc.out' from cache
+Retrieved `all' from cache
+"""))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+# Verify that using --cache-show reports the files as being rebuilt,
+# even though we actually fetch them from the cache.  Then clean up.
+test.run(chdir = 'src',
+         arguments = '--cache-show .',
+         stdout = test.wrap_stdout("""\
+%s build.py aaa.out aaa.in
+%s build.py bbb.out bbb.in
+cat("ccc.out", "ccc.in")
+cat("all", ["aaa.out", "bbb.out", "ccc.out"])
+""" % (python, python)))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.up_to_date(chdir = 'src', arguments = '.')
+
+test.run(chdir = 'src', arguments = '-c .')
+
+# Verify that using --cache-show -n reports the files as being rebuilt,
+# even though we don't actually fetch them from the cache.  No need to
+# clean up.
+test.run(chdir = 'src',
+         arguments = '--cache-show -n .',
+         stdout = test.wrap_stdout("""\
+%s build.py aaa.out aaa.in
+%s build.py bbb.out bbb.in
+cat("ccc.out", "ccc.in")
+cat("all", ["aaa.out", "bbb.out", "ccc.out"])
+""" % (python, python)))
+
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
+
+test.fail_test(os.path.exists(test.workpath('src', 'aaa.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'bbb.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'ccc.out')))
+test.fail_test(os.path.exists(test.workpath('src', 'all')))
+
+# Verify that using --cache-show -s doesn't report anything, even though
+# we do fetch the files from the cache.  No need to clean up.
+test.run(chdir = 'src',
+         arguments = '--cache-show -s .',
+         stdout = "")
 
-test.run(arguments = '--cache-show .',
-	 stderr = "Warning:  the --cache-show option is not yet implemented\n")
+test.fail_test(test.read(['src', 'all']) != "aaa.in\nbbb.in\nccc.in\n")
+test.fail_test(os.path.exists(test.workpath('src', 'cat.out')))
 
+# All done.
 test.pass_test()
-