Skip to the content.

JSON Schema Definitions File. Schema

definitions.schema.json

This file is used for declaring definitions that are referenced from other schemas

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Cannot be instantiated Yes Unknown status Unknown identifiability Forbidden Allowed none definitions.schema.json

JSON Schema Definitions File. Type

unknown (JSON Schema Definitions File. )

JSON Schema Definitions File. Definitions

Definitions group list_of_strings

Reference this group by using

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

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

Definitions group string_or_list

Reference this group by using

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

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

Definitions group list_of_ints

Reference this group by using

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

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

Definitions group int_or_list

Reference this group by using

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

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

Definitions group regex

Reference this group by using

{"$ref":"definitions.schema.json#/definitions/regex"}
Property Type Required Nullable Defined by
stream string Required cannot be null JSON Schema Definitions File.
exp string Required cannot be null JSON Schema Definitions File.

stream

The stream field can be stdout or stderr. buildtest will read the output or error stream after completion of test and check if regex matches in stream

stream

stream Type

string

stream Constraints

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

Value Explanation
"stdout"  
"stderr"  

exp

Specify a regular expression to run with input stream specified by stream field. buildtest uses re.search when performing regex

exp

exp Type

string

Definitions group env

Reference this group by using

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

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

Definitions group description

Reference this group by using

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

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

Definitions group summary

Reference this group by using

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

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

Definitions group tags

Reference this group by using

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

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

Definitions group skip

Reference this group by using

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

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

Definitions group executor

Reference this group by using

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

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

Definitions group needs

Reference this group by using

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

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

Definitions group metrics_field

Reference this group by using

{"$ref":"definitions.schema.json#/definitions/metrics_field"}
Property Type Required Nullable Defined by
regex object Optional cannot be null JSON Schema Definitions File.

regex

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

regex

regex Type

object (Details)

Definitions group metrics

Reference this group by using

{"$ref":"definitions.schema.json#/definitions/metrics"}
Property Type Required Nullable Defined by
^.*$ object Optional cannot be null JSON Schema Definitions File.

Pattern: ^.*$

Name of metric

^.*$

^.*$ Type

object (Details)

Definitions group state

Reference this group by using

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

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

Definitions group returncode

Reference this group by using

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

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

Definitions group status

Reference this group by using

{"$ref":"definitions.schema.json#/definitions/status"}
Property Type Required Nullable Defined by
slurm_job_state string Optional cannot be null JSON Schema Definitions File.
pbs_job_state string Optional cannot be null JSON Schema Definitions File.
lsf_job_state string Optional cannot be null JSON Schema Definitions File.
returncode Merged Optional cannot be null JSON Schema Definitions File.
regex object Optional cannot be null JSON Schema Definitions File.
runtime object Optional cannot be null JSON Schema Definitions File.
state string Optional cannot be null JSON Schema Definitions File.

slurm_job_state

This field can be used to pass test based on Slurm Job State, if there is a match buildtest will report as PASS

slurm_job_state

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"  

pbs_job_state

This field can be used to pass test based on PBS Job State, if there is a match buildtest will report as PASS

pbs_job_state

pbs_job_state Type

string

pbs_job_state Constraints

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

Value Explanation
"H"  
"S"  
"F"  

lsf_job_state

This field can be used to pass test based on LSF Job State, if there is a match buildtest will report as PASS

lsf_job_state

lsf_job_state Type

string

lsf_job_state Constraints

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

Value Explanation
"DONE"  
"EXIT"  

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

returncode Type

merged type (Details)

one (and only one) of

regex

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

regex

regex Type

object (Details)

runtime

The runtime section will pass test based on min and max values and compare with actual runtime.

runtime

runtime Type

object (Details)

state

explicitly mark state of test regardless of status calculation

state

state Type

string

state Constraints

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

Value Explanation
"PASS"  
"FAIL"  

Definitions group BB

Reference this group by using

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

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

Definitions group DW

Reference this group by using

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

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

Definitions group sbatch

Reference this group by using

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

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

Definitions group bsub

Reference this group by using

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

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

Definitions group cobalt

Reference this group by using

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

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

Definitions group pbs

Reference this group by using

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

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

Definitions group executors

Reference this group by using

{"$ref":"definitions.schema.json#/definitions/executors"}
Property Type Required Nullable Defined by
description Not specified Optional cannot be null Untitled schema
^.*$ Not specified Optional cannot be null JSON Schema Definitions File.

Pattern: description

no description

description

Untitled schema Type

unknown

Pattern: ^.*$

^.*$

^.*$ Type

unknown

Definitions group cc

Reference this group by using

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

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

Definitions group fc

Reference this group by using

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

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

Definitions group cxx

Reference this group by using

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

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

Definitions group cflags

Reference this group by using

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

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

Definitions group fflags

Reference this group by using

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

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

Definitions group cxxflags

Reference this group by using

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

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

Definitions group ldflags

Reference this group by using

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

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

Definitions group cppflags

Reference this group by using

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

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

Definitions group run

Reference this group by using

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

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

Definitions group module

Reference this group by using

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

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.

restore

Load a collection name via module restore

restore

restore Type

string

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.