Skip to the content.

compiler schema Schema

compiler.schema.json

The compiler schema is of type: compiler in sub-schema which is used for compiling and running programs

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

compiler schema Type

object (compiler schema)

compiler schema Properties

Property Type Required Nullable Defined by
type string Required cannot be null compiler schema
description string Optional cannot be null compiler schema
summary string Optional cannot be null compiler schema
needs array Optional cannot be null compiler schema
compilers object Required cannot be null compiler schema
source string Required cannot be null compiler schema
executor string Required cannot be null compiler schema
skip boolean Optional cannot be null compiler schema
tags Merged Optional cannot be null compiler schema
metrics object Optional cannot be null compiler schema

type

Select schema type to use when validating buildspec. This must be of set to compiler.

type

type Type

string

type Constraints

pattern: the string must match the following regular expression:

^compiler$

try pattern

description

The description field is used to document what the test is doing

description

description Type

string

description Constraints

maximum length: the maximum number of characters for this string is: 80

summary

The summary field is used to document what the test is doing and can be a multi-line string

summary

summary Type

string

needs

A list of test names that are dependency before runnning job

needs

needs Type

an array where each item follows the corresponding schema in the following list:

  1. Untitled undefined type in JSON Schema Definitions File.

compilers

compilers

compilers Type

object (Details)

source

Specify a source file for compilation, the file can be relative path to buildspec or an absolute path

source

source Type

string

executor

Select one of the executor name defined in your configuration file (config.yml). Every buildspec must have an executor which is responsible for running job.

executor

executor Type

string

skip

The skip is a boolean field that can be used to skip tests during builds. By default buildtest will build and run all tests in your buildspec file, if skip: True is set it will skip the buildspec.

skip

skip Type

boolean

tags

Classify tests using a tag name, this can be used for categorizing test and building tests using --tags option

tags

tags Type

merged type (Details)

one (and only one) of

metrics

This field is used for defining one or more metrics that is recorded for each test. A metric must have a unique name which is recorded in the test metadata.

metrics

metrics Type

object (Details)

compiler schema Definitions

Definitions group cc

Reference this group by using

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

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

Definitions group fc

Reference this group by using

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

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

Definitions group cxx

Reference this group by using

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

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

Definitions group cflags

Reference this group by using

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

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

Definitions group fflags

Reference this group by using

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

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

Definitions group cxxflags

Reference this group by using

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

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

Definitions group ldflags

Reference this group by using

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

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

Definitions group cppflags

Reference this group by using

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

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

Definitions group pre_build

Reference this group by using

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

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

Definitions group post_build

Reference this group by using

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

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

Definitions group pre_run

Reference this group by using

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

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

Definitions group post_run

Reference this group by using

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

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

Definitions group run

Reference this group by using

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

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

Definitions group default_compiler_all

Reference this group by using

{"$ref":"compiler.schema.json#/definitions/default_compiler_all"}
Property Type Required Nullable Defined by
sbatch array Optional cannot be null compiler schema
bsub array Optional cannot be null compiler schema
cobalt array Optional cannot be null compiler schema
pbs array Optional cannot be null compiler schema
BB array Optional cannot be null compiler schema
DW array Optional cannot be null compiler schema
env object Optional cannot be null compiler schema
vars object Optional cannot be null compiler schema
status object Optional cannot be null compiler schema
pre_build string Optional cannot be null compiler schema
post_build string Optional cannot be null compiler schema
pre_run string Optional cannot be null compiler schema
post_run string Optional cannot be null compiler schema
run string Optional cannot be null compiler schema

sbatch

This field is used for specifying #SBATCH options in test script.

sbatch

sbatch Type

string[]

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

bsub

This field is used for specifying #BSUB options in test script.

bsub

bsub Type

string[]

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

cobalt

This field is used for specifying #COBALT options in test script.

cobalt

cobalt Type

string[]

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

pbs

This field is used for specifying #PBS directives in test script.

pbs

pbs Type

string[]

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

BB

Create burst buffer space, this specifies #BB options in your test.

BB

BB Type

string[]

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

DW

