2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <html><head><title>Python: module telemetry.unittest.tab_test_case</title>
4 </head><body bgcolor="#f0f0f8">
6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
8 <td valign=bottom> <br>
9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.tab_test_case</strong></big></big></font></td
10 ><td align=right valign=bottom
11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/unittest/tab_test_case.py">telemetry/unittest/tab_test_case.py</a></font></td></tr></table>
12 <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br>
13 # Use of this source code is governed by a BSD-style license that can be<br>
14 # found in the LICENSE file.</tt></p>
16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
17 <tr bgcolor="#aa55cc">
18 <td colspan=3 valign=bottom> <br>
19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.browser_finder.html">telemetry.core.browser_finder</a><br>
23 </td><td width="25%" valign=top><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br>
24 </td><td width="25%" valign=top><a href="unittest.html">unittest</a><br>
25 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
27 <tr bgcolor="#ee77aa">
28 <td colspan=3 valign=bottom> <br>
29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
31 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
33 <dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest.case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
36 <dt><font face="helvetica, arial"><a href="telemetry.unittest.tab_test_case.html#TabTestCase">TabTestCase</a>
41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
42 <tr bgcolor="#ffc8d8">
43 <td colspan=3 valign=bottom> <br>
44 <font color="#000000" face="helvetica, arial"><a name="TabTestCase">class <strong>TabTestCase</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</a>)</font></td></tr>
46 <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
47 <td width="100%"><dl><dt>Method resolution order:</dt>
48 <dd><a href="telemetry.unittest.tab_test_case.html#TabTestCase">TabTestCase</a></dd>
49 <dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd>
50 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
53 Methods defined here:<br>
54 <dl><dt><a name="TabTestCase-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl>
56 <dl><dt><a name="TabTestCase-__init__"><strong>__init__</strong></a>(self, *args)</dt></dl>
58 <dl><dt><a name="TabTestCase-setUp"><strong>setUp</strong></a>(self)</dt></dl>
60 <dl><dt><a name="TabTestCase-tearDown"><strong>tearDown</strong></a>(self)</dt></dl>
63 Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
64 <dl><dt><a name="TabTestCase-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl>
66 <dl><dt><a name="TabTestCase-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
68 <dl><dt><a name="TabTestCase-__hash__"><strong>__hash__</strong></a>(self)</dt></dl>
70 <dl><dt><a name="TabTestCase-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
72 <dl><dt><a name="TabTestCase-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
74 <dl><dt><a name="TabTestCase-__str__"><strong>__str__</strong></a>(self)</dt></dl>
76 <dl><dt><a name="TabTestCase-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br>
77 completed. Functions added are called on a LIFO basis and are<br>
78 called after tearDown on test failure or success.<br>
80 Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl>
82 <dl><dt><a name="TabTestCase-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br>
84 This method is for use by <a href="unittest.case.html#TestCase">TestCase</a> subclasses that need to register<br>
85 their own type equality functions to provide nicer error messages.<br>
88 typeobj: The data type to call this function on when both values<br>
89 are of the same type in <a href="#TabTestCase-assertEqual">assertEqual</a>().<br>
90 function: The callable taking two arguments and an optional<br>
91 msg= argument that raises self.<strong>failureException</strong> with a<br>
92 useful error message when the two arguments are not equal.</tt></dd></dl>
94 <dl><dt><a name="TabTestCase-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br>
95 difference rounded to the given number of decimal places<br>
96 (default 7) and comparing to zero, or by comparing that the<br>
97 between the two objects is more than the given delta.<br>
99 Note that decimal places (from zero) are usually not the same<br>
100 as significant digits (measured from the most signficant digit).<br>
102 If the two objects compare equal then they will automatically<br>
103 compare almost equal.</tt></dd></dl>
105 <dl><dt><a name="TabTestCase-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br>
106 difference rounded to the given number of decimal places<br>
107 (default 7) and comparing to zero, or by comparing that the<br>
108 between the two objects is more than the given delta.<br>
110 Note that decimal places (from zero) are usually not the same<br>
111 as significant digits (measured from the most signficant digit).<br>
113 If the two objects compare equal then they will automatically<br>
114 compare almost equal.</tt></dd></dl>
116 <dl><dt><a name="TabTestCase-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl>
118 <dl><dt><a name="TabTestCase-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl>
120 <dl><dt><a name="TabTestCase-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br>
121 operator.</tt></dd></dl>
123 <dl><dt><a name="TabTestCase-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br>
124 operator.</tt></dd></dl>
126 <dl><dt><a name="TabTestCase-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is false.</tt></dd></dl>
128 <dl><dt><a name="TabTestCase-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl>
130 <dl><dt><a name="TabTestCase-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl>
132 <dl><dt><a name="TabTestCase-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl>
134 <dl><dt><a name="TabTestCase-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl>
136 <dl><dt><a name="TabTestCase-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TabTestCase-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br>
137 default message.</tt></dd></dl>
139 <dl><dt><a name="TabTestCase-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TabTestCase-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl>
141 <dl><dt><a name="TabTestCase-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl>
143 <dl><dt><a name="TabTestCase-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl>
145 <dl><dt><a name="TabTestCase-assertItemsEqual"><strong>assertItemsEqual</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison. It asserts that<br>
146 actual_seq and expected_seq have the same element counts.<br>
147 Equivalent to::<br>
149 <a href="#TabTestCase-assertEqual">assertEqual</a>(Counter(iter(actual_seq)),<br>
150 Counter(iter(expected_seq)))<br>
152 Asserts that each element has the same count in both sequences.<br>
154 - [0, 1, 1] and [1, 0, 1] compare equal.<br>
155 - [0, 0, 1] and [0, 1] compare unequal.</tt></dd></dl>
157 <dl><dt><a name="TabTestCase-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl>
159 <dl><dt><a name="TabTestCase-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl>
161 <dl><dt><a name="TabTestCase-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br>
164 list1: The first list to compare.<br>
165 list2: The second list to compare.<br>
166 msg: Optional message to use on failure instead of a list of<br>
167 differences.</tt></dd></dl>
169 <dl><dt><a name="TabTestCase-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl>
171 <dl><dt><a name="TabTestCase-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br>
172 difference rounded to the given number of decimal places<br>
173 (default 7) and comparing to zero, or by comparing that the<br>
174 between the two objects is less than the given delta.<br>
176 Note that decimal places (from zero) are usually not the same<br>
177 as significant digits (measured from the most signficant digit).<br>
179 Objects that are equal automatically fail.</tt></dd></dl>
181 <dl><dt><a name="TabTestCase-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br>
182 difference rounded to the given number of decimal places<br>
183 (default 7) and comparing to zero, or by comparing that the<br>
184 between the two objects is less than the given delta.<br>
186 Note that decimal places (from zero) are usually not the same<br>
187 as significant digits (measured from the most signficant digit).<br>
189 Objects that are equal automatically fail.</tt></dd></dl>
191 <dl><dt><a name="TabTestCase-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br>
192 operator.</tt></dd></dl>
194 <dl><dt><a name="TabTestCase-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br>
195 operator.</tt></dd></dl>
197 <dl><dt><a name="TabTestCase-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl>
199 <dl><dt><a name="TabTestCase-assertNotIsInstance"><strong>assertNotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsInstance.</tt></dd></dl>
201 <dl><dt><a name="TabTestCase-assertNotRegexpMatches"><strong>assertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the text matches the regular expression.</tt></dd></dl>
203 <dl><dt><a name="TabTestCase-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br>
204 by callableObj when invoked with arguments args and keyword<br>
205 arguments kwargs. If a different type of exception is<br>
206 thrown, it will not be caught, and the test case will be<br>
207 deemed to have suffered an error, exactly as for an<br>
208 unexpected exception.<br>
210 If called with callableObj omitted or None, will return a<br>
211 context object used like this::<br>
213 with <a href="#TabTestCase-assertRaises">assertRaises</a>(SomeException):<br>
214 do_something()<br>
216 The context manager keeps a reference to the exception as<br>
217 the 'exception' attribute. This allows you to inspect the<br>
218 exception after the assertion::<br>
220 with <a href="#TabTestCase-assertRaises">assertRaises</a>(SomeException) as cm:<br>
221 do_something()<br>
222 the_exception = cm.exception<br>
223 <a href="#TabTestCase-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl>
225 <dl><dt><a name="TabTestCase-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br>
228 expected_exception: Exception class expected to be raised.<br>
229 expected_regexp: Regexp (re pattern object or string) expected<br>
230 to be found in error message.<br>
231 callable_obj: Function to be called.<br>
232 args: Extra args.<br>
233 kwargs: Extra kwargs.</tt></dd></dl>
235 <dl><dt><a name="TabTestCase-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the text matches the regular expression.</tt></dd></dl>
237 <dl><dt><a name="TabTestCase-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br>
239 For the purposes of this function, a valid ordered sequence type is one<br>
240 which can be indexed, has a length, and has an equality operator.<br>
243 seq1: The first sequence to compare.<br>
244 seq2: The second sequence to compare.<br>
245 seq_type: The expected datatype of the sequences, or None if no<br>
246 datatype should be enforced.<br>
247 msg: Optional message to use on failure instead of a list of<br>
248 differences.</tt></dd></dl>
250 <dl><dt><a name="TabTestCase-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br>
253 set1: The first set to compare.<br>
254 set2: The second set to compare.<br>
255 msg: Optional message to use on failure instead of a list of<br>
256 differences.<br>
258 assertSetEqual uses ducktyping to support different types of sets, and<br>
259 is optimized for sets specifically (parameters must support a<br>
260 difference method).</tt></dd></dl>
262 <dl><dt><a name="TabTestCase-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl>
264 <dl><dt><a name="TabTestCase-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br>
267 tuple1: The first tuple to compare.<br>
268 tuple2: The second tuple to compare.<br>
269 msg: Optional message to use on failure instead of a list of<br>
270 differences.</tt></dd></dl>
272 <dl><dt><a name="TabTestCase-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl>
274 <dl><dt><a name="TabTestCase-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl>
276 <dl><dt><a name="TabTestCase-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl>
278 <dl><dt><a name="TabTestCase-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl>
280 <dl><dt><a name="TabTestCase-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br>
281 tearDown.</tt></dd></dl>
283 <dl><dt><a name="TabTestCase-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl>
285 <dl><dt><a name="TabTestCase-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
287 <dl><dt><a name="TabTestCase-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
289 <dl><dt><a name="TabTestCase-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
291 <dl><dt><a name="TabTestCase-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
293 <dl><dt><a name="TabTestCase-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
295 <dl><dt><a name="TabTestCase-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
297 <dl><dt><a name="TabTestCase-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
299 <dl><dt><a name="TabTestCase-id"><strong>id</strong></a>(self)</dt></dl>
301 <dl><dt><a name="TabTestCase-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl>
303 <dl><dt><a name="TabTestCase-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns a one-line description of the test, or None if no<br>
304 description has been provided.<br>
306 The default implementation of this method returns the first line of<br>
307 the specified test method's docstring.</tt></dd></dl>
309 <dl><dt><a name="TabTestCase-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl>
312 Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
313 <dl><dt><a name="TabTestCase-setUpClass"><strong>setUpClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for setting up class fixture before running tests in the class.</tt></dd></dl>
315 <dl><dt><a name="TabTestCase-tearDownClass"><strong>tearDownClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for deconstructing the class fixture after running all tests in the class.</tt></dd></dl>
318 Data descriptors inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
319 <dl><dt><strong>__dict__</strong></dt>
320 <dd><tt>dictionary for instance variables (if defined)</tt></dd>
322 <dl><dt><strong>__weakref__</strong></dt>
323 <dd><tt>list of weak references to the object (if defined)</tt></dd>
326 Data and other attributes inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
327 <dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError'><dd><tt>Assertion failed.</tt></dl>
329 <dl><dt><strong>longMessage</strong> = False</dl>
331 <dl><dt><strong>maxDiff</strong> = 640</dl>
333 </td></tr></table></td></tr></table>