def62b0011a53f07c5c7ff6a7156095935a9ba96
[WebKit.git] / WebKitSite / quality / testing.html
1 <?php
2     $title = "Regression Testing";
3     include("../header.inc");
4 ?>
5 <h2>Regression Testing</h2>
6
7 <h3>The WebKit Tests</h3>
8
9 <p>Before patches can land in any of the frameworks in the repository, the
10 layout regression tests must pass. To run these tests, execute the
11 <tt>run-webkit-tests</tt> <a href="/coding/scripts.html">script</a>.</p>
12
13 <p>The script will dump the render trees for all of the pages and diff the results against the expected correct results.  If no
14 differences are found, then the patch has passed the tests.  If any tests fail, then the patch cannot be committed until the
15 discrepancies in the tests are resolved.</p>
16
17 <p>Regression tests must be run on Leopard, since the expected results checked in were generated on Leopard.</p>
18
19
20 <h3>The JavaScriptCore Tests</h3>
21
22 <p>If you are making changes to JavaScriptCore, there is an additional test suite you must run before landing changes.
23 This is the Mozilla JavaScript test suite.</p>
24
25 <h3>What's covered by the JavaScript tests?</h3>
26
27  <p>The JavaScript tests cover the functionality of the core JavaScript engine.
28  This includes the following JavaScript objects:
29
30       <table>
31         <tr>
32           <td valign="top">
33             <ul>
34               <li>Arrays</li>
35               <li>Booleans</li>
36               <li>Dates</li>
37               <li>Functions</li>
38             </ul>
39           </td>
40           <td valign="top">
41             <ul>
42               <li>Global Object</li>
43               <li>Math</li>
44               <li>Numbers</li>
45               <li>Objects</li>
46             </ul>
47           </td>
48           <td valign="top">
49             <ul>
50               <li>Regular Expressions</li>
51               <li>Strings</li>
52             </ul>
53           </td>
54         </tr>
55       </table>
56
57       In addition, the JavaScript tests cover parsing, lexical conventions,
58       expressions, statements, type conversion, and exception handling.  
59
60
61 <h3>How to run the tests</h3>
62
63 <p>Execute the <tt>run-javascriptcore-tests</tt> <a href="/coding/scripts.html">script</a>.
64 The script will run all the tests and summarize how the results differ
65 from what is currently expected.</p>
66
67 <h3>What just happened</h3>
68 <p>
69 After all the test runs have finished the results of tests are saved to <tt>actual.html</tt>. 
70 The script the compares these results from your local tree against what is expected to pass/fail from the tip of tree.
71 If there are any regressions caused by your changes you'll be made aware of them.
72 If you fixed a bug that caused an existing failure, you'll also be made aware of what specific test your fix affected.
73 </p>
74
75 <h3>What to do next</h3>
76
77 <p>So you fixed a bug that fixed a test.  This means you've now set a new baseline for the tree as a result.</p>
78 <p class="code">cp actual.html expected.html</p>
79 <p>When you land your changes, the baseline (expected.html) will be updated in the tree.</p>
80
81 <h3>What happens if I caused a regression?</h3>
82
83 <p>It's not the end of the world.  Go back and fix your bug and rerun
84 <tt>run-javascriptcore-tests</tt> as many times as necessary.</p>
85
86 <?php
87     include("../footer.inc");
88 ?>