Author: marrs
Date: Tue Apr 17 07:56:28 2012
New Revision: 1326976
URL: http://svn.apache.org/viewvc?rev=1326976&view=rev
Log:
Added a document that describes how to use the test script.
Added:
ace/site/trunk/content/dev-doc/design/test-script.mdtext
Modified:
ace/site/trunk/content/dev-doc/design/index.mdtext
Modified: ace/site/trunk/content/dev-doc/design/index.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/design/index.mdtext?rev=1326976&r1=1326975&r2=1326976&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/design/index.mdtext (original)
+++ ace/site/trunk/content/dev-doc/design/index.mdtext Tue Apr 17 07:56:28 2012
@@ -1,3 +1,4 @@
Title: Design
-* [Remote Interfaces](remote-interfaces.html)
\ No newline at end of file
+* [Remote Interfaces](remote-interfaces.html)
+* [Test Script](test-script.html)
Added: ace/site/trunk/content/dev-doc/design/test-script.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/design/test-script.mdtext?rev=1326976&view=auto
==============================================================================
--- ace/site/trunk/content/dev-doc/design/test-script.mdtext (added)
+++ ace/site/trunk/content/dev-doc/design/test-script.mdtext Tue Apr 17
07:56:28 2012
@@ -0,0 +1,23 @@
+Title: Test Script
+
+Besides all our automated tests, sometimes it is useful to run some tests by
hand to get a feel for the performance of Apache ACE and tweak it for specific
scenarios. To aid in setting up and running such tests, an Ant script was made
that allows you to:
+
+1. Configure it to create a runnable server, a collection of targets or both.
+2. Run every configured node.
+3. Cleanup afterwards.
+
+Typical use cases include running a set of targets and a server on the same
box, or having two or more boxes and distributing server and (groups of)
targets over both. The script, which is located in the `ace-test` project
folder, assumes you have a full checkout of ACE and that you have actually
already built the code (`mvn -DskipTests=true clean install` or something
similar). It also assumes you have a recent version of Ant on your machine.
+
+Before using the script, there are several variables that you can configure
that influence its behaviour:
+
+* with-server - when defined, will run an ACE server;
+* with-targets - when defined, will run a number of targets;
+* targets - a comma separated list of target names ("target-" will be used as
prefix for all of them);
+* server-host - the discovery URL for the server to use with the targets
+* version - the ACE version to use (should match whatever version of the code
you checked out).
+
+To run:
+
+1. `ant unzip` will unzip all required code into folders under the current
directory;
+2. `ant run` will run all nodes (and at least on Linux and Mac OS X stop them
again when you hit Ctrl-C);
+3. `ant rm` will delete all folders and files created in steps 1 and 2.
