michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: Layout Regression tests michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

Table Regression Tests

michael@0:

Bernd Mielke

michael@0:

About This Document

michael@0:

michael@0: This document describes my guerrilla approach to successfully running the table layout regression tests. It should encourage more people to run those tests. michael@0: michael@0:

Subject Overview

michael@0:

michael@0: The table element and its children are one of the major layout components that can create some structure on the screen. They are widely (ab)used by page authors. Every small change in the table code can generate a bunch of bugzilla entries and a lot of seemingly unrelated dupes. With the high frequency of checkins in to the source tree it is difficult and time consuming to track the regression down to a single checkin. The risk of becoming very infamous can be reduced by running the layout regression tests. michael@0: michael@0:

Prerequisites

michael@0:

michael@0: In order to run these tests, you will need to have: michael@0:

a debug build with a working viewer, an optimized build will not work! michael@0:
a mozilla tree with the testfiles at %MOZ_SRC%/layout/html/tests, michael@0:
DISABLE_TESTS should not be defined, michael@0:
patience and time. michael@0:

michael@0: michael@0:

Test Runs

michael@0: michael@0:

Go to the %MOZ_SRC%/layout/html/tests/block directory. michael@0:
Avoid the nasty assertions to pop up by set XPCOM_DEBUG_BREAK=warn, the world would be a much better place if we could first fix those assertions. michael@0:
The following shell scripts need a sh before the command under WinXX. michael@0:
Execute rtest.sh baseline michael@0:
Execute rtest.sh verify>outputfile.txt michael@0:
Make a note which tests have failed (these are false positives. If you are in bad mood file a bug against Chris Waterson about them) michael@0:
you can grep the failures by:
michael@0: grep 'rgd failed' <outputfile.txt >false_positive.txt michael@0:
Make a copy of gklayout.dll and gkcontent.dll in the dist directory. If you would like to switch back, you will need them. michael@0:
Make your changes to the source, compile and install. michael@0:
execute in the layout/html/tests/block directory rtest.sh verify >regression.txt michael@0:
Check how many tests have failed and analyse your results: michael@0:
- If the regression tests have failed at the same place as the previous diagnosed false positives => ignore michael@0:
  1. copy rtest.sh to my_rtest.sh michael@0:
  2. create a new directory my_files. michael@0:
  3. create in this directory a file file_list.txt, where you put the url's of your remaining test failures michael@0:
  4. change my_rtest.sh to use only directory my_files michael@0:
  5. go back to the original gklayout.dll and gkcontent.dll and repeat the regression test procedure on a much smaller set now. michael@0:
  michael@0:
- Try to figure out what the other regressions are: Are they michael@0: improving the picture or are they regressions? michael@0:
- Note the difficult to explain testfailures. michael@0:
michael@0:
Change the source if necessary until the regression tests indicate that your patch does not hork the block and table layout michael@0:
Submit your patch and lists the remaining differences in the bug michael@0:

michael@0: michael@0:

Be prepared to cycle. michael@0: michael@0:

How the layout regression tests work

michael@0: michael@0:

First the URL's to test are red from file_list.txt.

michael@0:
snippet from file_list.txt
michael@0:
file:///s|/mozilla/layout/html/tests/table/dom/appendCells1.html michael@0: file:///s|/mozilla/layout/html/tests/table/dom/appendCellsRebuild1.html michael@0: file:///s|/mozilla/layout/html/tests/table/dom/appendCol1.html michael@0: file:///s|/mozilla/layout/html/tests/table/dom/appendCol2.html michael@0: file:///s|/mozilla/layout/html/tests/table/dom/appendColGroup1.html michael@0: file:///s|/mozilla/layout/html/tests/table/dom/appendRowsExpand1.html
michael@0:
michael@0:

snippet from file_list.txt
michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendCells1.html michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendCellsRebuild1.html michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendCol1.html michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendCol2.html michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendColGroup1.html michael@0: file:///s\|/mozilla/layout/html/tests/table/dom/appendRowsExpand1.html michael@0:

The regression tests compare the frame tree dumps recorded at two different times. The URL's to test are red from file_list.txt michael@0: For every file in file_list.txtviewer takes the root frame and dumps the whole tree via michael@0: michael@0: nsFrame::DumpRegression. michael@0:

michael@0: The frame tree dumps are invoked by the -o switch to the viewer (see commandline arguments ). michael@0: When -o is specified together with a output directory for instance (-o s:\mozilla\layout\html\tests\table\dom\), michael@0: the frame trees are dumped to separate files in that directory for all URL's in file_list.txt (see: michael@0: michael@0: nsWebCrawler::DumpRegressionData) . michael@0:

