Massage test fixtures a bit

To avoid double loops, a couple now use fileinput module.

CC and CXX tests switch to using general mylink.py fixture instead of
locally defined linker script.  This did mean that the marker for the
mock linker that the script removes had to be harmonized as #link - some
were using /*link*/.

Could not switch CC/CXX to use the general mycompile.py mock compiler
due to difference in intent: mycompile.py is intended to plug in as a
*COM variable, which means the whole cmdline is in the caller's control.
mycc.py is intended to plug in as CC and mycxx.py as CXX, which means
standard os-dependent construction vars will be passed via the default
CCCOM and CXXCOM and have to be handled.

Signed-off-by: Mats Wichmann <mats@linux.com>

11 files changed, 211 insertions, 221 deletions

diff --git a/test/AS/fixture/myas.py b/test/AS/fixture/myas.py
index 3d05c79..a348ace 100644
--- a/test/AS/fixture/myas.py
+++ b/test/AS/fixture/myas.py
@@ -1,6 +1,7 @@
 import sys
 
-if sys.platform == 'win32':
+
+def my_win32_as():
     args = sys.argv[1:]
     inf = None
     while args:
@@ -10,29 +11,41 @@ if sys.platform == 'win32':
             args = args[2:]
             continue
         args = args[1:]
-        if not a[0] in "/-":
+        if not a[0] in '/-':
             if not inf:
                 inf = a
             continue
-        if a[:3] == '/Fo': out = a[3:]
+        if a[:3] == '/Fo':
+            out = a[3:]
+
     with open(inf, 'rb') as ifp, open(out, 'wb') as ofp:
-        for l in ifp.readlines():
-            if l[:3] != b'#as':
-                ofp.write(l)
-    sys.exit(0)
+        for line in ifp:
+            if not line.startswith(b'#as'):
+                ofp.write(line)
+
 
-else:
+def my_as():
     import getopt
+
     try:
         opts, args = getopt.getopt(sys.argv[1:], 'co:')
     except getopt.GetoptError:
         # we may be called with --version, just quit if so
         sys.exit(0)
     for opt, arg in opts:
-        if opt == '-o': out = arg
+        if opt == '-o':
+            out = arg
+
     if args:
         with open(args[0], 'rb') as ifp, open(out, 'wb') as ofp:
-            for l in ifp.readlines():
-                if l[:3] != b'#as':
-                    ofp.write(l)
+            for line in ifp:
+                if not line.startswith(b'#as'):
+                    ofp.write(line)
+
+
+if __name__ == "__main__":
+    if sys.platform == 'win32':
+        my_win32_as()
+    else:
+        my_as()
     sys.exit(0)
diff --git a/test/AS/fixture/myas_args.py b/test/AS/fixture/myas_args.py
index 24d68dc..7a5e6fa 100644
--- a/test/AS/fixture/myas_args.py
+++ b/test/AS/fixture/myas_args.py
@@ -1,6 +1,7 @@
 import sys
 
-if sys.platform == 'win32':
+
+def my_win32_as():
     args = sys.argv[1:]
     inf = None
     optstring = ''
@@ -21,25 +22,38 @@ if sys.platform == 'win32':
             out = a[3:]
             continue
         optstring = optstring + ' ' + a
+
     with open(inf, 'rb') as ifp, open(out, 'wb') as ofp:
-        ofp.write(bytearray(optstring + "\n",'utf-8'))
-        for l in ifp.readlines():
-            if l[:3] != b'#as':
-                ofp.write(l)
-    sys.exit(0)
-else:
+        optstring = optstring + "\n"
+        ofp.write(optstring.encode('utf-8'))
+        for line in ifp:
+            if not line.startswith(b'#as'):
+                ofp.write(line)
+
+
+def my_as():
     import getopt
+
     opts, args = getopt.getopt(sys.argv[1:], 'co:x')
     optstring = ''
 
     for opt, arg in opts:
-        if opt == '-o': out = arg
-        else: optstring = optstring + ' ' + opt
+        if opt == '-o':
+            out = arg
+        else:
+            optstring = optstring + ' ' + opt
 
     with open(args[0], 'rb') as ifp, open(out, 'wb') as ofp:
