Skip to the content.

buildtest configuration schema Schema

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
system object Required cannot be null buildtest configuration schema

system

system

system Type

object (Details)

buildtest configuration schema Definitions

Definitions group system

Reference this group by using

{"$ref":"settings.schema.json#/definitions/system"}
Property Type Required Nullable Defined by
hostnames array Required cannot be null buildtest configuration schema
description string Optional cannot be null buildtest configuration schema
poolsize integer Optional cannot be null buildtest configuration schema
buildspec_roots array Optional cannot be null buildtest configuration schema
testdir string Optional cannot be null buildtest configuration schema
logdir string Optional cannot be null buildtest configuration schema
moduletool string Required cannot be null buildtest configuration schema
timeout integer Optional cannot be null buildtest configuration schema
processor object Optional cannot be null buildtest configuration schema
compilers object Required cannot be null buildtest configuration schema
executors object Required cannot be null buildtest configuration schema
cdash object Optional cannot be null buildtest configuration schema

hostnames

Specify a list of hostnames to check where buildtest can run for the given system record

hostnames

hostnames Type

string[]

description

system description field

description

description Type

string

poolsize

Specify size of Process Pool for parallel processing using multiprocessing.Pool

poolsize

poolsize Type

integer

poolsize Constraints

minimum: the value of this number must greater than or equal to: 1

buildspec_roots

Specify a list of directory paths to search buildspecs. This field can be used with buildtest buildspec find to rebuild buildspec cache or build tests using buildtest build command

buildspec_roots

buildspec_roots Type

string[]

testdir

Specify full path to test directory where buildtest will write tests.

testdir

testdir Type

string

logdir

Specify location where buildtest will write log files

logdir

logdir Type

string

moduletool

Specify modules tool used for interacting with module command.

moduletool

moduletool Type

string

moduletool Constraints

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

Value Explanation
"environment-modules"  
"lmod"  
"N/A"  

timeout

Specify timeout duration in number of seconds

timeout

timeout Type

integer

timeout Constraints

minimum: the value of this number must greater than or equal to: 1

processor

Specify processor information

processor

processor Type

object (Details)

compilers

Declare compiler section for defining system compilers that can be referenced in buildspec.

compilers

compilers Type

object (Details)

executors

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

executors

executors Type

object (Details)

cdash

Specify CDASH configuration used to upload tests via ‘buildtest cdash’ command

cdash

cdash Type

object (Details)

Definitions group cc

Reference this group by using

{"$ref":"settings.schema.json#/definitions/cc"}

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

Definitions group cxx

Reference this group by using

{"$ref":"settings.schema.json#/definitions/cxx"}

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

Definitions group fc

Reference this group by using

{"$ref":"settings.schema.json#/definitions/fc"}

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

Definitions group max_jobs

Reference this group by using

{"$ref":"settings.schema.json#/definitions/max_jobs"}

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

Definitions group compiler_section

Reference this group by using

{"$ref":"settings.schema.json#/definitions/compiler_section"}
Property Type Required Nullable Defined by
cc string Required cannot be null buildtest configuration schema
cxx string Required cannot be null buildtest configuration schema
fc string Required cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

cc

Specify path to C compiler wrapper. You may specify a compiler wrapper such as gcc assuming its in $PATH or you can use modules property to resolve path to compiler wrapper.

cc

cc Type

string

cxx

Specify path to C++ compiler wrapper. You may specify a compiler wrapper such as g++ assuming its in $PATH or you can use modules property to resolve path to compiler wrapper.

cxx

cxx Type

string

fc

Specify path to Fortran compiler wrapper. You may specify a compiler wrapper such as gfortran assuming its in $PATH or you can use modules property to resolve path to compiler wrapper.

fc

fc Type

string

module

module

module Type

object (Details)

Definitions group unique_string_array

Reference this group by using

{"$ref":"settings.schema.json#/definitions/unique_string_array"}

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

Definitions group disable

Reference this group by using

{"$ref":"settings.schema.json#/definitions/disable"}

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

Definitions group module

Reference this group by using

{"$ref":"settings.schema.json#/definitions/module"}
Property Type Required Nullable Defined by
purge boolean Optional cannot be null buildtest configuration schema
load array Optional cannot be null buildtest configuration schema
swap array Optional cannot be null buildtest configuration schema
restore string Optional cannot be null buildtest configuration schema

purge

Run module purge if purge is set

purge

purge Type

boolean

load

Load one or more modules via module load

load

load Type

string[]

load 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.

swap

Swap modules using module swap. The swap property expects 2 unique modules.

swap

swap Type

string[]

swap Constraints

maximum number of items: the maximum number of items for this array is: 2

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

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

restore

Load a collection name via module restore

restore

restore Type

string

Definitions group script

Reference this group by using

{"$ref":"settings.schema.json#/definitions/script"}

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

Definitions group maxpendtime

Reference this group by using

{"$ref":"settings.schema.json#/definitions/maxpendtime"}

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

Definitions group account

Reference this group by using

{"$ref":"settings.schema.json#/definitions/account"}

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

Definitions group local

Reference this group by using

