Rename WebKitTools to Tools
[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 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 compare_output(self, port, filename, test_args, actual_test_output,
59                         expected_test_output):
60         """Implementation of CompareOutput that checks the output text against
61         the expected text from the LayoutTest directory."""
62         failures = []
63
64         # If we're generating a new baseline, we pass.
65         if test_args.new_baseline or test_args.reset_results:
66             # Although all test_shell/DumpRenderTree output should be utf-8,
67             # we do not ever decode it inside run-webkit-tests.  For some tests
68             # DumpRenderTree may not output utf-8 text (e.g. webarchives).
69             self._save_baseline_data(filename, actual_test_output.text,
70                                      ".txt", encoding=None,
71                                      generate_new_baseline=test_args.new_baseline)
72             return failures
73
74         # Normalize text to diff
75         actual_text = self._get_normalized_output_text(actual_test_output.text)
76         # Assuming expected_text is already normalized.
77         expected_text = expected_test_output.text
78
79         # Write output files for new tests, too.
80         if port.compare_text(actual_text, expected_text):
81             # Text doesn't match, write output files.
82             self.write_output_files(filename, ".txt", actual_text,
83                                     expected_text, encoding=None,
84                                     print_text_diffs=True)
85
86             if expected_text == '':
87                 failures.append(test_failures.FailureMissingResult())
88             else:
89                 failures.append(test_failures.FailureTextMismatch())
90
91         return failures