-        ofp.write(bytearray(optstring + "\n",'utf-8'))
-        for l in ifp.readlines():
-            if l[:3] != b'#as':
-                ofp.write(l)
+        optstring = optstring + "\n"
+        ofp.write(optstring.encode('utf-8'))
+        for line in ifp:
+            if not line.startswith(b'#as'):
+                ofp.write(line)
+
 
+if __name__ == "__main__":
+    if sys.platform == 'win32':
+        my_win32_as()
+    else:
+        my_as()
     sys.exit(0)
diff --git a/test/CC/CC-fixture/test1.c b/test/CC/CC-fixture/test1.c
index 7535b0a..6748e2c 100644
--- a/test/CC/CC-fixture/test1.c
+++ b/test/CC/CC-fixture/test1.c
@@ -1,3 +1,3 @@
 This is a .c file.
 /*cc*/
-/*link*/
+#link
diff --git a/test/CC/CC-fixture/test2.C b/test/CC/CC-fixture/test2.C
index a1ee9e3..388133b 100644
--- a/test/CC/CC-fixture/test2.C
+++ b/test/CC/CC-fixture/test2.C
@@ -1,3 +1,3 @@
 This is a .C file.
 /*cc*/
-/*link*/
+#link
diff --git a/test/CC/CC.py b/test/CC/CC.py
index 6363273..c2562d5 100644
--- a/test/CC/CC.py
+++ b/test/CC/CC.py
@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 #
-# __COPYRIGHT__
+# MIT License
+#
+# Copyright The SCons Foundation
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,46 +22,27 @@
 # 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 sys
 import TestSCons
 
 _python_ = TestSCons._python_
-_exe   = TestSCons._exe
+_exe = TestSCons._exe
 
 test = TestSCons.TestSCons()
 
 test.dir_fixture('CC-fixture')
+test.file_fixture('mylink.py')
 
+# Note: mycc.py differs from the general fixture file mycompile.py
+# in arg handling: that one is intended for use as a *COM consvar,
+# where no compiler consvars will be passed on, this one is intended
+# for use as $CC, where arguments like -o come into play.
 if sys.platform == 'win32':
-
-    test.write('mylink.py', r"""
-import sys
-args = sys.argv[1:]
-while args:
-    a = args[0]
-    if a == '-o':
-        out = args[1]
-        args = args[2:]
-        continue
-    if not a[0] in '/-':
-        break
-    args = args[1:]
-    if a[:5].lower() == '/out:': out = a[5:]
-infile = open(args[0], 'rb')
-outfile = open(out, 'wb')
-for l in infile.readlines():
-    if l[:8] != b'/*link*/':
-        outfile.write(l)
-sys.exit(0)
-""")
-
     test.write('mycc.py', r"""
 import sys
+
 args = sys.argv[1:]
 inf = None
 while args:
@@ -69,57 +52,47 @@ while args:
         args = args[2:]
         continue
     args = args[1:]
-    if not a[0] in '-/':
+    if a[0] not in '-/':
         if not inf:
             inf = a
         continue
-    if a[:3] == '/Fo': out = a[3:]
-infile = open(inf, 'rb')
-outfile = open(out, 'wb')
-for l in infile.readlines():
-    if l[:6] != b'/*cc*/':
-        outfile.write(l)
-sys.exit(0)
-""")
-
-else:
+    if a.startswith('/Fo'):
+        out = a[3:]
 
-    test.write('mylink.py', r"""
-import getopt
-import sys
-opts, args = getopt.getopt(sys.argv[1:], 'o:')
-for opt, arg in opts:
-    if opt == '-o': out = arg
-infile = open(args[0], 'rb')
-outfile = open(out, 'wb')
-for l in infile.readlines():
-    if l[:8] != b'/*link*/':
-        outfile.write(l)
+with open(inf, 'rb') as infile, open(out, 'wb') as outfile:
+    for line in infile:
+        if not line.startswith(b'/*cc*/'):
+            outfile.write(line)
 sys.exit(0)
 """)
 