Their name is generated by replacing the old extension .html or .xml with .rgd. For file:///s|/mozilla/layout/html/tests/table/dom/appendCells1.html a file appendCells1.rgd will be created in the s:\mozilla\layout\html\tests\table\dom\ directory. michael@0: michael@0:

michael@0: There is a special type of frame dumps - the printing regression tests, they are invoked by the -Prt command line argument to the viewer and include first a display then a frame dump taking into account the printer pages. A typical beginning of a dump (*.rgd file) looks like:

michael@0:

michael@0: <frame va="15022440" type="Viewport(-1)" state="270340" parent="0">
michael@0:   <view va="47171904">
michael@0:   </view>
michael@0:   <stylecontext va="15022232">
michael@0:     <font serif 240 240 0 />
michael@0:     <color data="-16777216"/>
michael@0:     <background data="0 2 3 -1 0 0 "/>
michael@0:     <spacing data="left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0" />
michael@0:     <list data="100 100 " />
michael@0:     <position data="left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  " />
michael@0:     <text data="0 0 0 Normal  Normal  0[0x0]tw  Normal  " />
michael@0:     <textreset data="0 10[0xa]enum  " />
michael@0:     <display data="0 1 0 0 0 0 0 0 0 0 0 0 " />
michael@0:     <visibility data="0 1 1.000000" />
michael@0:     <table data="0 0 4 -1 1 " />
michael@0:     <tableborder data="1 Null  Null  0 2 " />
michael@0:     <content data="0 0 0 Null  " />
michael@0:     <quotes data="0 " />
michael@0:     <ui data="3 0 0 1 " />
michael@0:     <uireset data="7 0 4" />
michael@0:     <xul data="0 0 0 0 0 1    <svg data="0 1.000000 1.000000 0 1.000000" />
michael@0:   </stylecontext>

michael@0:

The first run of the regression tests is started with the argument baseline and it creates the reference frame dumps. michael@0:

The baseline log will look like: michael@0:

michael@0: Type Manifest File: C:\MOZ_SOUR\MOZILLA\MOZILLA\DIST\WIN32_D.OBJ\BIN\components\xpti.dat
michael@0: nsNativeComponentLoader: autoregistering begins.
michael@0: nsNativeComponentLoader: autoregistering succeeded
michael@0: Going to create the event queue
michael@0: WEBSHELL+ = 1
michael@0: Note: verifyreflow is disabled
michael@0: Note: styleverifytree is disabled
michael@0: Note: frameverifytree is disabled
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCells1.html: done loading (11810 msec)
michael@0: appendCells1.rgd - being written
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCellsRebuild1.html: done loading (1260 msec)
michael@0: appendCellsRebuild1.rgd - being written
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCol1.html: done loading (270 msec)
michael@0: appendCol1.rgd - being written
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCol2.html: done loading (220 msec)
michael@0: appendCol2.rgd - being written
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendColGroup1.html: done loading (390 msec)
michael@0: appendColGroup1.rgd - being written
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendRowsExpand1.html: done loading (220 msec)
michael@0: appendRowsExpand1.rgd - being written
michael@0:

michael@0:

michael@0: The second run with the argument verify creates first the frame dumps in a subdirectory (verify) and compares each frame dump with the corresponding reference frame dump. If they differ in critical points the test fails. michael@0:

A typical part of the verify log would look like: michael@0:

michael@0: Type Manifest File: C:\MOZ_SOUR\MOZILLA\MOZILLA\DIST\WIN32_D.OBJ\BIN\components\xpti.dat
michael@0: nsNativeComponentLoader: autoregistering begins.
michael@0: nsNativeComponentLoader: autoregistering succeeded
michael@0: Going to create the event queue
michael@0: WEBSHELL+ = 1
michael@0: Note: verifyreflow is disabled
michael@0: Note: styleverifytree is disabled
michael@0: Note: frameverifytree is disabled
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCells1.html: done loading (2200 msec)
michael@0: frame bbox mismatch: 0,285,930,435 vs. 0,285,1305,435
michael@0: Node 1:
michael@0:   TableOuter(table)(1) 0x10004 0,285,930,435, |null attr|-16777216|left: 0[0x0]tw top: 0[0x0]tw right: 0[0x0]tw bottom: 0[0x0]tw  left: 0[0x0]tw top: 0[0x0]tw right: 0[0x0]tw bottom: 0[0x0]tw  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Inherit top: Inherit right: Inherit bottom: Inherit  0[0x0]tw  0[0x0]tw  Null  0[0x0]tw  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 8 0 0 0 0 0 1 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null
michael@0: Node 2:
michael@0:   TableOuter(table)(1) 0x10004 0,285,1305,435, |null attr|-16777216|left: 0[0x0]tw top: 0[0x0]tw right: 0[0x0]tw bottom: 0[0x0]tw  left: 0[0x0]tw top: 0[0x0]tw right: 0[0x0]tw bottom: 0[0x0]tw  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Inherit top: Inherit right: Inherit bottom: Inherit  0[0x0]tw  0[0x0]tw  Null  0[0x0]tw  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 8 0 0 0 0 0 1 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null  
michael@0: frame bbox mismatch: 0,0,930,435 vs. 0,0,1305,435
michael@0: Node 1:
michael@0:   Table(table)(1) 0x10004 0,0,930,435, |null attr|-16777216|left: Null top: 0[0x0]tw right: Null bottom: 0[0x0]tw  left: Null top: Null right: Null bottom: Null  left: 15[0xf]tw top: 15[0xf]tw right: 15[0xf]tw bottom: 15[0xf]tw  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  2 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 8 0 0 0 0 0 0 0 0 0 0 |0 8 4 -1 1 |0 0 0 Null 
michael@0: Node 2:
michael@0:   Table(table)(1) 0x10004 0,0,1305,435, |null attr|-16777216|left: Null top: 0[0x0]tw right: Null bottom: 0[0x0]tw  left: Null top: Null right: Null bottom: Null  left: 15[0xf]tw top: 15[0xf]tw right: 15[0xf]tw bottom: 15[0xf]tw  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  2 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 8 0 0 0 0 0 0 0 0 0 0 |0 8 4 -1 1 |0 0 0 Null 
michael@0: frame bbox mismatch: 45,15,840,405 vs. 45,15,1215,405
michael@0: Node 1:
michael@0:   TableColGroup(table)(1) 0x80010004 45,15,840,405, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 12 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null 
michael@0: Node 2:
michael@0:   TableColGroup(table)(1) 0x80010004 45,15,1215,405, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 12 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null 
michael@0: frame state mismatch: 0x30010406 vs. 0x30010004
michael@0: Node 1:
michael@0:   TableCol(table)(1) 0x30010406 0,0,0,0, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 11 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null 
michael@0: Node 2:
michael@0:   TableCol(table)(1) 0x30010004 870,0,345,405, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 11 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null  
michael@0: frame bbox mismatch: 0,0,0,0 vs. 870,0,345,405
michael@0: Node 1:
michael@0:   TableCol(table)(1) 0x30010406 0,0,0,0, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 11 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null 
michael@0: Node 2:
michael@0:   TableCol(table)(1) 0x30010004 870,0,345,405, |null attr|-16777216|left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null left: 1[0x1]enum top: 1[0x1]enum right: 1[0x1]enum bottom: 1[0x1]enum  left: Null top: Null right: Null bottom: Null  left: Null top: Null right: Null bottom: Null  1[0x1]enum 0|100 100 |left: Auto top: Auto right: Auto bottom: Auto  Auto  0[0x0]tw  Null  Auto  0[0x0]tw  Null  0 Auto  |0 0 0 Normal  Normal  0[0x0]tw  Normal  |0 11 0 0 0 0 0 0 0 0 0 0 |0 0 4 -1 1 |0 0 0 Null  
michael@0: regression test s:\mozilla\layout\html\tests\table\dom\verify\appendCells1.rgd failed
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCellsRebuild1.html: done loading (390 msec)
michael@0: 044regression test s:\mozilla\layout\html\tests\table\dom\verify\appendCellsRebuild1.rgd passed
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCol1.html: done loading (280 msec)
michael@0: regression test s:\mozilla\layout\html\tests\table\dom\verify\appendCol1.rgd passed
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendCol2.html: done loading (220 msec)
michael@0: regression test s:\mozilla\layout\html\tests\table\dom\verify\appendCol2.rgd passed
michael@0: +++ file:///s|/mozilla/layout/html/tests/table/dom/appendColGroup1.html: done loading (220 msec)
michael@0: regression test s:\mozilla\layout\html\tests\table\dom\verify\appendColGroup1.rgd passed
michael@0:

michael@0:

michael@0: The first regression test has failed and it is marked so. michael@0: michael@0: michael@0:

Adding new regression tests

michael@0:

michael@0: Once you have checked in the code: michael@0:

please add your testcase for the bug to the regression tests. michael@0:
A testcase should only contain local files. michael@0:
Place the images in table/images (don't forget cvs commit -kb ) michael@0:
and the testfile in the table/bugs directory. michael@0:
Update the file_listx.txt in order to include your file. michael@0:

michael@0:

I would like to thank Chris Karnaze for his guidance and fantasai for his language support. michael@0:

<regression.html> <Last updated: michael@0: 2002-06-16 Bernd Mielke

michael@0: michael@0: michael@0: