Merge to XFA: One test runner to rule them all.

This CL takes the three test runners (corpus, javascript, pixel) and combines
the code into a single test_runner file. Each of the individual runners still
exists and calls the test runner with their data directory.

With this change, the pixel and javascript test will now run in parallel if
multiple processors are available.

TBR=thestig@chromium.org

Review URL: https://codereview.chromium.org/1430623006 .

(cherry picked from commit a1215ba51a235fb7abcb995f0e768ea0176d9275)

Review URL: https://codereview.chromium.org/1411553010 .

4 files changed, 238 insertions, 315 deletions

diff --git a/testing/tools/run_corpus_tests.py b/testing/tools/run_corpus_tests.py
index 29f23b504a..c7ff605475 100755
--- a/testing/tools/run_corpus_tests.py
+++ b/testing/tools/run_corpus_tests.py
@@ -3,165 +3,13 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import cStringIO
-import functools
-import multiprocessing
-import optparse
-import os
-import re
-import shutil
-import subprocess
 import sys
 
-import common
-import pngdiffer
-import suppressor
-
-class KeyboardInterruptError(Exception): pass
-
-# Nomenclature:
-#   x_root - "x"
-#   x_filename - "x.ext"
-#   x_path - "path/to/a/b/c/x.ext"
-#   c_dir - "path/to/a/b/c"
-
-def test_one_file(input_filename, source_dir, working_dir,
-                  pdfium_test_path, image_differ, redirect_output=False):
-  input_path = os.path.join(source_dir, input_filename)
-  pdf_path = os.path.join(working_dir, input_filename)
-
-  # Remove any existing generated images from previous runs.
-  actual_images = image_differ.GetActualFiles(
-      input_filename, source_dir, working_dir)
-  for image in actual_images:
-    if os.path.exists(image):
-      os.remove(image)
-
-  shutil.copyfile(input_path, pdf_path)
-  sys.stdout.flush()
-  error = common.RunCommand([pdfium_test_path, '--png', pdf_path],
-                            redirect_output)
-  if error:
-    print "FAILURE: " + input_filename + "; " + str(error)
-    return False
-  return not image_differ.HasDifferences(input_filename, source_dir,
-                                         working_dir, redirect_output)
-
-
-def test_one_file_parallel(working_dir, pdfium_test_path, image_differ,
-                           test_case):
-  """Wrapper function to call test_one_file() and redirect output to stdout."""
-  try:
-    old_stdout = sys.stdout
-    old_stderr = sys.stderr
-    sys.stdout = cStringIO.StringIO()
-    sys.stderr = sys.stdout
-    input_filename, source_dir = test_case
-    result = test_one_file(input_filename, source_dir, working_dir,
-                           pdfium_test_path, image_differ, True);
-    output = sys.stdout
-    sys.stdout = old_stdout
-    sys.stderr = old_stderr
-    return (result, output.getvalue(), input_filename, source_dir)
-  except KeyboardInterrupt:
-    raise KeyboardInterruptError()
-
-
-def handle_result(test_suppressor, input_filename, input_path, result,
-                  surprises, failures):
-  if test_suppressor.IsSuppressed(input_filename):
-    if result:
-      surprises.append(input_path)
-  else:
-    if not result:
-      failures.append(input_path)
-
+import test_runner
 
 def main():
