vmassol 01/04/07 00:16:58
Modified: cactus/docs/framework/xdocs changes.xml contributors.xml
doc-book.xml installation.xml sample_servlet.xml
site-book.xml todo.xml
Added: cactus/docs/framework/xdocs index.xml installation_ant.xml
installation_sample.xml
Log:
moved from XML Apache skin to jakarta skin + udpdated documentation + added tutorial
for installing Ant + tutorial for installing the Cactus sample
Revision Changes Path
1.2 +21 -429 jakarta-commons-sandbox/cactus/docs/framework/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/changes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- changes.xml 2001/03/31 20:22:38 1.1
+++ changes.xml 2001/04/07 07:16:55 1.2
@@ -8,16 +8,34 @@
<person name="Vincent Massol" email="[EMAIL PROTECTED]" id="VMA"/>
</devs>
- <release version="1.0 in CVS" date="unknown">
+ <release version="1.0" date="April 6 2001">
<action dev="VMA" type="update">
+ Changed the web site skin to be the Jakarta skin and not the Apache XML
+ skin. This is because Cactus is now part of the Jakarta Commons project.
+ </action>
+ <action dev="VMA" type="update">
+ Updated the web site installation section to better explain the
+ required steps to install Cactus. Namely, it covers
+ <link href="installation_ant.html">installing Ant</link> and
+ <link href="installation_sample.html">installing the Cactus Sample
+ application</link>.
+ </action>
+ <action dev="VMA" type="remove">
+ Removed the deliverable dependencies jar. Instead, provides a zipped
+ installation of Ant containing the needed jar for tasks used by Cactus
+ and Cactus Sample build files. Also provide zipped versions of Servlet
+ API 2.2 and 2.3 from the <code>jakarta-servletapi</code> and
+ <code>jakarta-servletapi-4</code> projects.
+ </action>
+ <action dev="VMA" type="update">
Removed the <code>misc/</code> directory and JBuilder files from CVS
and source distribution.
</action>
<action dev="VMA" type="update">
Renamed the project from J2EEUnit to Cactus. Although it was a difficult
decision to make, it had to be done as J2EE is a Sun trademark. Renamed
- all occurrences of J2EEUnit and changed package names. Check the web site
- for an explanation on the name.
+ all occurrences of J2EEUnit to Cactus and changed package names (from
+ <code>j2eeunit.*</code> to <code>org.apache.commons.castor.*</code>.
</action>
<action dev="VMA" type="fix">
The sample application sources now contains all needed configuration
@@ -29,432 +47,6 @@
Changed license from GPL to APL. Moved packages from
<code>j2eeunit.*</code> to <code>org.apache.commons.j2eeunit.*</code>
and changed copyrights
- </action>
- </release>
-
- <release version="0.9" date="March 26 2001">
- <action dev="VMA" type="update" due-to="René Leonhardt"
due-to-email="[EMAIL PROTECTED]">
- Modified the J2EEUnit sample not to use a helper class anymore to test
- servlet method that make use of <code>getServletConfig()</code>,
- <code>getServletContext()</code>, <code>log()</code>, ... methods. This is
- actually not needed. The workaround is simply to call
- <code>init(ServletConfig)</code> on the class to test, passing it the
- <code>config</code> implicit object, prior to calling the method to test.
- </action>
- <action dev="VMA" type="update">
- Removed version numbers in the generated deliverables. However, there is
- now a version.txt file in all generated zips and as usual a manifest file
- for the generated jars. Also note that the versions are still specified
- on the SourceForge download area for J2EEUnit : this is to let user be
- able to pick previous versions of J2EEUnit if they wish.
- </action>
- <action dev="VMA" type="add" due-to="Sam Ruby"
due-to-email="[EMAIL PROTECTED]">
- Continuous builds of J2EEUnit using GUMP, hosted on the Jakarta project
- servers. Check
- <link href="http://jakarta.apache.org/builds/gump/latest/j2eeunit.html">
- here</link>.
- </action>
- <action dev="VMA" type="update">
- Complete refactoring of the J2EEUnit Ant build process in order to use
- Ant as an application, remove all dependent libraries (they are still
- available for download in a separate zip file) and remove all the
- batch files. Now J2EEUnit works on all OS and all platforms (that's easy
- to do with only Java and no batch files ... hehe).
- </action>
- <action dev="VMA" type="update">
- Updated to Stylebook version b3 that uses Xalan 2. As Xalan 2 need a
- JAXP 1.1 compliant XML parver, <code>parser.jar</code> has been replaced
- by <code>crimson.jar</code>.
- </action>
- <action dev="VMA" type="remove">
- Removed the webalizer statistics on the web site as the Sourceforge
- statistics are working again. For statistics, go
- <link href="http://sourceforge.net/project/stats/?group_id=14156">
- here</link>.
- </action>
- </release>
-
- <release version="0.8.1" date="March 9 2001">
- <action dev="VMA" type="add">
- Tests with Orion server now also stops automatically the running Orion
- engine.
- </action>
- <action dev="VMA" type="fix" due-to="Khairy Mahmoud" due-to-email="">
- Fixed the <code>HttpClientHelper</code> class which was using a JDK 1.3
- API to check if a query string was present in the URL. Changed to support
- both JDK 1.2 and 1.3. Also fixed other minor issues so that J2EEUnit now
- works fine with borh JDKs.
- </action>
- <action dev="VMA" type="add">
- Added a <code>ServletConfig.setServletName()</code> method to the
- <code>config</code> implicit object to set the servlet's name. This is the
- value that will be returned by <code>ServletConfig.getServletName()</code>.
- This only concerns Servlet API 2.3 as there is no
- <code>ServletConfig.getServletName()</code> method for Servlet API 2.2.
- </action>
- <action dev="VMA" type="add">
- Added a <code>setInitParameter()</code> method to the <code>config</code>
- implicit object to add a sevlet config parameter, as if it had
- been defined in the <code>web.xml</code> file.
- </action>
- </release>
-
- <release version="0.8" date="March 7 2001">
- <action dev="VMA" type="add">
- Explained how to test classes that call <code>getServletContext()</code>
- and <code>getServletConfig()</code> in the
- <link href="faq.html">FAQ</link>.
- </action>
- <action dev="VMA" type="update">
- Updated web site docs to match version 0.8
- </action>
- <action dev="VMA" type="add" due-to="René Leonhardt"
due-to-email="[EMAIL PROTECTED]">
- Added a helper method that returns the server output stream as a String.
- This is to help assert the returned servlet output stream in
- <code>endXXX()</code> methods.
- </action>
- <action dev="VMA" type="update">
- Upgraded to JUnit 3.5.
- </action>
- <action dev="VMA" type="fix">
- If an error occurs during the tests, the servlet engine is now stopped.
- </action>
- <action dev="VMA" type="update">
- Updated to Ant 1.3.
- </action>
- <action dev="VMA" type="add">
- Integrated the sample application as part of the J2EEUnit framework and
- use it for running the J2EEUnit functional test suite.
- </action>
- <action dev="VMA" type="add">
- Added a redirector JSP in order to offer new implicit objects :
- <code>pageContext</code> (of type <code>PageContext</code>) and
- <code>out</code> (of type <code>JspWriter</code>). This is needed to
- unit testing custom JSP tags for example.
- </action>
- <action dev="VMA" type="add">
- Implemented wrappers for <code>ServletConfig</code> and
- <code>ServletContext</code> to override
- <code>getRequestDispatcher()</code> to return a
- <code>RequestDispatcherWrapper</code> which in turn overrides
- <code>forward()</code> and <code>include()</code> to use the original
- request and not the simulated one.
- </action>
- <action dev="VMA" type="remove">
- Dropped support of Servlet API 2.1 as it has been superseeded by Servlet
- API 2.2 and 2.3.
- </action>
- <action dev="VMA" type="add">
- Added API to ease testing of received cookies in the <code>endXXX()</code>
- method
- (<code>j2eeunit.util.AssertUtils.getCookies(HttpURLConnection)</code>).
- </action>
- <action dev="VMA" type="add" due-to="cowboyd" due-to-email="">
- Provided a new <code>ServletTestRequest.setMethod(POST|GET)</code> API
- in order to choose how the connection to the server redirector is made
- (POST or GET). This is so that you can test classes which use the
- <code>HttpServletRequest.getMethod()</code> API (requested by cowboyd).
- </action>
- <action dev="VMA" type="add">
- Ensure that <code>AssertionFailedException</code> exceptions raised on
- the server side are raised on JUnit side as
- <code>AssertionFailedException</code> so that the JUnit GUI display them
- in another color.
- </action>
- <action dev="VMA" type="remove">
- Dropped support for Tomcat 3.1 because newer versions of Tomcat exist
- (3.2 and 3.3). Also Tomcat 3.1 does not support the <jsp-file>
- tag in <code>web.xml</code>.
- </action>
- </release>
-
- <release version="0.7" date="February 25 2001">
- <action dev="VMA" type="add">
- Added new batch files and a new Ant <code>build-test-all.xml</code> in
- order to support automatic run of the J2EEUnit tests for all supported
- Servlet engines and for all Servlet API.
- </action>
- <action dev="VMA" type="add">
- Created a <code>j2eeunit.ant.ResinRun</code> class to start/stop Resin
- from Ant. Starting was already possible using the Ant <code>java</code>
- task but stopping it was not possible. It now is, which let us add
- Resin tests to the list of automated tests.
- </action>
- <action dev="VMA" type="update">
- Improved (refactored) Ant build scripts as a whole for better Servlet
- engine support and test automation.
- </action>
- <action dev="VMA" type="add">
- Added a "Tomcat How-to" tutorial that explains how to integrate Tomcat
- with Ant for automatic test runs.
- </action>
- <action dev="VMA" type="add">
- Added a tutorial that explains how to integrate J2EEUnit with Ant. It
- also includes a chapter on continuous integration.
- </action>
- <action dev="VMA" type="update">
- Created an Ant task that starts a target in another thread (this target
- should be a target that starts a servlet engine) and waits for that engine
- to be started prior to continuing. Updated all test batch files so that
- starting a test for a given servlet engine only requires starting a single
- batch file (whereas previously you had to first start the servlet engine
- with a given batch file and then when it was started you manually had to
- call the batch file that started the tests). This will enable us to
- do automatic testing with no human intervention needed. The Ant
- <code>build.xml</code> file has also been updated to include this new
- Ant task in the build process.
- </action>
- <action dev="VMA" type="update">
- Moved to Ant 1.4alpha, 19th february 2001 (there were problems with
- version 1.3beta2 regarding JUnit and the Execute task).
- </action>
- <action dev="VMA" type="add">
- Added statistics on the J2EEUnit web site (however it seems it is broken
- as the figures seem to be too high and not evolving !).
- </action>
- <action dev="VMA" type="fix">
- Design bug correction : it is now possible for the method under test to
- write to the Servlet output stream without breaking the test. Moreover it
- is also now possible for the class under test to use Request Dispatcher.
- </action>
- <action dev="VMA" type="add">
- You can now test the output of your classes under test in the
- <code>endXXX()</code> method (i.e. everything that is written in the
- servlet output stream).
- </action>
- <action dev="VMA" type="fix">
- Corrected the news.xml documentation page. The <code>img</code> tag used
- to fetch the remote SourceForge image was breaking Stylebook. I have now
- enriched the Stylebook DTD and stylesheets to accept a
- <code>img-external</code> tag.
- </action>
- </release>
-
- <release version="0.6" date="February 11 2001">
- <action dev="VMA" type="remove">
- Don't provide a default j2eeunit.properties file any more. Users <em>
- must</em> provide one for each application tested. This is to prevent
- problems with having to place the file in the CLASSPATH before the
- J2EEUnit jar file. Moreover, most of the time, you need to modify this
- file to match your web application context name.
- </action>
- <action dev="VMA" type="update">
- Improved the Ant build scripts and server test configurations so that
- they package the J2EEUnit tests in a <code>.WAR</code> file.
- </action>
- <action dev="VMA" type="update">
- Refactored the Ant build.xml file and changed the generated files. They
- now are : <code>j2eeunit-<servlet.api>-<version>.jar</code>
- (the runtime jar), <code>j2eeunit-src-<version>.zip</code> (the
- J2EEUnit sources),
- <code>j2eeunit-doc-<servlet.api>-<version>.zip</code>,
- (the documentation : javadoc + local web site) and,
- <code>j2eeunit-website-<timestamp>.zip</code> (the generated remote
- web site).
- </action>
- <action dev="VMA" type="add">
- Added a section on the J2EEUnit Architecture web page to explain the
- reasons behind J2EEUnit and the assumptions that were made to reach it's
- design.
- </action>
- <action dev="VMA" type="update">
- Moved to Ant nightly build of 04/02/2001.
- </action>
- <action dev="VMA" type="remove">
- Removed the JUnit 3.2 from the source distribution (only JUnit 3.4 is
- packaged with the source zip file).
- </action>
- <action dev="VMA" type="add">
- Added version information in the J2EEUnit manifest.
- </action>
- <action dev="VMA" type="add" due-to="Yasuhiko Sakakibara" due-to-email="">
- Added a new <code>config</code> implicit object (of type
- <code>ServletConfig</code>) in order to be able to test methods that
- require a <code>ServletConfig</code> or <code>ServletContext</code>
- object. It is accessible from <code>setUp()</code>, <code>tearDown()</code>,
- <code>beginXXX()</code>, <code>testXXX()</code> and <code>endXXX()</code>
- methods.
- </action>
- <action dev="VMA" type="update">
- Complete modification of the J2EEUnit web site to use the Apache Stylebook
- system (stylebook-1.0-b2.jar). This is to easily publish changes to the
- web site and be independent of it's presentation. The presentation can
- now be changed easily by modifying the Stylebook skin used.
- </action>
- <action dev="VMA" type="add">
- Added the J2EEUnit web site to the <code>j2eeunit</code> CVS module under
- the <code>docs/</code> directory. This is to provide better synchronization
- between J2EEUnit and it's web site.
- </action>
- <action dev="VMA" type="fix">
- Corrected exception stack trace transportation from the server side
- to the JUnit client. Before the correction, an exception raised on the
- server side would print <code><<no stack trace available>></code>.
- Now the correct stack trace is printed.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for Orion 1.4.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for Tomcat 4.0.
- </action>
- </release>
-
- <release version="0.5" date="December 30 2000">
- <action dev="VMA" type="update">
- Separated the project into several branches for cleanly handling Servlet
- API 2.1, 2.2 and 2.3. Reorganized the build scripts accordingly.
- </action>
- <action dev="VMA" type="add">
- Added the JBuilder4 projects for J2EEUnit to the distribution fullsrc zip.
- Note: the project files are added under the root directory because it is
- needed for JBuilder4 to work properly with CVS ! I would have much
- preferred to put it under <code>/misc</code> if I had the choice ...
- </action>
- <action dev="VMA" type="update">
- Now, J2EEUnit verifies the correct signatures of the begin and end method
- (returned type, modifier, parameters) and throw an exception if they are
- not correct.
- </action>
- <action dev="VMA" type="update">
- Updated the Ant scripts to support Tomcat 3.1.1.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for Tomcat 3.2.1.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for Resin 1.2.1 and Resin1.2snap of 15/12/2000.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for Resin 1.3snap of 21/12/2000.
- </action>
- <action dev="VMA" type="add">
- Added Ant scripts support for WebLogic 5.1 SP 8.
- </action>
- <action dev="VMA" type="update">
- Moved to the Ant nightly build of 17/12/2000.
- </action>
- <action dev="VMA" type="update">
- Moved to JUnit 3.4. J2EEUnit now supports JUnit 3.2 and JUnit 3.4. Note
- that JUnit 3.4 seems to have dropped the support of JDK 1.1.
- </action>
- <action dev="VMA" type="update">
- Improved simulating a full URL in the <code>ServletTestRequest</code>
- class : <code>URL = http://" + serverName (including port) + contextPath +
- servletPath + pathInfo + "?" + requestString</code>. Note that the
- <code>getContextPath()</code> method is not supported by the Servlet 2.1
- API.
- </action>
- <action dev="VMA" type="add">
- Added the <code>HttpServletRequest.getContextPath()</code> (except for
- Servlet API 2.1) for simulating the context path.
- </action>
- <action dev="VMA" type="add">
- Added the <code>HttpServletRequest.getPathInfo()</code> for simulating
- the path info.
- </action>
- <action dev="VMA" type="add">
- Added the <code>HttpServletRequest.getRequestURI()</code> for simulating
- the request URI.
- </action>
- <action dev="VMA" type="add">
- Added the <code>HttpServletRequest.getServletPath()</code> for simulating
- the servlet path.
- </action>
- <action dev="VMA" type="add">
- Added the <code>HttpServletRequest.getQueryString()</code> for simulating
- the query string.
- </action>
- <action dev="VMA" type="remove">
- Removed the <code>release_notes</code> files. Only kept the current
- <code>changelog</code> file.
- </action>
- <action dev="VMA" type="fix">
- Corrected bug in <code>ServletHttpClient.addCookies()</code>. It failed
- if more than one Cookie was added because it was missing a <code>";"</code>
- between Cookies.
- </action>
- <action dev="VMA" type="update">
- Tests have been conducted on W2K with JDK 1.3, JDK 1.2.2 and JDK 1.1 with
- the following servlet engines : Tomcat 3.1.1 (Servlet API 2.1 and 2.2),
- Tomcat 3.2.1 (Servlet API 2.1 and 2.2), Resin 1.2x (Servlet API 2.1 and
- 2.2), Resin 1.3x (Servlet API 2.3) and WebLogic 5.1 (Servlet API 2.2).
- </action>
- <action dev="VMA" type="fix" due-to="shaabans" due-to-email="">
- The <code>ServletRedirectorRequest_xx.setAttribute()</code>
- had a bug, it was calling itself recursively instead of calling the
- wrapped <code>HttpServletRequest</code>'s <code>setAttribute()</code>
- method.
- </action>
- <action dev="VMA" type="fix">
- The <code>ServletHttpClient</code> class was not sending properly the
- cookies in the HTTP connection; it was missing the <code>$Version</code>
- attribute. It now conforms to the RFC 2109.
- </action>
- </release>
-
- <release version="0.4" date="November 17 2000">
- <action dev="VMA" type="update">
- Renamed class <code>ServletRedirectorRequest</code> to
- <code>ServletRedirectorRequest_22</code> and added a
- <code>ServletRedirectorRequest_21</code> class to support Servlet API 2.1
- and 2.2 at the same time.
- </action>
- <action dev="VMA" type="add">
- Added the <code>j2eeunit.HttpServletRequestImplementation</code> property
- to <code>j2eeunit.properties</code> to specify which Servlet API (2.1 or
- 2.2) is being used and thus internally to choose between the 2
- implementations : <code>ServletRedirectorRequest_21</code> and
- <code>ServletRedirectorRequest_22</code>.
- </action>
- <action dev="VMA" type="update">
- Modified build.xml to support compilation for both Servlet API 2.1 and 2.2
- and to support compilation with JDK 1.1.
- </action>
- </release>
-
- <release version="0.3" date="November 8 2000">
- <action dev="VMA" type="add">
- Added the <code>ServletTestRequest.setAutomaticSession(boolean
createAutomatically)</code>
- method to enable/disable the automatic creation of an HTTP Session in the
- servlet redirector.
- </action>
- <action dev="VMA" type="update">
- Do not generate javadoc for the private and protected methods.
- </action>
- <action dev="VMA" type="add">
- Added handling of <code>setUp()</code> and <code>tearDown()</code> methods.
- </action>
- <action dev="VMA" type="add">
- Added a <code>ServletTestCase.currentTestMethod</code> public field which
- is the name of the current test method being executed. This name is valid
- both on the client side and on the server side, meaning you can call it
- from a <code>testXXX()</code>, <code>setUp()</code> or <code>tearDown()</code>
- method, as well as from <code>beginXXX()</code> and <code>endXXX()</code>
- methods.
- </action>
- <action dev="VMA" type="update">
- Added some javadoc comments
- </action>
- <action dev="VMA" type="update">
- Modify <code>ServletTestRequest</code> to handle parameters that have
- several values: changed
- API from <code>String getParameterValue()</code> to <code>String[]
getParameterValues()</code>
- and added the <code>String getParameter()</code> method which returns the
- first value for the given parameter name.
- </action>
- </release>
-
- <release version="0.2" date="November 6 2000">
- <action dev="VMA" type="add">
- Added some javadoc comments.
- </action>
- <action dev="VMA" type="add">
- Added version tag in java source files.
- </action>
- <action dev="VMA" type="add">
- Added a <code>conf/j2eeunit.properties</code> file to configure the URL
- under which the servlet redirector is matched.
</action>
</release>
1.4 +2 -2
jakarta-commons-sandbox/cactus/docs/framework/xdocs/contributors.xml
Index: contributors.xml
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/contributors.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- contributors.xml 2001/04/04 10:01:01 1.3
+++ contributors.xml 2001/04/07 07:16:55 1.4
@@ -28,8 +28,8 @@
<tr>
<td>
<link href="mailto:[EMAIL PROTECTED]">Lyonel Thouvenot</link><br/>
- Cactus web site design and graphisms (prior to using Jakarta's
- Stylebook).
+ Cactus logo (and web site design and graphisms when Cactus was not
+ using Stylebook).
</td>
</tr>
</table>
1.2 +2 -0 jakarta-commons-sandbox/cactus/docs/framework/xdocs/doc-book.xml
Index: doc-book.xml
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/doc-book.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- doc-book.xml 2001/03/31 20:22:38 1.1
+++ doc-book.xml 2001/04/07 07:16:55 1.2
@@ -10,6 +10,8 @@
<page id="downloads" label="Downloads" source="downloads.xml"/>
<separator/>
<page id="installation" label="Installation" source="installation.xml"/>
+ <page id="installation_ant" label="Installing Ant" source="installation_ant.xml"/>
+ <page id="installation_sample" label="Installing Sample"
source="installation_sample.xml"/>
<page id="configuration" label="Configuration" source="configuration.xml"/>
<page id="using" label="Using" source="using.xml"/>
<page id="sample_servlet" label="Servlet Sample" source="sample_servlet.xml"/>
1.2 +35 -53
jakarta-commons-sandbox/cactus/docs/framework/xdocs/installation.xml
Index: installation.xml
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- installation.xml 2001/03/31 20:22:38 1.1
+++ installation.xml 2001/04/07 07:16:55 1.2
@@ -12,6 +12,35 @@
<body>
+ <s1 title="Forewords">
+
+ <p>
+ You have 2 options for installing Cactus :
+ </p>
+ <ul>
+ <li>
+ Integrate Cactus in your existing developement environment and build
+ process. This is what I call the "manual" installation because you'll
+ have to understand how Cactus works,
+ </li>
+ <li>
+ Use the Cactus Sample as a starting point. The Cactus Sample
+ application is more than just an example of how to use Cactus. It is
+ a <em>methodology</em> for using Cactus. This methodology is described
+ in the <link href="ant.html">Ant integration</link> and
+ in the <link href="servlets.html">Servlet engine integration</link>
+ tutorials. The Cactus Sample is the implementation of this
+ methodology.
+ </li>
+ </ul>
+ <p>
+ The steps below will explain how to "manually" install Cactus in your
+ developement environment. For explanations on how to install the Cactus
+ Sample, go <link href="installation_sample.html">here</link>.
+ </p>
+
+ </s1>
+
<s1 title="System Requirements">
<p>
In order to use Cactus for unit-testing you need to have the following
@@ -33,69 +62,22 @@
<link href="features.html">features list</link>).
</li>
<li>
- <strong>Ant</strong>
- Ant 1.3 or greater need to be installed only for building Cactus and
- for automating Cactus unit tests.
+ <strong>Ant (optional)</strong>
+ Ant is needed only if you wish to either run the Cactus Sample
+ application or if you wish to use Ant as your build system for
+ running and automating your unit tests. See the
+ <link href="installation_ant.html">Ant installation</link> tutorial.
</li>
</ul>
</s1>
- <s1 title="Libraries Dependencies">
- <p>
- You may need to download several of the external libraries mentionned
- below to perform so tasks for running Cactus tests or for building
- Cactus :
- </p>
-
- <ul>
- <li>
- <strong>JUnit</strong>
- The <link href="http://junit.org">JUnit</link> framework is needed
- both for building Cactus and for running Cactus tests.
- </li>
- <li>
- <strong>Servlet API 2.2 and/or 2.3</strong>
- You'll need the <code>javax.servlet.*</code> packages in order to
- build Cactus only. You can download either the
- <link href="http://java.sun.com/products/servlet/download.html">Sun
- API</link> or the Jakarta reference implementation for
- <link href="http://jakarta.apache.org/builds/jakarta-servletapi/">
- Servlet API 2.2</link> and/or
- <link href="http://jakarta.apache.org/builds/jakarta-servletapi-4/">
- Servlet API 2.3</link>. This is not needed for running
- Cactus tests as these APIs are already provided by your servlet
- engine.
- </li>
- <li>
- <strong>Stylebook version b3 for Xalan 2.0, Xalan 2.0, Xerces 1.3</strong>
- This is needed for building the Cactus documentation from the
- sources. Stylebook is downloadable from CVS, Xalan from
- <link href="http://xml.apache.org/xalan-j/">here</link> and
- Xerces from <link href="http://xml.apache.org/xerces-j">here</link>.
- Note that you'll also need to use a
- <link href="http://java.sun.com/xml/download.html">JAXP 1.1
- implementation (crimson.jar)</link> as the XML parser
- for Ant (it should replace <code>parser.jar</code> for Ant 1.3 and
- before. Ant 1.4 is already JAXP 1.1 ready). JAXP 1.1 is needed for
- Xalan 2.0
- </li>
- </ul>
-
- <note>
- In order to simply the gathering of these jars, I have packaged them in
- a zip file, that you can find in the
- <link href="downloads.html">download</link> section :)
- </note>
-
- </s1>
-
<s1 title="Installing Cactus">
<p>
The steps below show how to set up an environment for executing
servlet unit tests. However, look at the
- <link href="downloads.html">Cactus sample sources</link> for
+ <link href="downloads.html">Cactus Sample sources</link> for
an already set up environment that uses Ant to automate the running of
unit tests.
</p>
1.2 +2 -1
jakarta-commons-sandbox/cactus/docs/framework/xdocs/sample_servlet.xml
Index: sample_servlet.xml
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/sample_servlet.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sample_servlet.xml 2001/03/31 20:22:38 1.1
+++ sample_servlet.xml 2001/04/07 07:16:55 1.2
@@ -50,7 +50,8 @@
public class SimpleServlet extends HttpServlet
{
- public void doGet(HttpServletRequest theRequest, HttpServletResponse
theResponse) throws IOException
+ public void doGet(HttpServletRequest theRequest, HttpServletResponse
theResponse)
+ throws IOException
{
PrintWriter pw = theResponse.getWriter();
1.2 +40 -25
jakarta-commons-sandbox/cactus/docs/framework/xdocs/site-book.xml
Index: site-book.xml
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/site-book.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- site-book.xml 2001/03/31 20:22:38 1.1
+++ site-book.xml 2001/04/07 07:16:55 1.2
@@ -1,27 +1,42 @@
<?xml version="1.0"?>
-<book software="Cactus" title="Cactus documentation" copyright="@year@ Apache
Software Foundation">
- <page id="index" label="News" source="news.xml"/>
- <page id="features" label="Features" source="features.xml"/>
- <changes id="changes" label="Changes" source="changes.xml"/>
- <todo id="todo" label="Todo" source="todo.xml"/>
- <page id="contributors" label="Contributors" source="contributors.xml"/>
-<separator/>
- <page id="downloads" label="Downloads" source="downloads.xml"/>
-<separator/>
- <page id="installation" label="Installation" source="installation.xml"/>
- <page id="configuration" label="Configuration" source="configuration.xml"/>
- <page id="using" label="Using" source="using.xml"/>
- <page id="sample_servlet" label="Servlet Sample" source="sample_servlet.xml"/>
- <faqs id="faq" label="FAQ" source="faq.xml"/>
-<separator/>
- <page id="architecture" label="Architecture" source="architecture.xml"/>
-<separator/>
- <page id="ant" label="Ant integration" source="ant.xml"/>
- <page id="servlets" label="Servlet Engines" source="servlets.xml"/>
-<separator/>
- <page id="javadoc" label="API Reference" source="javadoc.xml"/>
-<separator/>
- <page id="support" label="Support" source="support.xml"/>
- <external label="Statistics"
href="http://sourceforge.net/project/stats/?group_id=14156"/>
-</book>
+<book software="Cactus"
+ title="Cactus Documentation"
+ copyright="@year@ The Apache Software Foundation">
+
+ <menu label="About">
+ <menu-item label="News" source="index.xml"/>
+ <menu-item label="Features" source="features.xml"/>
+ <menu-item label="Changes" source="changes.xml" type="changes"/>
+ <menu-item label="Todo" source="todo.xml" type="todo"/>
+ <menu-item label="Contributors" source="contributors.xml"/>
+ </menu>
+
+ <menu label="Downloads">
+ <menu-item label="Downloads" source="downloads.xml"/>
+ </menu>
+
+ <menu label="User Guides">
+ <menu-item label="Installation" source="installation.xml"/>
+ <menu-item label="Installing Ant" source="installation_ant.xml"/>
+ <menu-item label="Installing Sample" source="installation_sample.xml"/>
+ <menu-item label="Configuration" source="configuration.xml"/>
+ <menu-item label="Using" source="using.xml"/>
+ <menu-item label="Servlet Sample" source="sample_servlet.xml"/>
+ </menu>
+
+ <menu label="Developer's Corner">
+ <menu-item label="Architecture" source="architecture.xml"/>
+ <menu-item label="Ant integration" source="ant.xml"/>
+ <menu-item label="Servlet Engines" source="servlets.xml"/>
+ <menu-item label="API Reference" source="javadoc.xml"/>
+ </menu>
+
+ <menu label="Support">
+ <menu-item label="CVS" href="http://jakarta.apache.org/site/cvsindex.html"
type="external"/>
+ <menu-item label="Bug database" href="http://jakarta.apache.org/site/bugs.html"
type="external"/>
+ <menu-item label="Mailing lists"
href="http://jakarta.apache.org/site/mail.html" type="external"/>
+ <menu-item label="FAQ"
href="http://jakarta.apache.org:8080/jyve-faq/Turbine/screen/DisplayTopics/action/SetAll/project_id/2/faq_id/39"
type="external"/>
+ </menu>
+
+</book>
\ No newline at end of file
1.3 +37 -2 jakarta-commons-sandbox/cactus/docs/framework/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/cactus/docs/framework/xdocs/todo.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- todo.xml 2001/04/04 09:39:32 1.2
+++ todo.xml 2001/04/07 07:16:56 1.3
@@ -11,9 +11,44 @@
</devs>
<actions priority="high">
+ <action context="admin">
+ Move the Cactus FAQ to Jyve.
+ </action>
+ <action context="admin">
+ Package an Ant installation as a zip and put it in the download area
+ </action>
<action context="docs">
- Change the web site skin to be the Jakarta skin and not the Apache XML
- skin. This is because Cactus is part of the Jakarta Commons project.
+ Modify the downloads web page not to include the file names to download.
+ Instead provide a link that list the entries in the release/nightly build
+ directories. Only describe the files. Add an entry for the packaged Ant
+ distribution.
+ </action>
+ <action context="admin">
+ Copy the 1.0 distributable files to the release area on the web site.
+ </action>
+ <action context="admin">
+ Set up GUMP to use Cactus instead of J2EEUnit.
+ </action>
+ <action context="admin">
+ Move Cactus from the Sandbox to the Commons.
+ </action>
+ <action context="admin">
+ Put the Cactus web site on the live Jakarta-Commons web site.
+ </action>
+ <action context="docs">
+ Write a short announcement about Cactus to be put on the Jakarta news
+ page.
+ </action>
+ <action context="admin">
+ Modify J2EEUnit pages on SourceForge to announce the new location and
+ new name and redirect all links to Jakarta Cactus.
+ </action>
+ <action context="admin">
+ Post Cactus announcement on mailing lists : junit on egroups, xp on
+ egroups, apache general (?)
+ </action>
+ <action context="admin">
+ Ask Eric Maede to change the link to J2EEUnit on the JUnit web site.
</action>
</actions>
1.1 jakarta-commons-sandbox/cactus/docs/framework/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Cactus</title>
<subtitle>Server-Side Unit Testing Framework</subtitle>
<authors>
<person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Project description">
<p>
Cactus is a simple test framework for unit testing server-side java
code. It is based on <link href="http://junit.org">JUnit</link>.
It's primary goal is to be able to unit test server side java methods
which use Servlet objects such as <code>HttpServletRequest</code>,
<code>HttpServletResponse</code>, <code>HttpSession</code>, ... (see
the full <link href="features.html">feature list</link>). This
framework is <em>not</em> a functional test framework which views your
server classes as a black box and only tests the returned results
from externally calling your application (see
<link href="http://sourceforge.net/projects/httpunit">HttpUnit</link>
for this). Both frameworks are complementary.
</p>
</s1>
<s1 title="Latest news">
<table>
<tr>
<td>
07/04/2001
</td>
<td>
Cactus 1.0 is available for
<link href="downloads.html">download</link>. Check the updated
<link href="features.html">feature list</link> and the
<link href="changes.html">changes</link> for the details.
</td>
</tr>
<tr>
<td>
07/04/2001
</td>
<td>
The web site has been updated to reflect the modifications that
occurred during the donation to Apache and the change of name :
the license has changed to APL, the packages have moved from
<code>j2eeunit.*</code> to <code>org.apache.commons.cactus.*</code>
</td>
</tr>
<tr>
<td>
07/04/2001
</td>
<td>
J2EEUnit has been renamed to Cactus.
</td>
</tr>
<tr>
<td>
07/04/2001
</td>
<td>
J2EEUnit has been donated to the Apache Software Foundation.
</td>
</tr>
</table>
</s1>
</body>
</document>
1.1
jakarta-commons-sandbox/cactus/docs/framework/xdocs/installation_ant.xml
Index: installation_ant.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Installing Ant</title>
<authors>
<person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Forewords">
<p>
Ant is a Java based build tool. It is used to build the Cactus
framework itself and the Cactus Sample application.
</p>
</s1>
<s1 title="Ant tasks needed by Cactus">
<p>
Cactus uses the following optional tasks of Ant :
</p>
<ul>
<li>
<strong><code><stylebook></code></strong> to build the Cactus
web site and Cactus
documentation. The Stylebook version required by the Cactus build is
the Stylebook 1.0b3 for Xalan2 (named
<code>stylebook-1.0-b3_xalan-2.jar</code>) which needs the Xalan 2.0
jar and the Xerces 1.3 jar. The Ant stylebook task It is not used by
the Cactus Sample application build process.
</li>
<li>
<strong><code><junit></code></strong> to run the unit tests of
Cactus itself and the Cactus unit tests in the Sample application.
</li>
<li>
The Cactus Sample application uses a custom task provided by Cactus
in the <code>cactus-ant-<version>.jar</code> jar file (the task
is called <strong><code><runservertests></code></strong>).
</li>
</ul>
</s1>
<s1 title="Installing Ant on Windows systems">
<p>
Ant is an application that needs to be installed somewhere on your
hard drive.
</p>
<p>
Follow the steps below to install Ant :
</p>
<ol>
<li>
Download Jakarta Ant
(<code>jakarta-ant-<version>-bin.zip</code>) from
<link href="http://jakarta.apache.org/ant/index.html">here</link>. I
recommend version 1.3 or above. Alternatively you can download a
prepackaged Ant version (containing required optional tasks and jars)
from <link href="TODO">here</link>,
</li>
<li>
Unzip it in a directory. Let's call this directory
<code>antroot</code>,
</li>
<li>
Create an environment variable named <code>ANT_HOME</code> that points
to your <code>antroot</code> directory,
</li>
<li>
Modify the <code>PATH</code> environment variable to include the
<code>%ANT_HOME%\bin</code> directory (so that you'll be able to type
<code>ant</code> in a DOS shell, in whatever directory and it will
call the <code>%ANT_HOME%\bin\ant.bat</code> script,
</li>
<li>
Download the Ant optional task jar
(<code>jakarta-ant-<version>-optional.jar</code>) from
<link href="http://jakarta.apache.org/ant/index.html">here</link>
and put it in <code>%ANT_HOME%\lib</code>,
</li>
<li>
If you haven't downloaded the prepackaged Ant zip, you'll need to
download the Stylebook 1.0b3 for Xalan 2 jar (from ?), the latest
<link href="http://xml.apache.org/xalan-j/">Xalan</link>, the latest
<link href="http://xml.apache.org/xerces-j">Xerces</link> and the
latest <link href="http://junit.org">JUnit</link> jars. You'll also
need to ensure that you use a JAXP 1.1 parser (Ant 1.3 comes with
a JAXP 1.0 parser only, called <code>parser.jar</code>. Ant 1.4
already bundles a JAXP 1.1 parser, called <code>crimson.jar</code>).
You can download one (crimson) from
<link href="http://java.sun.com/xml/download.html">here</link>. Put
all these jars in <code>%ANT_HOME%\lib</code>.
</li>
</ol>
<note>
You should ensure that the Ant optional jar that you download contains
the <stylebook> and <junit> tasks. Alternatively you can
download the prepackaged Ant zip as mentionned above.
</note>
</s1>
</body>
</document>
1.1
jakarta-commons-sandbox/cactus/docs/framework/xdocs/installation_sample.xml
Index: installation_sample.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Installing the Cactus Sample</title>
<authors>
<person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Prerequisites">
<p>
You need to install the following prior to building the Cactus Sample
application :
</p>
<ul>
<li>
A JVM (1.2 or above),
</li>
<li>
A Servlet Engine (Servlet API 2.2 or above). The Cactus Sample
Ant build script supports automatic running the Cactus unit tests on
the following Servle Engines (however, it is easy to support others)
<ul>
<li>
Tomcat 3.2
</li>
<li>
Tomcat 4.0
</li>
<li>
WebLogic 5.1
</li>
<li>
Orion Server 1.4
</li>
<li>
Resin 1.2
</li>
<li>
Resin 1.3
</li>
</ul>
</li>
<li>
Ant (see the <link href="installation_ant.html">"Installing Ant"</link>
tutorial).
</li>
<li>
Servlet API corresponding to the Cactus Sample release you have
downloaded (for Servlet API 2.2 or 2.3). Download the API :
<ul>
<li>
For Servlet API 2.2
<ul>
<li>
From
<link href="http://java.sun.com/products/servlet/download.html">
Sun</link> or from the
<link href="http://jakarta.apache.org/builds/jakarta-servletapi/">
Jakarta reference implementation</link>
</li>
</ul>
</li>
<li>
For Servlet API 2.3
<ul>
<li>
From
<link href="http://java.sun.com/products/servlet/download.html">
Sun</link> or from the
<link
href="http://jakarta.apache.org/builds/jakarta-servletapi-4/">
Jakarta reference implementation</link>
</li>
</ul>
</li>
</ul>
You can put these libraries whereever you want on your hard disk.
You'll just have to specify the location where they are in the
<code>build.properties</code> file, as described below.
</li>
</ul>
</s1>
<s1 title="Installing the Cactus Sample">
<p>
Follow these steps :
</p>
<ul>
<li>
Download the <link href="downloads.html">Cactus Sample</link> and
unzip it in a directory. Let's call this directory
<em><code>sampleroot</code></em>.
</li>
<li>
Rename (or copy) the
<em><code>sampleroot</code></em>
<code>/build/build.properties.sample</code> file
to <code>build.properties</code>. This file defines the dependencies
between the Cactus Sample build process and your environment
(location of external jars, home directory for installed servlet
engine(s), ...). Edit this file to reflect your environment values.
</li>
<li>
In your shell, cd to the <em><code>sampleroot</code></em>
<code>/build</code> directory and type '<code>ant usage</code>' to
get the list of callable targets.
</li>
</ul>
</s1>
</body>
</document>
