1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
#!/usr/bin/env python
# Copyright (C) 2010 Google Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""Defines the interface TestTypeBase which other test types inherit from.
"""
import cgi
import errno
import logging
_log = logging.getLogger("webkitpy.layout_tests.test_types.test_type_base")
# Python bug workaround. See the wdiff code in WriteOutputFiles for an
# explanation.
_wdiff_available = True
class TestTypeBase(object):
# Filename pieces when writing failures to the test results directory.
FILENAME_SUFFIX_ACTUAL = "-actual"
FILENAME_SUFFIX_EXPECTED = "-expected"
FILENAME_SUFFIX_DIFF = "-diff"
FILENAME_SUFFIX_WDIFF = "-wdiff.html"
FILENAME_SUFFIX_PRETTY_PATCH = "-pretty-diff.html"
FILENAME_SUFFIX_COMPARE = "-diff.png"
def __init__(self, port, root_output_dir):
"""Initialize a TestTypeBase object.
Args:
port: object implementing port-specific information and methods
root_output_dir: The unix style path to the output dir.
"""
self._root_output_dir = root_output_dir
self._port = port
def _make_output_directory(self, filename):
"""Creates the output directory (if needed) for a given test
filename."""
fs = self._port._filesystem
output_filename = fs.join(self._root_output_dir,
self._port.relative_test_filename(filename))
fs.maybe_make_directory(fs.dirname(output_filename))
def output_filename(self, filename, modifier):
"""Returns a filename inside the output dir that contains modifier.
For example, if filename is c:/.../fast/dom/foo.html and modifier is
"-expected.txt", the return value is
c:/cygwin/tmp/layout-test-results/fast/dom/foo-expected.txt
Args:
filename: absolute filename to test file
modifier: a string to replace the extension of filename with
Return:
The absolute windows path to the output filename
"""
fs = self._port._filesystem
output_filename = fs.join(self._root_output_dir,
self._port.relative_test_filename(filename))
return fs.splitext(output_filename)[0] + modifier
def compare_output(self, port, filename, options, actual_driver_output,
expected_driver_output):
"""Method that compares the output from the test with the
expected value.
This is an abstract method to be implemented by all sub classes.
Args:
port: object implementing port-specific information and methods
filename: absolute filename to test file
options: command line argument object from optparse
actual_driver_output: a DriverOutput object which represents actual test
output
expected_driver_output: a ExpectedDriverOutput object which represents a
expected test output
Return:
a list of TestFailure objects, empty if the test passes
"""
raise NotImplementedError
def _write_into_file_at_path(self, file_path, contents, encoding):
"""This method assumes that byte_array is already encoded
into the right format."""
fs = self._port._filesystem
if encoding is None:
fs.write_binary_file(file_path, contents)
return
fs.write_text_file(file_path, contents)
def write_output_files(self, filename, file_type,
output, expected, encoding,
print_text_diffs=False):
"""Writes the test output, the expected output and optionally the diff
between the two to files in the results directory.
The full output filename of the actual, for example, will be
<filename>-actual<file_type>
For instance,
my_test-actual.txt
Args:
filename: The test filename
file_type: A string describing the test output file type, e.g. ".txt"
output: A string containing the test output
expected: A string containing the expected test output
print_text_diffs: True for text diffs. (FIXME: We should be able to get this from the file type?)
"""
self._make_output_directory(filename)
actual_filename = self.output_filename(filename, self.FILENAME_SUFFIX_ACTUAL + file_type)
expected_filename = self.output_filename(filename, self.FILENAME_SUFFIX_EXPECTED + file_type)
# FIXME: This function is poorly designed. We should be passing in some sort of
# encoding information from the callers.
if output:
self._write_into_file_at_path(actual_filename, output, encoding)
if expected:
self._write_into_file_at_path(expected_filename, expected, encoding)
if not output or not expected:
return
if not print_text_diffs:
return
# Note: We pass encoding=None for all diff writes, as we treat diff
# output as binary. Diff output may contain multiple files in
# conflicting encodings.
diff = self._port.diff_text(expected, output, expected_filename, actual_filename)
diff_filename = self.output_filename(filename, self.FILENAME_SUFFIX_DIFF + file_type)
self._write_into_file_at_path(diff_filename, diff, encoding=None)
# Shell out to wdiff to get colored inline diffs.
wdiff = self._port.wdiff_text(expected_filename, actual_filename)
wdiff_filename = self.output_filename(filename, self.FILENAME_SUFFIX_WDIFF)
self._write_into_file_at_path(wdiff_filename, wdiff, encoding=None)
# Use WebKit's PrettyPatch.rb to get an HTML diff.
pretty_patch = self._port.pretty_patch_text(diff_filename)
pretty_patch_filename = self.output_filename(filename, self.FILENAME_SUFFIX_PRETTY_PATCH)
self._write_into_file_at_path(pretty_patch_filename, pretty_patch, encoding=None)
|
