You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2002/12/17 17:21:50 UTC
cvs commit: jakarta-turbine-maven/src/plugins-build/latka/xdocs index.xml
dion 2002/12/17 08:21:50
Modified: src/plugins-build/latka/xdocs index.xml
Log:
Added more docs
Revision Changes Path
1.2 +92 -2 jakarta-turbine-maven/src/plugins-build/latka/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/latka/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 8 Dec 2002 12:41:33 -0000 1.1
+++ index.xml 17 Dec 2002 16:21:50 -0000 1.2
@@ -7,10 +7,100 @@
</properties>
<body>
- <section name="Maven Latka Plug-in">
+ <section name="Contents">
+ <p>The following sections are available in the Latka plugin documentation</p>
+ <ol>
+ <li><a href="#Overview">An overview of how this plugin works</a></li>
+ <li><a href="#Customizing Latka">How to get more from Latka</a></li>
+ <li><a href="#Futures">What's in store for the Latka plugin</a></li>
+ </ol>
+ </section>
+ <section name="Overview">
<p>
- This plugin runs Latka web testing scripts.
+ This plugin runs
+ <a href="http://jakarta.apache.org/commons/latka/index.html">Latka</a>
+ web testing scripts.
</p>
+ <p>
+ To use the plugin, you simply need to create some Latka test
+ scripts and place them in the <code>src/test/latka</code> directory.
+ </p>
+ <p>
+ To execute the scripts, simply run
+ </p>
+ <source>maven latka</source>
+ <p>
+ By default this will simply print the results of running your
+ Latka test suite to the console, and if the suite(s) failed,
+ the build is stopped with an appropriate exception
+ </p>
+ </section>
+ <section name="Customizing Latka">
+ <p>
+ Latka can be customised in many ways when running within
+ the plugin. The Latka docs should be read thoroughly first as they
+ should contain far more detail on the ways Latka can be tweaked.
+ </p>
+ <subsection name="XML Report">
+ <p>
+ Latka has the concept of <strong>listeners</strong>, classes
+ whose job it is to listen for, and report on the progress of
+ a Latka suite.
+ </p>
+ <p>
+ Latka looks for a listener at the start of the suite tag as
+ a <a href="http://jakarta.apache.org/commons/sandbox/jelly/">Jelly</a>
+ variable named <code>latkaEventListener</code>. If one is not found,
+ Latka notes this internally and creates an <code>XMLReporter</code>
+ as the default listener.
+ </p>
+ <p>
+ You can provide your own listener to Latka simply by using jelly's
+ <code>new</code> tag <strong>before</strong> the suite tag, e.g.
+ </p>
+ <source><![CDATA[
+<j:new var="latkaEventListener" className="org.apache.commons.latka.XMLReporter" />
+]]></source>
+ <p>
+ Once the suite is complete, you can then access the XML report using
+ all the usual jelly xml tags. For example, to simply print out the
+ resulting report in XML format use the following:
+ </p>
+ <source><![CDATA[${latkaEventListener.documentAsString}]]></source>
+ <p>
+ Once you have the report, you can then do anything else you may like
+ such as
+ <ul>
+ <li>Writing the report to a file using <code>j:file</code></li>
+ <li>
+ Perform JSL transformations on the report to generate
+ documentation
+ </li>
+ <li>Extract pieces of the report using Jelly's XML tags</li>
+ </ul>
+ </p>
+ </subsection>
+ </section>
+
+ <section name="Futures">
+ <ul>
+ <li>
+ The Latka Jelly tags are only new, and we're sure we'll find more bugs
+ in them as time goes by, so first on the agenda is those pesky bugs and
+ making Latka rock solid within Maven.
+ </li>
+ <li>
+ Secondly a way to generate xdoc reports from the Latka XML Reporter,
+ so that the Latka results can be incorporated into the site reports
+ </li>
+ <li>
+ Exposing more detail about requests and responses to Jelly so
+ people can get at them easily
+ </li>
+ <li>
+ Your suggestions are always welcome!
+ </li>
+ </ul>
</section>
</body>
</document>