Specify Data Warp option (#DW) when using burst buffer.

DW

DW Type

string[]

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

env

One or more key value pairs for an environment (key=value)

env

env Type

object (Details)

env Constraints

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

vars

One or more key value pairs for an environment (key=value)

vars

vars Type

object (Details)

vars Constraints

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

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.

status

status Type

object (Details)

pre_build

Run commands before building program

pre_build

pre_build Type

string

post_build

Run commands after building program

post_build

post_build Type

string

pre_run

Run commands before running program

pre_run

pre_run Type

string

post_run

Run commands after running program

post_run

post_run Type

string

run

Run command for launching compiled binary

run

run Type

string

Definitions group default_compiler_config

Reference this group by using

{"$ref":"compiler.schema.json#/definitions/default_compiler_config"}
Property Type Required Nullable Defined by
cc string Optional cannot be null compiler schema
fc string Optional cannot be null compiler schema
cxx string Optional cannot be null compiler schema
cflags string Optional cannot be null compiler schema
fflags string Optional cannot be null compiler schema
cxxflags string Optional cannot be null compiler schema
ldflags string Optional cannot be null compiler schema
cppflags string Optional cannot be null compiler schema
sbatch array Optional cannot be null compiler schema
bsub array Optional cannot be null compiler schema
cobalt array Optional cannot be null compiler schema
pbs array Optional cannot be null compiler schema
BB array Optional cannot be null compiler schema
DW array Optional cannot be null compiler schema
env object Optional cannot be null compiler schema
vars object Optional cannot be null compiler schema
status object Optional cannot be null compiler schema
pre_build string Optional cannot be null compiler schema
post_build string Optional cannot be null compiler schema
pre_run string Optional cannot be null compiler schema
post_run string Optional cannot be null compiler schema
run string Optional cannot be null compiler schema

cc

Set C compiler wrapper

cc

cc Type

string

fc

Set Fortran compiler wrapper

fc

fc Type

string

cxx

Set C++ compiler wrapper

cxx

cxx Type

string

cflags

Set C compiler flags.

cflags

cflags Type

string

fflags

Set Fortran compiler flags.

fflags

fflags Type

string

cxxflags

Set C++ compiler flags.

cxxflags

cxxflags Type

string

ldflags

Set linker flags

ldflags

ldflags Type

string

cppflags

Set C or C++ preprocessor flags

cppflags

cppflags Type

string

sbatch

This field is used for specifying #SBATCH options in test script.

sbatch

sbatch Type

string[]

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

bsub

This field is used for specifying #BSUB options in test script.

bsub

bsub Type

string[]

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

cobalt

This field is used for specifying #COBALT options in test script.

cobalt

cobalt Type

string[]

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

pbs

This field is used for specifying #PBS directives in test script.

pbs

pbs Type

string[]

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

BB

Create burst buffer space, this specifies #BB options in your test.

BB

BB Type

string[]

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

DW

Specify Data Warp option (#DW) when using burst buffer.

DW

DW Type

string[]

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

env

One or more key value pairs for an environment (key=value)

env

env Type

object (Details)

env Constraints

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

vars

One or more key value pairs for an environment (key=value)

vars

vars Type

object (Details)

vars Constraints

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

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.

status

status Type

object (Details)

pre_build

Run commands before building program

pre_build

pre_build Type

string

post_build

Run commands after building program

post_build

post_build Type

string

pre_run

Run commands before running program

pre_run

pre_run Type

string

post_run

Run commands after running program

post_run

post_run Type

string

run

Run command for launching compiled binary

run

run Type

string

Definitions group compiler_declaration

Reference this group by using

{"$ref":"compiler.schema.json#/definitions/compiler_declaration"}
Property Type Required Nullable Defined by
cc string Optional cannot be null compiler schema
fc string Optional cannot be null compiler schema
cxx string Optional cannot be null compiler schema
cflags string Optional cannot be null compiler schema
fflags string Optional cannot be null compiler schema
cxxflags string Optional cannot be null compiler schema
ldflags string Optional cannot be null compiler schema
cppflags string Optional cannot be null compiler schema
sbatch array Optional cannot be null compiler schema
bsub array Optional cannot be null compiler schema
cobalt array Optional cannot be null compiler schema
pbs array Optional cannot be null compiler schema
BB array Optional cannot be null compiler schema
DW array Optional cannot be null compiler schema
env object Optional cannot be null compiler schema
vars object Optional cannot be null compiler schema
status object Optional cannot be null compiler schema
pre_build string Optional cannot be null compiler schema
post_build string Optional cannot be null compiler schema
pre_run string Optional cannot be null compiler schema
post_run string Optional cannot be null compiler schema
run string Optional cannot be null compiler schema
module object Optional cannot be null compiler schema

cc

Set C compiler wrapper

cc

cc Type

string

fc

Set Fortran compiler wrapper

fc

fc Type

string

cxx

Set C++ compiler wrapper

cxx

cxx Type

string

cflags

Set C compiler flags.

cflags

cflags Type

string

fflags

Set Fortran compiler flags.

fflags

fflags Type

string

cxxflags

Set C++ compiler flags.

cxxflags

cxxflags Type

string

ldflags

Set linker flags

ldflags

ldflags Type

string

cppflags

Set C or C++ preprocessor flags

cppflags

cppflags Type

string

sbatch

This field is used for specifying #SBATCH options in test script.

sbatch

sbatch Type

string[]

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

bsub

This field is used for specifying #BSUB options in test script.

bsub

bsub Type

string[]

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

cobalt

This field is used for specifying #COBALT options in test script.

cobalt

cobalt Type

string[]

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

pbs

This field is used for specifying #PBS directives in test script.

pbs

pbs Type

string[]

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

BB

Create burst buffer space, this specifies #BB options in your test.

BB

BB Type

string[]

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

DW

Specify Data Warp option (#DW) when using burst buffer.

DW

DW Type

string[]

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

env

One or more key value pairs for an environment (key=value)

env

env Type

object (Details)

env Constraints

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

vars

One or more key value pairs for an environment (key=value)

vars

vars Type

object (Details)

vars Constraints

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

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.

status

status Type

object (Details)

pre_build

Run commands before building program

pre_build

pre_build Type

string

post_build

Run commands after building program

post_build

post_build Type

string

pre_run

Run commands before running program

pre_run

pre_run Type

string

post_run

Run commands after running program

post_run

post_run Type

string

run

Run command for launching compiled binary

run

run Type

string

module

module

module Type

object (Details)