+else:
     test.write('mycc.py', r"""
 import getopt
 import sys
+
 opts, args = getopt.getopt(sys.argv[1:], 'co:')
 for opt, arg in opts:
-    if opt == '-o': out = arg
-infile = open(args[0], 'rb')
-outfile = open(out, 'wb')
-for l in infile.readlines():
-    if l[:6] != b'/*cc*/':
-        outfile.write(l)
+    if opt == '-o':
+        out = arg
+
+with open(args[0], 'rb') as infile, open(out, 'wb') as outfile:
+    for line in infile:
+        if not line.startswith(b'/*cc*/'):
+            outfile.write(line)
 sys.exit(0)
 """)
 
 test.write('SConstruct', """
 cc = Environment().Dictionary('CC')
-env = Environment(LINK = r'%(_python_)s mylink.py',
-                  LINKFLAGS = [],
-                  CC = r'%(_python_)s mycc.py',
-                  CXX = cc,
-                  CXXFLAGS = [])
-env.Program(target = 'test1', source = 'test1.c')
+env = Environment(
+    LINK=r'%(_python_)s mylink.py',
+    LINKFLAGS=[],
+    CC=r'%(_python_)s mycc.py',
+    CXX=cc,
+    CXXFLAGS=[],
+)
+env.Program(target='test1', source='test1.c')
 """ % locals())
 
 test.run(arguments = '.', stderr = None)
@@ -130,10 +103,12 @@ if os.path.normcase('.c') == os.path.normcase('.C'):
 
     test.write('SConstruct', """
 cc = Environment().Dictionary('CC')
-env = Environment(LINK = r'%(_python_)s mylink.py',
-                  CC = r'%(_python_)s mycc.py',
-                  CXX = cc)
-env.Program(target = 'test2', source = 'test2.C')
+env = Environment(
+    LINK=r'%(_python_)s mylink.py',
+    CC=r'%(_python_)s mycc.py',
+    CXX=cc,
+)
+env.Program(target='test2', source='test2.C')
 """ % locals())
 
     test.run(arguments = '.', stderr = None)
@@ -144,9 +119,9 @@ test.file_fixture('wrapper.py')
 test.write('SConstruct', """
 foo = Environment()
 cc = foo.Dictionary('CC')
-bar = Environment(CC = r'%(_python_)s wrapper.py ' + cc)
-foo.Program(target = 'foo', source = 'foo.c')
-bar.Program(target = 'bar', source = 'bar.c')
+bar = Environment(CC=r'%(_python_)s wrapper.py ' + cc)
+foo.Program(target='foo', source='foo.c')
+bar.Program(target='bar', source='bar.c')
 """ % locals())
 
 test.run(arguments = 'foo' + _exe)
diff --git a/test/CXX/CXX.py b/test/CXX/CXX.py
index 4be4199..836324f 100644
--- a/test/CXX/CXX.py
+++ b/test/CXX/CXX.py
@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 #
-# __COPYRIGHT__
+# MIT License
+#
+# Copyright The SCons Foundation
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,9 +22,6 @@
 # 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 sys
 import TestSCons
@@ -32,33 +31,16 @@ _exe   = TestSCons._exe
 
 test = TestSCons.TestSCons()
 
+test.file_fixture('mylink.py')
 
-
+# Note: mycxx.py differs from the general fixture file mycompile.py
+# in arg handling: that one is intended for use as a *COM consvar,
+# where no compiler consvars will be passed on, this one is intended
+# for use as $CXX, where arguments like -o come into play.
 if sys.platform == 'win32':
