Template Types

TestCaseTemplate

This is the master template for all code to be generated. Typically, one TestCaseTemplate is embedded per test model.

Keyword

Description

{{{ModelURL}}}

URL of the model

{{{TestCaseName}}

Name of the test case

{{{test-suite-id}}}

ID of the associated test suite being exported

//Region – Testcases

Region to embed test case definitions code template – See TestCaseMethodTemplate.

//EndRegion – Testcases

Terminal location to stop embedding test case definitions

Below is an example:

TestCaseMethodTemplate

This is the test case template used for each instance of a test case (i.e. path) within the model. This is embedded when the ‘//Region – Testcases’ and ‘//EndRegion – Testcases’ keywords are embedded within a code template.

Keyword

Description

{{{groups}}}

Tags defined in the model

{{{test-guid}}

Guid of the test case in test modeller

{{{allocateTag}}}

Allocate tag. If any allocations are defined for the test case this will be replaced with the ‘AllocateTagTemplate’

{{{TestName}}}

Name of the test case. This is the name of the path.

//Region – Allocate

Region to embed any ‘AllocationDataRowTemplate’ tags to initialise any allocations performed within the test case.

//EndRegion – Allocate

End region for allocate tags

//Region – Test Logic

Region to embed the test logic for the test case.

Below is an example:

AllocateTagTemplate

The tag to use for functions which have Data Allocation defined within the test case. This is embedded whenever the code template engine comes across a tag with {{{AllocateTag}}} embedded within it.

Keyword

Description

{{{AllocatePoolName}}}

Allocation pool name being used.

{{{AllocateSuiteName}}}

Suite name performed.

{{{AllocateGroupName}}}

Group of test names of the allocation to be consumed.

Below is an example:

AllocateDataRowTemplate

This is called to initialise a new allocate data row object whenever a test case needs to access a previously unseen test allocation method this tag is embedded.

Keyword

Description

{{{AllocateResultName}}}

Auto-generated variable name for the allocations.

{{{TestPoolName}}}

Name of the allocation pool that is being referenced

{{{TestSuiteName}}}

Name of the test suite

{{{AllocateName}}}

Name of the allocation test case

Below is an example:

AllocateRetrieveDataValueTemplate

This is the code used to retrieve an allocated value from a test allocation object. This is only embedded in functions where the allocation is referenced.

Keyword

Description

{{{AllocateVariableName}}}

Auto-generated value which refers to the corresponding allocation initialised within
the ‘AllocateDataRowTemplate’

{{{AllocateColumnIndex}}}

Index of the value required from the allocation object for the referenced
parameter.

Below is an example:

Allocation Code Template

The code generators within Test Modeller use configurations in the background. To create or edit a code generation template. Navigate to the configuration page within the workspace tab of the left hand side menu.

Navigate to the code templates tab and select an existing template or click new template.

Here we choose to create a new code template while copying from an existing template to edit. You can also create a new template if you require. Note – it is important to select the language type being consumed.

The template item names are reserved, these can be broken down into 5 template types:

Template Name

Description

TestCaseTemplate

The master template for the test case. This is typically used to represent the entire test suite for a model.

TestCaseMethodTemplate

The code for each instance of a test case within the test case template

AllocateTagTemplate

The tag to use for specifying a data allocation – throughout this manual we have used ‘@DataAllocate’

AllocateDataRowTemplate

The code snippet to use for retrieving the data allocation results from the data allocation API.

AllocateRetrieveDataValueTemplate

The code snippet to use for querying the retrieved results to access the required column.

Test Data Allocation

TEST DATA AUTOMATION TEST DATA ALLOCATION