Getting Started

Aerial is designed to be extensible and to cover various input and output formats. Also, it may have different run options. In order to make processing more flexible and extensible for different areas there are some configuration capabilities. Mainly they include:

• General configuration options

• Source document parsing templates

• Scenario Generation Templates

Each of them is applied to different area and it is targeted to some specific part of the functionality.

General Configuration Options

Since version 0.0.4

In order to make Aerial working the direction it is expected there is a need to define some global settings which will be applied to core runner resources. Mainly it is related to the input/output format definition/customization or some common algorithm specifics or in general settings which can be used in multiple places in different point of Aerial processing life-cycle. All such parameters are stored in global configuration file.

During runtime all those values are stored in system properties.

By default Aerial uses internal resource with the configuration. It is stored under /src/main/resources/aerial.properties location. But Aerial functionality supports overriding it via:

• Command Line

• Maven Plugin Configuration

Currently the following properties are in use:

Source document parsing templates

Since version 0.0.4

The default input document format is pretty generic and it doesn’t include such simple things as formatting. Additionally, the set of keywords being used to indicate each specific block also can be different depending on input source and common requirements definition style. In order to adapt Aerial to such input format variations there was input format configuration designed.

Template Items Description

Templates are defined in specific property files. There is a bunch of built-in templates located at src/main/resources/input location. Also, Aerial provides functionality to define custom format in case we need to output generated content is some specific way.

All configuration properties are defined in the specific format:

1

aerial.<Format Name>.<Property Name>

Where:

• Format Name is the general name of the format to use. It is the name which is specified while defining which format we want to use

• Property Name is the suffix which uniquely identifies property to set.

Here is the list of acceptable suffixes:

Example

Here is an example of the properties file for the default input document template:

1
2
3
4
5
6
7
8

aerial.plain.token.action=Action:
aerial.plain.token.prerequisites=Pre-requisites:
aerial.plain.token.input=Input:
aerial.plain.token.valid_output=On Success:
aerial.plain.token.error_output=On Failure:
aerial.plain.token.feature=Feature:
aerial.plain.token.case=Case:
aerial.plain.token.additional_scenarios=Additional Scenarios:

Scenario Generation Templates

Since version 0.0.3

Aerial is targeted to generate test scenarios applicable to different engines. That can be some BDD engines like Cucumber or JBehave. Also it can be any other format. Main thing is that there are some data items which are generated by the engine as well as there are items which do not depend on generation algorithms and rather designed for formatted representation of data generated. So, mainly each specific file output format is defined by specific output formatting templates.

Template items description

Such templates are defined in specific property files. There is a bunch of built-in templates located at src/main/resources/generator location. Also, Aerial provides functionality to define custom format in case we need to output generated content is some specific way.

All configuration properties are defined in the specific format:

1

aerial.<Format Name>.<Property Name>

Where:

• Format Name is the general name of the format to use. It is the name which is specified while defining which format we want to use

• Property Name is the suffix which uniquely identifies property to set.

Here is the list of acceptable suffixes with insertion patterns:

Example

The example below shows the configuration for Cucumber scenarios generation:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

aerial.cucumber.feature=Feature: {NAME}\r\n\
{CASES}\
{ADDITIONAL_SCENARIOS}
aerial.cucumber.case=\tScenario Outline: {NAME}\r\n\
{BODY}\
\tExamples:\r\n\
{DATA}\r\n
aerial.cucumber.action=\t\tWhen {ACTION}\r\n
aerial.cucumber.prerequisite=\t\tGiven {CONTENT}
aerial.cucumber.output.valid=\t\tThen {CONTENT}\r\n
aerial.cucumber.output.error=\t\tThen {CONTENT}\r\n
aerial.cucumber.additional_scenarios=\
{CONTENT}
aerial.cucumber.data.header=\t\t| {TITLES} |\r\n
aerial.cucumber.data.header.delimiter=\ | 
aerial.cucumber.data.row=\t\t| {DATA} |\r\n
aerial.cucumber.data.row.delimiter=\ | 
aerial.cucumber.data.field=<{NAME}>
aerial.cucumber.data.field.modified_prefix=Modified

News