GreenPepper Maven Plugin - run

greenpepper:run

Run the specification testing.

Mojo Attributes

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

Required Parameters

Name	Type	Description
fixtureOutputDirectory	File	The directory where compiled fixture classes go. Default value is ${project.build.directory}/fixture-test-classes
reportsDirectory	File	No description. Default value is ${project.build.directory}/greenpepper-reports
systemUnderDevelopment	String	The SystemUnderDevelopment class to use Default value is com.greenpepper.systemunderdevelopment.DefaultSystemUnderDevelopment

Optional Parameters

Name	Type	Description
debug	boolean	Set the Debug mode. Default value is false
excludeDefaultRunner	boolean	When launching the tests in a fork, we create a default runner. You can exclude this default runner from the testing process if you want to configure your owns. Default value is false
fork	boolean	Launch the test in the Maven process if false. Or fork a java process if true. Default value is false
forkCount	Integer	The maximum number of default runner processes that needs to be spawn;
javaOptions	String	Additionnal JAVA Options to be added to the java command in fork mode. This is only used in FORK mode and for the default runner.
jvm	String	The Java Virtual Machine path to use for the default runner in fork mode. Default value is java
locale	String	Set the locale for the execution.
redirectOutputToFile	boolean	Set this to true to output the logs only in the log file and not in the console. Default value is false
refresh	boolean	Refresh the specificaction list (updating the index file) Default value is false
repositories	List	This list of repositories.
resume	boolean	Set this property to true to launch only new specifications + failed ones. Default value is false
runners	List	The list of runners that can be associated to repositories for testing.
selectedRepository	String	Set this to a Repository name defined in the pom.xml. This option is only used in case `-Dgp.test` is used.
selector	String	Set the Selector class. Default value is com.greenpepper.document.GreenPepperInterpreterSelector
skip	boolean	Set this to 'true' to bypass greenpepper tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default value is false
specFilter	String	Sets a filter to filter the output of the specs. The filter should have a specific syntax: `"substring"` : a string to look for inside the page name. The search is case insensitive `"[RE]regular expression"` : a regular expression that will be used to match the page name Additionnally you can filter on the `implemented` status of the page by adding a `"[I]"` as a prefix to your search filter. `[I]` : Give the implemented pages only `[!I]` : Give the non implemented pages only Note: A `"[I]"` or `"[!I]"` as a search filter will filter only on the implemented status.\ Examples: `sun` : all specifications having the substring 'sun' `[RE]taurus` : the specification matching exactly 'taurus' `[I]` : all implemented specifications `[!I]` : all non implemented specifications `[!I]dummy` : all non implemented specifications having the substring 'dummy' `[I][RE]'.moon[^dab]+'` : all implemented specifications having the RE '.moon[^dab]+'
stopOnFirstFailure	boolean	Set this to 'true' to stop the execution on a failure. Default value is false
systemUnderDevelopmentArgs	String	The {@link com.greenpepper.systemunderdevelopment.SystemUnderDevelopment} constructor args. This parameter is optionnal and can be achieved by appending them to the systemUnderDevelopment parameter.
testFailureIgnore	boolean	Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default value is false
testSpecification	String	Set this to a Specification name to run only this test. The test is searched inside the default repository.
testSpecificationOutput	String	Set this to a Specification name to run only this test. The test is searched inside the default repository.

Parameter Details

debug

Set the Debug mode.

Type	boolean
Required	No
Expression	${maven.greenpepper.debug}
Default	false

excludeDefaultRunner

When launching the tests in a fork, we create a default runner. You can exclude this default runner from the
testing process if you want to configure your owns.

Type	boolean
Required	No
Expression	${maven.greenpepper.excludedefaultrunner}
Default	false

fixtureOutputDirectory

The directory where compiled fixture classes go.

Type	java.io.File
Required	Yes
Default	${project.build.directory}/fixture-test-classes

fork

Launch the test in the Maven process if false. Or fork a java process if true.

Type	boolean
Required	No
Expression	${maven.greenpepper.fork}
Default	false

