xplat: runtests.py review cleanup

Address review comments.
Add TestResult class to record results.
Changed `print` calls to try to support python 3.

Author: Jianchun Xu

test/runtests.py

@@ -7,33 +7,34 @@
 import sys
 import os
 import subprocess as SP
-import argparse, textwrap
+import argparse
 import xml.etree.ElementTree as ET
 
+# handle command line args
 parser = argparse.ArgumentParser(
     description='ChakraCore *nix Test Script',
     formatter_class=argparse.RawDescriptionHelpFormatter,
-    epilog=textwrap.dedent('''\
-        Samples:
+    epilog='''\
+Samples:
 
-        test all folders:
-            {0}
+test all folders:
+    {0}
 
-        test only Array:
-            {0} Array
+test only Array:
+    {0} Array
+
+test a single file:
+    {0} Basics/hello.js
+'''.format(sys.argv[0]))
 
-        test a single file:
-            {0} Basics/hello.js
-    '''.format(sys.argv[0]))
-    )
 parser.add_argument('folders', metavar='folder', nargs='*',
                     help='folder subset to run tests')
-parser.add_argument('-b', '--binary', metavar='binary', help='ch full path');
+parser.add_argument('-b', '--binary', metavar='bin', help='ch full path')
 parser.add_argument('-d', '--debug', action='store_true',
                     help='use debug build');
-parser.add_argument('-t', '--test', action='store_true', help='use test build');
-parser.add_argument('--x86', action='store_true', help='use x86 build');
-parser.add_argument('--x64', action='store_true', help='use x64 build');
+parser.add_argument('-t', '--test', action='store_true', help='use test build')
+parser.add_argument('--x86', action='store_true', help='use x86 build')
+parser.add_argument('--x64', action='store_true', help='use x64 build')
 args = parser.parse_args()
 
 
@@ -46,52 +47,85 @@
     arch = os.environ.get('_BuildArch', 'x86')
 
 # flavor: debug, test, release
+type_flavor = {'chk':'debug', 'test':'test', 'fre':'release'}
 flavor = 'debug' if args.debug else ('test' if args.test else None)
 if flavor == None:
-    flavor = {'chk':'debug', 'test':'test', 'fre':'release'}\
-                    [os.environ.get('_BuildType', 'fre')]
+    flavor = type_flavor[os.environ.get('_BuildType', 'fre')]
 
 # binary: full ch path
 binary = args.binary
 if binary == None:
     if sys.platform == 'win32':
-        binary = os.path.join(repo_root,
-            'Build/VcBuild/bin/{}_{}/ch.exe'.format(arch, flavor))
+        binary = 'Build/VcBuild/bin/{}_{}/ch.exe'.format(arch, flavor)
     else:
-        binary = os.path.join(repo_root, "BuildLinux/ch")
+        binary = 'BuildLinux/ch'
+    binary = os.path.join(repo_root, binary)
 if not os.path.isfile(binary):
-    print '{} not found. Did you run ./build.sh already?'.format(binary)
+    print('{} not found. Did you run ./build.sh already?'.format(binary))
     sys.exit(1)
 
-pass_count = 0
-fail_count = 0
+
+# records pass_count/fail_count
+class PassFailCount(object):
+    def __init__(self):
+        self.pass_count = 0
+        self.fail_count = 0
+
+    def __str__(self):
+        return 'passed {}, failed {}'.format(self.pass_count, self.fail_count)
+
+# records total and individual folder's pass_count/fail_count
+class TestResult(PassFailCount):
+    def __init__(self):
+        super(self.__class__, self).__init__()
+        self.folders = {}
+
+    def _get_folder_result(self, folder):
+        r = self.folders.get(folder)
+        if not r:
+            r = PassFailCount()
+            self.folders[folder] = r
+        return r
+
+    def log(self, filename=None, folder=None, fail=False):
+        if not folder:
+            folder = os.path.basename(os.path.dirname(filename))
+        r = self._get_folder_result(folder)
+        if fail:
+            r.fail_count += 1
+            self.fail_count += 1
+        else:
+            r.pass_count += 1
+            self.pass_count += 1
+
+test_result = TestResult()
+
 
 def show_failed(filename, output, exit_code, expected_output):
-    print "\nFailed ->", filename
+    print("\nFailed -> {}".format(filename))
     if expected_output == None:
-        print "\nOutput:"
-        print "----------------------------"
-        print output
-        print "----------------------------"
+        print("\nOutput:")
+        print("----------------------------")
+        print(output)
+        print("----------------------------")
     else:
         lst_output = output.split('\n')
         lst_expected = expected_output.split('\n')
         ln = min(len(lst_output), len(lst_expected))
         for i in range(0, ln):
             if lst_output[i] != lst_expected[i]:
-                print "Output: (at line " + str(i) + ")"
-                print "----------------------------"
-                print lst_output[i]
-                print "----------------------------"
-                print "Expected Output:"
-                print "----------------------------"
-                print lst_expected[i]
-                print "----------------------------"
+                print("Output: (at line " + str(i) + ")")
+                print("----------------------------")
+                print(lst_output[i])
+                print("----------------------------")
+                print("Expected Output:")
+                print("----------------------------")
+                print(lst_expected[i])
+                print("----------------------------")
                 break
 
-    print "exit code:", exit_code
-    global fail_count
-    fail_count += 1
+    print("exit code: {}".format(exit_code))
+    test_result.log(filename, fail=True)
 
 def test_path(path):
     if os.path.isfile(path):
@@ -103,19 +137,18 @@ def test_path(path):
     if len(tests) == 0:
         return
 
-    print "Testing ->", os.path.basename(folder)
+    print("Testing -> " + os.path.basename(folder))
     for test in tests:
         test_one(folder, test)
 
 def test_one(folder, test):
     js_file = os.path.join(folder, test['files'])
     js_output = ""
 
-    cmd = [x for x in [binary,
-            '-WERExceptionSupport',
-            '-ExtendedErrorStackForTestHost',
-            test.get('compile-flags'),
-            js_file]  if x != None]
+    flags = test.get('compile-flags')
+    cmd = [binary, '-WERExceptionSupport', '-ExtendedErrorStackForTestHost'] \
+          + (flags.split() if flags else []) \
+          + [js_file]
     p = SP.Popen(cmd, stdout=SP.PIPE, stderr=SP.STDOUT)
     js_output = p.communicate()[0].replace('\r','')
     exit_code = p.wait()
@@ -133,9 +166,8 @@ def test_one(folder, test):
             if expected_output.replace('\n', '') != js_output.replace('\n', ''):
                 return show_failed(js_file, js_output, exit_code, expected_output)
 
-    print "\tPassed ->", os.path.basename(js_file)
-    global pass_count
-    pass_count += 1
+    print("\tPassed -> " + os.path.basename(js_file))
+    test_result.log(folder=folder)
 
 def load_tests(folder, file):
     try:
@@ -169,8 +201,13 @@ def main():
     for folder in args.folders:
         test_path(folder)
 
-    print 'Passed:', pass_count, 'Failed:', fail_count
-    print 'Success!' if fail_count == 0 else 'Failed!'
+    print('\n')
+    print('============================')
+    for folder, result in sorted(test_result.folders.items()):
+        print('{}: {}'.format(folder, result))
+    print('============================')
+    print('Total: {}'.format(test_result))
+    print('Success!' if test_result.fail_count == 0 else 'Failed!')
     return 0
 
 if __name__ == '__main__':