schemas

buildtest configuration schema Schema

https://buildtesters.github.io/schemas/schemas/settings.schema.json

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	Yes	Unknown status	No	Forbidden	Forbidden	none	settings.schema.json

buildtest configuration schema Type

object (buildtest configuration schema)

buildtest configuration schema Properties

Property	Type	Required	Nullable	Defined by
executors	object	Required	cannot be null	buildtest configuration schema
config	object	Required	cannot be null	buildtest configuration schema
additionalProperties	Not specified	Optional	cannot be null	Untitled schema

executors

The executor section is used for declaring your executors that are responsible for running jobs. The executor section can be local, lsf, slurm, ssh. The executors are referenced in buildspec using executor field.

executors

• is required
• Type: object (Details)
• cannot be null
• defined in: buildtest configuration schema

executors Type

object (Details)

config

config

• is required
• Type: object (Details)
• cannot be null
• defined in: buildtest configuration schema

config Type

object (Details)

additionalProperties

no description

additionalProperties

• is optional
• Type: unknown
• cannot be null
• defined in: Untitled schema

Untitled schema Type

unknown

buildtest configuration schema Definitions

Definitions group modules

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/modules"}

Property	Type	Required	Nullable	Defined by
purge	boolean	Optional	cannot be null	buildtest configuration schema
load	array	Optional	cannot be null	buildtest configuration schema

purge

purge

• is optional
• Type: boolean
• cannot be null
• defined in: buildtest configuration schema

purge Type

boolean

load

load

• is optional
• Type: string[]
• cannot be null
• defined in: buildtest configuration schema

load Type

string[]

Definitions group script

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/script"}

| Property | Type | Required | Nullable | Defined by | | :——- | —- | ——– | ——– | :——— |

Definitions group local

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/local"}

Property	Type	Required	Nullable	Defined by
description	string	Optional	cannot be null	buildtest configuration schema
shell	string	Required	cannot be null	buildtest configuration schema
before_script	Not specified	Optional	cannot be null	buildtest configuration schema
after_script	Not specified	Optional	cannot be null	buildtest configuration schema

description

description field for documenting your executor

description

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

description Type

string

shell

Specify the shell launcher you want to use when running tests locally

shell

• is required
• Type: string
• cannot be null
• defined in: buildtest configuration schema

shell Type

string

shell Constraints

pattern: the string must match the following regular expression:

^(/bin/bash|/bin/sh|sh|bash|python).*

try pattern

before_script

before_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

before_script Type

unknown

after_script

after_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

after_script Type

unknown

Definitions group slurm

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/slurm"}

Property	Type	Required	Nullable	Defined by
description	string	Optional	cannot be null	buildtest configuration schema
launcher	string	Optional	cannot be null	buildtest configuration schema
options	array	Optional	cannot be null	buildtest configuration schema
cluster	string	Optional	cannot be null	buildtest configuration schema
partition	string	Optional	cannot be null	buildtest configuration schema
qos	string	Optional	cannot be null	buildtest configuration schema
before_script	Not specified	Optional	cannot be null	buildtest configuration schema
after_script	Not specified	Optional	cannot be null	buildtest configuration schema

description

description field for documenting your executor

description

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

description Type

string

launcher

Specify the slurm batch scheduler to use. This overrides the default launcher field. This must be sbatch.

launcher

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

launcher Type

string

launcher Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"sbatch"

options

Specify any other options for sbatch used by this executor for running all jobs.

options

• is optional
• Type: string[]
• cannot be null
• defined in: buildtest configuration schema

options Type

string[]

cluster

Specify the slurm cluster you want to use -M <cluster>

cluster

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

cluster Type

string

partition

Specify the slurm partition you want to use -p <partition>

partition

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

partition Type

string

qos

Specify the slurm qos you want to use -q <qos>

qos

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

qos Type

string

before_script

before_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

before_script Type

unknown

after_script

after_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

after_script Type

unknown

Definitions group lsf

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/lsf"}

Property	Type	Required	Nullable	Defined by
description	string	Optional	cannot be null	buildtest configuration schema
launcher	string	Optional	cannot be null	buildtest configuration schema
options	array	Optional	cannot be null	buildtest configuration schema
queue	string	Optional	cannot be null	buildtest configuration schema
before_script	Not specified	Optional	cannot be null	buildtest configuration schema
after_script	Not specified	Optional	cannot be null	buildtest configuration schema

description

description field for documenting your executor

description

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

description Type

string

launcher

Specify the lsf batch scheduler to use. This overrides the default launcher field. It must be bsub.

launcher

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

launcher Type

string

launcher Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"bsub"

options

Specify any options for bsub for this executor when running all jobs associated to this executor

options

• is optional
• Type: string[]
• cannot be null
• defined in: buildtest configuration schema

options Type

string[]

queue

Specify the lsf queue you want to use -q <queue>

queue

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

queue Type

string

before_script

before_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

before_script Type

unknown

after_script

after_script

• is optional
• Type: unknown
• cannot be null
• defined in: buildtest configuration schema

after_script Type

unknown

Definitions group ssh

Reference this group by using

{"$ref":"https://buildtesters.github.io/schemas/schemas/settings.schema.json#/definitions/ssh"}

Property	Type	Required	Nullable	Defined by
description	string	Optional	cannot be null	buildtest configuration schema
host	string	Required	cannot be null	buildtest configuration schema
user	string	Required	cannot be null	buildtest configuration schema
identity_file	string	Required	cannot be null	buildtest configuration schema

description

description

• is optional
• Type: string
• cannot be null
• defined in: buildtest configuration schema

description Type

string

host

host

• is required
• Type: string
• cannot be null
• defined in: buildtest configuration schema

host Type

string

user

user

• is required
• Type: string
• cannot be null
• defined in: buildtest configuration schema

user Type

string

identity_file

identity_file

• is required
• Type: string
• cannot be null
• defined in: buildtest configuration schema

identity_file Type

string

This site is open source. Improve this page.