forkCount

The maximum number of default runner processes that needs to be spawn;

Type	java.lang.Integer
Required	No
Expression	${maven.greenpepper.forkcount}

javaOptions

Additionnal JAVA Options to be added to the java command in fork mode.

This is only used in FORK mode and for the default runner.

Type	java.lang.String
Required	No
Expression	${maven.greenpepper.javaoptions}

jvm

The Java Virtual Machine path to use for the default runner in fork mode.

Type	java.lang.String
Required	No
Expression	${maven.greenpepper.jvm}
Default	java

locale

Set the locale for the execution.

Type	java.lang.String
Required	No
Expression	${maven.greenpepper.locale}

redirectOutputToFile

Set this to true to output the logs only in the log file and not in the console.

Type	boolean
Required	No
Expression	${maven.greenpepper.redirect.output}
Default	false

refresh

Refresh the specificaction list (updating the index file)

Type	boolean
Required	No
Expression	${greenpepper.refresh}
Default	false

reportsDirectory

No Description.

Type	java.io.File
Required	Yes
Default	${project.build.directory}/greenpepper-reports

repositories

This list of repositories.

Type	java.util.List
Required	No

resume

Set this property to true to launch only new specifications + failed ones.

Type	boolean
Required	No
Expression	${maven.greenpepper.resume}
Default	false

runners

The list of runners that can be associated to repositories for testing.

Type	java.util.List
Required	No

selectedRepository

Set this to a Repository name defined in the pom.xml.
This option is only used in case -Dgp.test is used.

Type	java.lang.String
Required	No
Expression	${gp.repo}

selector

Set the Selector class.

Type	java.lang.String
Required	No
Expression	${maven.greenpepper.selector}
Default	com.greenpepper.document.GreenPepperInterpreterSelector

skip

Set this to 'true' to bypass greenpepper tests entirely.
Its use is NOT RECOMMENDED, but quite convenient on occasion.

Type	boolean
Required	No
Expression	${maven.greenpepper.test.skip}
Default	false

specFilter

Sets a filter to filter the output of the specs. The filter should have a specific syntax:

"substring" : a string to look for inside the page name. The search is case insensitive
"[RE]regular expression" : a regular expression that will be used to match the page name

Additionnally you can filter on the implemented status of the page by adding a "[I]"
as a prefix to your search filter.

[I] : Give the implemented pages only
[!I] : Give the non implemented pages only

Note: A "[I]" or "[!I]" as a search filter will filter only on the implemented status.\
Examples:

sun : all specifications having the substring 'sun'
[RE]taurus : the specification matching exactly 'taurus'
[I] : all implemented specifications
[!I] : all non implemented specifications
[!I]dummy : all non implemented specifications having the substring 'dummy'
[I][RE]'.*moon[^dab]+' : all implemented specifications having the RE '.*moon[^dab]+'

Type	java.lang.String
Required	No
Expression	${gp.specFilter}

stopOnFirstFailure

Set this to 'true' to stop the execution on a failure.

Type	boolean
Required	No
Expression	${maven.greenpepper.test.stop}
Default	false

systemUnderDevelopment

The SystemUnderDevelopment class to use

Type	java.lang.String
Required	Yes
Default	com.greenpepper.systemunderdevelopment.DefaultSystemUnderDevelopment

systemUnderDevelopmentArgs

The {@link com.greenpepper.systemunderdevelopment.SystemUnderDevelopment} constructor args.
This parameter is optionnal and can be achieved by appending them to the systemUnderDevelopment parameter.

Type	java.lang.String
Required	No

testFailureIgnore

Set this to true to ignore a failure during testing.
Its use is NOT RECOMMENDED, but quite convenient on occasion.

Type	boolean
Required	No
Expression	${maven.greenpepper.test.failure.ignore}
Default	false

testSpecification

Set this to a Specification name to run only this test.
The test is searched inside the default repository.

Type	java.lang.String
Required	No
Expression	${gp.test}

testSpecificationOutput