-  parser = optparse.OptionParser()
-  parser.add_option('--build-dir', default=os.path.join('out', 'Debug'),
-                    help='relative path from the base source directory')
-  parser.add_option('-j', default=multiprocessing.cpu_count(),
-                    dest='num_workers', type='int',
-                    help='run NUM_WORKERS jobs in parallel')
-  options, args = parser.parse_args()
-  finder = common.DirectoryFinder(options.build_dir)
-  pdfium_test_path = finder.ExecutablePath('pdfium_test')
-  if not os.path.exists(pdfium_test_path):
-    print "FAILURE: Can't find test executable '%s'" % pdfium_test_path
-    print "Use --build-dir to specify its location."
-    return 1
-  working_dir = finder.WorkingDir(os.path.join('testing', 'corpus'))
-  if not os.path.exists(working_dir):
-    os.makedirs(working_dir)
-
-  test_suppressor = suppressor.Suppressor(finder)
-  image_differ = pngdiffer.PNGDiffer(finder)
-
-  # test files are under .../pdfium/testing/corpus.
-  failures = []
-  surprises = []
-  walk_from_dir = finder.TestingDir('corpus');
-  input_file_re = re.compile('^[a-zA-Z0-9_.]+[.]pdf$')
-  test_cases = []
-
-  if len(args):
-    for file_name in args:
-      input_path = os.path.join(walk_from_dir, file_name)
-      if not os.path.isfile(input_path):
-        print "Can't find test file '%s'" % file_name
-        return 1
-
-      test_cases.append((os.path.basename(input_path),
-                         os.path.dirname(input_path)))
-  else:
-    for source_dir, _, filename_list in os.walk(walk_from_dir):
-      for input_filename in filename_list:
-        if input_file_re.match(input_filename):
-          input_path = os.path.join(source_dir, input_filename)
-          if os.path.isfile(input_path):
-            test_cases.append((input_filename, source_dir))
-
-  if options.num_workers > 1 and len(test_cases) > 1:
-    try:
-      pool = multiprocessing.Pool(options.num_workers)
-      worker_func = functools.partial(test_one_file_parallel, working_dir,
-                                      pdfium_test_path, image_differ)
-      worker_results = pool.imap(worker_func, test_cases)
-      for worker_result in worker_results:
-        result, output, input_filename, source_dir = worker_result
-        input_path = os.path.join(source_dir, input_filename)
-        sys.stdout.write(output)
-        handle_result(test_suppressor, input_filename, input_path, result,
-                      surprises, failures)
-      pool.close()
-    except KeyboardInterrupt:
-      pool.terminate()
-    finally:
-      pool.join()
-  else:
-    for test_case in test_cases:
-      input_filename, source_dir = test_case
-      result = test_one_file(input_filename, source_dir, working_dir,
-                             pdfium_test_path, image_differ)
-      handle_result(test_suppressor, input_filename, input_path, result,
-                    surprises, failures)
-
-  if surprises:
-    surprises.sort()
-    print '\n\nUnexpected Successes:'
-    for surprise in surprises:
-      print surprise;
-
-  if failures:
-    failures.sort()
-    print '\n\nSummary of Failures:'
-    for failure in failures:
-      print failure
-    return 1
-
-  return 0
-
+  runner = test_runner.TestRunner('corpus')
+  runner.Run()
 
 if __name__ == '__main__':
   sys.exit(main())
diff --git a/testing/tools/run_javascript_tests.py b/testing/tools/run_javascript_tests.py
index e2fdc66918..2f468820dc 100755
--- a/testing/tools/run_javascript_tests.py
+++ b/testing/tools/run_javascript_tests.py
@@ -3,84 +3,13 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import optparse
-import os
-import re
-import subprocess
 import sys
 
-import common
-
-# Nomenclature:
-#   x_root - "x"
-#   x_filename - "x.ext"
-#   x_path - "path/to/a/b/c/x.ext"
-#   c_dir - "path/to/a/b/c"
-
-def generate_and_test(input_filename, source_dir, working_dir,
-                      fixup_path, pdfium_test_path, text_diff_path):
-  input_root, _ = os.path.splitext(input_filename)
-  input_path = os.path.join(source_dir, input_root + '.in')
-  pdf_path = os.path.join(working_dir, input_root + '.pdf')
-  txt_path = os.path.join(working_dir, input_root + '.txt')
-  expected_path = os.path.join(source_dir, input_root + '_expected.txt')
-  try:
-    sys.stdout.flush()
-    subprocess.check_call(
-        [sys.executable, fixup_path, '--output-dir=' + working_dir, input_path])
-    with open(txt_path, 'w') as outfile:
-      subprocess.check_call([pdfium_test_path, pdf_path], stdout=outfile)
-    subprocess.check_call(
-        [sys.executable, text_diff_path, expected_path, txt_path])
-  except subprocess.CalledProcessError as e:
-    print "FAILURE: " + input_filename + "; " + str(e)
-    return False
-  return True
+import test_runner
 
 def main():
