Home Schema Example JSON Schema

Project Settings

Type: object

Project.settings is used to determine the configuration for the test when executed by Virtuosa.

No Additional Properties

Timeout

Type: number

The timeout for this test in seconds. Defaults to settings.BACH_TEST_TIMEOUT seconds (i.e., 600).

Value must be greater or equal to 30

Environment Variables

Type: object

A key-value map of environment variables that will be passed into Virtuosa instance.

Each additional property must conform to the following schema

Type: string

Uploaded Files

Type: array of object

An array of files to upload. This is useful when starting the project session via Mastermind where there is no way to upload files.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Filename

Type: string

This filename will be used and stored in $UPLOADED_PATH/<filename>.

Must be at least 1 characters long

Content

Type: string

Content of file.

Must be at least 1 characters long

Base64 Encoded

Type: boolean

Whether the contents are standard Base-64 encoded. Defaults to false.

Pre-start Commend

Type: string

Shell command to run before starting Virtuosa instance.

Must be at least 1 characters long

AWS Key Pair

Type: string

AWS key pair to use for Virtuosa instance. Defaults to {settings.ENVIRONMENT}@botmd.io.

Must be at least 1 characters long

AWS instance profile ARN

Type: string

Instance profile ARN for Virtuosa instance. Defaults to settings.BACH_VIRTUOSA_INSTANCE_PROFILE (i.e., arn:aws:iam::394252546268:instance-profile/{ENVIRONMENT}-virtuosa-instance_profile).

Must match regular expression: ^arn\:aws\:iam\:\:[0-9]+:instance\-profile\/[a-z0-9\-\_]+$

AWS Key Pair

Type: string

Instance type for Virtuosa instance. Defaults to c5.large.

Must be at least 1 characters long

AWS Security Groups

Type: array of string

Security group names or ID for Virtuosa instance. Defaults to [staging-virtuosa-instance_sg].

No Additional Items

Each item of this array must be:

AWS Subnet ID

Type: string

Subnet ID for running Virtuosa instance. Defaults to secrets.choice(settings.BACH_VIRTUOSA_SUBNETS).

Must match regular expression: ^subnet\-[0-9a-z]+$