-
-    test.write('mylink.py', r"""
-import sys
-args = sys.argv[1:]
-while args:
-    a = args[0]
-    if a == '-o':
-        out = args[1]
-        args = args[2:]
-        continue
-    if not a[0] in '/-':
-        break
-    args = args[1:]
-    if a[:5].lower() == '/out:': out = a[5:]
-infile = open(args[0], 'r')
-outfile = open(out, 'w')
-for l in infile.readlines():
-    if l[:8] != '/*link*/':
-        outfile.write(l)
-sys.exit(0)
-""")
-
     test.write('myc++.py', r"""
 import sys
+
 args = sys.argv[1:]
 inf = None
 while args:
@@ -73,79 +55,67 @@ while args:
             inf = a
         continue
     if a[:3] == '/Fo': out = a[3:]
-infile = open(inf, 'r')
-outfile = open(out, 'w')
-for l in infile.readlines():
-    if l[:7] != '/*c++*/':
-        outfile.write(l)
-sys.exit(0)
-""")
-
-else:
 
-    test.write('mylink.py', r"""
-import getopt
-import sys
-opts, args = getopt.getopt(sys.argv[1:], 'o:')
-for opt, arg in opts:
-    if opt == '-o': out = arg
-infile = open(args[0], 'r')
-outfile = open(out, 'w')
-for l in infile.readlines():
-    if l[:8] != '/*link*/':
-        outfile.write(l)
+with open(inf, 'rb') as infile, open(out, 'wb') as outfile:
+    for line in infile:
+        if not line.startswith(b'/*c++*/'):
+            outfile.write(line)
 sys.exit(0)
 """)
 
+else:
     test.write('myc++.py', r"""
 import getopt
 import sys
+
 opts, args = getopt.getopt(sys.argv[1:], 'co:')
 for opt, arg in opts:
     if opt == '-o': out = arg
-infile = open(args[0], 'r')
-outfile = open(out, 'w')
-for l in infile.readlines():
-    if l[:7] != '/*c++*/':
-        outfile.write(l)
+
+with open(args[0], 'rb') as infile, open(out, 'wb') as outfile:
+    for line in infile:
+        if not line.startswith(b'/*c++*/'):
+            outfile.write(line)
 sys.exit(0)
 """)
 
 test.write('SConstruct', """
-env = Environment(LINK = r'%(_python_)s mylink.py',
-                  LINKFLAGS = [],
-                  CXX = r'%(_python_)s myc++.py',
-                  CXXFLAGS = [])
-env.Program(target = 'test1', source = 'test1.cc')
-env.Program(target = 'test2', source = 'test2.cpp')
-env.Program(target = 'test3', source = 'test3.cxx')
-env.Program(target = 'test4', source = 'test4.c++')
-env.Program(target = 'test5', source = 'test5.C++')
+env = Environment(
+    LINK=r'%(_python_)s mylink.py',
+    LINKFLAGS=[],
+    CXX=r'%(_python_)s myc++.py',
+    CXXFLAGS=[],
+)
+env.Program(target='test1', source='test1.cc')
+env.Program(target='test2', source='test2.cpp')
+env.Program(target='test3', source='test3.cxx')
+env.Program(target='test4', source='test4.c++')
+env.Program(target='test5', source='test5.C++')
 """ % locals())
 
 test.write('test1.cc', r"""This is a .cc file.
 /*c++*/
-/*link*/
+#link
 """)
 
 test.write('test2.cpp', r"""This is a .cpp file.
 /*c++*/
-/*link*/
+#link
 """)
 
 test.write('test3.cxx', r"""This is a .cxx file.
 /*c++*/
-/*link*/
+#link
 """)
 
 test.write('test4.c++', r"""This is a .c++ file.
 /*c++*/
-/*link*/
+#link
 """)
 
 test.write('test5.C++', r"""This is a .C++ file.
 /*c++*/
-/*link*/
+#link
 """)
 
 test.run(arguments = '.', stderr = None)
@@ -161,35 +131,32 @@ test.must_match('test4' + _exe, "This is a .c++ file.\n", mode='r')
 test.must_match('test5' + _exe, "This is a .C++ file.\n", mode='r')
 
 if TestSCons.case_sensitive_suffixes('.c', '.C'):