-  parser = optparse.OptionParser()
-  parser.add_option('--build-dir', default=os.path.join('out', 'Debug'),
-                    help='relative path from the base source directory')
-  options, args = parser.parse_args()
-
-  finder = common.DirectoryFinder(options.build_dir)
-  fixup_path = finder.ScriptPath('fixup_pdf_template.py')
-  text_diff_path = finder.ScriptPath('text_diff.py')
-  source_dir = finder.TestingDir(os.path.join('resources', 'javascript'))
-  pdfium_test_path = finder.ExecutablePath('pdfium_test')
-  if not os.path.exists(pdfium_test_path):
-    print "FAILURE: Can't find test executable '%s'" % pdfium_test_path
-    print "Use --build-dir to specify its location."
-    return 1
-  working_dir = finder.WorkingDir(os.path.join('testing', 'javascript'))
-  if not os.path.exists(working_dir):
-    os.makedirs(working_dir)
-
-  input_files = []
-  if len(args):
-    for file_name in args:
-      input_files.append(file_name.replace(".pdf", ".in"))
-  else:
-    input_files = os.listdir(source_dir)
-
-  failures = []
-  input_file_re = re.compile('^[a-zA-Z0-9_.]+[.]in$')
-  for input_filename in input_files:
-    if input_file_re.match(input_filename):
-      input_path = os.path.join(source_dir, input_filename)
-      if os.path.isfile(input_path):
-        if not generate_and_test(input_filename, source_dir, working_dir,
-                                 fixup_path, pdfium_test_path, text_diff_path):
-          failures.append(input_path)
-
-  if failures:
-    failures.sort()
-    print '\n\nSummary of Failures:'
-    for failure in failures:
-      print failure
-    return 1
-  return 0
-
+  runner = test_runner.TestRunner('javascript')
+  runner.Run()
 
 if __name__ == '__main__':
   sys.exit(main())
diff --git a/testing/tools/run_pixel_tests.py b/testing/tools/run_pixel_tests.py
index b167923b86..cb1b42ddaa 100755
--- a/testing/tools/run_pixel_tests.py
+++ b/testing/tools/run_pixel_tests.py
@@ -3,96 +3,13 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import optparse
-import os
-import re
-import subprocess
 import sys
 
-import common
-import pngdiffer
-import suppressor
-
-# Nomenclature:
-#   x_root - "x"
-#   x_filename - "x.ext"
-#   x_path - "path/to/a/b/c/x.ext"
-#   c_dir - "path/to/a/b/c"
-
-def generate_and_test(input_filename, source_dir, working_dir,
-                      fixup_path, pdfium_test_path, image_differ):
-  input_root, _ = os.path.splitext(input_filename)
-  input_path = os.path.join(source_dir, input_root + '.in')
-  pdf_path = os.path.join(working_dir, input_root + '.pdf')
-
-  # Remove any existing generated images from previous runs.
-  actual_images = image_differ.GetActualFiles(
-      input_filename, source_dir, working_dir)
-  for image in actual_images:
-    if os.path.exists(image):
-      os.remove(image)
-
-  try:
-    sys.stdout.flush()
-    subprocess.check_call(
-        [sys.executable, fixup_path, '--output-dir=' + working_dir, input_path])
-    subprocess.check_call([pdfium_test_path, '--png', pdf_path])
-  except subprocess.CalledProcessError as e:
-    print "FAILURE: " + input_filename + "; " + str(e)
-    return False
-  if image_differ.HasDifferences(input_filename, source_dir, working_dir):
-    print "FAILURE: " + input_filename
-    return False
-  return True
-
+import test_runner
 
 def main():
-  parser = optparse.OptionParser()
-  parser.add_option('--build-dir', default=os.path.join('out', 'Debug'),
-                    help='relative path from the base source directory')
-  options, args = parser.parse_args()
-  finder = common.DirectoryFinder(options.build_dir)
-  fixup_path = finder.ScriptPath('fixup_pdf_template.py')
-  source_dir = finder.TestingDir(os.path.join('resources', 'pixel'))
-  pdfium_test_path = finder.ExecutablePath('pdfium_test')
-  if not os.path.exists(pdfium_test_path):
-    print "FAILURE: Can't find test executable '%s'" % pdfium_test_path
-    print "Use --build-dir to specify its location."
-    return 1
-  working_dir = finder.WorkingDir(os.path.join('testing', 'pixel'))
-  if not os.path.exists(working_dir):
-    os.makedirs(working_dir)
-
-  test_suppressor = suppressor.Suppressor(finder)
-  image_differ = pngdiffer.PNGDiffer(finder)
-
-  input_files = []
-  if len(args):
-    for file_name in args:
-      input_files.append(file_name.replace(".pdf", ".in"))
-  else:
-    input_files = os.listdir(source_dir)
-
-  failures = []
-  input_file_re = re.compile('^[a-zA-Z0-9_.]+[.]in$')
-  for input_filename in input_files:
-    if input_file_re.match(input_filename):
-      input_path = os.path.join(source_dir, input_filename)
-      if os.path.isfile(input_path):
-        if test_suppressor.IsSuppressed(input_filename):
-          continue
-        if not generate_and_test(input_filename, source_dir, working_dir,
-                                 fixup_path, pdfium_test_path, image_differ):
-          failures.append(input_path)
-
-  if failures:
-    failures.sort()
-    print '\n\nSummary of Failures:'
-    for failure in failures:
-      print failure
-    return 1
-  return 0
-
+  runner = test_runner.TestRunner('pixel')
+  runner.Run()
 
 if __name__ == '__main__':
   sys.exit(main())