{"$ref":"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
max_jobs integer Optional cannot be null buildtest configuration schema
disable boolean Optional cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

description

description field for documenting your executor

description

description Type

string

shell

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

shell

shell Type

string

before_script

before_script

before_script Type

unknown

max_jobs

Maximum number of jobs that can be run at a given time for a particular executor

max_jobs

max_jobs Type

integer

max_jobs Constraints

minimum: the value of this number must greater than or equal to: 1

disable

Disable executor

disable

disable Type

boolean

module

module

module Type

object (Details)

Definitions group slurm

Reference this group by using

{"$ref":"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
maxpendtime integer Optional cannot be null buildtest configuration schema
account string Optional cannot be null buildtest configuration schema
max_jobs integer Optional cannot be null buildtest configuration schema
disable boolean Optional cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

description

description field for documenting your executor

description

description Type

string

launcher

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

launcher

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

options Type

string[]

cluster

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

cluster

cluster Type

string

partition

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

partition

partition Type

string

qos

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

qos

qos Type

string

before_script

The before_script section can be used to specify commands before start of test. The script will be sourced in active shell.

before_script

before_script Type

unknown

maxpendtime

Cancel job if it is still pending in queue beyond maxpendtime

maxpendtime

maxpendtime Type

integer

maxpendtime Constraints

minimum: the value of this number must greater than or equal to: 1

maxpendtime Default Value

The default value is:

86400

account

Specify Job Account for charging resources

account

account Type

string

max_jobs

Maximum number of jobs that can be run at a given time for a particular executor

max_jobs

max_jobs Type

integer

max_jobs Constraints

minimum: the value of this number must greater than or equal to: 1

disable

Disable executor

disable

disable Type

boolean

module

module

module Type

object (Details)

Definitions group lsf

Reference this group by using

{"$ref":"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 Required cannot be null buildtest configuration schema
before_script Not specified Optional cannot be null buildtest configuration schema
maxpendtime integer Optional cannot be null buildtest configuration schema
account string Optional cannot be null buildtest configuration schema
max_jobs integer Optional cannot be null buildtest configuration schema
disable boolean Optional cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

description

description field for documenting your executor

description

description Type

string

launcher

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

launcher

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

options Type

string[]

queue

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

queue

queue Type

string

before_script

The before_script section can be used to specify commands before start of test. The script will be sourced in active shell.

before_script

before_script Type

unknown

maxpendtime

Cancel job if it is still pending in queue beyond maxpendtime

maxpendtime

maxpendtime Type

integer

maxpendtime Constraints

minimum: the value of this number must greater than or equal to: 1

maxpendtime Default Value

The default value is:

86400

account

Specify Job Account for charging resources

account

account Type

string

max_jobs

Maximum number of jobs that can be run at a given time for a particular executor

max_jobs

max_jobs Type

integer

max_jobs Constraints

minimum: the value of this number must greater than or equal to: 1

disable

Disable executor

disable

disable Type

boolean

module

module

module Type

object (Details)

Definitions group cobalt

Reference this group by using

{"$ref":"settings.schema.json#/definitions/cobalt"}
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 Required cannot be null buildtest configuration schema
before_script Not specified Optional cannot be null buildtest configuration schema
maxpendtime integer Optional cannot be null buildtest configuration schema
account string Optional cannot be null buildtest configuration schema
max_jobs integer Optional cannot be null buildtest configuration schema
disable boolean Optional cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

description

description field for documenting your executor

description

description Type

string

launcher

Specify the cobalt batch scheduler to use. This overrides the default launcher field. It must be qsub.

launcher

launcher Type

string

launcher Constraints

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

Value Explanation
"qsub"  

options

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

options

options Type

string[]

queue

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

queue

queue Type

string

before_script

The before_script section can be used to specify commands before start of test. The script will be sourced in active shell.

before_script

before_script Type

unknown

maxpendtime

Cancel job if it is still pending in queue beyond maxpendtime

maxpendtime

maxpendtime Type

integer

maxpendtime Constraints

minimum: the value of this number must greater than or equal to: 1

maxpendtime Default Value

The default value is:

86400

account

Specify Job Account for charging resources

account

account Type

string

max_jobs

Maximum number of jobs that can be run at a given time for a particular executor

max_jobs

max_jobs Type

integer

max_jobs Constraints

minimum: the value of this number must greater than or equal to: 1

disable

Disable executor

disable

disable Type

boolean

module

module

module Type

object (Details)

Definitions group pbs

Reference this group by using

{"$ref":"settings.schema.json#/definitions/pbs"}
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 Required cannot be null buildtest configuration schema
before_script Not specified Optional cannot be null buildtest configuration schema
maxpendtime integer Optional cannot be null buildtest configuration schema
account string Optional cannot be null buildtest configuration schema
max_jobs integer Optional cannot be null buildtest configuration schema
disable boolean Optional cannot be null buildtest configuration schema
module object Optional cannot be null buildtest configuration schema

description

description field for documenting your executor

description

description Type

string

launcher

Specify the pbs batch scheduler to use. This overrides the default launcher field. It must be qsub.

launcher

launcher Type

string

launcher Constraints

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

Value Explanation
"qsub"  

options

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

options

options Type

string[]

queue

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

queue

queue Type

string

before_script

The before_script section can be used to specify commands before start of test. The script will be sourced in active shell.

before_script

before_script Type

unknown

maxpendtime

Cancel job if it is still pending in queue beyond maxpendtime

maxpendtime

maxpendtime Type

integer

maxpendtime Constraints

minimum: the value of this number must greater than or equal to: 1

maxpendtime Default Value

The default value is:

86400

account

Specify Job Account for charging resources

account

account Type

string

max_jobs

Maximum number of jobs that can be run at a given time for a particular executor

max_jobs

max_jobs Type

integer

max_jobs Constraints

minimum: the value of this number must greater than or equal to: 1

disable

Disable executor

disable

disable Type

boolean

module

module

module Type

object (Details)