2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

Cactus Settings

Property Optional? Description
cactus.home.[container name] At least one container

Home directory of where you have installed the container on which you wish to run the Cactus tests. Valid container names are: tomcat4x, tomcat5x, resin2x, resin3x, orion1x, orion2x, jboss3x and weblogic7x.

cactus.src.dir Yes

Location of the Cactus test cases. Default value is src/test-cactus.

cactus.port Yes

Port on which to start the containers. Default value is 8080.

cactus.test.includes Yes

Lists of test classes that will be executed. Default value is **/*Test*.class.

cactus.test.excludes Yes

Lists of test classes that will not be excluded. Default value is **/All*Test*.class,**/Test*All.class.

cactus.junit.usefile Yes

Decides whether the test result will be printed to the console or not. Default value is false, meaning errors will be displayed on the console.

cactus.reports.dir Yes

Location of junit test reports for the Cactus tests. Default value is ${cactus.target.dir}/test-cactus-reports.

cactus.halt.on.error Yes

Decides whether to stop the build on test errors. Default value is true.

cactus.halt.on.failure Yes

Decides whether to stop the build on test failures Default value is true.

cactus.src.mergewebxml Yes

Location of a test-specific web.xml file that will be merged with the application web.xml, during the War cactification. Note that by default the cactification already adds the Cactus redirector definitions.Decides whether to stop the build on test failures. Example: cactus.src.mergewebxml = ${basedir}/src/conf/cactus-web.xml.

cactus.printsummary Yes

How summary information on test should be printed to the console. This property has the same meaning as the printsummary attribute of the JUnit Ant task. Default value is cactus.printsummary = withOutAndErr.

cactus.tmp.dir Yes

Location where Cactus will put its temporary files (mostly where it setups containers for execution). Default value is [java.io.tmpdir]/[containername].

cactus.execute.during.report Yes

Should Cactus tests be run whenever cactus:report is called (e.g. when the web site is generated). Default value is true.

cactus.j2ee.version Yes

J2EE version for the generated appxml descriptor (needed only when testing EJBs with Cactus). Defaults to 1.3.

cactus.src.war Yes

Location of war to cactify. Defaults to ${maven.build.dir}/${pom.artifactId}.war.

cactus.src.ejb Yes

Location of the EJB to test (for the test-ear goal only). Defaults to ${maven.build.dir}/${pom.artifactId}-${pom.currentVersion}.jar.

cactus.war Yes

Location where to generate the cactified WAR. Note that this is also the name of the test context that will be used (except if the context is specified by other means such as in application.xml if the WAR is packaged in an EAR, etc). Defaults to ${maven.build.dir}/${pom.artifactId}-cactus.war.

cactus.ear Yes

Location where to generate the cactified EAR. Defaults to ${maven.build.dir}/${pom.artifactId}-cactus.ear.

cactus.build.goal.war Yes

Goal that Cactus should call for generating the war artifact. Default to war:war.

cactus.build.goal.ejb Yes

Goal that Cactus should call for generating the ejb artifact. Default to ejb:ejb.

cactus.logging.config.client Yes

Location of client logging properties file to debug Cactus tests. For example cactus.logging.config.client = ${basedir}/logging_client.properties.

cactus.logging.config.server Yes

Location of server logging properties file to debug Cactus tests. For example cactus.logging.config.server = ${basedir}/logging_server.properties.

cactus.is.ear Yes

If this is true then the cactus:test target will execute cactus:test-ear. Default value is false.

cactus.test.skip Yes

If set to true, goal cactus:test will skip tests (it does not affects other goals though, like cactus:test-war and cactus:test-ear). Default value is ${maven.test.skip}.

cactus.sysproperties Yes Use this property elements to specify system properties required by the test class. These properties will be made available to the Cactus client side and server side JVMs during the execution of the test. You can specify several system properties by listing their names, separating them with spaces. Each property value is defined as a separate Maven property. For example:
cactus.sysproperties=prop1 basedir
prop1=your value
basedir=${basedir}

            
cactus.servlet.version Yes

Servlet version for the generated Cactus War file. Particularly useful when the project does not provide a web descriptor ( web.xml) - in this situation, the generated file will be an empty descriptor for the Servlet API version defined by this property. Default value is 2.3 and currently only 2.2 and 2.3 are supported.

Cactus Path Settings

Path Id Optional? Description
cactus.compile.src.set No

