Refactor PDFium python test utilities.

testing/tools/run_pixel_tests.py

 #!/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 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 extract_suppressions(filename):
-  with open(filename) as f:
-    suppressions = [y for y in [
-      x.split('#')[0].strip() for x in f.readlines()] if y]
-  return suppressions
-
 def generate_and_test(input_filename, source_dir, working_dir,
-                      fixup_path, pdfium_test_path, pdfium_diff_path):
+                      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')
-  actual_path_template = os.path.join(working_dir, input_root + '.pdf.%d.png')
-  expected_path_template = os.path.join(source_dir,
-                                        input_root + '_expected.pdf.%d.png')
   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])
-    i = 0;
-    while True:
-      expected_path = expected_path_template % i;
-      actual_path = actual_path_template % i;
-      if not os.path.exists(expected_path):
-        if i == 0:
-          print "WARNING: no expected results files found for " + input_filename
-        break
-      print "Checking " + actual_path
-      sys.stdout.flush()
-      subprocess.check_call([pdfium_diff_path, expected_path, actual_path])
-      i += 1
   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
 
 def main():
-  if sys.platform.startswith('linux'):
-    os_name = 'linux'
-  elif sys.platform.startswith('win'):
-    os_name = 'win'
-  elif sys.platform.startswith('darwin'):
-    os_name = 'mac'
-  else:
-    print 'Confused, can not determine OS, aborting.'
-    return 1
-
   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()
-
-  # Expect |my_dir| to be .../pdfium/testing/tools.
-  my_dir = os.path.dirname(os.path.realpath(__file__))
-  testing_dir = os.path.dirname(my_dir)
-  pdfium_dir = os.path.dirname(testing_dir)
-  if (os.path.basename(my_dir) != 'tools' or
-      os.path.basename(testing_dir) != 'testing'):
-    print 'Confused, can not find pdfium root directory, aborting.'
-    return 1
-
-  # Other scripts are found in the same directory as this one.
-  fixup_path = os.path.join(my_dir, 'fixup_pdf_template.py')
-
-  # test files are in .../pdfium/testing/resources/pixel.
-  source_dir = os.path.join(testing_dir, 'resources', 'pixel')
-
-  # Find path to build directory.  This depends on whether this is a
-  # standalone build vs. a build as part of a chromium checkout. For
-  # standalone, we expect a path like .../pdfium/out/Debug, but for
-  # chromium, we expect a path like .../src/out/Debug two levels
-  # higher (to skip over the third_party/pdfium path component under
-  # which chromium sticks pdfium).
-  base_dir = pdfium_dir
-  one_up_dir = os.path.dirname(base_dir)
-  two_up_dir = os.path.dirname(one_up_dir)
-  if (os.path.basename(two_up_dir) == 'src' and
-      os.path.basename(one_up_dir) == 'third_party'):
-    base_dir = two_up_dir
-  build_dir = os.path.join(base_dir, options.build_dir)
-
-  # Compiled binaries are found under the build path.
-  pdfium_test_path = os.path.join(build_dir, 'pdfium_test')
-  pdfium_diff_path = os.path.join(build_dir, 'pdfium_diff')
-  if sys.platform.startswith('win'):
-    pdfium_test_path = pdfium_test_path + '.exe'
-    pdfium_diff_path = pdfium_diff_path + '.exe'
-  # TODO(tsepez): Mac may require special handling here.
-
-  # Place generated files under the build directory, not source directory.
-  gen_dir = os.path.join(build_dir, 'gen', 'pdfium')
-  working_dir = os.path.join(gen_dir, 'testing', 'pixel')
+  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')
+  working_dir = finder.WorkingDir(os.path.join('testing', 'pixel'))
   if not os.path.exists(working_dir):
     os.makedirs(working_dir)
 
-  suppression_list = extract_suppressions(
-    os.path.join(testing_dir, 'SUPPRESSIONS'))
-
-  platform_suppression_filename = 'SUPPRESSIONS_%s' % os_name
-  platform_suppression_list = extract_suppressions(
-    os.path.join(testing_dir, platform_suppression_filename))
+  test_suppressor = suppressor.Suppressor(finder)
+  image_differ = pngdiffer.PNGDiffer(finder)
 
   failures = []
   input_file_re = re.compile('^[a-zA-Z0-9_.]+[.]in$')
   for input_filename in os.listdir(source_dir):
     if input_file_re.match(input_filename):
       input_path = os.path.join(source_dir, input_filename)
       if os.path.isfile(input_path):
-        if input_filename in suppression_list:
-          print "Not running %s, found in SUPPRESSIONS file" % input_filename
-          continue
-        if input_filename in platform_suppression_list:
-          print ("Not running %s, found in %s file" %
-                 (input_filename, platform_suppression_filename))
+        if test_suppressor.IsSuppressed(input_filename):
           continue
         if not generate_and_test(input_filename, source_dir, working_dir,
-                                 fixup_path, pdfium_test_path, pdfium_diff_path):
+                                 fixup_path, pdfium_test_path, image_differ):
           failures.append(input_path)
 
   if failures:
     print '\n\nSummary of Failures:'
     for failure in failures:
       print failure
     return 1
   return 0
 
 if __name__ == '__main__':
   sys.exit(main())