Revision: 774
http://jwebunit.svn.sourceforge.net/jwebunit/?rev=774&view=rev
Author: jevonwright
Date: 2008-11-30 23:17:46 +0000 (Sun, 30 Nov 2008)
Log Message:
-----------
expanding and clearing up documentation for 2.1 release
Modified Paths:
--------------
trunk/src/site/site.xml
trunk/src/site/xdoc/articles.xml
trunk/src/site/xdoc/building-maven.xml
trunk/src/site/xdoc/index.xml
Modified: trunk/src/site/site.xml
===================================================================
--- trunk/src/site/site.xml 2008-11-30 21:49:24 UTC (rev 773)
+++ trunk/src/site/site.xml 2008-11-30 23:17:46 UTC (rev 774)
@@ -59,16 +59,18 @@
<menu name="Developper documentation">
<item name="Building JWebUnit with Maven 2"
href="/building-maven.html" collapse="true">
- <item name="Installing Maven" href="#Installing Maven" />
- <item name="Using Maven" href="#Using Maven" />
- <item name="Installing not released or snapshot plugins"
- href="#Installing not released or snapshot plugins" />
- <item name="Building JWebUnit"
- href="#Building JWebUnit" />
- <item name="Building Sourceforge upload bundle"
- href="#Building Sourceforge upload bundle" />
- <item name="Building JWebUnit Web site and reports"
- href="#Building JWebUnit Web site and reports" />
+ <item name="Installing" href="#Installing_Maven" />
+ <item name="Using" href="#Using_Maven" />
+ <item name="Building"
+ href="#Building_JWebUnit" />
+ <item name="Testing"
+ href="#Testing_JWebUnit" />
+ <item name="Using Eclipse"
+ href="#Using_Eclipse" />
+ <item name="Sourceforge upload bundle"
+ href="#Building_Sourceforge_upload_bundle" />
+ <item name="JWebUnit Web site and reports"
+ href="#Building_JWebUnit_Web_site_and_reports" />
</item>
<item name="How-To contribute"
Modified: trunk/src/site/xdoc/articles.xml
===================================================================
--- trunk/src/site/xdoc/articles.xml 2008-11-30 21:49:24 UTC (rev 773)
+++ trunk/src/site/xdoc/articles.xml 2008-11-30 23:17:46 UTC (rev 774)
@@ -6,9 +6,14 @@
</properties>
<body class="default">
<section name="Articles about JWebUnit">
- <p>Some articles from Johannes Brodwall</p>
- <a
href="http://www.brodwall.com/johannes/blog/2006/12/10/in-process-web-integration-tests-with-jetty-and-jwebunit/";>http://www.brodwall.com/johannes/blog/2006/12/10/in-process-web-integration-tests-with-jetty-and-jwebunit/</a>
- <a
href="http://www.brodwall.com/johannes/blog/2007/01/20/article-ready-for-edit-embedded-web-integration-testing-with-jetty/";>http://www.brodwall.com/johannes/blog/2007/01/20/article-ready-for-edit-embedded-web-integration-testing-with-jetty/</a>
+ <p>Some articles from Johannes Brodwall:
+
+ <ul>
+ <li><a
href="http://www.brodwall.com/johannes/blog/2006/12/10/in-process-web-integration-tests-with-jetty-and-jwebunit/";>In-process
Web Integration Tests with Jetty and JWebUnit</a></li>
+ <li><a
href="http://www.brodwall.com/johannes/blog/2007/01/20/article-ready-for-edit-embedded-web-integration-testing-with-jetty/";>Embedded
Web Integration Testing with Jetty</a></li>
+ </ul>
+
+ </p>
</section>
</body>
</document>
\ No newline at end of file
Modified: trunk/src/site/xdoc/building-maven.xml
===================================================================
--- trunk/src/site/xdoc/building-maven.xml 2008-11-30 21:49:24 UTC (rev
773)
+++ trunk/src/site/xdoc/building-maven.xml 2008-11-30 23:17:46 UTC (rev
774)
@@ -77,9 +77,36 @@
</p>
<p>
You now have successfully built JWebUnit. The files
- are in your private repository.
+ are in your private repository. To remove all traces of
+ generated files, allowing your repository to install from
+ scratch, use:
+ <source>mvn clean</source>
</p>
</subsection>
+ <subsection name="Testing JWebUnit">
+ <p>
+ JWebUnit is supported with a suite of test cases, which
+ ensure that the testing framework works as expected.
+ These tests are run through Maven by running:
+ <source>mvn test</source>
+ </p>
+ </subsection>
+ <subsection name="Using Eclipse">
+ <p>
+ If you are using the <a
href="http://www.eclipse.org";>Eclipse IDE</a>
+ to develop the JWebUnit plugin,
+ you can use Maven to create the classpath and .project
files
+ of each module:
+ <source>mvn eclipse:eclipse</source>
+ (This command will also download the attached source
files of the
+ dependencies.)
+ </p>
+ <p>
+ You can then import these modules into your Eclipse
workspace once
+ you configure the path to your Maven repository:
+ <source>M2_REPO=your_home/.m2/repository</source>
+ </p>
+ </subsection>
<subsection name="Building Sourceforge upload bundle">
<p>
For those who don't want to use Maven, we have to
@@ -99,6 +126,13 @@
If you want to test the final assembled site, just hit:</p>
<source>mvn site:stage -DstagingDirectory=C:\fullsite</source>
<p>You can of course customize the destination folder of the
assembled site.</p>
+
+ <p>If it is taking a long time to build the dependencies
report of each plugin,
+ you can disable it by adding the following parameter (<a
href="http://www.nabble.com/Skipping-dependency-report-during-Maven2-site-generation-td20116761.html";>reference</a>):
+ <source>-Ddependency.locations.enabled=false</source>
+ This will disable the generation of dependency locations in
the report and may
+ reduce site generation time significantly.
+ </p>
</subsection>
</section>
</body>
Modified: trunk/src/site/xdoc/index.xml
===================================================================
--- trunk/src/site/xdoc/index.xml 2008-11-30 21:49:24 UTC (rev 773)
+++ trunk/src/site/xdoc/index.xml 2008-11-30 23:17:46 UTC (rev 774)
@@ -2,47 +2,98 @@
<document>
<properties>
<author email="dashorst.at.users.sourceforge.net">Martijn
Dashorst</author>
+ <author email="jevonwright.at.users.sourceforge.net">Jevon
Wright</author>
<title>JWebUnit</title>
</properties>
- <meta name="keyword" content="jwebunit, java, junit, htmlunit, jacobie,
httpunit, integration, test, automated, html, webtest"/>
+ <meta name="keyword" content="jwebunit, java, junit, htmlunit, selenium,
httpunit, integration, test, automated, html, webtest, web"/>
<head>
<link rel="shortcut icon" href="favicon.ico"
type="image/x-icon" />
</head>
<body>
<section name="Welcome">
<p>
- You are on the JWebUnit website. Current version is 2.0. This is
- the "stable" version of JWebUnit. This version requires Java 1.5.
+ JWebUnit is a Java-based testing framework for web applications. It
wraps existing testing
+ frameworks such as <a
href="http://htmlunit.sourceforge.net/";>HtmlUnit</a> and <a
href="http://openqa.org/selenium-rc/";>Selenium</a> with a unified, simple
testing interface to allow
+ you to quickly test the correctness of your web applications.
</p>
</section>
-<section name="Please help JWebUnit !!">
+
+<section name="What does JWebUnit provide?">
<p>
- JWebUnit is not dead but is looking for contributors. The current
maintainer will only be able to do quick fix, a bit of support on the
- mailing-list and perfom releases. If you want new functionalities feel
free to <a href="how-to-contribute.html">contribute</a>.
+ JWebUnit provides a high-level Java API for navigating a web
application combined with a set
+ of assertions to verify the application's correctness. This includes
navigation
+ via links, form entry and submission, validation of table contents,
and other
+ typical business web application features.
</p>
-</section>
-<section name="What is JWebUnit?">
+
<p>
- JWebUnit is a Java framework that facilitates creation of acceptance
tests for web applications. It
- evolved from a project where we were using <a
href="http://www.junit.org";>JUnit</a> to create acceptance tests.
- Also, we can have different testing engines. Currently, only <a
href="jwebunit-htmlunit-plugin/index.html">HtmlUnit plugin</a> is ready.
- Some work is in progress to use Selenium to execute tests.
- As the tests were being written, they were continuously refactored to
remove duplication and other bad smells in the test
- code. JWebUnit is the result of these refactorings.
+ The simple navigation methods and ready-to-use
+ assertions allow for more rapid test creation than using only <a
href="http://www.junit.org/";>JUnit</a> or <a
href="http://htmlunit.sourceforge.net/";>HtmlUnit</a>.
+ And if you want to switch from HtmlUnit to other plugins such as <a
href="http://openqa.org/selenium-rc/";>Selenium</a> (available soon), there is
no need to
+ rewrite your tests.
</p>
+
+ <p>
+ The current version of JWebUnit is 2.1. This is the "stable" version of
+ JWebUnit, and requires Java 1.5.
+ </p>
</section>
-<section name="What does JWebUnit provide?">
+
+<section name="Using JWebUnit">
+ <p>
+ To use JWebUnit you only need to <a
href="http://sourceforge.net/projects/jwebunit/files";>download the latest
release JARs</a>
+ and include them into your project classpath. You may then test
your web application
+ by extending WebTestCase, and running these test cases with
JUnit:
+
+ <source>
+public class ExampleWebTestCase extends WebTestCase {
+ public ExampleWebTestCase(String name) {
+ super(name);
+ getTestContext().setBaseUrl("http://localhost:8080/test";);
+ }
+
+ public void test1() {
+ beginAt("/home");
+ clickLink("login");
+ assertTitleEquals("Login");
+ setTextField("username", "test");
+ setTextField("password", "test123");
+ submit();
+ assertTitleEquals("Welcome, test!");
+ }
+}
+ </source>
+
+ For some more examples on how to use JWebUnit in your project,
please look at the
+ <a href="quickstart.html">quick start guide</a>.
+ <!--
+ waiting on issue 2367400:
+ and the <a href="">generated WebTestCase
documentation</a>.
+ -->
+ </p>
+</section>
+
+<section name="Contributing to JWebUnit">
<p>
- JWebUnit provides a high-level Java API for navigating a web
application combined with a set
- of assertions to verify the application's correctness. This includes
navigation
- via links, form entry and submission, validation of table contents,
and other
- typical business web application features. This code try to stay
independent of the libraries behind
- the scenes. The simple navigation methods and ready-to-use assertions
allow for
- more rapid test creation than using only JUnit and HtmlUnit. And if
you want to switch
- from HtmlUnit to the other soon available plugins, no need to rewrite
your tests (in the past, the HttpUnit to HtmlUnit migration was done
- with only minor API changes).
+ <ul>
+ <li>To get support with using JWebUnit in your project, consider
joining the <a href="mail-lists.html">JWebUnit-users mailing list</a>.</li>
+ <li>If you find a bug in JWebUnit, please let us know on <a
href="https://sourceforge.net/tracker2/?group_id=61302&atid=497982";>our bug
tracker</a> hosted on Sourceforge.</li>
+ <li>If you would like to propose a new feature or concept in the
framework, please submit it to <a
href="https://sourceforge.net/tracker2/?group_id=61302&atid=497985";>our
feature request tracker</a>.</li>
+ </ul>
</p>
- <img src="images/jwebunit-architecture.png" alt="JWebUnit architecture"/>
+
+ <p>
+ JWebUnit aims to be an active project with a vibrant community. As such
we are
+ <a href="how-to-contribute.html">looking for contributors</a>,
+ especially help in implementing other plugins such as Selenium.
+ </p>
</section>
+
+<section name="JWebUnit Architecture">
+ <p>
+ <img src="images/jwebunit-architecture.png" alt="JWebUnit
architecture"/>
+ </p>
+</section>
+
</body>
</document>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
JWebUnit-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/jwebunit-development
