Fork me on GitHub

qa-jgiven-reporter:permethod-report

Full name:

dev.aherscu.qa:qa-jgiven-reporter-maven-plugin:1.0.5-SNAPSHOT:permethod-report

Description:

Generates JGiven report in QA format per method with associated attributes. Scans all JGiven report .json files for specified referenceTag. Only reports having such tag are processed. For every scenario method, all its tags are written in an associated "attributes" file. The association is done by file name. These "attributes" can later be used as additional publishing information.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: verify.

Optional Parameters

Name Type Since Description
<datePattern> String - (no description)
Default value is: yyyy-MMM-dd HH:mm O.
<debug> boolean - Whether to generate an aggregated JSON report model for debugging purposes. Defaults to false.
Default value is: false.
<outputDirectory> File - Directory where the reports are generated to. Defaults to ${project.build.directory/jgiven-reports/qa-html}.
Default value is: ${project.build.directory}/jgiven-reports/qa-html.
<pdf> boolean - Whether to generate PDF reports. Defaults to true.
Default value is: true.
<referenceTag> String - JGiven Reference> tag. Not linked in this module in order to allow faster builds (otherwise the build of this module would depend on qa-jgiven-commons module).
Default value is: Reference.
<screenshotScale> String - (no description)
Default value is: 0.2.
<skip> boolean - (no description)
Default value is: false.
User property is: jgivenreporter.skip.
<sourceDirectory> File - Directory to read the JSON report files from. Defaults to ${project.build.directory/jgiven-reports/json}.
Default value is: ${project.build.directory}/jgiven-reports/json.
<templateResource> String - (no description)
Default value is: /qa-jgiven-permethod-reporter.html.

Parameter Details

<datePattern>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: yyyy-MMM-dd HH:mm O

<debug>

Whether to generate an aggregated JSON report model for debugging purposes. Defaults to false.
  • Type: boolean
  • Required: No
  • Default: false

<outputDirectory>

Directory where the reports are generated to. Defaults to ${project.build.directory/jgiven-reports/qa-html}.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/jgiven-reports/qa-html

<pdf>

Whether to generate PDF reports. Defaults to true.
  • Type: boolean
  • Required: No
  • Default: true

<referenceTag>

JGiven Reference> tag. Not linked in this module in order to allow faster builds (otherwise the build of this module would depend on qa-jgiven-commons module).
  • Type: java.lang.String
  • Required: No
  • Default: Reference

<screenshotScale>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: 0.2

<skip>

(no description)
  • Type: boolean
  • Required: No
  • User Property: jgivenreporter.skip
  • Default: false

<sourceDirectory>

Directory to read the JSON report files from. Defaults to ${project.build.directory/jgiven-reports/json}.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/jgiven-reports/json

<templateResource>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: /qa-jgiven-permethod-reporter.html