org.apache.maven.plugin.failsafe

Class VerifyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.failsafe.VerifyMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, SurefireReportParameters

@Mojo(name="verify",
      defaultPhase=VERIFY,
      requiresProject=true,
      threadSafe=true)
public class VerifyMojo
extends org.apache.maven.plugin.AbstractMojo
implements SurefireReportParameters

Verify integration tests ran using Surefire.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	basedir The base directory of the project being tested.
private java.util.Collection<CommandLineOption>	cli
private java.lang.String	encoding The character encoding scheme to be applied.
private java.lang.Boolean	failIfNoTests Set this to "true" to cause a failure if there are no tests to run.
private java.io.File	reportsDirectory Base directory where all reports are written to.
private org.apache.maven.execution.MavenSession	session The current build session instance.
private boolean	skip Set this to 'true' to bypass unit tests entirely.
private boolean	skipExec Deprecated. Use -DskipTests instead.
private boolean	skipITs Set this to 'true' to skip running integration tests, but still compile them.
private boolean	skipTests Set this to 'true' to skip running tests, but still compile them.
private java.io.File	summaryFile The summary file to read integration test results from.
private java.io.File[]	summaryFiles Additional summary files to read integration test results from.
private java.io.File	testClassesDirectory The directory containing generated test classes of the project being tested.
private boolean	testFailureIgnore Set this to true to ignore a failure during testing.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
VerifyMojo()

Method Summary

Modifier and Type	Method and Description
private java.util.Collection<CommandLineOption>	commandLineOptions()
void	execute()
private boolean	existsSummary()
private boolean	existsSummaryFile()
private boolean	existsSummaryFiles()
java.io.File	getBasedir()
protected java.lang.String[]	getDefaultIncludes()
java.lang.Boolean	getFailIfNoTests()
protected java.lang.String	getPluginName()
java.io.File	getReportsDirectory()
java.io.File	getTestClassesDirectory()
boolean	isSkip()
boolean	isSkipExec() Deprecated.
boolean	isSkipITs()
boolean	isSkipTests()
boolean	isTestFailureIgnore()
private void	logDebugOrCliShowErrors(java.lang.CharSequence s)
private RunResult	readSummary(java.lang.String encoding, java.io.File summaryFile)
void	setBasedir(java.io.File basedir)
void	setFailIfNoTests(boolean failIfNoTests)
void	setReportsDirectory(java.io.File reportsDirectory)
void	setSkip(boolean skip)
void	setSkipExec(boolean skipExec) Deprecated.
void	setSkipITs(boolean skipITs)
void	setSkipTests(boolean skipTests)
void	setTestClassesDirectory(java.io.File testClassesDirectory)
void	setTestFailureIgnore(boolean testFailureIgnore)
protected boolean	verifyParameters()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

skipTests

@Parameter(property="skipTests")
private boolean skipTests

Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.

Since:

2.4

skipITs

@Parameter(property="skipITs")
private boolean skipITs

Set this to 'true' to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.

Since:

2.4.3-alpha-2

skipExec

@Parameter(property="maven.test.skip.exec")
private boolean skipExec

Deprecated. Use -DskipTests instead.

This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec.

Since:

2.3

skip

@Parameter(property="maven.test.skip",
           defaultValue="false")
private boolean 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.

testFailureIgnore

@Parameter(property="maven.test.failure.ignore",
           defaultValue="false")
private boolean testFailureIgnore

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

basedir

@Parameter(defaultValue="${basedir}")
private java.io.File basedir

The base directory of the project being tested. This can be obtained in your unit test by System.getProperty("basedir").

testClassesDirectory

@Parameter(defaultValue="${project.build.testOutputDirectory}")
private java.io.File testClassesDirectory

The directory containing generated test classes of the project being tested. This will be included at the beginning the test classpath.

reportsDirectory

@Parameter(defaultValue="${project.build.directory}/failsafe-reports")
private java.io.File reportsDirectory

