2011-01-28 Tony Chang <tony@chromium.org>
[WebKit-https.git] / Tools / 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 import errno
37 import logging
38
39 from webkitpy.layout_tests.layout_package import test_failures
40 from webkitpy.layout_tests.test_types import test_type_base
41
42 _log = logging.getLogger("webkitpy.layout_tests.test_types.text_diff")
43
44
45 class TestTextDiff(test_type_base.TestTypeBase):
46
47     def _get_normalized_output_text(self, output):
48         """Returns the normalized text output, i.e. the output in which
49         the end-of-line characters are normalized to "\n"."""
50         # Running tests on Windows produces "\r\n".  The "\n" part is helpfully
51         # changed to "\r\n" by our system (Python/Cygwin), resulting in
52         # "\r\r\n", when, in fact, we wanted to compare the text output with
53         # the normalized text expectation files.
54         return output.replace("\r\r\n", "\r\n").replace("\r\n", "\n")
55
56     def compare_output(self, port, filename, test_args, actual_test_output,
57                         expected_test_output):
58         """Implementation of CompareOutput that checks the output text against
59         the expected text from the LayoutTest directory."""
60         failures = []
61
62         # If we're generating a new baseline, we pass.
63         if test_args.new_baseline or test_args.reset_results:
64             # Although all DumpRenderTree output should be utf-8, we do not
65             # ever decode it inside run-webkit-tests.  For some tests
66             # DumpRenderTree may not output utf-8 text (e.g.  webarchives).
67             self._save_baseline_data(filename, actual_test_output.text,
68                                      ".txt", encoding=None,
69                                      generate_new_baseline=test_args.new_baseline)
70             return failures
71
72         # Normalize text to diff
73         actual_text = self._get_normalized_output_text(actual_test_output.text)
74         # Assuming expected_text is already normalized.
75         expected_text = expected_test_output.text
76
77         # Write output files for new tests, too.
78         if port.compare_text(actual_text, expected_text):
79             # Text doesn't match, write output files.
80             self.write_output_files(filename, ".txt", actual_text,
81                                     expected_text, encoding=None,
82                                     print_text_diffs=True)
83
84             if expected_text == '':
85                 failures.append(test_failures.FailureMissingResult())
86             else:
87                 failures.append(test_failures.FailureTextMismatch())
88
89         return failures