diff --git a/testing/tools/test_runner.py b/testing/tools/test_runner.py
new file mode 100644
index 0000000000..f4751ad175
--- /dev/null
+++ b/testing/tools/test_runner.py
@@ -0,0 +1,229 @@
+#!/usr/bin/env python
+# Copyright 2015 The PDFium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import cStringIO
+import functools
+import multiprocessing
+import optparse
+import os
+import re
+import shutil
+import subprocess
+import sys
+
+import common
+import pngdiffer
+import suppressor
+
+class KeyboardInterruptError(Exception): pass
+
+# Nomenclature:
+#   x_root - "x"
+#   x_filename - "x.ext"
+#   x_path - "path/to/a/b/c/x.ext"
+#   c_dir - "path/to/a/b/c"
+
+def TestOneFileParallel(this, test_case):
+  """Wrapper function to call GenerateAndTest() and redirect output
+     to stdout."""
+  try:
+    old_stdout = sys.stdout
+    old_stderr = sys.stderr
+    sys.stdout = cStringIO.StringIO()
+    sys.stderr = sys.stdout
+
+    input_filename, source_dir = test_case
+    result = this.GenerateAndTest(input_filename, source_dir, True);
+
+    output = sys.stdout
+    sys.stdout = old_stdout
+    sys.stderr = old_stderr
+    return (result, output.getvalue(), input_filename, source_dir)
+  except KeyboardInterrupt:
+    raise KeyboardInterruptError()
+
+
+class TestRunner:
+  def __init__(self, dirname):
+    self.test_dir = dirname
+
+
+  def GenerateAndTest(self, input_filename, source_dir, redirect_output=False):
+    input_root, _ = os.path.splitext(input_filename)
+    expected_txt_path = os.path.join(source_dir, input_root + '_expected.txt')
+
+    pdf_path = os.path.join(self.working_dir, input_root + '.pdf')
+
+    # Remove any existing generated images from previous runs.
+    actual_images = self.image_differ.GetActualFiles(input_filename, source_dir,
+                                                     self.working_dir)
+    for image in actual_images:
+      if os.path.exists(image):
+        os.remove(image)
+
+    sys.stdout.flush()
+
+    raised_exception = self.Generate(source_dir, input_filename, input_root,
+                                     pdf_path, redirect_output)
+
+    if raised_exception != None:
+      print "FAILURE: " + input_filename + "; " + str(raised_exception)
+      return False
+
+    if os.path.exists(expected_txt_path):
+      raised_exception = self.TestText(input_root, expected_txt_path, pdf_path,
+                                       redirect_output)
+    else:
+      raised_exception = self.TestPixel(pdf_path, redirect_output)
+
+    if raised_exception != None:
+      print "FAILURE: " + input_filename + "; " + str(raised_exception)
+      return False
+
+    if len(actual_images):
+      if self.image_differ.HasDifferences(input_filename, source_dir,
+                                          self.working_dir, redirect_output):
+        return False
+
+    return True
+
+
+  def Generate(self, source_dir, input_filename, input_root, pdf_path,
+               redirect_output):
+    original_path = os.path.join(source_dir, input_filename)
+    input_path = os.path.join(source_dir, input_root + '.in')
+
+    if os.path.exists(original_path) and not os.path.exists(input_path):
+      shutil.copyfile(original_path, pdf_path)
+
+    if not os.path.exists(input_path):
+      return None
+
+    cmd = [sys.executable, self.fixup_path,
+           '--output-dir=' + self.working_dir, input_path]
+    return common.RunCommand(cmd, redirect_output)
+
+
+  def TestText(self, input_root, expected_txt_path, pdf_path, redirect_output):
+    txt_path = os.path.join(self.working_dir, input_root + '.txt')
+    with open(txt_path, 'w') as outfile:
+      subprocess.check_call([self.pdfium_test_path, pdf_path], stdout=outfile)
+
+    cmd = [sys.executable, self.text_diff_path, expected_txt_path, txt_path]
+    return common.RunCommand(cmd, redirect_output)
+
+
+  def TestPixel(self, pdf_path, redirect_output):
+    return common.RunCommand(
+        [self.pdfium_test_path, '--png', pdf_path], redirect_output)
+
+
+  def HandleResult(self, input_filename, input_path, result):
+    if self.test_suppressor.IsSuppressed(input_filename):
+      if result:
+        self.surprises.append(input_path)
+    else:
+      if not result:
+        self.failures.append(input_path)
+
+
+  def Run(self):
+    parser = optparse.OptionParser()
+    parser.add_option('--build-dir', default=os.path.join('out', 'Debug'),
+                      help='relative path from the base source directory')
+    parser.add_option('-j', default=multiprocessing.cpu_count(),
+                      dest='num_workers', type='int',
+                      help='run NUM_WORKERS jobs in parallel')
+    options, args = parser.parse_args()
+
+    finder = common.DirectoryFinder(options.build_dir)
+    self.fixup_path = finder.ScriptPath('fixup_pdf_template.py')
+    self.text_diff_path = finder.ScriptPath('text_diff.py')
+
+    self.source_dir = finder.TestingDir()
+
+    if self.test_dir != 'corpus':
+      test_dir = finder.TestingDir(os.path.join('resources', self.test_dir))
+    else:
+      test_dir = finder.TestingDir(self.test_dir)
+
+    self.pdfium_test_path = finder.ExecutablePath('pdfium_test')
+    if not os.path.exists(self.pdfium_test_path):
+      print "FAILURE: Can't find test executable '%s'" % self.pdfium_test_path
+      print "Use --build-dir to specify its location."
+      return 1
+
+    self.working_dir = finder.WorkingDir(os.path.join('testing', self.test_dir))
+    if not os.path.exists(self.working_dir):
+      os.makedirs(self.working_dir)
+
+    self.test_suppressor = suppressor.Suppressor(finder)
+    self.image_differ = pngdiffer.PNGDiffer(finder)
+
+    walk_from_dir = finder.TestingDir(test_dir);
+
+    test_cases = []
+    input_file_re = re.compile('^[a-zA-Z0-9_.]+[.](in|pdf)$')
+
+    if len(args):
+      for file_name in args:
+        file_name.replace(".pdf", ".in")
+        input_path = os.path.join(walk_from_dir, file_name)
+        if not os.path.isfile(input_path):
+          print "Can't find test file '%s'" % file_name
+          return 1
+
+        test_cases.append((os.path.basename(input_path),
+                           os.path.dirname(input_path)))
+    else:
+      for file_dir, _, filename_list in os.walk(walk_from_dir):
+        for input_filename in filename_list:
+          if input_file_re.match(input_filename):
+            input_path = os.path.join(file_dir, input_filename)
+            if os.path.isfile(input_path):
+              test_cases.append((input_filename, file_dir))
+
+    self.failures = []
+    self.surprises = []
+
+    if options.num_workers > 1 and not len(args):
+      try:
+        pool = multiprocessing.Pool(options.num_workers)
+        worker_func = functools.partial(TestOneFileParallel, self)
+
+        worker_results = pool.imap(worker_func, test_cases)
+        for worker_result in worker_results:
+          result, output, input_filename, source_dir = worker_result
+          input_path = os.path.join(source_dir, input_filename)
+          sys.stdout.write(output)
+
+          self.HandleResult(input_filename, input_path, result)
+      except KeyboardInterrupt:
+        pool.terminate()
+      finally:
+        pool.close()
+        pool.join()
+    else:
+      for test_case in test_cases:
+        input_filename, input_file_dir = test_case
+        result = self.GenerateAndTest(input_filename, input_file_dir)
+        self.HandleResult(input_filename,
+                          os.path.join(input_file_dir, input_filename), result)
+
+    if self.surprises:
+      self.surprises.sort()
+      print '\n\nUnexpected Successes:'
+      for surprise in self.surprises:
+        print surprise;
+
+    if self.failures:
+      self.failures.sort()
+      print '\n\nSummary of Failures:'
+      for failure in self.failures:
+        print failure
+      return 1
+
+    return 0
+