-
     test.write('SConstruct', """
-env = Environment(LINK = r'%(_python_)s mylink.py',
-                  LINKFLAGS = [],
-                  CXX = r'%(_python_)s myc++.py',
-                  CXXFLAGS = [])
-env.Program(target = 'test6', source = 'test6.C')
+env = Environment(
+    LINK=r'%(_python_)s mylink.py',
+    LINKFLAGS=[],
+    CXX=r'%(_python_)s myc++.py',
+    CXXFLAGS=[],
+)
+env.Program(target='test6', source='test6.C')
 """ % locals())
 
     test.write('test6.C', r"""This is a .C file.
 /*c++*/
-/*link*/
+#link
 """)
 
     test.run(arguments = '.', stderr = None)
-
     test.must_match('test6' + _exe, "This is a .C file.\n", mode='r')
 
-
-
-
 test.file_fixture('wrapper.py')
 
 test.write('SConstruct', """
 foo = Environment()
 cxx = foo.Dictionary('CXX')
-bar = Environment(CXX = r'%(_python_)s wrapper.py ' + cxx)
-foo.Program(target = 'foo', source = 'foo.cxx')
-bar.Program(target = 'bar', source = 'bar.cxx')
+bar = Environment(CXX=r'%(_python_)s wrapper.py ' + cxx)
+foo.Program(target='foo', source='foo.cxx')
+bar.Program(target='bar', source='bar.cxx')
 """ % locals())
 
 test.write('foo.cxx', r"""
diff --git a/test/fixture/mycompile.py b/test/fixture/mycompile.py
index 0f37d19..a60a35f 100644
--- a/test/fixture/mycompile.py
+++ b/test/fixture/mycompile.py
@@ -1,19 +1,31 @@
-r"""
-Phony "compiler" for testing SCons.
+"""
+Phony compiler for testing SCons.
+
+Copies its source files to the target file, dropping lines that match
+a pattern, so we can recognize the tool has made a modification.
+Intended for use as a *COM construction variable.
+
+Calling convention is:
+  argv[1] the function of the script (cc, c++, as, link etc.)
+  argv[2] the output file to write
+  argv[3:] one or more input files to "compile"
 
-Copies its source files to the target file, dropping lines
-that match a pattern, so we can recognize the tool
-has made a modification.
+Invocation often looks like:
+  Environment(CCCOM = r'%(_python_)s mycompile.py cc $TARGET $SOURCE', ...
 """
 
+import fileinput
+import getopt
 import sys
 
+def fake_compile():
+    skipline = f"/*{sys.argv[1]}*/\n".encode("utf-8")
+    with open(sys.argv[2], 'wb') as ofp, fileinput.input(files=sys.argv[3:], mode='rb') as ifp:
+        for line in ifp:
+            if line != skipline:
+                ofp.write(line)
+
+
 if __name__ == '__main__':
-    line = ('/*' + sys.argv[1] + '*/\n').encode()
-    with open(sys.argv[2], 'wb') as ofp:
-        for f in sys.argv[3:]:
-            with open(f, 'rb') as ifp:
-                lines = [ln for ln in ifp if ln != line]
-                for ln in lines:
-                    ofp.write(ln)
+    fake_compile()
     sys.exit(0)
diff --git a/test/fixture/mygcc.py b/test/fixture/mygcc.py
index ceb10e5..5f524c2 100644
--- a/test/fixture/mygcc.py
+++ b/test/fixture/mygcc.py
@@ -1,18 +1,21 @@
 import getopt
 import sys
 
-compiler = sys.argv[1]
-clen = len(compiler) + 1
-opts, args = getopt.getopt(sys.argv[2:], 'co:xf:K:')
-for opt, arg in opts:
-    if opt == '-o':
-        out = arg
-    elif opt == '-x':
-        with open('mygcc.out', 'a') as f:
-            f.write(compiler + "\n")
+def fake_gcc():
+    compiler = sys.argv[1].encode('utf-8')
+    opts, args = getopt.getopt(sys.argv[2:], 'co:xf:K:')
+    for opt, arg in opts:
+        if opt == '-o':
+            out = arg
+        elif opt == '-x':
+            with open('mygcc.out', 'ab') as f:
+                f.write(compiler + b"\n")
 
-with open(out, 'w') as ofp, open(args[0], 'r') as ifp:
-    for line in ifp.readlines():
-        if line[:clen] != '#' + compiler:
-            ofp.write(line)
-sys.exit(0)
+    with open(out, 'wb') as ofp, open(args[0], 'rb') as ifp:
+        for line in ifp:
+            if not line.startswith(b'#' + compiler):
+                ofp.write(line)
+
+if __name__ == '__main__':
+    fake_gcc()
+    sys.exit(0)
diff --git a/test/fixture/mylink.py b/test/fixture/mylink.py
index 19969f0..a0b4e27 100644
--- a/test/fixture/mylink.py
+++ b/test/fixture/mylink.py
@@ -1,6 +1,11 @@
 """
-Dummy linker for use by tests"
+Phony linker for testing SCons.
+
+Copies its source files to the target file, dropping lines that match
+a pattern, so we can recognize the tool has made a modification.
+Intended for use as the $LINK construction variable.
 """
+import fileinput
 import getopt
 import sys
 
@@ -10,13 +15,10 @@ def fake_link():
         if opt == '-o':
             out = arg
 
-    with open(out, 'w') as ofp:
-        for f in args:
-            with open(f, 'r') as ifp:
-                for line in ifp.readlines():
-                    if line[:5] != '#link':
-                        ofp.write(line)
-    sys.exit(0)
+    with open(out, 'wb') as ofp, fileinput.input(files=args, mode='rb') as ifp:
+        for line in ifp:
+            if not line.startswith(b'#link'):
+                ofp.write(line)
 
 def fake_win32_link():
     args = sys.argv[1:]
@@ -26,18 +28,19 @@ def fake_win32_link():
             out = args[1]
             args = args[2:]
             continue
-        if not a[0] in '/-':
+        if a[0] not in '/-':
             break
         args = args[1:]
-        if a[:5].lower() == '/out:': out = a[5:]
+        if a.lower().startswith('/out:'):
+            out = a[5:]
     with open(args[0], 'rb') as ifp, open(out, 'wb') as ofp:
-        for line in ifp.readlines():
+        for line in ifp:
             if not line.startswith(b'#link'):
                 ofp.write(line)
-    sys.exit(0)
 
 if __name__ == '__main__':
     if sys.platform == 'win32':
         fake_win32_link()
     else:
         fake_link()
+    sys.exit(0)
diff --git a/test/fixture/mylink_win32.py b/test/fixture/mylink_win32.py
index 477fc95..8edbe70 100644
--- a/test/fixture/mylink_win32.py
+++ b/test/fixture/mylink_win32.py
@@ -9,8 +9,8 @@ while args:
     if a[:5] == '/OUT:':
         out = a[5:]
 
-with open(out, 'w') as ofp, open(args[0], 'r') as ifp:
-    for line in ifp.readlines():
-        if line[:5] != '#link':
+with open(out, 'wb') as ofp, open(args[0], 'rb') as ifp:
+    for line in ifp:
+        if not line.startswith(b'#link'):
             ofp.write(line)
 sys.exit(0)
diff --git a/test/fixture/myrewrite.py b/test/fixture/myrewrite.py
index 6914611..eb83cac 100644
--- a/test/fixture/myrewrite.py
+++ b/test/fixture/myrewrite.py
@@ -2,16 +2,19 @@ r"""
 Phony tool to modify a file in place for testing SCons.
 
 Drops lines that match a pattern.  Currently used to test
-ranlib-related behavior without invoking ranlib.
+ranlib and ar behavior without actually invoking those tools.
 """
 
 import sys
 
-if __name__ == '__main__':
-    line = ('/*' + sys.argv[1] + '*/\n').encode()
+def rewrite():
+    line = ('/*' + sys.argv[1] + '*/\n').encode('utf-8')
     with open(sys.argv[2], 'rb') as ifp:
         lines = [ln for ln in ifp if ln != line]
     with open(sys.argv[2], 'wb') as ofp:
-        for ln in lines:
-            ofp.write(ln)
+        ofp.writelines(lines)
+
+
+if __name__ == '__main__':
+    rewrite()
     sys.exit(0)