dunit.impl

Class DUnitConfigAntTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

dunit.impl.DUnitConfigAntTask

All Implemented Interfaces:

Cloneable

public class DUnitConfigAntTask
extends org.apache.tools.ant.Task

This class is an Ant task that creates a Hydra conf file for running Distributed Unit Tests. To use this task in a build file, you must set up a taskdef such as:

 <taskdef name="dunitconfig" 
    classname="dunit.impl.DUnitConfigAntTask"
    classpath="${gemfire.home}/lib/tests.jar" />
 

DUnitConfig

Description

Generates a Hydra config file for running Distributed Unit Tests.

The location of the generated file is specified with the file attribute. The tests classes are specified with the nested tests parameter (a FileSet).

Parameters

Attribute	Description	Required
confFile	Specifies the name of the Hydra configuration file to be generated.	Yes
btFile	Specifies the name of the battery test file to be generated.	Yes
tests	Specifies the test classes to be run.	Yes
dunitSites	Specifies the number of DUnit Environments to create. This is used allow parrralle dunit execution.	Yes
systemCount	Specifies the number of GemFire systems that the Distributed Unit Tests should be run with.	No
includeFile	Specifies the Hydra include file that contains the GemFire system configuration for the distributed unit tests.	No
logLevel	Specifies the log level of the distribution managers started by the DUnit test.	No
verbose	Should the distribution managers log information about the messages that are sent/received (true or false)? See DistributionManager#VERBOSE	No
extraLocatorClasspath	Specifies extra files that should be on the hydra Locator's class path. See VmPrms.extraClassPaths. This is a path-like structure and may be nested.	No
extraControllerClasspath	Specifies extra files that should be on the hydra Controller's class path. See VmPrms.extraClassPaths. This is a path-like structure and may be nested.	No
extraClientClasspath	Specifies extra files that should be on the hydra clients' class path. See VmPrms.extraClassPaths. This is a path-like structure and may be nested.	No
param	Specifies an additional hydra parameter to be included in the generated .conf files. See BasePrms.	No
jprobeClient	Nested element that specified how JProbe should be run on client VMs. See JProbePrms.	No
debugJavaGroups	Should the distribution managers log copious debug information about Jgroups (true or false)? See DistributionManager#VERBOSE.	No

Examples

 <dunitconfig confFile="dunit.conf" btFile="dunit.bt" 
                 systemCount="2">
   <extraClientClasspath>
      <fileset dir="${other.jars}" includes="*.jar"/>
   </extraClientClasspath>
   <param name="mytest.TestPrms-maxCount" value="1000"/>
   <jprobeClient/>
   <tests dir="${tests.src.dir}">
     <include name="com/tests/distributed/**"/>
   </tests>
 </dunitconfig>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DUnitConfigAntTask.JProbe Represents a JProbe configuration.
static class	DUnitConfigAntTask.Param Holds the name and value of a hydra param to be added to the generated .conf file.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
DUnitConfigAntTask()

Method Summary

Modifier and Type	Method and Description
org.apache.tools.ant.types.Path	createExtraClientClasspath() Creates a nested extraClientClasspath path
org.apache.tools.ant.types.Path	createExtraControllerClasspath() Creates a nested extraControllerClasspath path
org.apache.tools.ant.types.Path	createExtraLocatorClasspath() Creates a nested extraLocatorClasspath path
DUnitConfigAntTask.JProbe	createJprobeclient() Returns the JProbe for the GemFire Client VM
DUnitConfigAntTask.Param	createParam() Creates a nested param
org.apache.tools.ant.types.FileSet	createTests() Sets the test classes for which to generate config information
void	execute() Executes this task.
int	getDunitSites() Gets the number of dunitSites that will be created.
void	setBtfile(File btFile) Sets the file that will contain the a battery test configuration (.bt)
void	setConffile(File configFile) Sets the file that will contain the Hydra configuration (.conf)
void	setDebugjavagroups(String debug)
void	setDunitSites(int sites) Sets the number of dunitSites to create, this is passed into the conf
void	setExtraVMArgs(String arg)
void	setIncludefile(String includeFileName) Sets the name of the Hydra include file that contains the GemFire system configurations.
void	setLoglevel(String logLevel)
void	setSystemcount(int count) Sets the number of GemFire systems to configure for.
void	setUseIPv6(String useIt)
void	setVerbose(String verbose)

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DUnitConfigAntTask

public DUnitConfigAntTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Executes this task. Creates the Hydra config file for DUnit and populates with test classes to run.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

setBtfile

public void setBtfile(File btFile)

Sets the file that will contain the a battery test configuration (.bt)

setConffile

public void setConffile(File configFile)

Sets the file that will contain the Hydra configuration (.conf)

getDunitSites

public int getDunitSites()

Gets the number of dunitSites that will be created.

Returns:

an integer value indicating the number of dunit sites that will be created to run the DUnit test suite in parallel.

See Also:

setDunitSites(int)

setDunitSites

public void setDunitSites(int sites)

Sets the number of dunitSites to create, this is passed into the conf

setSystemcount

public void setSystemcount(int count)

Sets the number of GemFire systems to configure for. This number must agree with the configuration specified in the include file.

setIncludefile

public void setIncludefile(String includeFileName)

Sets the name of the Hydra include file that contains the GemFire system configurations.

setLoglevel

public void setLoglevel(String logLevel)

setVerbose

public void setVerbose(String verbose)

setExtraVMArgs

public void setExtraVMArgs(String arg)

setUseIPv6

public void setUseIPv6(String useIt)

setDebugjavagroups

public void setDebugjavagroups(String debug)

createExtraClientClasspath

public org.apache.tools.ant.types.Path createExtraClientClasspath()

Creates a nested extraClientClasspath path

createExtraControllerClasspath

public org.apache.tools.ant.types.Path createExtraControllerClasspath()

Creates a nested extraControllerClasspath path

createExtraLocatorClasspath

public org.apache.tools.ant.types.Path createExtraLocatorClasspath()

Creates a nested extraLocatorClasspath path

createJprobeclient

public DUnitConfigAntTask.JProbe createJprobeclient()

Returns the JProbe for the GemFire Client VM

createParam

public DUnitConfigAntTask.Param createParam()

Creates a nested param

createTests

public org.apache.tools.ant.types.FileSet createTests()

Sets the test classes for which to generate config information