aerial:generate

Full name:

com.github.mkolisnyk:aerial-maven-plugin:0.0.2:generate

Description:

Generates Cucumber feature files based on Aerial document descriptions. Input documents can be stored in many accessible types (controlled by AerialMavenGeneratorPlugin.inputType field.

Attributes:

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

Required Parameters

Name Type Since Description
destination String 0.0.1 Identifies output location depending on AerialMavenGeneratorPlugin.outputType. For FILE it indicates output directory.
User property is: aerial.output.destination.
source String 0.0.1 Identifies the actual source to get data from. Depending on AerialMavenGeneratorPlugin.inputType parameter value it can be:
  • For FILE - main folder where to get document files from
  • For JIRA - base JIRA URL to send queries to
  • For STRING - ignored as not needed
  • For CUSTOM - anything that's defined in appropriate handler

User property is: aerial.input.source.

Optional Parameters

Name Type Since Description
inputType AerialSourceType 0.0.1 Identifies input type to use for source data. Available values are: FILE, JIRA, STRING, CUSTOM.
Default value is: FILE.
User property is: aerial.input.type.
namedParams Map 0.0.1 Some sources require additional information to be passed in addition to input and output locations. E.g. JIRA source additionally requires user name, password and field name. Some other sources may require something else. Main feature is that this field contain parameters with known name.
outputType AerialSourceType 0.0.1 Identifies output type to use for generated data. Available values are: FILE, CUSTOM.
Default value is: FILE.
User property is: aerial.output.type.
valueParams List 0.0.1 Contains the list of additional values passed with the input sources. Mainly they contain some search filters or input strings which can be passed in big quantity and processed uniformly. E.g. :
  • For STRING source type this is the actual container of input text.
  • For FILE source it is the list of file name filters.
  • For JIRA source it is the list of JQL queries to use for data retrieval.

Parameter Details

destination:

Identifies output location depending on AerialMavenGeneratorPlugin.outputType. For FILE it indicates output directory.
  • Type: java.lang.String
  • Since: 0.0.1
  • Required: Yes
  • User Property: aerial.output.destination

inputType:

Identifies input type to use for source data. Available values are: FILE, JIRA, STRING, CUSTOM.
  • Type: com.github.mkolisnyk.aerial.core.params.AerialSourceType
  • Since: 0.0.1
  • Required: No
  • User Property: aerial.input.type
  • Default: FILE

namedParams:

Some sources require additional information to be passed in addition to input and output locations. E.g. JIRA source additionally requires user name, password and field name. Some other sources may require something else. Main feature is that this field contain parameters with known name.
  • Type: java.util.Map
  • Since: 0.0.1
  • Required: No

outputType:

Identifies output type to use for generated data. Available values are: FILE, CUSTOM.
  • Type: com.github.mkolisnyk.aerial.core.params.AerialSourceType
  • Since: 0.0.1
  • Required: No
  • User Property: aerial.output.type
  • Default: FILE

source:

Identifies the actual source to get data from. Depending on AerialMavenGeneratorPlugin.inputType parameter value it can be:
  • For FILE - main folder where to get document files from
  • For JIRA - base JIRA URL to send queries to
  • For STRING - ignored as not needed
  • For CUSTOM - anything that's defined in appropriate handler
  • Type: java.lang.String
  • Since: 0.0.1
  • Required: Yes
  • User Property: aerial.input.source

valueParams:

Contains the list of additional values passed with the input sources. Mainly they contain some search filters or input strings which can be passed in big quantity and processed uniformly. E.g. :
  • For STRING source type this is the actual container of input text.
  • For FILE source it is the list of file name filters.
  • For JIRA source it is the list of JQL queries to use for data retrieval.
  • Type: java.util.List
  • Since: 0.0.1
  • Required: No