An ant task to run ScalaTest. Instructions on how to specify various options are below. See the scaladocs for the Runner class for a description of what each of the options does.

To use the ScalaTest ant task, you must first define it in your ant file using taskdef. Here's an example:

  <path id="scalatest.classpath">
    <pathelement location="${lib}/scalatest.jar"/>
    <pathelement location="${lib}/scala-library.jar"/>
  </path>

  <target name="main" depends="dist">
    <taskdef name="scalatest" classname="org.scalatest.tools.ScalaTestAntTask">
      <classpath refid="scalatest.classpath"/>
    </taskdef>

    <scalatest ...
  </target>
 

Once defined, you use the task by specifying information in a scalatest element:

   <scalatest ...>
     ...
   </scalatest>
 

You can place key value pairs into the configMap using nested <config> elements, like this:

   <scalatest>
     <config name="dbname" value="testdb"/>
     <config name="server" value="192.168.1.188"/>
 

You can specify a runpath using either a runpath attribute and/or nested <runpath> elements, using standard ant path notation:

   <scalatest runpath="serviceuitest-1.1beta4.jar:myjini">
 

   <scalatest>
     <runpath>
       <pathelement location="serviceuitest-1.1beta4.jar"/>
       <pathelement location="myjini"/>
     </runpath>
 

To add a URL to your runpath, use a <runpathurl> element (since ant paths don't support URLs):

   <scalatest>
     <runpathurl url="http://foo.com/bar.jar"/>
 

You can specify reporters using nested <reporter> elements, where the type attribute must be one of the following:

• graphic
• file
• junitxml
• stdout
• stderr
• reporterclass

Each may include a config attribute to specify the reporter configuration. Types file, junitxml and reporterclass require additional attributes filename, directory, and classname, respectively:

   <scalatest>
     <reporter type="stdout"        config="FAB"/>
     <reporter type="file"          filename="test.out"/>
     <reporter type="junitxml"      directory="target"/>
     <reporter type="reporterclass" classname="my.ReporterClass"/>
 

Specify tags to include and/or exclude using <tagsToInclude> and <tagsToExclude> elements, like this:

   <scalatest>
     <tagsToInclude>
         CheckinTests
         FunctionalTests
     </tagsToInclude>

     <tagsToExclude>
         SlowTests
         NetworkTests
     </tagsToExclude>
 

To specify suites to run, use either a suite attribute or nested <suite> elements:

   <scalatest suite="com.artima.serviceuitest.ServiceUITestkit">
 

or

   <scalatest>
     <suite classname="com.artima.serviceuitest.ServiceUITestkit"/>
 

To specify suites using members-only or wildcard package names, use either the membersonly or wildcard attributes, or nested <membersonly> or <wildcard> elements:

   <scalatest membersonly="com.artima.serviceuitest">
 

or

   <scalatest wildcard="com.artima.joker">
 

or

   <scalatest>
     <membersonly package="com.artima.serviceuitest"/>
     <wildcard package="com.artima.joker"/>
 

Use attribute parallel="true" to specify parallel execution of suites. (If the parallel attribute is left out or set to false, suites will be executed sequentially by one thread.) When parallel is true, you can include an optional numthreads attribute to specify the number of threads to be created in thread pool (e.g., numthreads="10").

Use attribute haltonfailure="true" to cause ant to fail the build if there's a test failure.

Use attribute fork="true" to cause ant to run the tests in a separate process.

When fork is true, attribute maxmemory may be used to specify the maximum memory size that will be passed to the forked jvm.  For example, the following setting will cause "-Xmx1280M" to be passed to the java command used to run the tests.

   <scalatest maxmemory="1280M">
 

When fork is true, attribute dir may be used to specify the directory to be used by the forked jvm. 

When fork is true, nested <jvmarg> elements may be used to pass additional arguments to the forked jvm. For example, if you are running into 'PermGen space' memory errors, you could add the following jvmarg to bump up the JVM's MaxPermSize value:

   <jvmarg value="-XX:MaxPermSize=128m"/>