Untitled object in spack schema version Schema

spack.schema.json#/properties/status

The status section describes how buildtest detects PASS/FAIL on test. By default returncode 0 is a PASS and anything else is a FAIL, however buildtest can support other types of PASS/FAIL conditions.

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

status Type

object (Details)

status Properties

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.
file_regex	`array`	Optional	cannot be null	JSON Schema Definitions File.
runtime	`object`	Optional	cannot be null	JSON Schema Definitions File.
assert_ge	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_le	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_gt	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_lt	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_eq	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_ne	`array`	Optional	cannot be null	JSON Schema Definitions File.
assert_range	`array`	Optional	cannot be null	JSON Schema Definitions File.
contains	Not specified	Optional	cannot be null	JSON Schema Definitions File.
not_contains	Not specified	Optional	cannot be null	JSON Schema Definitions File.
is_symlink	`array`	Optional	cannot be null	JSON Schema Definitions File.
exists	`array`	Optional	cannot be null	JSON Schema Definitions File.
is_dir	`array`	Optional	cannot be null	JSON Schema Definitions File.
is_file	`array`	Optional	cannot be null	JSON Schema Definitions File.
file_count	`array`	Optional	cannot be null	JSON Schema Definitions File.
state	`string`	Optional	cannot be null	JSON Schema Definitions File.
mode	`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

is optional
Type: string
cannot be null
defined in: JSON Schema Definitions File.

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

is optional
Type: string
cannot be null
defined in: JSON Schema Definitions File.

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

is optional
Type: string
cannot be null
defined in: JSON Schema Definitions File.

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

is optional
Type: merged type (Details)
cannot be null
defined in: JSON Schema Definitions File.

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

is optional
Type: object (Details)
cannot be null
defined in: JSON Schema Definitions File.

regex Type

object (Details)

file_regex

Specify a list of regular expressions to match files in the current working directory. The regular expression is matched using re.search python module.

file_regex

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

file_regex Type

object[] (Details)

runtime

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

runtime

is optional
Type: object (Details)
cannot be null
defined in: JSON Schema Definitions File.

runtime Type

object (Details)

assert_ge

Perform assertion of greater and equal (>=) with reference value

assert_ge

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_ge Type

object[] (Details)

assert_le

Perform assertion of less than and equal (<=) with reference value

assert_le

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_le Type

object[] (Details)

assert_gt

Perform assertion of greater than (>) with reference value

assert_gt

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_gt Type

object[] (Details)

assert_lt

Perform assertion of less than (<) with reference value

assert_lt

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_lt Type

object[] (Details)

assert_eq

Perform assertion of equality (=) with reference value

assert_eq

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_eq Type

object[] (Details)

assert_ne

Perform assertion of not equal with reference value

assert_ne

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_ne Type

object[] (Details)

assert_range

Perform assertion based on lower and upper bound

assert_range

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

assert_range Type

object[] (Details)

contains

Check if metric value is in a list of reference values

contains

is optional
Type: unknown
cannot be null
defined in: JSON Schema Definitions File.

contains Type

unknown

not_contains

Check if metric value not in a list of reference values

not_contains

is optional
Type: unknown
cannot be null
defined in: JSON Schema Definitions File.

not_contains Type

unknown

is_symlink

Check for list of files or directory paths that are symbolic links

is_symlink

is optional
Type: string[]
cannot be null
defined in: JSON Schema Definitions File.

is_symlink Type

string[]

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

exists

Check for list of file or directory path for existences using os.path.exists

exists

is optional
Type: string[]
cannot be null
defined in: JSON Schema Definitions File.

exists Type

string[]

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

is_dir

Check for list of filepaths are directories

is_dir

is optional
Type: string[]
cannot be null
defined in: JSON Schema Definitions File.

is_dir Type

string[]

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

is_file

Check for list of filepaths are files

is_file

is optional
Type: string[]
cannot be null
defined in: JSON Schema Definitions File.

is_file Type

string[]

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

file_count

Perform assertion check by comparing file count in a directory

file_count

is optional
Type: object[] (Details)
cannot be null
defined in: JSON Schema Definitions File.

file_count Type

object[] (Details)

state

explicitly mark state of test regardless of status calculation

state

is optional
Type: string
cannot be null
defined in: JSON Schema Definitions File.

state Type

string

state Constraints

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

Value	Explanation
`"PASS"`
`"FAIL"`

mode

Determine how the status check is resolved, for instance it can be logical AND or OR

mode

is optional
Type: string
cannot be null
defined in: JSON Schema Definitions File.

mode Type

string

mode Constraints

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

Value	Explanation
`"any"`
`"all"`