d06ec8d34659f122ed5e8a91e0bc6e26d75d44fa
[WebKit.git] / WebKitTools / Scripts / webkitpy / layout_tests / test_types / text_diff.py
1 #!/usr/bin/env python
2 # Copyright (C) 2010 Google Inc. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 """Compares the text output of a test to the expected text output.
31
32 If the output doesn't match, returns FailureTextMismatch and outputs the diff
33 files into the layout test results directory.
34 """
35
36 from __future__ import with_statement
37
38 import codecs
39 import errno
40 import logging
41 import os.path
42
43 from webkitpy.layout_tests.layout_package import test_failures
44 from webkitpy.layout_tests.test_types import test_type_base
45
46 _log = logging.getLogger("webkitpy.layout_tests.test_types.text_diff")
47
48
49 class TestTextDiff(test_type_base.TestTypeBase):
50
51     def _get_normalized_output_text(self, output):
52         # Some tests produce "\r\n" explicitly.  Our system (Python/Cygwin)
53         # helpfully changes the "\n" to "\r\n", resulting in "\r\r\n".
54         norm = output.replace("\r\r\n", "\r\n").strip("\r\n").replace(
55              "\r\n", "\n")
56         return norm + "\n"
57
58     def _get_normalized_expected_text(self, filename):
59         """Given the filename of the test, read the expected output from a file
60         and normalize the text.  Returns a string with the expected text, or ''
61         if the expected output file was not found."""
62         # Read the port-specific expected text.
63         expected_filename = self._port.expected_filename(filename, '.txt')
64         return self._get_normalized_text(expected_filename)
65
66     def _get_normalized_text(self, filename):
67         # FIXME: We repeat this pattern often, we should share code.
68         try:
69             # NOTE: -expected.txt files are ALWAYS utf-8.  However,
70             # we do not decode the output from DRT, so we should not
71             # decode the -expected.txt values either to allow comparisons.
72             with codecs.open(filename, "r", encoding=None) as file:
73                 text = file.read()
74                 # We could assert that the text is valid utf-8.
75         except IOError, e:
76             if errno.ENOENT != e.errno:
77                 raise
78             return ''
79
80         # Normalize line endings
81         return text.strip("\r\n").replace("\r\n", "\n") + "\n"
82
83     def compare_output(self, port, filename, output, test_args, configuration):
84         """Implementation of CompareOutput that checks the output text against
85         the expected text from the LayoutTest directory."""
86         failures = []
87
88         # If we're generating a new baseline, we pass.
89         if test_args.new_baseline or test_args.reset_results:
90             # Although all test_shell/DumpRenderTree output should be utf-8,
91             # we do not ever decode it inside run-webkit-tests.  For some tests
92             # DumpRenderTree may not output utf-8 text (e.g. webarchives).
93             self._save_baseline_data(filename, output, ".txt", encoding=None,
94                                      generate_new_baseline=test_args.new_baseline)
95             return failures
96
97         # Normalize text to diff
98         output = self._get_normalized_output_text(output)
99         expected = self._get_normalized_expected_text(filename)
100
101         # Write output files for new tests, too.
102         if port.compare_text(output, expected):
103             # Text doesn't match, write output files.
104             self.write_output_files(port, filename, ".txt", output,
105                                     expected, encoding=None,
106                                     print_text_diffs=True)
107
108             if expected == '':
109                 failures.append(test_failures.FailureMissingResult(self))
110             else:
111                 failures.append(test_failures.FailureTextMismatch(self, True))
112
113         return failures
114
115     def diff_files(self, port, file1, file2):
116         """Diff two text files.
117
118         Args:
119           file1, file2: full paths of the files to compare.
120
121         Returns:
122           True if two files are different.
123           False otherwise.
124         """
125
126         return port.compare_text(self._get_normalized_text(file1),
127                                  self._get_normalized_text(file2))