From 30762ceda9db949550de6785b36dbe0d89c6d9d2 Mon Sep 17 00:00:00 2001 From: Tom Sepez Date: Thu, 9 Apr 2015 13:37:02 -0700 Subject: Merge to XFA: testing utility combo patch This pulls in the following CLs from master: Review URL: https://codereview.chromium.org/1072613003 Review URL: https://codereview.chromium.org/1058463004 Review URL: https://codereview.chromium.org/1057983003 Review URL: https://codereview.chromium.org/1036073002 Review URL: https://codereview.chromium.org/1031203003 Review URL: https://codereview.chromium.org/1029193002 Review URL: https://codereview.chromium.org/1016613004 Review URL: https://codereview.chromium.org/1026903002 TBR=thestig@chromium.org Review URL: https://codereview.chromium.org/1062163003 --- testing/tools/common.py | 70 +++++++++++++++++++++++++++ testing/tools/pngdiffer.py | 48 ++++++++++++++++++ testing/tools/run_corpus_tests.py | 87 ++++++++++++--------------------- testing/tools/run_javascript_tests.py | 68 +++++++++----------------- testing/tools/run_pixel_tests.py | 91 +++++++++++------------------------ testing/tools/suppressor.py | 34 +++++++++++++ testing/tools/text_diff.py | 32 ++++++++++++ 7 files changed, 265 insertions(+), 165 deletions(-) create mode 100755 testing/tools/common.py create mode 100755 testing/tools/pngdiffer.py create mode 100755 testing/tools/suppressor.py create mode 100755 testing/tools/text_diff.py (limited to 'testing/tools') diff --git a/testing/tools/common.py b/testing/tools/common.py new file mode 100755 index 0000000000..14745a8a3e --- /dev/null +++ b/testing/tools/common.py @@ -0,0 +1,70 @@ +#!/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 os +import sys + +def os_name(): + if sys.platform.startswith('linux'): + return 'linux' + if sys.platform.startswith('win'): + return 'win' + if sys.platform.startswith('darwin'): + return 'mac' + raise Exception('Confused, can not determine OS, aborting.') + + +class DirectoryFinder: + '''A class for finding directories and paths under either a standalone + checkout or a chromium checkout of PDFium.''' + + def __init__(self, build_location): + # |build_location| is typically "out/Debug" or "out/Release". + # Expect |my_dir| to be .../pdfium/testing/tools. + self.my_dir = os.path.dirname(os.path.realpath(__file__)) + self.testing_dir = os.path.dirname(self.my_dir) + if (os.path.basename(self.my_dir) != 'tools' or + os.path.basename(self.testing_dir) != 'testing'): + raise Exception('Confused, can not find pdfium root directory, aborting.') + self.pdfium_dir = os.path.dirname(self.testing_dir) + # 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). + self.base_dir = self.pdfium_dir + one_up_dir = os.path.dirname(self.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'): + self.base_dir = two_up_dir + self.build_dir = os.path.join(self.base_dir, build_location) + self.os_name = os_name() + + def ExecutablePath(self, name): + '''Finds compiled binaries under the build path.''' + result = os.path.join(self.build_dir, name) + if self.os_name == 'win': + result = result + '.exe' + return result + + def ScriptPath(self, name): + '''Finds other scripts in the same directory as this one.''' + return os.path.join(self.my_dir, name) + + def WorkingDir(self, other_components=''): + '''Places generated files under the build directory, not source dir.''' + result = os.path.join(self.build_dir, 'gen', 'pdfium') + if other_components: + result = os.path.join(result, other_components) + return result + + def TestingDir(self, other_components=''): + '''Finds test files somewhere under the testing directory.''' + result = self.testing_dir + if other_components: + result = os.path.join(result, other_components) + return result diff --git a/testing/tools/pngdiffer.py b/testing/tools/pngdiffer.py new file mode 100755 index 0000000000..7a7e8ddbc6 --- /dev/null +++ b/testing/tools/pngdiffer.py @@ -0,0 +1,48 @@ +#!/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 os +import subprocess +import sys + +class PNGDiffer(): + ACTUAL_TEMPLATE = '.pdf.%d.png' + EXPECTED_TEMPLATE = '_expected' + ACTUAL_TEMPLATE + PLATFORM_EXPECTED_TEMPLATE = '_expected_%s' + ACTUAL_TEMPLATE + + def __init__(self, finder): + self.pdfium_diff_path = finder.ExecutablePath('pdfium_diff') + self.os_name = finder.os_name + + def HasDifferences(self, input_filename, source_dir, working_dir): + input_root, _ = os.path.splitext(input_filename) + actual_path_template = os.path.join( + working_dir, input_root + self.ACTUAL_TEMPLATE) + expected_path_template = os.path.join( + source_dir, input_root + self.EXPECTED_TEMPLATE) + platform_expected_path_template = os.path.join( + source_dir, input_root + self.PLATFORM_EXPECTED_TEMPLATE) + i = 0 + try: + while True: + actual_path = actual_path_template % i + expected_path = expected_path_template % i + platform_expected_path = ( + platform_expected_path_template % (self.os_name, i)) + if os.path.exists(platform_expected_path): + expected_path = platform_expected_path + elif not os.path.exists(expected_path): + if i == 0: + print "WARNING: no expected results files for " + input_filename + break + print "Checking " + actual_path + sys.stdout.flush() + subprocess.check_call( + [self.pdfium_diff_path, expected_path, actual_path]) + i += 1 + except subprocess.CalledProcessError as e: + print "FAILURE: " + input_filename + "; " + str(e) + return True + return False diff --git a/testing/tools/run_corpus_tests.py b/testing/tools/run_corpus_tests.py index 2f6de07212..13376f7878 100755 --- a/testing/tools/run_corpus_tests.py +++ b/testing/tools/run_corpus_tests.py @@ -6,9 +6,14 @@ import optparse import os import re +import shutil import subprocess import sys +import common +import pngdiffer +import suppressor + # Nomenclature: # x_root - "x" # x_filename - "x.ext" @@ -16,30 +21,18 @@ import sys # c_dir - "path/to/a/b/c" def test_one_file(input_filename, source_dir, working_dir, - pdfium_test_path, pdfium_diff_path): - input_root, _ = os.path.splitext(input_filename) + pdfium_test_path, image_differ): input_path = os.path.join(source_dir, input_filename) pdf_path = os.path.join(working_dir, input_filename) - 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: - subprocess.check_call(['cp', input_path, pdf_path]) + shutil.copyfile(input_path, pdf_path) + sys.stdout.flush() 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 - 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): + return False return True def main(): @@ -47,57 +40,37 @@ def main(): 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 - - # 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. - working_dir = os.path.join(build_dir, 'gen', 'pdfium', 'testing', 'corpus') + finder = common.DirectoryFinder(options.build_dir) + pdfium_test_path = finder.ExecutablePath('pdfium_test') + 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. - os_exit_code = 0 - walk_from_dir = os.path.join(testing_dir, 'corpus'); + failures = [] + walk_from_dir = finder.TestingDir('corpus'); input_file_re = re.compile('^[a-zA-Z0-9_.]+[.]pdf$') 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): - if not test_one_file(input_filename, source_dir, working_dir, - pdfium_test_path, pdfium_diff_path): - os_exit_code = 1 + if test_suppressor.IsSuppressed(input_filename): + continue + if not test_one_file(input_filename, source_dir, working_dir, + 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 os_exit_code + return 0 if __name__ == '__main__': diff --git a/testing/tools/run_javascript_tests.py b/testing/tools/run_javascript_tests.py index ddc82665d5..9b3d69e8f3 100755 --- a/testing/tools/run_javascript_tests.py +++ b/testing/tools/run_javascript_tests.py @@ -9,6 +9,8 @@ import re import subprocess import sys +import common + # Nomenclature: # x_root - "x" # x_filename - "x.ext" @@ -16,18 +18,20 @@ import sys # c_dir - "path/to/a/b/c" def generate_and_test(input_filename, source_dir, working_dir, - fixup_path, pdfium_test_path): + 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( - [fixup_path, '--output-dir=' + working_dir, input_path]) + [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(['diff', expected_path, txt_path]) + 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 @@ -38,59 +42,31 @@ def main(): 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/javascript. - source_dir = os.path.join(testing_dir, 'resources', 'javascript') - - # 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') - if sys.platform.startswith('win'): - pdfium_test_path = pdfium_test_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', 'javascript') + 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') + working_dir = finder.WorkingDir(os.path.join('testing', 'javascript')) if not os.path.exists(working_dir): os.makedirs(working_dir) - os_exit_code = 0 + 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 not generate_and_test(input_filename, source_dir, working_dir, - fixup_path, pdfium_test_path): - os_exit_code = 1 + fixup_path, pdfium_test_path, text_diff_path): + failures.append(input_path) - return os_exit_code + if failures: + print '\n\nSummary of Failures:' + for failure in failures: + print failure + return 1 + return 0 if __name__ == '__main__': diff --git a/testing/tools/run_pixel_tests.py b/testing/tools/run_pixel_tests.py index 9bd321b560..1fec0ddcb1 100755 --- a/testing/tools/run_pixel_tests.py +++ b/testing/tools/run_pixel_tests.py @@ -9,6 +9,10 @@ import re import subprocess import sys +import common +import pngdiffer +import suppressor + # Nomenclature: # x_root - "x" # x_filename - "x.ext" @@ -16,31 +20,21 @@ import sys # c_dir - "path/to/a/b/c" 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( - [fixup_path, '--output-dir=' + working_dir, input_path]) + [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 - 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(): @@ -48,62 +42,35 @@ def main(): 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) - os_exit_code = 0 + 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 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): - os_exit_code = 1 - - return os_exit_code + 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()) diff --git a/testing/tools/suppressor.py b/testing/tools/suppressor.py new file mode 100755 index 0000000000..fff9bc8381 --- /dev/null +++ b/testing/tools/suppressor.py @@ -0,0 +1,34 @@ +#!/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 os + +import common + +class Suppressor: + SUPPRESSIONS_FILENAME = 'SUPPRESSIONS' + PLATFORM_SUPPRESSIONS_FILENAME = 'SUPPRESSIONS_%s' % common.os_name() + + def __init__(self, finder): + testing_dir = finder.TestingDir() + self.suppression_list = self._ExtractSuppressions( + os.path.join(testing_dir, self.SUPPRESSIONS_FILENAME)) + self.platform_suppression_list = self._ExtractSuppressions( + os.path.join(testing_dir, self.PLATFORM_SUPPRESSIONS_FILENAME)) + + def _ExtractSuppressions(self, suppressions_filename): + with open(suppressions_filename) as f: + return [y for y in [x.split('#')[0].strip() for x in f.readlines()] if y] + + def IsSuppressed(self, input_filename): + if input_filename in self.suppression_list: + print ("Not running %s, found in %s file" % + (input_filename, self.SUPPRESSIONS_FILENAME)) + return True + if input_filename in self.platform_suppression_list: + print ("Not running %s, found in %s file" % + (input_filename, self.PLATFORM_SUPPRESSIONS_FILENAME)) + return True + return False diff --git a/testing/tools/text_diff.py b/testing/tools/text_diff.py new file mode 100755 index 0000000000..3a5bd7bf6a --- /dev/null +++ b/testing/tools/text_diff.py @@ -0,0 +1,32 @@ +#!/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 difflib +import sys + +def main(argv): + if len(argv) != 3: + print '%s: invalid arguments' % argv[0] + return 2 + filename1 = argv[1] + filename2 = argv[2] + try: + with open(filename1, "r") as f1: + str1 = f1.readlines(); + with open(filename2, "r") as f2: + str2 = f2.readlines(); + diffs = difflib.unified_diff( + str1, str2, fromfile=filename1, tofile=filename2) + except Exception as e: + print "something went astray: %s" % e + return 1 + status_code = 0 + for diff in diffs: + sys.stdout.write(diff) + status_code = 1 + return status_code + +if __name__ == '__main__': + sys.exit(main(sys.argv)) -- cgit v1.2.3