citrus:create-html-doc

Full name:

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

Description:

Creates test overview documentation in HTML. The web page contains a list of all available tests with meta information.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Optional Parameters

Name Type Since Description
columns String - Number of columns in test overview table
Default value is: 1.
interactiveMode boolean - Whether to use interactive mode where user is prompted for parameter input during execution.
Default value is: true.
logo String - Company or project logo displayed on top of page. Defaults to "logo.png"
Default value is: logo.png.
outputFile String - Name of output file (.html file extension is added automatically and can be left out). Defaults to "CitrusTests"
Default value is: CitrusTests.
overviewTitle String - The overview title displayed at the top of the test overview
Default value is: Overview.
pageTitle String - Page title displayed at the top of the page
Default value is: Citrus Test Documentation.
testDirectory String - All test files in this directory are included into the report. Defaults to "src/citrus/tests"
Default value is: src/citrus/tests.

Parameter Details

columns:

Number of columns in test overview table
  • Type: java.lang.String
  • Required: No
  • Default: 1

interactiveMode:

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

logo:

Company or project logo displayed on top of page. Defaults to "logo.png"
  • Type: java.lang.String
  • Required: No
  • Default: logo.png

outputFile:

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

overviewTitle:

The overview title displayed at the top of the test overview
  • Type: java.lang.String
  • Required: No
  • Default: Overview

pageTitle:

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

testDirectory:

All test files in this directory are included into the report. Defaults to "src/citrus/tests"
  • Type: java.lang.String
  • Required: No
  • Default: src/citrus/tests