googlewebtoolkit2:test

Runs special (non surefire) test phase for GWTTestCase derived tests. This is necessary because of several complications with regard to surefire and the classpath for GWTTestCase/JUnitShell. See further notes in source.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: test
  • Automatically executes within the lifecycle phase: test

Required Parameters

Name Type Description
compileTargets String[] List of GWT module names that should be compiled with the GWT compiler.
runTarget String URL that should be automatically opened by default in the GWT shell.

Optional Parameters

Name Type Description
artifactFactory ArtifactFactory No description.
blacklist String Whitelist URL pattern for GWTShell and JUnitShell
buildDir File Location on filesystem where project should be built.
compileSkip boolean Whether or not to skip GWT compilation. Default value is false.
contextXml File Source Tomcat context.xml for GWT shell - copied to /gwt/localhost/ROOT.xml (used as the context.xml for the SHELL - requires Tomcat 5.0.x format - hence no default).
debugPort int Port to listen for debugger connection on. Default value is 8000.
debugSuspend boolean Whether or not to suspend execution until a debugger connects. Default value is true.
enableAssertions boolean Whether or not to enable assertions in generated scripts (-ea). Default value is false.
extraDir File Non-deployable files directory (1.6+) Default value is ${project.build.directory}/gwtExtra.
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).
extraTestArgs String Extra JVM arguments that are passed only to the GWT-Maven generated test scripts (in addition to std extraJvmArgs).
gen File Location on filesystem where GWT will write generated content for review (-gen option to GWTCompiler).
generateGettersAndSetters boolean Whether or not to generate getter/setter methods for generated classes.
generatePropertyChangeSupport boolean Whether or not to generate PropertyChangeSupport handling for generated classes.
generatorDestinationPackage String Destination package for generated classes.
generatorRootClasses String[] Top level (root) of classes to begin generation from.
gwtHome File Location on filesystem where GWT is installed - for manual mode (existing GWT on machine - not needed for automatic mode).
gwtVersion String Set the GWT version number - used to build dependency paths, should match the "version" in the Maven repo. Default value is 1.5.3.
i18nConstantsNames String[] List of names of properties files that should be used to generate i18n Constants interfaces.
i18nConstantsWithLookup boolean Whether or not to generate i18n Constants interfaces with the added ability to look up values at runtime with a string key. Default value is false.
i18nMessagesNames String[] List of names of properties files that should be used to generate i18n Messages interfaces.
i18nOutputDir File Location on filesystem to output generated i18n Constants and Messages interfaces.
jvm String Option to specify the jvm (or path to the java executable) to use with the test cases. For the default, the jvm will be the same as JAVA_HOME.
localRepository ArtifactRepository No description.
localWorkers int Specifies the number of worker threads to use to compile (1.6+) Default value is 2.
logLevel String GWT logging level (-logLevel ERROR, WARN, INFO, TRACE, DEBUG, SPAM, or ALL). Default value is INFO.
noServer boolean Prevents the embedded GWT Tomcat server from running (even if a port is specified). Default value is false.
output File Location on filesystem where GWT will write output files (-out option to GWTCompiler).
overwriteGeneratedClasses boolean Whether or not to overwrite generated classes if they exist.
port int Runs the embedded GWT Tomcat server on the specified port. Default value is 8888.
remoteRepositories List No description.
resolver ArtifactResolver No description.
resourcesOnPath boolean Whether or not to add resources root to classpath. Default value is true.
shellServletMappingURL String Specifies the mapping URL to be used with the shell servlet. Default value is /*.
showTreeLogger boolean Toggles the graphical logger (1.6+) Default value is false.
sourcesOnPath boolean Whether or not to add compile source root to classpath. Default value is true.
style String GWT JavaScript compiler output style (-style OBF[USCATED], PRETTY, or DETAILED). Default value is OBF.
testFilter String Simple string filter for classes that should be treated as GWTTestCase type (and therefore invoked during gwtTest goal). Default value is GwtTest*.
testSkip boolean Whether or not to skip GWT testing. Default value is false.
tomcat File Specify the location on the filesystem for the generated embedded Tomcat directory.
webXml File Source web.xml deployment descriptor that is used for GWT shell and for deployment WAR to "merge" servlet entries.
webXmlServletPathAsIs boolean Specifies whether or not to add the module name as a prefix to the servlet path when merging web.xml. If you set this to false the exact path from the GWT module will be used, nothing else will be prepended. Default value is false.
whitelist String Whitelist URL pattern for GWTShell and JUnitShell
workDir File Compiler work directory (1.6+) Default value is ${project.build.directory}/gwtWork.

Parameter Details

artifactFactory

No Description.

  • Type: org.apache.maven.artifact.factory.ArtifactFactory
  • Required: No

blacklist

Whitelist URL pattern for GWTShell and JUnitShell

  • Type: java.lang.String
  • Required: No

buildDir

Location on filesystem where project should be built.

  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}

compileSkip

Whether or not to skip GWT compilation.

  • Type: boolean
  • Required: No
  • Expression: ${google.webtoolkit.compileSkip}
  • Default: false

compileTargets

List of GWT module names that should be compiled with the GWT compiler.

  • Type: java.lang.String[]
  • Required: Yes

contextXml

Source Tomcat context.xml for GWT shell - copied to /gwt/localhost/ROOT.xml (used as the context.xml for the SHELL - requires Tomcat 5.0.x format - hence no default).

  • Type: java.io.File
  • Required: No

debugPort

Port to listen for debugger connection on.

  • Type: int
  • Required: No
  • Default: 8000

debugSuspend

Whether or not to suspend execution until a debugger connects.

  • Type: boolean
  • Required: No
  • Default: true

enableAssertions

Whether or not to enable assertions in generated scripts (-ea).

  • Type: boolean
  • Required: No
  • Default: false

extraDir

Non-deployable files directory (1.6+)

  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/gwtExtra

extraJvmArgs

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

  • Type: java.lang.String
  • Required: No
  • Expression: ${google.webtoolkit.extrajvmargs}

extraTestArgs

Extra JVM arguments that are passed only to the GWT-Maven generated test scripts (in addition to std extraJvmArgs).

  • Type: java.lang.String
  • Required: No

gen

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

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

generateGettersAndSetters

Whether or not to generate getter/setter methods for generated classes.

  • Type: boolean
  • Required: No

generatePropertyChangeSupport

Whether or not to generate PropertyChangeSupport handling for generated classes.

  • Type: boolean
  • Required: No

generatorDestinationPackage

Destination package for generated classes.

  • Type: java.lang.String
  • Required: No

generatorRootClasses

Top level (root) of classes to begin generation from.

  • Type: java.lang.String[]
  • Required: No

gwtHome

Location on filesystem where GWT is installed - for manual mode (existing GWT on machine - not needed for automatic mode).

  • Type: java.io.File
  • Required: No
  • Expression: ${google.webtoolkit.home}

gwtVersion

Set the GWT version number - used to build dependency paths, should match the "version" in the Maven repo.

  • Type: java.lang.String
  • Required: No
  • Default: 1.5.3

i18nConstantsNames

List of names of properties files that should be used to generate i18n Constants interfaces.

  • Type: java.lang.String[]
  • Required: No

i18nConstantsWithLookup

Whether or not to generate i18n Constants interfaces with the added ability to look up values at runtime with a string key.

  • Type: boolean
  • Required: No
  • Default: false

i18nMessagesNames

List of names of properties files that should be used to generate i18n Messages interfaces.

  • Type: java.lang.String[]
  • Required: No

i18nOutputDir

Location on filesystem to output generated i18n Constants and Messages interfaces.

  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/java/

jvm

Option to specify the jvm (or path to the java executable) to use with the test cases. For the default, the jvm will be the same as JAVA_HOME.

  • Type: java.lang.String
  • Required: No
  • Expression: ${google.webtoolkit.jvm}

localRepository

No Description.

  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

localWorkers

Specifies the number of worker threads to use to compile (1.6+)

  • Type: int
  • Required: No
  • Default: 2

logLevel

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

  • Type: java.lang.String
  • Required: No
  • Default: INFO

noServer

Prevents the embedded GWT Tomcat server from running (even if a port is specified).

  • Type: boolean
  • Required: No
  • Default: false

output

Location on filesystem where GWT will write output files (-out option to GWTCompiler).

  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/${project.build.finalName}

overwriteGeneratedClasses

Whether or not to overwrite generated classes if they exist.

  • Type: boolean
  • Required: No

port

Runs the embedded GWT Tomcat server on the specified port.

  • Type: int
  • Required: No
  • Default: 8888

remoteRepositories

No Description.

  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

resolver

No Description.

  • Type: org.apache.maven.artifact.resolver.ArtifactResolver
  • Required: No

resourcesOnPath

Whether or not to add resources root to classpath.

  • Type: boolean
  • Required: No
  • Default: true

runTarget

URL that should be automatically opened by default in the GWT shell.

  • Type: java.lang.String
  • Required: Yes

shellServletMappingURL

Specifies the mapping URL to be used with the shell servlet.

  • Type: java.lang.String
  • Required: No
  • Default: /*

showTreeLogger

Toggles the graphical logger (1.6+)

  • Type: boolean
  • Required: No
  • Default: false

sourcesOnPath

Whether or not to add compile source root to classpath.

  • Type: boolean
  • Required: No
  • Default: true

style

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

  • Type: java.lang.String
  • Required: No
  • Default: OBF

testFilter

Simple string filter for classes that should be treated as GWTTestCase type (and therefore invoked during gwtTest goal).

  • Type: java.lang.String
  • Required: No
  • Default: GwtTest*

testSkip

Whether or not to skip GWT testing.

  • Type: boolean
  • Required: No
  • Expression: ${google.webtoolkit.testSkip}
  • Default: false

tomcat

Specify the location on the filesystem for the generated embedded Tomcat directory.

  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/tomcat

webXml

Source web.xml deployment descriptor that is used for GWT shell and for deployment WAR to "merge" servlet entries.

  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/webapp/WEB-INF/web.xml

webXmlServletPathAsIs

Specifies whether or not to add the module name as a prefix to the servlet path when merging web.xml. If you set this to false the exact path from the GWT module will be used, nothing else will be prepended.

  • Type: boolean
  • Required: No
  • Default: false

whitelist

Whitelist URL pattern for GWTShell and JUnitShell

  • Type: java.lang.String
  • Required: No

workDir

Compiler work directory (1.6+)

  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/gwtWork