Updated docs

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113178 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol committed 2003-03-22 21:24:31 +00:00
1 parent c1e03909c2
commit d4b5b795c9
6 files changed
+52 -250

No files matched your search

+2 -34
View File
@@ -10,40 +10,8 @@
<section name="Cactus Plug-in Features">
<ul>
<li>
Support for the following containers:
<ul>
<li>
Support for Tomcat 4.x
</li>
<li>
Support for Resin 2.x
</li>
<li>
Support for WebLogic 7.x
</li>
</ul>
</li>
<li>
HTML report generation (integrated with Maven reports).
</li>
<li>
Support for keeping the server running between redeployments.
</li>
<li>
Automatic discovery of Cactus Test Cases and ignore test support
classes.
</li>
<li>
Ability to use either the Text or Swing Test Runner for running the
Cactus tests.
</li>
<li>
Automatically merge the <code>web.xml</code> elements needed by
Cactus to the user project <code>web.xml</code> file.
</li>
<li>
Ability to exclude Cactus tests (for long running tests for example,
in debug period).
Uses the <a href="http://jakarta.apache.org/cactus">Cactus/Ant
Integration</a> module. Thus benefits from all its features.
</li>
</ul>
</section>
+5 -38
View File
@@ -8,44 +8,11 @@
<body>
<goals>
<goal>
<name>cactus:compile</name>
<description>Compile Cactus tests</description>
</goal>
<goal>
<name>cactus:generate</name>
<description>Generate HTML report</description>
</goal>
<goal>
<name>cactus:init</name>
<description>Creates objects useful for several goals</description>
</goal>
<goal>
<name>cactus:merge-webxml</name>
<description>Generate a web.xml which is the merge betweem the user project web.xml and the webapp elements needed by Cactus</description>
</goal>
<goal>
<name>cactus:single</name>
<description>Execute a single test defined using the 'testcase' variable</description>
</goal>
<goal>
<name>cactus:test-init</name>
<description>Test initialization</description>
</goal>
<goal>
<name>cactus:test-swing</name>
<description>Start the tests using the swing runner</description>
</goal>
<goal>
<name>cactus:test-text</name>
<description>Start the tests using the text runner</description>
</goal>
<goal>
<name>cactus:webapp</name>
<description>Create the Cactus webapp</description>
</goal>
<goal>
<name>cactus:webapp-update</name>
<description>Generate an expanded Cactus webapp from a project expanded webapp</description>
<name>cactus:test</name>
<description>
Run the Cactus tests on the containers for which you have defined
a <code>cactus.home.[container name]</code> property.
</description>
</goal>
</goals>
</body>
-5
View File
@@ -54,11 +54,6 @@
Then, you should read the <a href="using.html">Quick Start</a> page
which provides details about how to use the plugin.
</p>
<p>
A sample application using Cactus is packaged within the Cactus plugin.
Go to where you installed Maven and look into the
<code>plugins/maven-cactus-plugin-*/sample</code> directory.
</p>
<p>
The latest changes are available <a href="changes-report.html">here</a>.
</p>
+40 -111
View File
@@ -14,148 +14,77 @@
<th>Description</th>
</tr>
<tr>
<td>maven.cactus.test.fileset.exclude</td>
<td>Yes</td>
<td>cactus.home.[container name]</td>
<td>At least one container</td>
<td>
<p>Default value is
<code>
</code>.</p>
<p>
Home directory of where you have installed the container on
which you wish to run the Cactus tests. Valid container
names are: <code>tomcat4x</code>, <code>resin2x</code>,
<code>orion1x</code>, <code>weblogic6x</code>,
<code>weblogic7x</code> and <code>jboss3x</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.testrunner.swing.excluded</td>
<td>cactus.src.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/excluded.properties</code>.</p>
<p>
Location of the Cactus test cases. Default value is
<code>src/test-cactus</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.build.dir</td>
<td>cactus.port</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.build.dir}/cactus</code>.</p>
<p>
Port on which to start the containers. Default value is
<code>8080</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.src.dir</td>
<td>cactus.target.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>src/test-cactus</code>.</p>
<p>
Location where the plugins puts temporary build-generated
files. Default value is <code>${maven.build.dir}</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.classes.dir</td>
<td>cactus.src.includes</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.cactus.build.dir}/classes</code>.</p>
<p>
Lists of test classes that will be executed. Default value is
<code>**/*Test*.java</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.scripts.dir</td>
<td>cactus.src.excludes</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/scripts</code>.</p>
<p>
Lists of classes that will be excluded in the tests. Default
value is <code>**/AllTests.java,**/Test*All.java</code>.
</p>
</td>
</tr>
<tr>
<td>maven.cactus.webxml.dvsl</td>
<td>cactus.context</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/web.xml.dvsl</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.test.reportsDirectory</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.cactus.build.dir}/test-reports</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.build.resources.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.cactus.build.dir}/resources</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.jspRedirector</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/web/jspRedirector.jsp</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.configFile</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/cactus.properties</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.junit.usefile</td>
<td>Yes</td>
<td>
<p>Default value is
<code>true</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.test.fileset.include</td>
<td>Yes</td>
<td>
<p>Default value is
<code>**/*.class</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.prewar.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.war.build.dir}</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.emptywebxml</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/web.xml</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.port</td>
<td>Yes</td>
<td>
<p>Default value is
<code>8080</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.conf.containers.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${plugin.dir}/conf/containers</code>.</p>
</td>
</tr>
<tr>
<td>maven.cactus.testrunner</td>
<td>Yes</td>
<td>
<p>Default value is
<code>text</code>.</p>
<p>
Name of the webapp context under which the application will be
deployed for executing the Cactus tests. Default
value is <code>cactustest</code>.
</p>
</td>
</tr>
</table>
-29
View File
@@ -14,35 +14,6 @@
<subsection name="Unassigned">
<p>
<ul>
<li>
Describe plugin properties in the Maven plugin documentation.
</li>
<li>
Fix the "single" goal as it will not really work because it
expects that the cactus war has been deployed and it won't
redeploy it when the code changes.
</li>
<li>
Transform cactus Ant scripts to Jelly scripts for :
Tomcat 3.x, Orion 1.5, Orion 1.6, WebLogic 6.x,
Enhydra 5.x
</li>
<li>
Add more scripts for JBoss/Jonas/Jetty.
</li>
<li>
Add a <code>test-all</code> goal that runs the tests on all
defined containers.
</li>
<li>
Support packaging as an EAR for EJB unit testing. Requires the
EAR plugin first.
</li>
<li>
Add the rhino jar for HttpUnit javascript support.
</li>
</ul>
</p>
</subsection>
+5 -33
View File
@@ -13,7 +13,7 @@
Create a <code>src/test-cactus</code> directory in your project and
put your Cactus test classes in it (with the normal package directory
structure). Note that the location of the Cactus test sources can be
configured through the <code>maven.cactus.src.dir</code> property.
configured through the <code>cactus.src.dir</code> property.
</li>
<li>
Create a <code>build.properties</code> file in your project root
@@ -24,44 +24,16 @@
</li>
<source><![CDATA[
maven.cactus.tomcat4x.home = C:/Apps/jakarta-tomcat-4.1.10
maven.cactus.resin2x.home = C:/Apps/resin-2.1.4
cactus.home.tomcat4x = C:/Apps/jakarta-tomcat-4.1.10
cactus.home.resin2x = C:/Apps/resin-2.1.4
]]></source>
<li>
Call the
<a href="http://maven.apache.org/reference/plugins/war/index.html">War</a>
plugin's goals to generate a war for your webapp. For example:
<code>maven war</code>. Note that in the future you would also be
able to call the Ear plugin if your application is an EAR.
</li>
<li>
Then, simply run the Cactus goal for your container. For example,
type <code>maven cactus:test-tomcat-4x</code> to run the tests with
Tomcat 4.x. You can type <code>maven -g</code> for a full list of the
available goals.
</li>
<li>
If you wish to generate Cactus HTML test reports, type
<code>maven cactus:generate site</code>.
Then, simply type <code>maven cactus:test</code> to run the Cactus
tests.
</li>
</ol>
<p>
The plugin will automatically add what is needed for the Cactus tests
to your application WAR/webapp by repackaging it. In detail, it will
add the Cactus test classes, Cactus configuration files and Cactus jars
to your WAR/webapp. It will then deploy it, configure the container you
have chosen, start it, run the Cactus tests and stop the container.
</p>
<p>
It is possible (and recommended for performance reasons) to run all the
goals in one Maven invocation. For example:
<code>maven war cactus:test-tomcat-4x cactus:generate site</code>. You
can also put that sequence in your project's <code>maven.xml</code>
file.
</p>
</section>
</body>