Fix the build.
[WebKit-https.git] / WebKitSite / quality / testwriting.html
1 <?php
2     $title = "Writing New Tests";
3     include("../header.inc");
4 ?>
5
6 <h2>Writing New Tests</h2>
7
8 <p>A layout test is simply a web page. The layout test machinery renders the web page, and then dumps the
9 internal representation, the render tree, with details of the layout. This lets engineers working on the project know 
10 if they do anything that changes the layout. Once we get a test rendering properly, we check it in as part of the layout test suite.
11 </p>
12
13 <p>The following are some guidelines to follow when writing new layout tests:</p>
14
15 <ol>
16 <li>The test should be the smallest possible code fragment that tests the feature.
17 <li>The test should fit on one page (unless of course it&rsquo;s testing scrolling).
18 <li>The test should clearly describe what feature it is testing.
19 <li>The test should clearly describe the expected result.  It should be possible through visual inspection alone to determine that the test has
20 failed.
21 </ol>
22
23 <p>An example of a layout test that follows these guidelines is <tt>fast/events/event-creation.html</tt>.</p>
24
25
26 <p>A layout test should work both in the browser itself, and in the layout test tool. The layout test tool provides an 
27 additional object on the window object called the layout test controller with some methods that control test output. 
28 One you should know about is the <tt>layoutTestController.dumpAsText</tt> method. Calling this from JavaScript within a test arranges 
29 for the output to be written out as plain text rather than as a render tree dump. 
30 This is useful for tests that are testing something other than layout. The event creation test mentioned above is a good example of 
31 how to do this and when it makes sense.</p>
32
33 <p><a href="http://www.hixie.ch/resources/fonts/">The Ahem font</a> is useful in testing text layout, since its
34 glyphs&rsquo; metrics are well known, and it is always available to tests running
35 in the layout test tool. However, if you want to view tests that use Ahem in Safari,
36 you should <a href="Ahem.ttf">download Ahem</a>, open it in the Font Book
37 application, and click on the Install Font button to install it.</p>
38
39 <p>The CSS working group has an excellent document on <a href="http://www.w3.org/Style/CSS/Test/guidelines.html">test writing guidelines</a> for CSS tests.  <a href="http://trac.webkit.org/projects/webkit/wiki/Writing%20Layout%20Tests%20for%20DumpRenderTree">This wiki article</a> has more information on writing good tests and the DumpRenderTree tool.</p>
40
41 <?php
42     include("../footer.inc");
43 ?>