citrus:create-excel-doc

Full name:

com.consol.citrus.mvn:citrus-maven-plugin:1.2.M2:create-excel-doc

Description:

Creates test documentation in MS Excel listing all available tests with meta information (name, author, description, date, ...) .

Attributes:

  • Requires a Maven 2.0 project to be executed.

Optional Parameters

Name Type Since Description
author String - Author name that goes into Excel meta information.
Default value is: Citrus Testframework.
company String - Name of company that goes into Excel meta information.
Default value is: Unknown.
customHeaders String - Customized column headers as comma separated value string (e.g. "Nr;Name;Author;Status;TestCase;Date").
interactiveMode boolean - Whether to use interactive mode where user is prompted for parameter input during execution.
Default value is: true.
outputFile String - Name of output file (.xsl file extension is added automatically and can be left out). Defaults to "CitrusTests".
Default value is: CitrusTests.
pageTitle String - Page title displayed on top of the sheet.
Default value is: Citrus Test Documentation.
testDirectory String - Mojo looks in this directory for test files that are included in this report. Defaults to "src/citrus/tests"
Default value is: src/citrus/tests.

Parameter Details

author:

Author name that goes into Excel meta information.
  • Type: java.lang.String
  • Required: No
  • Default: Citrus Testframework

company:

Name of company that goes into Excel meta information.
  • Type: java.lang.String
  • Required: No
  • Default: Unknown

customHeaders:

Customized column headers as comma separated value string (e.g. "Nr;Name;Author;Status;TestCase;Date").
  • Type: java.lang.String
  • Required: No

interactiveMode:

Whether to use interactive mode where user is prompted for parameter input during execution.
  • Type: boolean
  • Required: No
  • Expression: ${interactiveMode}
  • Default: true

outputFile:

Name of output file (.xsl file extension is added automatically and can be left out). Defaults to "CitrusTests".
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputFile}
  • Default: CitrusTests

pageTitle:

Page title displayed on top of the sheet.
  • Type: java.lang.String
  • Required: No
  • Default: Citrus Test Documentation

testDirectory:

Mojo looks in this directory for test files that are included in this report. Defaults to "src/citrus/tests"
  • Type: java.lang.String
  • Required: No
  • Default: src/citrus/tests