schemas

global schema Schema

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

buildtest global schema is validated for all buildspecs. The global schema defines top-level structure of buildspec and defintions that are inherited for sub-schemas

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

global schema Type

object (global schema)

global schema Properties

Property	Type	Required	Nullable	Defined by
version	string	Required	cannot be null	global schema
maintainers	array	Optional	cannot be null	global schema
buildspecs	object	Required	cannot be null	global schema

version

The semver version of the schema to use (x.x).

version

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

version Type

string

maintainers

One or more maintainers or aliases

maintainers

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

maintainers Type

string[]

maintainers Constraints

minimum number of items: the minimum number of items for this array is: 1

buildspecs

This section is used to define one or more tests (buildspecs). Each test must be unique name

buildspecs

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

buildspecs Type

object (Details)

global schema Definitions

Definitions group env

Reference this group by using

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

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

Definitions group tags

Reference this group by using

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

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

Definitions group skip

Reference this group by using

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

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

Definitions group executor

Reference this group by using

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

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

Definitions group sbatch

Reference this group by using

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

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

Definitions group bsub

Reference this group by using

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

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

Definitions group status

Reference this group by using

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

Property	Type	Required	Nullable	Defined by
slurm_job_state	string	Optional	cannot be null	global schema
returncode	array	Optional	cannot be null	global schema
regex	object	Optional	cannot be null	global schema

slurm_job_state

This field can be used for checking Slurm Job State, if there is a match buildtest will report as PASS

slurm_job_state

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

slurm_job_state Type

string

slurm_job_state Constraints

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

Value	Explanation
"COMPLETED"
"FAILED"
"OUT_OF_MEMORY"
"TIMEOUT"

returncode

Specify a list of returncodes to match with script’s exit code. buildtest will PASS test if script’s exit code is found in list of returncodes. You must specify unique numbers as list and a minimum of 1 item in array

returncode

• is optional
• Type: integer[]
• cannot be null
• defined in: global schema

returncode Type

integer[]

returncode Constraints

minimum number of items: the minimum number of items for this array is: 1

unique items: all items in this array must be unique. Duplicates are not allowed.

regex

Perform regular expression search using re.search python module on stdout/stderr stream for reporting if test PASS.

regex

• is optional
• Type: object (Details)
• cannot be null
• defined in: global schema

regex Type

object (Details)

This site is open source. Improve this page.