cxx:coverage

Full name:

org.codehaus.mojo:cxx-maven-plugin:0.0.6-SNAPSHOT:coverage

Description:

Goal which gcovr execution.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: test.

Required Parameters

Name Type Since Description
executable String 0.0.4 The executable. Can be a full path or a the name executable. In the latter case, the executable must be in the PATH for the execution to work.
User property is: launch.executable.

Optional Parameters

Name Type Since Description
arguments List 0.0.4 Can be of type <argument> or <classpath> Can be overriden using "cxx.args" env. variable
commandArgs String - Arguments for the executed program
User property is: launch.args.
environmentVariables Map 0.0.4 Environment variables to pass to the executed program.
excludeOS List 0.0.4 Os for which command shall not be executed os name match is java.lang.System.getProperty( "os.name" )
gcovrArgs String - Arguments for the gcovr program. Shall be -x -d ex: -x -d to produce Xml reports and clean gcda execution reports after reading
Default value is: -x -d.
User property is: coverage.args.
includeOS List 0.0.4 Os for which command shall be executed os name match is java.lang.System.getProperty( "os.name" )
inputStream File 0.0.5 The InputStream Location.
User property is: launch.inputStream.
outputStreamErr File 0.0.5 The OutputStreamErr Location.
User property is: launch.outputStreamErr.
outputStreamOut File 0.0.5 The OutputStreamOut Location.
User property is: launch.outputStreamOut.
preclean boolean 0.0.4 Arguments to clean preexisting gcda report under workingDir
Default value is: true.
User property is: coverage.preclean.
reportIdentifier String 0.0.4 The Report OutputFile name identifier.
User property is: coverage.reportIdentifier.
reportsfileDir File 0.0.4 The Report OutputFile Location.
Default value is: ${project.build.directory}/gcovr-reports.
User property is: coverage.reportsfilePath.
skip boolean 0.0.5 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 shall disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
Default value is: false.
User property is: maven.test.skip.
skipTests boolean 0.0.5 Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default value is: false.
User property is: skipTests.
successCodes List 0.0.4 Exit codes to be resolved as successful execution for non-compliant applications (applications not returning 0 for success).
workingDir File 0.0.4 The current working directory. Optional. If not specified, basedir will be used.
User property is: launch.workingdir.

Parameter Details

arguments:

Can be of type <argument> or <classpath> Can be overriden using "cxx.args" env. variable
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

commandArgs:

Arguments for the executed program
  • Type: java.lang.String
  • Required: No
  • User Property: launch.args

environmentVariables:

Environment variables to pass to the executed program.
  • Type: java.util.Map
  • Since: 0.0.4
  • Required: No

excludeOS:

Os for which command shall not be executed os name match is java.lang.System.getProperty( "os.name" )
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

executable:

The executable. Can be a full path or a the name executable. In the latter case, the executable must be in the PATH for the execution to work.
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: Yes
  • User Property: launch.executable

gcovrArgs:

Arguments for the gcovr program. Shall be -x -d ex: -x -d to produce Xml reports and clean gcda execution reports after reading
  • Type: java.lang.String
  • Required: No
  • User Property: coverage.args
  • Default: -x -d

includeOS:

Os for which command shall be executed os name match is java.lang.System.getProperty( "os.name" )
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

inputStream:

The InputStream Location.
  • Type: java.io.File
  • Since: 0.0.5
  • Required: No
  • User Property: launch.inputStream

outputStreamErr:

The OutputStreamErr Location.
  • Type: java.io.File
  • Since: 0.0.5
  • Required: No
  • User Property: launch.outputStreamErr

outputStreamOut:

The OutputStreamOut Location.
  • Type: java.io.File
  • Since: 0.0.5
  • Required: No
  • User Property: launch.outputStreamOut

preclean:

Arguments to clean preexisting gcda report under workingDir
  • Type: boolean
  • Since: 0.0.4
  • Required: No
  • User Property: coverage.preclean
  • Default: true

reportIdentifier:

The Report OutputFile name identifier.
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: No
  • User Property: coverage.reportIdentifier

reportsfileDir:

The Report OutputFile Location.
  • Type: java.io.File
  • Since: 0.0.4
  • Required: No
  • User Property: coverage.reportsfilePath
  • Default: ${project.build.directory}/gcovr-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 shall disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
  • Type: boolean
  • Since: 0.0.5
  • Required: No
  • User Property: maven.test.skip
  • Default: false

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
  • Since: 0.0.5
  • Required: No
  • User Property: skipTests
  • Default: false

successCodes:

Exit codes to be resolved as successful execution for non-compliant applications (applications not returning 0 for success).
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

workingDir:

The current working directory. Optional. If not specified, basedir will be used.
  • Type: java.io.File
  • Since: 0.0.4
  • Required: No
  • User Property: launch.workingdir