Base directory where all reports are written to.

summaryFile

@Parameter(defaultValue="${project.build.directory}/failsafe-reports/failsafe-summary.xml",
           required=true)
private java.io.File summaryFile

The summary file to read integration test results from.

summaryFiles

@Parameter
private java.io.File[] summaryFiles

Additional summary files to read integration test results from.

Since:

2.6

failIfNoTests

@Parameter(property="failIfNoTests")
private java.lang.Boolean failIfNoTests

Set this to "true" to cause a failure if there are no tests to run.

Since:

2.4

encoding

@Parameter(property="encoding",
           defaultValue="${project.reporting.outputEncoding}")
private java.lang.String encoding

The character encoding scheme to be applied.

session

@Component
private org.apache.maven.execution.MavenSession session

The current build session instance.

cli

private java.util.Collection<CommandLineOption> cli

Constructor Detail

VerifyMojo

public VerifyMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

readSummary

private RunResult readSummary(java.lang.String encoding,
                              java.io.File summaryFile)
                       throws java.io.IOException

Throws:

java.io.IOException

verifyParameters

protected boolean verifyParameters()
                            throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getPluginName

protected java.lang.String getPluginName()

getDefaultIncludes

protected java.lang.String[] getDefaultIncludes()

isSkipTests

public boolean isSkipTests()

Specified by:

isSkipTests in interface SurefireReportParameters

setSkipTests

public void setSkipTests(boolean skipTests)

Specified by:

setSkipTests in interface SurefireReportParameters

isSkipITs

public boolean isSkipITs()

setSkipITs

public void setSkipITs(boolean skipITs)

isSkipExec

@Deprecated
public boolean isSkipExec()

Deprecated.

Specified by:

isSkipExec in interface SurefireReportParameters

setSkipExec

@Deprecated
public void setSkipExec(boolean skipExec)

Deprecated.

Specified by:

setSkipExec in interface SurefireReportParameters

isSkip

public boolean isSkip()

Specified by:

isSkip in interface SurefireReportParameters

setSkip

public void setSkip(boolean skip)

Specified by:

setSkip in interface SurefireReportParameters

isTestFailureIgnore

public boolean isTestFailureIgnore()

Specified by:

isTestFailureIgnore in interface SurefireReportParameters

setTestFailureIgnore

public void setTestFailureIgnore(boolean testFailureIgnore)

Specified by:

setTestFailureIgnore in interface SurefireReportParameters

getBasedir

public java.io.File getBasedir()

Specified by:

getBasedir in interface SurefireReportParameters

setBasedir

public void setBasedir(java.io.File basedir)

Specified by:

setBasedir in interface SurefireReportParameters

getTestClassesDirectory

public java.io.File getTestClassesDirectory()

Specified by:

getTestClassesDirectory in interface SurefireReportParameters

setTestClassesDirectory

public void setTestClassesDirectory(java.io.File testClassesDirectory)

Specified by:

setTestClassesDirectory in interface SurefireReportParameters

getReportsDirectory

public java.io.File getReportsDirectory()

Specified by:

getReportsDirectory in interface SurefireReportParameters

setReportsDirectory

public void setReportsDirectory(java.io.File reportsDirectory)

Specified by:

setReportsDirectory in interface SurefireReportParameters

getFailIfNoTests

public java.lang.Boolean getFailIfNoTests()

Specified by:

getFailIfNoTests in interface SurefireReportParameters

setFailIfNoTests

public void setFailIfNoTests(boolean failIfNoTests)

Specified by:

setFailIfNoTests in interface SurefireReportParameters

existsSummaryFile

private boolean existsSummaryFile()

existsSummaryFiles

private boolean existsSummaryFiles()

existsSummary

private boolean existsSummary()

commandLineOptions

private java.util.Collection<CommandLineOption> commandLineOptions()

logDebugOrCliShowErrors

private void logDebugOrCliShowErrors(java.lang.CharSequence s)