Test session templates
Session templates overview
A test session identifies a set of tests to run, along with other details like the environment to run against, whether or not to repeat failed tests, etc. Manually creating test sessions can be done using the Web UI, which is good enough for ad-hoc test runs. However, this is also a repetitive, time consuming and error-prone process, especially when including a large number of tests. Furthermore, the manual input of these details is not possible when a test session is kicked off automatically from a CI system. To address these problems, OpenTest introduces the concept of a test session template.
The location and structure of template files
Test session templates are stored as YAML files in the
templates subdirectory of the test repository. For example, to create a session template named
My first session template, that contains two tests
Test 1 and
Test 2, the test repo will have to look as follows:
test-repo ├── templates │ └── My first session template.yaml └── tests ├── Test 1.yaml └── Test 2.yaml
The template file structure is as shown below. All properties are optional, so you can mix and match as needed.
description: A test session template that runs two dummy tests sessionLabel: Two tests actorTags:  environment: null maxIterations: 1 includeTestsWithTags: (tag1 || tag2) && tag3 includeTestsFromTemplates: [dir1/template1, dir2/template2] tests: - name: Test 1 path: . - name: Test 2 path: .
Human-readable description of the template.
The session label that will be assigned to test sessions created from this template.
An array of strings representing the list of tags that will be required for the test actors executing the test session. Default: null.
The environment the new session will be executed against. Default: null.
The maximum number of times to repeat execution of failed tests. Default: 1.
An expression that identifies the tests to include in the session based on the tags that were assigned to them using the
A list of template names that will be used as the source for the list of tests to include in the session. Make sure to specify the template names, along with their path, relative to the
An array that stores the list of tests to include in the test session. Each test is specified as an object with the properties
Creating a test session based on a template
There are two ways to create a new test session based on a template file:
Using the server’s web UI, from the menu, select Session > Create Session From Template. Select the template file you want and click Create session.
Using the OpenTest server API.