definitions.schema.json

{
  "$id": "definitions.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON Schema Definitions File. ",
  "description": "This file is used for declaring definitions that are referenced from other schemas",
  "definitions": {
    "list_of_strings": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "type": "string"
      }
    },
    "string_or_list": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/definitions/list_of_strings"
        }
      ]
    },
    "list_of_ints": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "type": "integer"
      }
    },
    "list_of_positive_integers": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "items": {
        "type": "integer",
        "minimum": 1
      }
    },
    "int_or_list": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "$ref": "#/definitions/list_of_ints"
        }
      ]
    },
    "file": {
      "type": "string",
      "description": "Specify a file name to read"
    },
    "file_regex": {
      "type": "array",
      "description": "Specify a list of regular expressions to match files in the current working directory. The regular expression is matched using ``re.search`` python module. ",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "file",
          "exp"
        ],
        "properties": {
          "file": {
            "$ref": "#/definitions/file"
          },
          "exp": {
            "type": "string",
            "description": "Specify a regular expression to run on the selected file name"
          },
          "item": {
            "type": "integer",
            "minimum": 0,
            "description": "Specify the item number used to index element in `match.group() <https://docs.python.org/3/library/re.html#match-objects>`_"
          },
          "re": {
            "type": "string",
            "description": "Specify the regular expression type, it can be either re.search, re.match, or re.fullmatch. By default it uses re.search",
            "enum": [
                "re.search",
                "re.match",
                "re.fullmatch"
            ]
          }
        }
      }
    },
    "file_regex_in_metrics": {
      "type": "object",
      "additionalProperties": false,
      "description": "Specify a regular expressions on a filepath used for assigning value to metrics. The regular expression is matched using ``re.search`` python module. ",
      "required": [
        "file",
        "exp"
      ],
      "properties": {
        "additionalProperties": false,
        "file": {
          "$ref": "#/definitions/file"
        },
        "exp": {
          "type": "string",
          "description": "Specify a regular expression to run on the selected file name"
        },
        "item": {
          "type": "integer",
          "minimum": 0,
          "description": "Specify the item number used to index element in `match.group() <https://docs.python.org/3/library/re.html#match-objects>`_"
        },
        "linenum": {
          "type": "integer",
          "description": "Specify the line number used to extract from the file content where regex is applied"
        },
        "re": {
          "type": "string",
          "description": "Specify the regular expression type, it can be either re.search, re.match, or re.fullmatch. By default it uses re.search",
          "enum": [
              "re.search",
              "re.match",
              "re.fullmatch"
          ]
        }
      }
    },
    "regex": {
      "type": "object",
      "additionalProperties": false,
      "description": "Perform regular expression search using ``re.search`` python module on stdout/stderr stream for reporting if test ``PASS``. ",
      "required": [
        "exp",
        "stream"
      ],
      "properties": {
        "stream": {
          "type": "string",
          "enum": [
            "stdout",
            "stderr"
          ],
          "description": "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"
        },
        "exp": {
          "type": "string",
          "description": "Specify a regular expression to run with input stream specified by ``stream`` field. buildtest uses re.search when performing regex"
        },
        "item": {
          "type": "integer",
          "minimum": 0,
          "description": "Specify the item number used to index element in `match.group() <https://docs.python.org/3/library/re.html#match-objects>`_"
        },
        "linenum": {
          "type": "integer",
          "description": "Specify the line number used to extract from the content where regex is applied"
        },
        "re": {
          "type": "string",
          "description": "Specify the regular expression type, it can be either re.search, re.match, or re.fullmatch. By default it uses re.search",
          "enum": [
              "re.search",
              "re.match",
              "re.fullmatch"
          ]
        }
      }
    },
    "env": {
      "type": "object",
      "description": "One or more key value pairs for an environment (key=value)",
      "minItems": 1,
      "items": {
        "type": "object",
        "minItems": 1,
        "propertyNames": {
          "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
        }
      }
    },
    "description": {
      "type": "string",
      "description": "The ``description`` field is used to document what the test is doing",
      "maxLength": 80
    },
    "summary": {
      "type": "string",
      "description": "The ``summary`` field is used to document what the test is doing and can be a multi-line string"
    },
    "tags": {
      "description": "Classify tests using a tag name, this can be used for categorizing test and building tests using ``--tags`` option",
      "$ref": "#/definitions/string_or_list"
    },
    "skip": {
      "type": "boolean",
      "description": "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."
    },
    "executor": {
      "type": "string",
      "description": "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. "
    },
    "needs": {
      "description": "A list of test names that are dependency before runnning job",
      "type": "array",
      "items": [
        {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "patternProperties": {
                "^.*$": {
                  "additionalProperties": false,
                  "properties": {
                    "state": {
                      "$ref": "#/definitions/state"
                    },
                    "returncode": {
                      "$ref": "#/definitions/returncode"
                    }
                  }
                }
              }
            }
          ]
        }
      ]
    },
    "metrics_field": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Specify python data-type (str, int, float) to convert metric. ",
          "enum": [
            "str",
            "int",
            "float"
          ]
        },
        "regex": {
          "$ref": "#/definitions/regex"
        },
        "file_regex": {
          "$ref": "#/definitions/file_regex_in_metrics"
        }
      },
      "oneOf": [
        {
          "required": [
            "regex"
          ]
        },
        {
          "required": [
            "file_regex"
          ]
        }
      ]
    },
    "metrics": {
      "type": "object",
      "description": "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.",
      "propertyNames": {
        "pattern": "^[A-Za-z0-9_.-]+$"
      },
      "additionalProperties": {
        "$ref": "#/definitions/metrics_field"
      }
    },
    "state": {
      "type": "string",
      "description": "explicitly mark state of test regardless of status calculation",
      "enum": [
        "PASS",
        "FAIL"
      ]
    },
    "returncode": {
      "description": "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",
      "$ref": "#/definitions/int_or_list"
    },
    "status": {
      "type": "object",
      "description": "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.",
      "additionalProperties": false,
      "properties": {
        "slurm_job_state": {
          "type": "string",
          "enum": [
            "COMPLETED",
            "FAILED",
            "OUT_OF_MEMORY",
            "TIMEOUT"
          ],
          "description": "This field can be used to pass test based on Slurm Job State, if there is a match buildtest will report as ``PASS`` "
        },
        "pbs_job_state": {
          "type": "string",
          "description": "This field can be used to pass test based on PBS Job State, if there is a match buildtest will report as ``PASS`` ",
          "enum": [
            "H",
            "S",
            "F"
          ]
        },
        "lsf_job_state": {
          "type": "string",
          "description": "This field can be used to pass test based on LSF Job State, if there is a match buildtest will report as ``PASS`` ",
          "enum": [
            "DONE",
            "EXIT"
          ]
        },
        "returncode": {
          "$ref": "#/definitions/returncode"
        },
        "regex": {
          "$ref": "#/definitions/regex",
          "description": "Determine state (PASS/FAIL) of test based on regular expression on output or error stream"
        },
        "file_regex": {
          "$ref": "#/definitions/file_regex",
          "description": "Perform a regular expression search on a list of arbitrary files, if expression matches for any file buildtest will report as ``PASS``. This field is useful for checking output of a test that is not captured in stdout or stderr. "
        },
        "runtime": {
          "type": "object",
          "description": "The runtime section will pass test based on min and max values and compare with actual runtime. ",
          "properties": {
            "min": {
              "type": "number",
              "minimum": 0,
              "description": "Specify a minimum runtime in seconds. The test will PASS if actual runtime exceeds min time."
            },
            "max": {
              "type": "number",
              "minimum": 0,
              "description": "Specify a maximum runtime in seconds. The test will PASS if actual runtime is less than max time"
            }
          }
        },
        "assert_ge": {
          "description": "Perform assertion of greater and equal (>=) with reference value",
          "$ref": "#/definitions/status_check_ge_gt_le_lt"
        },
        "assert_le": {
          "description": "Perform assertion of greater and equal (>=) with reference value",
          "$ref": "#/definitions/status_check_ge_gt_le_lt"
        },
        "assert_gt": {
          "description": "Perform assertion of greater than (>) with reference value",
          "$ref": "#/definitions/status_check_ge_gt_le_lt"
        },
        "assert_lt": {
          "description": "Perform assertion of less than (<) with reference value",
          "$ref": "#/definitions/status_check_ge_gt_le_lt"
        },
        "assert_eq": {
          "description": "Perform assertion of equality (=) with reference value",
          "$ref": "#/definitions/status_check_eq_ne"
        },
        "assert_ne": {
          "description": "Perform assertion of not equal (!=) with reference value",
          "$ref": "#/definitions/status_check_eq_ne"
        },
        "assert_range": {
          "type": "object",
          "description": "Perform assertion based on lower and upper bound",
          "additionalProperties": false,
          "required": [
            "comparisons"
          ],
          "properties": {
            "mode": {
              "$ref": "#/definitions/mode"
            },
            "comparisons": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "lower",
                  "upper"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of metric to use for comparison"
                  },
                  "lower": {
                    "description": "Specify reference value for lower bound",
                    "type": "number"
                  },
                  "upper": {
                    "description": "Specify reference value for upper bound",
                    "type": "number"
                  }
                }
              }
            }
          }
        },
        "contains": {
          "description": "Check if metric value is in a list of reference values",
          "$ref": "#/definitions/status_check_contains_not_contains"
        },
        "not_contains": {
          "description": "Check if metric value not in a list of reference values ",
          "$ref": "#/definitions/status_check_contains_not_contains"
        },
        "is_symlink": {
          "description": "Check for list of files or directory paths that are symbolic links",
          "$ref": "#/definitions/list_of_strings"
        },
        "exists": {
          "description": "Check for list of file or directory path for existences using os.path.exists",
          "$ref": "#/definitions/list_of_strings"
        },
        "is_dir": {
          "description": "Check for list of filepaths are directories",
          "$ref": "#/definitions/list_of_strings"
        },
        "is_file": {
          "description": "Check for list of filepaths are files",
          "$ref": "#/definitions/list_of_strings"
        },
        "file_count": {
          "description": "Perform assertion check by comparing file count in a directory",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dir",
              "count"
            ],
            "properties": {
              "dir": {
                "type": "string",
                "description": "Directory path to check for file count"
              },
              "count": {
                "type": "integer",
                "description": "Number of files expected in directory",
                "minimum": 0
              },
              "depth": {
                "type": "integer",
                "description": "Depth of directory to search for files",
                "minimum": 0
              },
              "ext": {
                "$ref": "#/definitions/string_or_list",
                "description": "File extension to filter files in directory"
              },
              "filepattern": {
                "type": "string",
                "description": "Specify a regular expression when searching for files in directory"
              },
              "filetype": {
                "type": "string",
                "description": "Specify file type when searching for files in directory. It can be 'file', 'dir' or 'symlink'",
                "enum": [
                  "file",
                  "dir",
                  "symlink"
                ]
              },
              "file_traverse_limit": {
                "type": "integer",
                "description": "Limit the number of files to traverse when searching for files in directory",
                "minimum": 1,
                "default": 10000,
                "maximum": 999999
              }
            }
          }
        },
        "state": {
          "$ref": "#/definitions/state",
          "description": "explicitly mark state of test regardless of status calculation"
        },
        "mode": {
          "$ref": "#/definitions/mode"
        },
        "linecount": {
          "type": "object",
          "description": "Check for number of lines in stdout or stderr stream. If linecount is set, buildtest will check for number of lines in stdout or stderr stream and compare with linecount. If linecount matches buildtest will report as ``PASS``",
          "additionalProperties": false,
          "required": [
            "stream",
            "count"
          ],
          "properties": {
            "stream": {
              "type": "string",
              "enum": [
                "stdout",
                "stderr"
              ],
              "description": "The stream field can be stdout or stderr. buildtest will read the output or error stream after completion of test and check if linecount matches"
            },
            "count": {
              "type": "integer",
              "description": "Specify number of lines as reference value to compare with actual output",
              "minimum": 0
            }
          }
        },
        "file_linecount": {
          "type": "array",
          "description": "Specify a list of files to perform line count comparison by reading the file and comparing the line count with reference value",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "file",
              "count"
            ],
            "properties": {
              "file": {
                "$ref": "#/definitions/file"
              },
              "count": {
                "type": "integer",
                "description": "Specify number of lines as reference value to compare with actual output",
                "minimum": 0
              }
            }
          }
        }
      }
    },
    "status_check_ge_gt_le_lt": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "comparisons"
      ],
      "properties": {
        "mode": {
          "$ref": "#/definitions/mode"
        },
        "comparisons": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "ref"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of metric to use for comparison"
              },
              "ref": {
                "type": "number",
                "description": "Specify reference value (int,float) for comparison"
              }
            }
          }
        }
      }
    },
    "status_check_eq_ne": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "comparisons"
      ],
      "properties": {
        "mode": {
          "$ref": "#/definitions/mode"
        },
        "comparisons": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "ref"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of metric to use for comparison"
              },
              "ref": {
                "description": "Specify reference value (str, int, float) for comparison",
                "oneOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "string"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "status_check_contains_not_contains": {
      "type": "object",
      "required": [
        "comparisons"
      ],
      "additionalProperties": false,
      "properties": {
        "mode": {
          "$ref": "#/definitions/mode"
        },
        "comparisons": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "ref"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of metric to use for comparison"
              },
              "ref": {
                "type": "array",
                "minItems": 1,
                "description": "Specify a list of reference value"
              }
            }
          }
        }
      }
    },
    "mode": {
      "description": "Determine how the status check is resolved, for instance it can be logical AND or OR",
      "type": "string",
      "enum": [
        "or",
        "and",
        "OR",
        "AND"
      ]
    },
    "BB": {
      "$ref": "#/definitions/list_of_strings",
      "description": "Create burst buffer space, this specifies #BB options in your test."
    },
    "DW": {
      "$ref": "#/definitions/list_of_strings",
      "description": "Specify Data Warp option (#DW) when using burst buffer."
    },
    "sbatch": {
      "$ref": "#/definitions/list_of_strings",
      "description": "This field is used for specifying #SBATCH options in test script."
    },
    "bsub": {
      "$ref": "#/definitions/list_of_strings",
      "description": "This field is used for specifying #BSUB options in test script."
    },
    "pbs": {
      "$ref": "#/definitions/list_of_strings",
      "description": "This field is used for specifying #PBS directives in test script."
    },
    "executors": {
      "type": "object",
      "description": "Define executor specific configuration",
      "patternProperties": {
        "description": "Name of executor to override configuration",
        "^.*$": {
          "additionalProperties": false,
          "properties": {
            "env": {
              "$ref": "#/definitions/env"
            },
            "vars": {
              "$ref": "#/definitions/env"
            },
            "sbatch": {
              "$ref": "#/definitions/list_of_strings"
            },
            "bsub": {
              "$ref": "#/definitions/list_of_strings"
            },
            "pbs": {
              "$ref": "#/definitions/list_of_strings"
            },
            "BB": {
              "$ref": "#/definitions/BB"
            },
            "DW": {
              "$ref": "#/definitions/DW"
            },
            "status": {
              "$ref": "#/definitions/status"
            },
            "metrics": {
              "$ref": "#/definitions/metrics"
            }
          }
        }
      }
    },
    "cc": {
      "type": "string",
      "description": "Set C compiler wrapper"
    },
    "fc": {
      "type": "string",
      "description": "Set Fortran compiler wrapper"
    },
    "cxx": {
      "type": "string",
      "description": "Set C++ compiler wrapper"
    },
    "cflags": {
      "type": "string",
      "description": "Set C compiler flags."
    },
    "fflags": {
      "type": "string",
      "description": "Set Fortran compiler flags."
    },
    "cxxflags": {
      "type": "string",
      "description": "Set C++ compiler flags."
    },
    "ldflags": {
      "type": "string",
      "description": "Set linker flags"
    },
    "cppflags": {
      "type": "string",
      "description": "Set C or C++ preprocessor flags"
    },
    "run": {
      "type": "string",
      "description": "Specify a series of commands to run."
    },
    "module": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "purge": {
          "type": "boolean",
          "description": "Run ``module purge`` if purge is set"
        },
        "load": {
          "$ref": "definitions.schema.json#/definitions/list_of_strings",
          "description": "Load one or more modules via ``module load``"
        },
        "restore": {
          "description": "Load a collection name via ``module restore``",
          "type": "string"
        },
        "swap": {
          "description": "Swap modules using ``module swap``. The swap property expects 2 unique modules.",
          "type": "array",
          "uniqueItems": true,
          "minItems": 2,
          "maxItems": 2,
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}