You are viewing a plain text version of this content. The canonical link for it is here.
Posted to batik-dev@xmlgraphics.apache.org by vh...@apache.org on 2001/11/14 11:11:45 UTC
cvs commit: xml-batik/xdocs testInfrastructure.xml
vhardy 01/11/14 02:11:45
Modified: xdocs testInfrastructure.xml
Log:
Updated test infrastructure documentation.
Revision Changes Path
1.4 +72 -33 xml-batik/xdocs/testInfrastructure.xml
Index: testInfrastructure.xml
===================================================================
RCS file: /home/cvs/xml-batik/xdocs/testInfrastructure.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- testInfrastructure.xml 2001/05/17 01:30:27 1.3
+++ testInfrastructure.xml 2001/11/14 10:11:45 1.4
@@ -11,7 +11,7 @@
<!-- ========================================================================= -->
<!-- author vincent.hardy@eng.sun.com -->
-<!-- version $Id: testInfrastructure.xml,v 1.3 2001/05/17 01:30:27 vhardy Exp $ -->
+<!-- version $Id: testInfrastructure.xml,v 1.4 2001/11/14 10:11:45 vhardy Exp $ -->
<!-- ========================================================================= -->
<document>
@@ -44,12 +44,9 @@
<p>This document describes:</p>
<ul>
- <li><link href="#infrastructure">Test infrastructure</link>This may be a little
- dry, but it helps understanding the format of the files used to run
- the test suites</li>
+ <li><link href="#infrastructure">Test infrastructure</link></li>
<li><link href="#managingATestSuite">How to describe and run a test suite</link></li>
- <li><link href="#regardReplacement">The 'regard' replacement</link></li>
- <li><link href="#regsvggenReplacement">The 'regsvggen' replacement</link></li>
+ <li><link href="#regard">Regard, the Batik test suite</link></li>
<li><link href="#writingNewTests">Writing new Tests</link></li>
</ul>
</s1>
@@ -144,29 +141,37 @@
<p>Test suites can be described in XML (XML-in refered to earlier
in this document). The general format for describing a test suite is:</p>
<source>
-<testSuite name="MyFavoriteTestSuite">
+<testSuite id="testSuiteA" name="MyFavoriteTestSuite">
<!-- =================================== -->
<!-- Set of tests to be run -->
<!-- =================================== -->
- <test class="myFavoriteTestClassA" />
- <test class="myFavoriteTestClassB" />
- <test class="myFavoriteTestClassC" />
+ <test id="t1" class="myFavoriteTestClassA" />
+ <test id="t2" class="myFavoriteTestClassB" />
+ <test id="t3" class="myFavoriteTestClassC" />
</testSuite>
</source>
+ <p>Note that tests can be grouped in <testGroup> elements which
+ can have their own id and class attribute. This is useful because it
+ allows developers to run specific tests or test groups by specifying
+ their ids. In addition, because the class attribute is inherited by
+ <test> elements from its parents, <testGroups> allow the
+ developers to group tests which use the same class and specify that
+ class on the group.</p>
+
<p>This simply list the test of <code>Test</code> instances that compose
a given test suite. For example: </p>
<source>
-<testSuite name="SAMPLE TEST SUITE">
+<testSuite id="sampleTestSuite" name="SAMPLE TEST SUITE">
<!-- ========================================================================== -->
<!-- Validates that the SVGRenderingAccuracyTest class is operating as expected -->
<!-- ========================================================================== -->
- <test class="org.apache.batik.test.svg.SVGRenderingAccuracyTestValidator" />
+ <test id="renderingAccuracyTest" class="org.apache.batik.test.svg.SVGRenderingAccuracyTestValidator" />
<!-- ========================================================================== -->
<!-- Rendering regression tests -->
<!-- ========================================================================== -->
- <test class="org.apache.batik.test.svg.SVGRenderingAccuracyTest">
+ <test id="anne.svg" class="org.apache.batik.test.svg.SVGRenderingAccuracyTest">
<arg class="java.net.URL"
value="file:samples/anne.svg" />
<arg class="java.net.URL"
@@ -190,9 +195,7 @@
Yet another XML file describes which test to run and how to process the
generated test reports. The general syntax is something like:</p>
<source>
-<testRun name="Test Run Name Here">
-
- <testRun name="REGARD">
+<testRun id="regard" name="Test Run Name Here">
<!-- =================================== -->
<!-- Descriptions of processors that -->
<!-- will process the results of the -->
@@ -208,7 +211,6 @@
<testSuite href="http://url.to.my.first.test.suite"/>
<testSuite href="http://url.to.my.second.test.suite" />
- </testRun>
</testRun>
</source>
@@ -245,16 +247,53 @@
<p><code>build runtestsuite path/to/my/newly/created/testSuite.xml</code>.
In addition, the <em>regard</em> rule runs a specific set of tests by default,
so that you do not need to pass any testRun file argument.</p>
+ <p><strong><code>regard</code> is the project's safeguard against regressions</strong>.</p>
</s2>
</s1>
+
+ <anchor id="regard" />
- <anchor id="regardReplacement" />
- <s1 title="The 'regard' replacement">
+ <s1 title="regard: the Batik regression test suite">
- <p>'regard' is the tool we have used so far to detect regressions in how we render SVG images</p>
- <p>There is a <code>Test</code> implementation, <code>SVGRenderingAccuracyTest</code> which takes over
- the responsibility that regard has and then goes beyond.</p>
+ <p>The regard test suite contains all the regression tests for the Batik project.
+ The <code>regard</code> tool is a specific test suite description, regard.xml
+ (which you can find in the <code>test-resources/org/apache/batik/test directory</code>). That
+ file contains a set of test suite files which sould be run.</p>
+
+ <p>The following describes how to use the regard tool and some of the most important tests
+ in the regard test suite</p>
+
+ <s2 title="Running regard">
+
+ <p>The regard tool lets you run either all the tests or any specific test you want in the
+ test suite. To run all the tests in the regard test suite, type the following at the command
+ line:</p>
+
+ <p><code>build.sh regard</code></p>
+
+ <p>To run a specific test in the test suite, type the qualified test id or any sub-portion of that
+ id:</p>
+
+ <p><code>build.sh regard <id list></code></p>
+
+ <p>For example:</p>
+
+ <p><code>build.sh regard unitTesting.ts batikFX.svg</code></p>
+ <p>will run all the tests with an id containing unitTesting.ts (i.e., all the test selection
+ unit testing, see the test-resources/org/apache/batik/gvt/unitTesting.xml) and the accuracy
+ rendering test on batikFX.svg (because it is the only test with batikFX.svg it its id).</p>
+
+ </s2>
+
+ <s2 title="Rendering Accuracy Tests">
+
+ <p>There is a <code>Test</code> implementation, <code>SVGRenderingAccuracyTest</code> which
+ checks that Batik's rendering of SVG document stays accurate. It compares reference images
+ with the rendering Batik produces and reports any discrepency.</p>
+
+ </s2>
+
<s2 title="The SVGRenderingAccuracyTest configuration">
<p>An <code>SVGRenderingAccuracyTest</code>'s constructor configuration is made of</p>
@@ -286,11 +325,9 @@
will allow the test to pass if that exact same variation remains constant.</p>
</s2>
- <s2 title="Day to day use of regard replacement">
- <p>Concretely, regard is replaced by a specific test suite description, regard.xml. That
- file contains a set of test files (the ones in the samples and samples/test directories)
- for which rendering regressions should be checked.</p>
+ <s2 title="Day to day use of regard">
+
<p><em>Initial set up</em></p>
<p>
To set up the test environment the first time, you need to:</p>
@@ -299,7 +336,8 @@
(sources, resources and references) and the build.xml file</li>
<li>Run the regard test suite once:<code>build regard</code></li>
</ul>
- <p>This will generate an HTML test report in the <code>test-reports/html</code> directory.
+ <p>This will generate an HTML test report (<code>report.html</code>) in the
+ <code>test-reports/yyyy.mm.dd-HHhMMmSSs/html/html</code> directory.
Depending on how much different text rendering is between your work environment and the
environment used to create the reference images, you will get more or less test that will fail,
because of differences in the way text is rendered on various platforms and because of
@@ -328,13 +366,13 @@
because of system specific reasons or if there is a bigger problem.</p>
</s2>
- </s1>
- <anchor id="regsvggenReplacement" />
- <s1 title="The 'regsvggen' replacement">
+
+ <s2 title="SVG Generator tests">
- <p>The regsvggen tool has been deprecated and replaced by a test suite (which you can
- find in <code>test-resources/org/apache/batik/svggen/regsvggen.xml</code> in the
- source distribution.</p>
+ <p>Regard contains over a 100 tests for checking regressions on the SVG Generator. If you use 'svggen' as an argument to
+ regard, all the SVG Generator tests will be run (because regard.xml points to test-resources/org/apache/batik/svggen/regsvggen.xml
+ which is a test suite descriptio for the SVG Generator and that the root <testSuite> element has the 'svggen' id).</p>
+ </s2>
</s1>
<anchor id="writingNewTests" />
@@ -401,6 +439,7 @@
configurations for the test can be added to the relevant test suite's XML description. In
some cases, it will be interesting to create a separate test suite.</p>
</s2>
+
</s1>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: batik-dev-help@xml.apache.org