Ant path containing the Java classes used by the cactus:compile goal. This path is created by the cactus:init goal ant initially populated with only one path element (${cactus.src.dir} - if a project requires multiple source directories, it could create a preGoal which would add more elements in the path. by a

Cactus/Generic Container Settings

Property Optional? Description
cactus.genericContainer.jvmArgs Yes

Arguments to be passed to a container's JVM (for instance, -Xms256m -Xmx800m). Each container has an equivalent property, which by default points to this one.

Cactus/JBoss 3.x Settings

Property Optional? Description
cactus.jboss3x.config.name Yes

Name of the JBoss server configuration to use. Default value is default.

cactus.jboss3x.tmp.dir Yes

Default tmp directory where the JBoss server configuration for Cactus will be created. Default value is ${cactus.home.jboss3x}/server/cactus.

cactus.jboss3x.config.dir Yes

Location of a custom user-specified server configuration which will be copied to cactus.jboss3x.tmp.dir if specified. By default this property is not set.

cactus.jboss3x.jndiport Yes

Name of the JNDI port on which JBoss is started. This is only used to shutdown JBoss. Defaults to 1099.

cactus.jboss3x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Resin 2.x Settings

Property Optional? Description
cactus.resin2x.config Yes

Location of the Resin 2.x configuration file if you don't want to use the cactus-provided one.

cactus.resin2x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Resin 3.x Settings

Property Optional? Description
cactus.resin3x.config Yes

Location of the Resin 3.x configuration file if you don't want to use the cactus-provided one.

cactus.resin3x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Orion 1.x Settings

Property Optional? Description
cactus.orion1x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Orion 2.x Settings

Property Optional? Description
cactus.orion2x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Tomcat 4.x Settings

Property Optional? Description
cactus.tomcat4x.config Yes

Location of the Tomcat 4.x configuration file if you don't want to use the cactus-provided one.

cactus.tomcat4x.conf.dir Yes

Location of custom Tomcat 4.x configuration file that will be copied, overwriting the Cactus-provided configuration files.

cactus.tomcat4x.conf.includes Yes

Configuration files located at ${cactus.tomcat4x.conf.dir that should be included in the Tomcat 4.x container set up by Cactus.

cactus.tomcat4x.conf.excludes Yes

Configuration files located at ${cactus.tomcat4x.conf.dir that should not be included in the Tomcat 4.x container set up by Cactus.

cactus.tomcat4x.tmpdir Yes

Directory to which the container will be installed for the tests. By default the system temporary directory is used.

cactus.tomcat4x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/Tomcat 5.x Settings

Property Optional? Description
cactus.tomcat5x.config Yes

Location of the Tomcat 5.x configuration file if you don't want to use the cactus-provided one.

cactus.tomcat5x.conf.dir Yes

Location of custom Tomcat 5.x configuration file that will be copied, overwriting the Cactus-provided configuration files.

cactus.tomcat5x.conf.includes Yes

Configuration files located at ${cactus.tomcat5x.conf.dir that should be included in the Tomcat 5.x container set up by Cactus.

cactus.tomcat5x.conf.excludes Yes

Configuration files located at ${cactus.tomcat5x.conf.dir that should not be included in the Tomcat 5.x container set up by Cactus.

cactus.tomcat5x.tmpdir Yes

Directory to which the container will be installed for the tests. By default the system temporary directory is used.

cactus.tomcat5x.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.

Cactus/WebLogic 7.x Settings

Property Optional? Description
cactus.weblogic7x.beahome Yes

Location of BEA HOME. If not specified it defaults to the parent directory of cactus.home.weblogic7x.

cactus.weblogic7x.config Yes

Location of the WebLogic 7.x configuration file if you don't want to use the cactus-provided one.

cactus.resources.dirs Yes Comma-separated list of resources labels to be used to include resources in the classpath (WEB-INF/classes) of the generated Cactus Web Application. The mechanism to include/exclude files use these labels to define other properties: cactus.resources.[label].dir, cactus.resources.[label].includes and cactus.resources.[label].excludes.
cactus.resources.[label].dir Yes Directory whose resources will be included in the war classpath. The [label] stands for the label name in the cactus.resources.dirs list.
cactus.resources.[label].includes Yes Comma-separated list of Which files in the directory defined by cactus.resources.[label].dir should be included in the Cactus war. Default value is **/*, which means all files are included.
cactus.resources.[label].excludes Yes Comma-separated list of which files in the directory defined by cactus.resources.[label].dir should be included in the Cactus war. Default value is none, which means no files are excluded.
cactus.weblogic.jvmArgs Yes

Arguments to be passed to the container's JVM. Defaults to ${cactus.genericContainer.jvmArgs}.