shitty:test

Full name:

org.codehaus.mojo:shitty-maven-plugin:1.0-alpha-3:test

Description:

Invoke child Maven builds to perform super helpful integration testing.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 1.0-alpha-1.
  • Binds by default to the lifecycle phase: integration-test.

Required Parameters

Name Type Since Description
buildLogFile String 1.0-alpha-1 The name of the build log to capture output to. Default value is: build.log.
goalsFile String 1.0-alpha-1 The name of the project-specific file that contains the list of goals to execute for that test. Multiple goals may be given on a single line, or spread over multiple lines in the file. Default value is: goals.txt.

Optional Parameters

Name Type Since Description
color boolean 1.0-alpha-1 Enable or disable use of ANSI colors. By default this value is auto-detected.
debug boolean 1.0-alpha-1 Enable child debug flags (ie. mvn -X ... ). Default value is: false.
flags String 1.0-alpha-1 Additional flags to pass to the mvn executable. Multiple flags are separated by white-space. To use a flag which contains white-space see flagsFile .
flagsFile String 1.0-alpha-1 The name of the project-specific file that contains the list of additional flags to pass to the mvn executable. Some flags (or rather flag arguments) might have spaces, so there is one flag (or flag argument) per-line in the file. Default value is: flags.txt.
ignoreFailures boolean 1.0-alpha-1 Ignore test build failures. Normally if failures are detected the build will be stopped. Setting this to true will cause the build to report success. Default value is: false.
offline boolean 1.0-alpha-1 If true then test builds are run offline. By default picks up the offline settings from the current environment. Default value is: ${settings.offline}.
parallel boolean 1.0-alpha-1 Set to true to run test builds in parallel. Default value is: false.
parallelTimeOut int 1.0-alpha-1 The number of seconds to wait for all parallel test build executions to complete. Default value is: 600.
projects FileSet[] 1.0-alpha-1 The set of test builds (pom.xml files) to execute. Defaults to all pom.xml files under src/it .
propertiesFile String 1.0-alpha-1 The name of the project-specific file that contains the execution (system) properties to be defined for the test. Default value is: test.properties.
setupScriptFilename String 1.0-alpha-1 The filename of the setup script. If this file exists as a peer to the test build pom, then it will be executed before the test build is executed. Default value is: setup.groovy.
skip boolean 1.0-alpha-1 Skip test build execution. Default value is: false.
tests String 1.0-alpha-1 Provides custom selection of projects to be executed.
threadCount int 1.0-alpha-1 The number of threads in the pool to use when test build execution is run in parallel. Default is the number of available processors + 1.
validateScriptFilename String 1.0-alpha-1 The filename of the validate script. If this file exists as a peer to the test build pom, then it will be executed after the test build is executed. Default value is: validate.groovy.
verbose boolean 1.0-alpha-1 When true displays extra details about the test build execution, and reports full logs for failed test builds. Default value is: false.
workingDirectory File 1.0-alpha-1 Directory where integration test projects files are copied to before execution. Default value is: ${project.build.directory}/shitty.

Parameter Details

buildLogFile :

The name of the build log to capture output to.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: Yes
  • Default: build.log

color :

Enable or disable use of ANSI colors. By default this value is auto-detected.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${color}

debug :

Enable child debug flags (ie. mvn -X ... ).

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${debug}
  • Default: false

flags :

Additional flags to pass to the mvn executable. Multiple flags are separated by white-space. To use a flag which contains white-space see flagsFile .

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${flags}

flagsFile :

The name of the project-specific file that contains the list of additional flags to pass to the mvn executable. Some flags (or rather flag arguments) might have spaces, so there is one flag (or flag argument) per-line in the file.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Default: flags.txt

goalsFile :

The name of the project-specific file that contains the list of goals to execute for that test. Multiple goals may be given on a single line, or spread over multiple lines in the file.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: Yes
  • Default: goals.txt

ignoreFailures :

Ignore test build failures. Normally if failures are detected the build will be stopped. Setting this to true will cause the build to report success.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${maven.test.failure.ignore}
  • Default: false

offline :

If true then test builds are run offline. By default picks up the offline settings from the current environment.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${offline}
  • Default: ${settings.offline}

parallel :

Set to true to run test builds in parallel.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${parallel}
  • Default: false

parallelTimeOut :

The number of seconds to wait for all parallel test build executions to complete.

  • Type: int
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${parallelTimeOut}
  • Default: 600

projects :

The set of test builds (pom.xml files) to execute. Defaults to all pom.xml files under src/it .

  • Type: org.apache.maven.shared.model.fileset.FileSet[]
  • Since: 1.0-alpha-1
  • Required: No

propertiesFile :

The name of the project-specific file that contains the execution (system) properties to be defined for the test.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Default: test.properties

setupScriptFilename :

The filename of the setup script. If this file exists as a peer to the test build pom, then it will be executed before the test build is executed.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Default: setup.groovy

skip :

Skip test build execution.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${maven.test.skip}
  • Default: false

tests :

Provides custom selection of projects to be executed.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${tests}

threadCount :

The number of threads in the pool to use when test build execution is run in parallel. Default is the number of available processors + 1.

  • Type: int
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${threadCount}

validateScriptFilename :

The filename of the validate script. If this file exists as a peer to the test build pom, then it will be executed after the test build is executed.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Default: validate.groovy

verbose :

When true displays extra details about the test build execution, and reports full logs for failed test builds.

  • Type: boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${verbose}
  • Default: false

workingDirectory :

Directory where integration test projects files are copied to before execution.

  • Type: java.io.File
  • Since: 1.0-alpha-1
  • Required: No
  • Default: ${project.build.directory}/shitty