Author: wsmoak
Date: Sat Sep 2 13:06:46 2006
New Revision: 439645
URL: http://svn.apache.org/viewvc?rev=439645&view=rev
Log:
SB-43 Add documentation for the Selenium tests.
Added:
struts/sandbox/trunk/tiles/src/site/apt/
struts/sandbox/trunk/tiles/src/site/apt/selenium.apt (with props)
Modified:
struts/sandbox/trunk/tiles/src/site/site.xml
Added: struts/sandbox/trunk/tiles/src/site/apt/selenium.apt
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/src/site/apt/selenium.apt?rev=439645&view=auto
==============================================================================
--- struts/sandbox/trunk/tiles/src/site/apt/selenium.apt (added)
+++ struts/sandbox/trunk/tiles/src/site/apt/selenium.apt Sat Sep 2 13:06:46
2006
@@ -0,0 +1,118 @@
+ -----------
+ Selenium Testing
+ -----------
+
+Selenium Testing
+
+ <<{{{http://selenium.openqa.org}Selenium}}>> is a test tool for web
+ applications. Unlike HtmlUnit or HttpUnit tests which <simulate> a browser,
+ Selenium tests run directly in a real browser such as Firefox or Internet
+ Explorer. The Selenium JavaScript code is deployed alongside your running
+ application, and interacts with it just as your users do.
+
+ Tiles 2 uses Selenium for functional testing of the example apps.
+ The following example apps include Selenium tests:
+
+ * Tiles Test
+
+* Install
+
+ Selenium is available in OpenQA's Maven repository, so no installation is
+ necessary.
+
+ However, you may want to download the Selenium distribution (which includes
+ the documentation) from
+ {{{http://www.openqa.org/selenium-core/download.action}
+ http://www.openqa.org/selenium-core/download.action}}.
+
+ While you're there, also install the Firefox plugin <<Selenium IDE>> from
+ {{{http://www.openqa.org/selenium-ide/}
+ http://www.openqa.org/selenium-ide/}}.
+
+* Package
+
+ <<Package>> the webapp with the 'selenium' profile activated.
+
+ The
{{{http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-test/pom.xml
+?view=markup}tiles-test pom}} includes a 'selenium' profile that will
+
+ * unpack the Selenium jar under 'target'
+
+ * copy the 'core' directory from the unpacked Selenium jar into the
+ webapp
+
+ * copy any files in 'src/test/selenium' into the webapp
+
+ []
+
++-----+
+mvn package -P selenium
++-----+
+
+ The webapp will contain the following additional directories: 'selenium/core'
+ and 'selenium/tests'.
+
+* Deploy
+
+ <<Deploy>> the webapp to your favorite container. The Cargo plugin is
+ configured to make this easy:
+
++-----+
+mvn package cargo:start -P selenium
+
+ or
+
+mvn package cargo:start -P selenium -Dcargo.tomcat5x.home=/path/to/tomcat5
++-----+
+
+
+* Run
+
+ <<Run>> the tests with the Selenium TestRunner.
+
+ * Visit <<<http://localhost:8080/<appname>/selenium/core/TestRunner.html>>>
+
+ * Click 'go' in the top left frame to load the TestSuite.html page
+
+ * Click 'All' in the top right frame to run the tests
+
+ []
+
+ <<Run>> the tests <automatically>.
+
+ * Check the 'Auto-run' box before clicking 'go' in the top left frame.
+
+ []
+
+ After it runs the tests automatically, Selenium can <<<POST>>> the results to
+ a URL you supply. If you accept the default, and nothing is there to process
+ the request, you will see a 404 Not Found error page in the bottom frame.
+
+
+* Edit
+
+ <<Edit>> an existing test, or write a new one.
+
+ If you add a new test, remember to add it to src/test/selenium/TestSuite.html
+ so the TestRunner will find it.
+
+** Selenium IDE
+
+ The Selenium IDE Firefox plugin is the easiest way to edit tests. With the
+ example app running, open the HTML file
(src/test/selenium/TestSomething.html)
+ from your svn checkout of Shale. Use the IDE to edit and run the test, and
+ save your changes.
+
+ <<Note>>: Your changes will not be visible to the TestRunner in the deployed
+ webapp unless you re-package and deploy it.
+
+** HTML Editor
+
+ Selenium tests are written in plain HTML tables, so you may edit them with
any
+ text editor.
+
+ If you prefer to edit the tests 'in place' in the running webapp, simply copy
+ the files back to your svn checkout directory and commit the changes (or
submit
+ a patch).
+
+
Propchange: struts/sandbox/trunk/tiles/src/site/apt/selenium.apt
------------------------------------------------------------------------------
svn:executable = *
Modified: struts/sandbox/trunk/tiles/src/site/site.xml
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/src/site/site.xml?rev=439645&r1=439644&r2=439645&view=diff
==============================================================================
--- struts/sandbox/trunk/tiles/src/site/site.xml (original)
+++ struts/sandbox/trunk/tiles/src/site/site.xml Sat Sep 2 13:06:46 2006
@@ -38,7 +38,9 @@
<item
name="DTD Doc"
href="/tiles-core/dtddoc/index.html"/>
-
+ <item
+ name="Selenium Testing"
+ href="/selenium.html"/>
</menu>
<menu name="Quick Links">
<item
