grimsell 2005/04/26 02:58:55
Modified: documentation/docs/xdocs/integration/ant index.xml
navigation.xml
documentation/docs/xdocs sitemap.xml
Added: documentation/docs/xdocs/integration/ant task_cactifyear.xml
Log:
Added documentation on ant task cactifyear
Revision Changes Path
1.11 +8 -0
jakarta-cactus/documentation/docs/xdocs/integration/ant/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/jakarta-cactus/documentation/docs/xdocs/integration/ant/index.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- index.xml 30 Dec 2004 23:22:30 -0000 1.10
+++ index.xml 26 Apr 2005 09:58:54 -0000 1.11
@@ -205,6 +205,14 @@
</td>
</tr>
<tr>
+ <th>CactifyEar</th>
+ <td>
+ This task can enhance a provided Enterprise application
archive (EAR),
+ and add the elements required to run Cactus tests against
it. It can
+ also add EJB references to allow testing of local EJB:s.
+ </td>
+ </tr>
+ <tr>
<th>Cactus</th>
<td>
This task extends the standard <code><junit></code>
task
1.15 +1 -0
jakarta-cactus/documentation/docs/xdocs/integration/ant/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/jakarta-cactus/documentation/docs/xdocs/integration/ant/navigation.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- navigation.xml 31 May 2004 20:05:24 -0000 1.14
+++ navigation.xml 26 Apr 2005 09:58:54 -0000 1.15
@@ -35,6 +35,7 @@
<menu label="Ant Tasks">
<item id="task_cactifywar" label="CactifyWar"/>
+ <item id="task_cactifyear" label="CactifyEar"/>
<item id="task_cactus" label="Cactus"/>
<item id="task_runservertests" label="RunServerTests"/>
<item id="task_webxmlmerge" label="WebXmlMerge"/>
1.1
jakarta-cactus/documentation/docs/xdocs/integration/ant/task_cactifyear.xml
Index: task_cactifyear.xml
===================================================================
<?xml version="1.0"?>
<!--
* ========================================================================
*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* ========================================================================
-->
<document id="task_cactifyear">
<properties>
<title>CactifyEar Ant Task</title>
</properties>
<body>
<section title="CactifyEar Task">
<p>
The task <strong>cactifyear</strong> allows the enhancement of an
existing
enterprise-application archive (EAR) with the elements needed to run
Cactus
in-container tests. This includes adding a web application that
contains
the deployed Cactus redirectors.
</p>
<p>
The <strong>cactifyear</strong> task extends the built-in Ant task
<strong>ear</strong>, so it also supports all attributes and nested
elements that <strong>ear</strong> supports.
</p>
<section title="Parameters">
<table>
<tr>
<th>Name</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td><strong>srcfile</strong></td>
<td>
The original ear that is going to be cactified.
</td>
<td>Yes</td>
</tr>
<tr>
<td>addEjbReferences</td>
<td>
Specifies if EJB references to all local EJB:s in the ear
should be added to the cactus war.
</td>
<td>No</td>
</tr>
</table>
</section>
<section title="Nested Elements">
<section title="cactuswar">
<p>
The <strong>cactuswar</strong> element configures everything that
has to do with the cactus web application that will end up in the
ear. This element has all the parameters of the
<link href="site:task_cactifywar">cactifywar</link> task except
the <strong>destfile</strong> parameter. The web application will
always be named cactus.war and be placed in the root of the ear.
</p>
<section title="Parameters">
<table>
<tr>
<th>Name</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td>context</td>
<td>
The context to wich the cactified web application will be
mapped to.
</td>
<td>No, the default is <em>/cactus</em></td>
</tr>
</table>
</section>
</section>
</section>
<section title="Examples">
<p>
The following example demonstrates the simplest-possible use of the
task. It will add a web application named cactus.war under the
context
/cactus. The web application will contain the redirectors necessary
for cactus to work.
</p>
<source><![CDATA[
<cactifyear srcfile="${build.dir}/my.ear"
destfile="${build.dir}/cactified.ear"/>
]]></source>
<p>
The next example demonstrates how to set the context for the web
application.
</p>
<source><![CDATA[
<cactifyear srcfile="${build.dir}/my.ear"
destfile="${build.dir}/cactified.ear">
<cactuswar context="/myTestFramework" version="2.3"/>
</cactifyear>
]]></source>
<p>
In the following example, we use an existing war by cactify it and
add it to the ear.
</p>
<source><![CDATA[
<cactifyear srcfile="${build.dir}/my.ear"
destfile="${build.dir}/cactified.ear">
<cactuswar srcfile="mytest.war"/>
</cactifyear>
]]></source>
<p>
As mentioned previously all parameters of the tasks
<strong>cactifywar</strong> and <strong>war</strong> can be used.
The only exception to this is <strong>destfile</strong> since
the resulting war always is placed inside the ear with the
name cactus.war.
</p>
<source><![CDATA[
<cactifyear srcfile="${build.dir}/my.ear"
destfile="${build.dir}/cactified.ear">
<cactuswar srcfile="mytest.war" mergewebxml="my-web.xml">
<classes dir="${classes}">
<include name="**/*Test.class"/>
</classes>
</cactuswar>
</cactifyear>
]]></source>
</section>
</section>
</body>
</document>
1.97 +6 -0 jakarta-cactus/documentation/docs/xdocs/sitemap.xml
Index: sitemap.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/docs/xdocs/sitemap.xml,v
retrieving revision 1.96
retrieving revision 1.97
diff -u -r1.96 -r1.97
--- sitemap.xml 13 Apr 2005 15:55:31 -0000 1.96
+++ sitemap.xml 26 Apr 2005 09:58:54 -0000 1.97
@@ -398,6 +398,12 @@
Documentation for the <cactifywar> task provided by Cactus.
</resource>
+ <resource id="task_cactifyear"
+ target="integration/ant/task_cactifyear.html"
+ name="CactifyEar Ant Task">
+ Documentation for the <cactifyear> task provided by Cactus.
+ </resource>
+
<resource id="task_cactus"
target="integration/ant/task_cactus.html"
name="Cactus Ant Task">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
