Capture a test case to verify correct behavior of $( $) on long lines

handled by TempFileMunge.  Comment the behavior.  Other minor cleanups.

3 files changed, 114 insertions, 9 deletions

diff --git a/src/engine/SCons/Platform/__init__.py b/src/engine/SCons/Platform/__init__.py
index 0a47059..e9a6a0b 100644
--- a/src/engine/SCons/Platform/__init__.py
+++ b/src/engine/SCons/Platform/__init__.py
@@ -51,6 +51,7 @@ import sys
 import tempfile
 
 import SCons.Errors
+import SCons.Subst
 import SCons.Tool
 
 def platform_default():
@@ -147,8 +148,18 @@ class TempFileMunge:
 
     def __call__(self, target, source, env, for_signature):
         if for_signature:
+            # If we're being called for signature calculation, it's
+            # because we're being called by the string expansion in
+            # Subst.py, which has the logic to strip any $( $) that
+            # may be in the command line we squirreled away.  So we
+            # just return the raw command line and let the upper
+            # string substitution layers do their thing.
             return self.cmd
-        cmd = env.subst_list(self.cmd, 0, target, source)[0]
+
+        # Now we're actually being called because someone is actually
+        # going to try to execute the command, so we have to do our
+        # own expansion.
+        cmd = env.subst_list(self.cmd, SCons.Subst.SUBST_CMD, target, source)[0]
         try:
             maxline = int(env.subst('$MAXLINELENGTH'))
         except ValueError:
diff --git a/test/long-lines.py b/test/long-lines/live.py
index 02551ce..916740a 100644
--- a/test/long-lines.py
+++ b/test/long-lines/live.py
@@ -24,7 +24,11 @@
 
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
-import os
+"""
+Verify correct execution of long command lines with the live utilities
+that use TempFileMunge().
+"""
+
 import sys
 
 import TestSCons
@@ -61,13 +65,13 @@ else:
     linkflag = ' -L' + test.workpath()
 
 test.write('SConstruct', """
-arflags = r'%s'
+arflags = r'%(arflag_init)s'
 while len(arflags) <= 8100:
-    arflags = arflags + r'%s'
+    arflags = arflags + r'%(arflag)s'
 
-linkflags = r'%s'
+linkflags = r'%(linkflag_init)s'
 while len(linkflags) <= 8100:
-    linkflags = linkflags + r'%s'
+    linkflags = linkflags + r'%(linkflag)s'
 
 env = Environment(ARFLAGS = '$ARXXX', ARXXX = arflags,
                   LINKFLAGS = '$LINKXXX', LINKXXX = linkflags)
@@ -76,7 +80,7 @@ env.Program(target = 'foo', source = 'foo.c')
 env.StaticLibrary(target = 'static', source = 'static.c')
 # SharedLibrary() uses $LINKFLAGS by default.
 env.SharedLibrary(target = 'shared', source = 'shared.c', no_import_lib=1)
-""" % (arflag_init, arflag, linkflag_init, linkflag))
+""" % locals())
 
 test.write('foo.c', r"""
 #include <stdio.h>
@@ -123,8 +127,8 @@ test.up_to_date(arguments = '.')
 
 test.run(program = test.workpath('foo'), stdout = "foo.c\n")
 
-test.fail_test(not os.path.exists(lib_static_lib))
+test.must_exist(lib_static_lib)
 
-test.fail_test(not os.path.exists(lib_shared_dll))
+test.must_exist(lib_shared_dll)
 
 test.pass_test()
diff --git a/test/long-lines/signature.py b/test/long-lines/signature.py
new file mode 100644
index 0000000..cc8f3e2
--- /dev/null
+++ b/test/long-lines/signature.py
@@ -0,0 +1,90 @@
+#!/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__"
+
+"""
+Verify that use of long command lines correctly excludes arguments
+surrounded by $( $) from the signature calculation.
+"""
+
+import os
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+build_py = test.workpath('build.py')
+
+test.write(build_py, """\
+#!/usr/bin/env python
+import string
+import sys
+if sys.argv[1][0] == '@':
+    args = open(sys.argv[1][1:], 'rb').read()
+    args = string.split(args)
+else:
+    args = sys.argv[1:]
+fp = open(args[0], 'wb')
+fp.write(open(args[1], 'rb').read())
+fp.write('FILEFLAG=%s\\n' % args[2])
+fp.write('TIMESTAMP=%s\\n' % args[3])
+""")
+
+os.chmod(build_py, 0755)
+
+test.write('SConstruct', """\
+arg = 'a_long_ignored_argument'
+extra_arguments = arg
+while len(extra_arguments) <= 1024:
+    extra_arguments = extra_arguments + ' ' + arg
+env = Environment(FILECOM=[r'%(build_py)s',
+                           '$TARGET', '$SOURCE',
+                           '$FILEFLAG',
+                           '$(', '$TIMESTAMP', '$)',
+                           '$EXTRA_ARGUMENTS'],
+                  FILEFLAG=ARGUMENTS.get('FILEFLAG'),
+                  TIMESTAMP=ARGUMENTS.get('TIMESTAMP'),
+                  EXTRA_ARGUMENTS=extra_arguments,
+                  MAXLINELENGTH=1024)
+env.PrependENVPath('PATHEXT', '.PY')
+env.Command('file.out', 'file.in',
+            '${TEMPFILE(FILECOM)}')
+""" % locals())
+
+test.write('file.in', "file.in\n")
+
+test.run(arguments='FILEFLAG=first TIMESTAMP=20090207 .')
+
+test.must_match('file.out', "file.in\nFILEFLAG=first\nTIMESTAMP=20090207\n")
+
+test.up_to_date(options='FILEFLAG=first TIMESTAMP=20090208', arguments = '.')
+
+test.run(arguments='FILEFLAG=second TIMESTAMP=20090208 .')
+
+test.must_match('file.out', "file.in\nFILEFLAG=second\nTIMESTAMP=20090208\n")
+
+test.up_to_date(options='FILEFLAG=second TIMESTAMP=20090209', arguments = '.')
+
+test.pass_test()