gwt:test

Full name:

org.codehaus.mojo:gwt-maven-plugin:1.1:test

Description:

Mimic surefire to run GWTTestCases during integration-test phase, until SUREFIRE-508 is fixed

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: integration-test.

Required Parameters

Name Type Since Description
generateDirectory File - Folder where generated-source will be created (automatically added to compile classpath). Default value is: ${project.build.directory}/generated-sources/gwt.

Optional Parameters

Name Type Since Description
excludes String - Comma separated list of ant-style exclusion patterns for GWT integration tests
extraArgs String - Deprecated. use extraJvmArgs
extraJvmArgs String - Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.

Default value is: -Xmx512m.
gen File - Location on filesystem where GWT will write generated content for review (-gen option to GWTCompiler).

Can be set from command line using '-Dgwt.gen=...'

Default value is: ${project.build.directory}/.generated.
gwtHome File - Location on filesystem where GWT is installed - for manual mode (existing GWT on machine). Setting this parameter will disable gwtVersion.
gwtVersion String - GWT version used to build dependency paths, should match the "version" in the Maven repo. If not set, will be autodetected from project com.google.gwt:gwt-user dependency
includes String - Comma separated list of ant-style inclusion patterns for GWT integration tests. For example, can be set to **\/*GwtTest.java to match all test class following this naming convention. Surefire plugin may then ne configured to exclude such tests.

It is recommended to use a TestSuite to run GwtTests, as they require some huge setup and are very slow. Running inside a suite allow to execute the setup only once. The default value is defined with this best practice in mind.

Default value is: **/GwtTest*.java,**/Gwt*Suite.java.
inplace boolean - Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war plugin. Default value is: false.
jvm String 1.1 Option to specify the jvm (or path to the java executable) to use with the forking scripts. For the default, the jvm will be the same as the one used to run Maven.
logLevel String - GWT logging level (-logLevel ERROR, WARN, INFO, TRACE, DEBUG, SPAM, or ALL).

Can be set from command line using '-Dgwt.logLevel=...'

Default value is: INFO.
module String - A single GWT module. Shortcut for <modules> or option to specify a single module from command line
modules String[] - The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
out String - output directory for code generated by GWT for tests Default value is: target/www-test.
reportsDirectory File - Directory for test reports, defaults to surefire one to match the surefire-report plugin Default value is: ${project.build.directory}/surefire-reports.
skip boolean - Set this to 'true' to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
skipExec boolean - DEPRECATED This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec. Use -DskipTests instead; it's shorter.
skipTests boolean - Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
style String - GWT JavaScript compiler output style (-style OBF[USCATED], PRETTY, or DETAILED).

Can be set from command line using '-Dgwt.style=...'

Default value is: OBF.
testTimeOut int - Time out (in seconds) for test execution in dedicated JVM Default value is: 60.
timeOut int - Forked process execution timeOut. Usefull to avoid maven to hang in continuous integration server.
warSourceDirectory File - Location of the web application static resources (same as maven-war-plugin parameter) Default value is: ${basedir}/src/main/webapp.
webappDirectory File - Location on filesystem where GWT will write output files (-out option to GWTCompiler). Default value is: ${project.build.directory}/${project.build.finalName}.

Parameter Details

excludes:

Comma separated list of ant-style exclusion patterns for GWT integration tests
  • Type: java.lang.String
  • Required: No

extraArgs:

Deprecated. use extraJvmArgs
For backward compatibility with googlecode gwt-maven, support the command line argument '-Dgoogle.webtoolkit.extrajvmargs=...'.
  • Type: java.lang.String
  • Required: No
  • Expression: ${google.webtoolkit.extrajvmargs}

extraJvmArgs:

Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.

  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.extraJvmArgs}
  • Default: -Xmx512m

gen:

Location on filesystem where GWT will write generated content for review (-gen option to GWTCompiler).

Can be set from command line using '-Dgwt.gen=...'

  • Type: java.io.File
  • Required: No
  • Expression: ${gwt.gen}
  • Default: ${project.build.directory}/.generated

generateDirectory:

Folder where generated-source will be created (automatically added to compile classpath).
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/gwt

gwtHome:

Location on filesystem where GWT is installed - for manual mode (existing GWT on machine). Setting this parameter will disable gwtVersion.
  • Type: java.io.File
  • Required: No
  • Expression: ${google.webtoolkit.home}

gwtVersion:

GWT version used to build dependency paths, should match the "version" in the Maven repo. If not set, will be autodetected from project com.google.gwt:gwt-user dependency
  • Type: java.lang.String
  • Required: No

includes:

Comma separated list of ant-style inclusion patterns for GWT integration tests. For example, can be set to **\/*GwtTest.java to match all test class following this naming convention. Surefire plugin may then ne configured to exclude such tests.

It is recommended to use a TestSuite to run GwtTests, as they require some huge setup and are very slow. Running inside a suite allow to execute the setup only once. The default value is defined with this best practice in mind.

  • Type: java.lang.String
  • Required: No
  • Default: **/GwtTest*.java,**/Gwt*Suite.java

inplace:

Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war plugin.
  • Type: boolean
  • Required: No
  • Expression: ${gwt.inplace}
  • Default: false

jvm:

Option to specify the jvm (or path to the java executable) to use with the forking scripts. For the default, the jvm will be the same as the one used to run Maven.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${gwt.jvm}

logLevel:

GWT logging level (-logLevel ERROR, WARN, INFO, TRACE, DEBUG, SPAM, or ALL).

Can be set from command line using '-Dgwt.logLevel=...'

  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.logLevel}
  • Default: INFO

module:

A single GWT module. Shortcut for <modules> or option to specify a single module from command line
  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.module}

modules:

The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
  • Type: java.lang.String[]
  • Required: No

out:

output directory for code generated by GWT for tests
  • Type: java.lang.String
  • Required: No
  • Default: target/www-test

reportsDirectory:

Directory for test reports, defaults to surefire one to match the surefire-report plugin
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/surefire-reports

skip:

Set this to 'true' to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
  • Type: boolean
  • Required: No
  • Expression: ${maven.test.skip}

skipExec:

DEPRECATED This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec. Use -DskipTests instead; it's shorter.
  • Type: boolean
  • Required: No
  • Expression: ${maven.test.skip.exec}

skipTests:

Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Required: No
  • Expression: ${skipTests}

style:

GWT JavaScript compiler output style (-style OBF[USCATED], PRETTY, or DETAILED).

Can be set from command line using '-Dgwt.style=...'

  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.style}
  • Default: OBF

testTimeOut:

Time out (in seconds) for test execution in dedicated JVM
  • Type: int
  • Required: No
  • Default: 60

timeOut:

Forked process execution timeOut. Usefull to avoid maven to hang in continuous integration server.
  • Type: int
  • Required: No

warSourceDirectory:

Location of the web application static resources (same as maven-war-plugin parameter)
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/webapp

webappDirectory:

Location on filesystem where GWT will write output files (-out option to GWTCompiler).
  • Type: java.io.File
  • Required: No
  • Expression: ${gwt.war}
  • Default: ${project.build.directory}/${project.build.finalName}