Buildspec Overview

What is a buildspec?

A buildspec is a YAML file that defines your test in buildtest which is validated by schema followed by building a shell script and running the generated test. Buildtest will parse the buildspec with the global schema file which defines the top-level structure of buildspec file.

Example

Let’s start off with a simple example that declares two variables X and Y and prints the sum of X+Y.

buildspecs:
  add_numbers:
    type: script
    executor: generic.local.bash
    description: Add X+Y
    tags: [tutorials]
    vars:
      X: 1
      Y: 2
    run: echo "$X+$Y=" $(($X+$Y))

buildtest will validate the entire file with global.schema.json, the schema requires version and buildspec in order to validate file. The buildspec is where you define each test. The name of the test is add_numbers. The test requires a type field which is the sub-schema used to validate the test section. In this example type: script informs buildtest to use the Script Schema when validating test section.

Each subschema has a list of field attributes that are supported, for example the fields: type, executor, vars and run are all valid fields supported by the script schema.

Let’s look at a more interesting example, shown below is a multi line run example using the script schema with test name called systemd_default_target, shown below is the content of test:

buildspecs:
  systemd_default_target:
    executor: generic.local.bash
    type: script
    tags: [system]
    description: check if default target is multi-user.target
    run: |
      if [ "multi-user.target" == `systemctl get-default` ]; then
        echo "multi-user is the default target";
        exit 0
      fi
      echo "multi-user is not the default target";
      exit 1

The test name systemd_default_target defined in buildspec section is validated with the following pattern "^[A-Za-z_][A-Za-z0-9_]*$". This test will use the executor generic.local.bash which means it will use the Local Executor with an executor name bash defined in the buildtest settings. The default buildtest settings will provide a bash executor as follows:

system:
  generic:
    hostnames: ["localhost"]
    executors:
      local:
        bash:
          description: submit jobs on local machine using bash shell
          shell: bash

The shell: bash indicates this executor will use bash to run the test scripts. To reference this executor use the format <system>.<type>.<name> in this case generic.local.bash refers to bash executor.

The description field is an optional key that can be used to provide a brief summary of the test. The description field is limited to 80 characters. In this example we can specify multiple commands in run section, this can be done in YAML using run: | followed by content of run section tab indented 2 spaces.

In this next example, we introduce the summary field, which can be used as an extended description of test. It has no impact on the test. Unlike the description field, the summary field has no limit on character count and one can define multi-line string using the pipe symbol |.

buildspecs:
  summary_example:
    type: script
    executor: generic.local.bash
    description: The summary field can be a multi-line string and exceed 80 char
    tags: [tutorials]
    summary: |
      This is a long description of test that
      can exceed 80 characters and be multiline
    run: hostname

Script Schema

The script schema is used for writing simple scripts (bash, sh, python) in Buildspec. To use this schema you must set type: script. The run field is responsible for writing the content of test.

Shown below is schema header for script.schema.json.

{
  "$id": "script.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "script schema version",
  "description": "The script schema is of ``type: script`` in sub-schema which is used for running shell scripts",
  "type": "object",
  "required": [
    "type",

The "type": "object" means sub-schema is a JSON object where we define a list of key/value pair. The "required" field specifies a list of fields that must be specified in order to validate the Buildspec. In this example, type, run, and executor are required fields. The additionalProperties: false informs schema to reject any extra properties not defined in the schema.

The executor key is required for all sub-schemas which instructs buildtest which executor to use when running the test. The executors are defined in How to configure buildtest. In our first example we define variables using the vars property which is a Key/Value pair for variable assignment. The run section is required for script schema which defines the content of the test script.

For more details on script schema see schema docs at https://buildtesters.github.io/buildtest/

Declaring Environment Variables

You can define environment variables using the env property, this is compatible with shells: bash, sh, zsh, csh and tcsh. It does not work with shell: python. In example below we declare three tests using environment variable with default shell (bash), csh, and tcsh

buildspecs:
  bash_env_variables:
    executor: generic.local.bash
    description: Declare environment variables in default shell (bash)
    type: script
    env:
      FIRST_NAME: avocado
      LAST_NAME: dinosaur
    tags: [tutorials]
    run: |
      hostname
      whoami
      echo $USER
      printf "${FIRST_NAME} ${LAST_NAME}\n"

  csh_env_declaration:
    executor: generic.local.csh
    type: script
    description: "csh shell example to declare environment variables"
    shell: /bin/csh
    tags: [tutorials]
    env:
      SHELL_NAME: "csh"
    run: echo "This is running $SHELL_NAME"

  tcsh_env_declaration:
    executor: generic.local.csh
    type: script
    description: "tcsh shell example to declare environment variables"
    shell: /bin/tcsh
    tags: [tutorials]
    env:
      path: "/usr/local/bin:$PATH"
    run: echo $path

This test can be run by issuing the following command: buildtest build -b tutorials/environment.yml. If we inspect one of the test script we will see that buildtest generates a build script that invokes the test using the shell wrapper /bin/csh for the csh test and gets the returncode.

#!/bin/bash


############# START VARIABLE DECLARATION ########################
export BUILDTEST_TEST_NAME=csh_env_declaration
export BUILDTEST_TEST_ROOT=/Users/siddiq90/Documents/GitHubDesktop/buildtest/var/tests/generic.local.csh/environment/csh_env_declaration/0
export BUILDTEST_BUILDSPEC_DIR=/Users/siddiq90/Documents/GitHubDesktop/buildtest/tutorials
export BUILDTEST_STAGE_DIR=/Users/siddiq90/Documents/GitHubDesktop/buildtest/var/tests/generic.local.csh/environment/csh_env_declaration/0/stage
export BUILDTEST_TEST_ID=501ec5d3-e614-4ae8-9c1e-4849ce340c76
############# END VARIABLE DECLARATION   ########################


# source executor startup script
source /Users/siddiq90/Documents/GitHubDesktop/buildtest/var/executor/generic.local.csh/before_script.sh
# Run generated script
/bin/csh /Users/siddiq90/Documents/GitHubDesktop/buildtest/var/tests/generic.local.csh/environment/csh_env_declaration/0/stage/csh_env_declaration.csh
# Get return code
returncode=$?
# Exit with return code
exit $returncode

This generated test looks something like this

#!/bin/csh
# Declare environment variables
setenv SHELL_NAME csh


# Content of run section
echo "This is running $SHELL_NAME"

Environment variables are defined using export in bash, sh, zsh while csh and tcsh use setenv.

Declaring Variables

Variables can be defined using vars property, this is compatible with all shells except for python. The variables are defined slightly different in csh, tcsh as pose to bash, sh, and zsh. In example below we define tests with bash and csh.

In YAML strings can be specified with or without quotes however in bash, variables need to be enclosed in quotes " if you are defining a multi word string (name="First Last").

If you need define a literal string it is recommended to use the literal block | that is a special character in YAML. If you want to specify " or ' in string you can use the escape character \ followed by any of the special character. In example below we define several variables such as X, Y that contain numbers, variable literalstring is a literal string processed by YAML. The variable singlequote and doublequote defines a variable with the special character ' and ". The variables current_user and num_files store result of a shell command. This can be done using var=$(<command>) or var=`<command>` where <command> is a Linux command.

buildspecs:
  variables_bash:
    type: script
    executor: generic.local.bash
    description: Declare shell variables in bash
    tags: [tutorials]
    vars:
      X: 1
      Y: 2
      literalstring: this is a literal string
      singlequote: \'singlequote\'
      doublequote: \"doublequote\"
      current_user: "$(whoami)"
      num_files: "`find $HOME -type f -maxdepth 1 | wc -l`"
      multiline_string: |
        Hello my name is Bob \n
        I am 30 years old


    run: |
      echo "$X+$Y="$(($X+$Y))
      echo $literalstring
      echo $singlequote
      echo $doublequote
      echo "current user:" $current_user
      echo "number of files:" $num_files
      echo -e $multiline_string

Next we build this test by running buildtest build -b $BUILDTEST_ROOT/tutorials/vars.yml.

buildtest build -b $BUILDTEST_ROOT/tutorials/vars.yml
$ buildtest build -b $BUILDTEST_ROOT/tutorials/vars.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:28                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/vars.yml: VALID
Total builder objects created: 1
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ variabl… │ script │ generic… │ None     │ None  │ None  │ Declare  │ /home/… │
│          │        │          │          │       │       │ shell    │         │
│          │        │          │          │       │       │ variabl… │         │
│          │        │          │          │       │       │ in bash  │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
variables_bash/18d256ca: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca
variables_bash/18d256ca: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/stage
variables_bash/18d256ca: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
variables_bash/18d256ca does not have any dependencies adding test to queue
variables_bash/18d256ca: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/stage
variables_bash/18d256ca: Running Test via command: bash --norc --noprofile -eo pipefail variables_bash_build.sh
variables_bash/18d256ca: Test completed in 0.009927 seconds
variables_bash/18d256ca: Test completed with returncode: 0
variables_bash/18d256ca: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash.out
variables_bash/18d256ca: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash.err
In this iteration we are going to run the following tests: [variables_bash/18d256ca]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ variables_ba │ generic.loc… │ PASS   │ N/A N/A N/A   │ 0          │ 0.009927 │
│ sh/18d256ca  │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%


Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_1e606gdy.log

Let’s check the generated script from the previous build, you can run buildtest inspect query -o variables_bash where -o refers to output file for testname variables_bash. Take note of the output file we

buildtest inspect query -o variables_bash
$ buildtest inspect query -o variables_bash
───────────── variables_bash/18d256ca-9c4b-45dc-900b-0d07019f070b ──────────────
Executor: generic.local.bash
Description: Declare shell variables in bash
State: PASS
Returncode: 0
Runtime: 0.009927 sec
Starttime: 2023/01/06 20:00:28
Endtime: 2023/01/06 20:00:28
Command: bash --norc --noprofile -eo pipefail variables_bash_build.sh
Test Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash.sh
Build Script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash_build.sh
Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash.out
Error File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/vars/variables_bash/18d256ca/variables_bash.err
Log File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_1e606gdy.log
─ Output File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/che… ─
1+2=3                                                                           
this is a literal string                                                        
\'singlequote\'                                                                 
"doublequote"                                                                   
current user: docs                                                              
number of files: 4                                                              
Hello my name is Bob                                                            
 I am 30 years old

Defining Tags

The tags field can be used to classify tests which can be used to organize tests or if you want to Building By Tags (buildtest build --tags <TAGNAME>). Tags can be defined as a string or list of strings. In this example, the test string_tag defines a tag name network while test list_of_strings_tags define a list of tags named network and ping.

buildspecs:
  string_tag:
    type: script
    executor: generic.local.bash
    description: tags can be a string
    tags: network
    run: hostname

  list_of_strings_tags:
    type: script
    executor: generic.local.bash
    description: tags can be a list of strings
    tags: [network, ping]
    run: ping -c 4 www.google.com

Each item in tags must be a string and no duplicates are allowed, for example in this test, we define a duplicate tag network which is not allowed.

buildspecs:
  duplicate_string_tags:
    type: script
    executor: generic.local.bash
    description: duplicate strings in tags list is not allowed
    tags: [network, network]
    run: hostname

If tags is a list, it must contain atleast one item.

Test Status

buildtest will record state of each test which can be PASS or FAIL. By default a 0 exit code is PASS and everything else is a FAIL. The status property can be used to determine how test will report its state. Currently, we can match state based on the following:

Return Code Matching

buildtest can report PASS/FAIL based on returncode, by default a 0 exit code is PASS and everything else is FAIL. The returncode can be a list of exit codes to match. In this example we have four tests called exit1_fail, exit1_pass, returncode_list_mismatch and returncode_int_match. We expect exit1_fail and returncode_mismatch to FAIL while exit1_pass and returncode_int_match will PASS.

buildspecs:

  exit1_fail:
    executor: generic.local.bash
    type: script
    description: exit 1 by default is FAIL
    tags: [tutorials, fail]
    run: exit 1

  exit1_pass:
    executor: generic.local.bash
    type: script
    description: report exit 1 as PASS
    run: exit 1
    tags: [tutorials, pass]
    status:
      returncode: [1]

  returncode_list_mismatch:
    executor: generic.local.bash
    type: script
    description: exit 2 failed since it failed to match returncode 1
    run: exit 2
    tags: [tutorials, fail]
    status:
      returncode: [1, 3]

  returncode_int_match:
    executor: generic.local.bash
    type: script
    description: exit 128 matches returncode 128
    run: exit 128
    tags: [tutorials, pass]
    status:
      returncode: 128

Let’s build this test and pay close attention to the status column in output.

buildtest build -b tutorials/test_status/pass_returncode.yml
$ buildtest build -b tutorials/test_status/pass_returncode.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:30                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/pass_returncode.yml: VALID
Total builder objects created: 4
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ exit1_f… │ script │ generic… │ None     │ None  │ None  │ exit 1   │ /home/… │
│          │        │          │          │       │       │ by       │         │
│          │        │          │          │       │       │ default  │         │
│          │        │          │          │       │       │ is FAIL  │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ exit1_p… │ script │ generic… │ None     │ None  │ None  │ report   │ /home/… │
│          │        │          │          │       │       │ exit 1   │         │
│          │        │          │          │       │       │ as PASS  │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ returnc… │ script │ generic… │ None     │ None  │ None  │ exit 2   │ /home/… │
│          │        │          │          │       │       │ failed   │         │
│          │        │          │          │       │       │ since it │         │
│          │        │          │          │       │       │ failed   │         │
│          │        │          │          │       │       │ to match │         │
│          │        │          │          │       │       │ returnc… │         │
│          │        │          │          │       │       │ 1        │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ returnc… │ script │ generic… │ None     │ None  │ None  │ exit 128 │ /home/… │
│          │        │          │          │       │       │ matches  │         │
│          │        │          │          │       │       │ returnc… │         │
│          │        │          │          │       │       │ 128      │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
exit1_fail/dd5620cd: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd
exit1_fail/dd5620cd: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd/stage
exit1_fail/dd5620cd: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd/exit1_fail_build.sh
exit1_pass/534865c9: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9
exit1_pass/534865c9: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9/stage
exit1_pass/534865c9: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9/exit1_pass_build.sh
returncode_list_mismatch/259a982e: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e
returncode_list_mismatch/259a982e: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e/stage
returncode_list_mismatch/259a982e: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e/returncode_list_mismatch_build.sh
returncode_int_match/03db6760: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760
returncode_int_match/03db6760: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760/stage
returncode_int_match/03db6760: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760/returncode_int_match_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
returncode_int_match/03db6760 does not have any dependencies adding test to queue
returncode_list_mismatch/259a982e does not have any dependencies adding test to queue
exit1_pass/534865c9 does not have any dependencies adding test to queue
exit1_fail/dd5620cd does not have any dependencies adding test to queue
returncode_int_match/03db6760: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760/stage
returncode_int_match/03db6760: Running Test via command: bash --norc --noprofile -eo pipefail returncode_int_match_build.sh
returncode_int_match/03db6760: Test completed in 0.005461 seconds
returncode_int_match/03db6760: Test completed with returncode: 128
returncode_int_match/03db6760: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760/returncode_int_match.out
returncode_int_match/03db6760: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_int_match/03db6760/returncode_int_match.err
returncode_int_match/03db6760: Checking returncode - 128 is matched in list [128]
exit1_pass/534865c9: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9/stage
exit1_pass/534865c9: Running Test via command: bash --norc --noprofile -eo pipefail exit1_pass_build.sh
exit1_pass/534865c9: Test completed in 0.005415 seconds
exit1_pass/534865c9: Test completed with returncode: 1
exit1_pass/534865c9: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9/exit1_pass.out
exit1_pass/534865c9: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_pass/534865c9/exit1_pass.err
exit1_pass/534865c9: Checking returncode - 1 is matched in list [1]
exit1_fail/dd5620cd: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd/stage
exit1_fail/dd5620cd: Running Test via command: bash --norc --noprofile -eo pipefail exit1_fail_build.sh
exit1_fail/dd5620cd: Test completed in 0.005202 seconds
exit1_fail/dd5620cd: Test completed with returncode: 1
exit1_fail/dd5620cd: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd/exit1_fail.out
exit1_fail/dd5620cd: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/exit1_fail/dd5620cd/exit1_fail.err
returncode_list_mismatch/259a982e: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e/stage
returncode_list_mismatch/259a982e: Running Test via command: bash --norc --noprofile -eo pipefail returncode_list_mismatch_build.sh
returncode_list_mismatch/259a982e: Test completed in 0.005246 seconds
returncode_list_mismatch/259a982e: Test completed with returncode: 2
returncode_list_mismatch/259a982e: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e/returncode_list_mismatch.out
returncode_list_mismatch/259a982e: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/pass_returncode/returncode_list_mismatch/259a982e/returncode_list_mismatch.err
returncode_list_mismatch/259a982e: Checking returncode - 2 is matched in list [1, 3]
In this iteration we are going to run the following tests: [returncode_int_match/03db6760, exit1_pass/534865c9, exit1_fail/dd5620cd, returncode_list_mismatch/259a982e]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ returncode_l │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.005246 │
│ ist_mismatch │              │        │ False         │            │          │
│ /259a982e    │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ exit1_pass/5 │ generic.loc… │ PASS   │ True False    │ 1          │ 0.005415 │
│ 34865c9      │              │        │ False         │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ returncode_i │ generic.loc… │ PASS   │ True False    │ 128        │ 0.005461 │
│ nt_match/03d │              │        │ False         │            │          │
│ b6760        │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ exit1_fail/d │ generic.loc… │ FAIL   │ N/A N/A N/A   │ 1          │ 0.005202 │
│ d5620cd      │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 2/4 Percentage: 50.000%
Failed Tests: 2/4 Percentage: 50.000%


Adding 4 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_63cnh6ob.log

The returncode field can be an integer or list of integers but it may not accept duplicate values. If you specify a list of exit codes, buildtest will check actual returncode with list of expected returncodes specified by returncode field.

Shown below are examples of invalid returncodes:

# empty list is not allowed
returncode: []

# floating point is not accepted in list
returncode: [1, 1.5]

# floating point not accepted
returncode: 1.5

# duplicates are not allowed
returncode: [1, 2, 5, 5]

Passing Test based on regular expression

buildtest can configure PASS/FAIL of test based on regular expression on output or error file. This can be useful if you are expecting a certain output from the test as pose to returncode check.

In this example we introduce, the regex field which is part of status that expects a regular expression via exp. The stream property must be stdout or stderr which indicates buildtest will read output or error file and apply regular expression. If there is a match, buildtest will record the test state as PASS otherwise it will be a FAIL. In this example, we have two tests that will apply regular expression on output file.

buildspecs:
  status_regex_pass:
    executor: generic.local.bash
    type: script
    tags: [system]
    description: Pass test based on regular expression
    run: echo "PASS"
    status:
      regex:
        stream: stdout
        exp: "^(PASS)$"

  status_regex_fail:
    executor: generic.local.bash
    type: script
    tags: [system]
    description: Pass test based on regular expression
    run: echo "FAIL"
    status:
      regex:
        stream: stdout
        exp: "^(123FAIL)$"

Now if we run this test, we will see first test will pass while second one will fail even though the returncode is a 0. Take a close look at the status property

buildtest build -b tutorials/test_status/status_regex.yml
$ buildtest build -b tutorials/test_status/status_regex.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:30                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/status_regex.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ status_… │ script │ generic… │ None     │ None  │ None  │ Pass     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ based on │         │
│          │        │          │          │       │       │ regular  │         │
│          │        │          │          │       │       │ express… │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ status_… │ script │ generic… │ None     │ None  │ None  │ Pass     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ based on │         │
│          │        │          │          │       │       │ regular  │         │
│          │        │          │          │       │       │ express… │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
status_regex_pass/5bd0b90e: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e
status_regex_pass/5bd0b90e: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/stage
status_regex_pass/5bd0b90e: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/status_regex_pass_build.sh
status_regex_fail/5022750e: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e
status_regex_fail/5022750e: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/stage
status_regex_fail/5022750e: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/status_regex_fail_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
status_regex_pass/5bd0b90e does not have any dependencies adding test to queue
status_regex_fail/5022750e does not have any dependencies adding test to queue
status_regex_pass/5bd0b90e: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/stage
status_regex_pass/5bd0b90e: Running Test via command: bash --norc --noprofile -eo pipefail status_regex_pass_build.sh
status_regex_pass/5bd0b90e: Test completed in 0.00547 seconds
status_regex_pass/5bd0b90e: Test completed with returncode: 0
status_regex_pass/5bd0b90e: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/status_regex_pass.out
status_regex_pass/5bd0b90e: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/status_regex_pass.err
status_regex_pass/5bd0b90e: performing regular expression - '^(PASS)$' on file: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_pass/5bd0b90e/status_regex_pass.out
status_regex_pass/5bd0b90e: Regular Expression Match - Success!
status_regex_fail/5022750e: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/stage
status_regex_fail/5022750e: Running Test via command: bash --norc --noprofile -eo pipefail status_regex_fail_build.sh
status_regex_fail/5022750e: Test completed in 0.005266 seconds
status_regex_fail/5022750e: Test completed with returncode: 0
status_regex_fail/5022750e: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/status_regex_fail.out
status_regex_fail/5022750e: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/status_regex_fail.err
status_regex_fail/5022750e: performing regular expression - '^(123FAIL)$' on file: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/status_regex/status_regex_fail/5022750e/status_regex_fail.out
status_regex_fail/5022750e: Regular Expression Match - Failed!
In this iteration we are going to run the following tests: [status_regex_pass/5bd0b90e, status_regex_fail/5022750e]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ status_regex │ generic.loc… │ PASS   │ False True    │ 0          │ 0.00547  │
│ _pass/5bd0b9 │              │        │ False         │            │          │
│ 0e           │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ status_regex │ generic.loc… │ FAIL   │ False False   │ 0          │ 0.005266 │
│ _fail/502275 │              │        │ False         │            │          │
│ 0e           │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/2 Percentage: 50.000%
Failed Tests: 1/2 Percentage: 50.000%


Adding 2 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_vyl3otlb.log

Passing Test based on runtime

buildtest can determine state of test based on runtime property which is part of status object. This can be used if you want to control how test PASS or FAIL based on execution time of test. In example below we have five tests that make use of runtime property for passing a test. The runtime property support min and max property that can mark test pass based on minimum and maximum runtime. A test will pass if it’s execution time is greater than min time and less than max time. If min is specified without max property the upperbound is not set, likewise max without min will pass if test is less than max time. The lower bound is not set, but test runtime will be greater than 0 sec.

In test timelimit_min, we sleep for 2 seconds and it will pass because minimum runtime is 1.0 seconds. Similarly, timelimit_max will pass because we sleep for 2 seconds with a max time of 5.0.

buildspecs:
  timelimit_min_max:
    type: script
    executor: generic.local.sh
    description: "Run a sleep job for 2 seconds and test pass if its within 1.0-3.0sec"
    tags: ["tutorials"]
    run: sleep 2
    status:
      runtime:
        min: 1.0
        max: 3.0

  timelimit_min:
    type: script
    executor: generic.local.sh
    description: "Run a sleep job for 2 seconds and test pass if its exceeds min time of 1.0 sec"
    tags: ["tutorials"]
    run: sleep 2
    status:
      runtime:
        min: 1.0

  timelimit_max:
    type: script
    executor: generic.local.sh
    description: "Run a sleep job for 2 seconds and test pass if it's within max time: 5.0 sec"
    tags: ["tutorials"]
    run: sleep 2
    status:
      runtime:
        max: 5.0

  timelimit_min_fail:
    type: script
    executor: generic.local.sh
    description: "This test fails because it runs less than mintime of 10 second"
    tags: ["tutorials"]
    run: sleep 2
    status:
      runtime:
        min: 10.0

  timelimit_max_fail:
    type: script
    executor: generic.local.sh
    description: "This test fails because it exceeds maxtime of 1.0 second"
    tags: ["tutorials"]
    run: sleep 3
    status:
      runtime:
        max: 1.0
buildtest build -b tutorials/test_status/runtime_status_test.yml
$ buildtest build -b tutorials/test_status/runtime_status_test.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:31                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/runtime_status_test.yml: VALID
Total builder objects created: 5
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ timelim… │ script │ generic… │ None     │ None  │ None  │ Run a    │ /home/… │
│          │        │          │          │       │       │ sleep    │         │
│          │        │          │          │       │       │ job for  │         │
│          │        │          │          │       │       │ 2        │         │
│          │        │          │          │       │       │ seconds  │         │
│          │        │          │          │       │       │ and test │         │
│          │        │          │          │       │       │ pass if  │         │
│          │        │          │          │       │       │ its      │         │
│          │        │          │          │       │       │ within   │         │
│          │        │          │          │       │       │ 1.0-3.0… │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ timelim… │ script │ generic… │ None     │ None  │ None  │ Run a    │ /home/… │
│          │        │          │          │       │       │ sleep    │         │
│          │        │          │          │       │       │ job for  │         │
│          │        │          │          │       │       │ 2        │         │
│          │        │          │          │       │       │ seconds  │         │
│          │        │          │          │       │       │ and test │         │
│          │        │          │          │       │       │ pass if  │         │
│          │        │          │          │       │       │ its      │         │
│          │        │          │          │       │       │ exceeds  │         │
│          │        │          │          │       │       │ min time │         │
│          │        │          │          │       │       │ of 1.0   │         │
│          │        │          │          │       │       │ sec      │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ timelim… │ script │ generic… │ None     │ None  │ None  │ Run a    │ /home/… │
│          │        │          │          │       │       │ sleep    │         │
│          │        │          │          │       │       │ job for  │         │
│          │        │          │          │       │       │ 2        │         │
│          │        │          │          │       │       │ seconds  │         │
│          │        │          │          │       │       │ and test │         │
│          │        │          │          │       │       │ pass if  │         │
│          │        │          │          │       │       │ it's     │         │
│          │        │          │          │       │       │ within   │         │
│          │        │          │          │       │       │ max      │         │
│          │        │          │          │       │       │ time:    │         │
│          │        │          │          │       │       │ 5.0 sec  │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ timelim… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ fails    │         │
│          │        │          │          │       │       │ because  │         │
│          │        │          │          │       │       │ it runs  │         │
│          │        │          │          │       │       │ less     │         │
│          │        │          │          │       │       │ than     │         │
│          │        │          │          │       │       │ mintime  │         │
│          │        │          │          │       │       │ of 10    │         │
│          │        │          │          │       │       │ second   │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ timelim… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ fails    │         │
│          │        │          │          │       │       │ because  │         │
│          │        │          │          │       │       │ it       │         │
│          │        │          │          │       │       │ exceeds  │         │
│          │        │          │          │       │       │ maxtime  │         │
│          │        │          │          │       │       │ of 1.0   │         │
│          │        │          │          │       │       │ second   │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
timelimit_min_max/ac230fa0: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0
timelimit_min_max/ac230fa0: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0/stage
timelimit_min_max/ac230fa0: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0/timelimit_min_max_build.sh
timelimit_min/cd12365d: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d
timelimit_min/cd12365d: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d/stage
timelimit_min/cd12365d: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d/timelimit_min_build.sh
timelimit_max/ef8fd070: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070
timelimit_max/ef8fd070: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070/stage
timelimit_max/ef8fd070: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070/timelimit_max_build.sh
timelimit_min_fail/5d864671: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671
timelimit_min_fail/5d864671: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671/stage
timelimit_min_fail/5d864671: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671/timelimit_min_fail_build.sh
timelimit_max_fail/a1ea884e: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e
timelimit_max_fail/a1ea884e: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e/stage
timelimit_max_fail/a1ea884e: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e/timelimit_max_fail_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
timelimit_min/cd12365d does not have any dependencies adding test to queue
timelimit_max_fail/a1ea884e does not have any dependencies adding test to queue
timelimit_min_max/ac230fa0 does not have any dependencies adding test to queue
timelimit_max/ef8fd070 does not have any dependencies adding test to queue
timelimit_min_fail/5d864671 does not have any dependencies adding test to queue
timelimit_min/cd12365d: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d/stage
timelimit_min/cd12365d: Running Test via command: sh --norc --noprofile -eo pipefail timelimit_min_build.sh
timelimit_min/cd12365d: Test completed in 0.003225 seconds
timelimit_min/cd12365d: Test completed with returncode: 2
timelimit_min/cd12365d: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d/timelimit_min.out
timelimit_min/cd12365d: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min/cd12365d/timelimit_min.err
timelimit_min/cd12365d: Checking  mintime < runtime: 1.0 < 0.003225
timelimit_min_max/ac230fa0: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0/stage
timelimit_min_max/ac230fa0: Running Test via command: sh --norc --noprofile -eo pipefail timelimit_min_max_build.sh
timelimit_min_max/ac230fa0: Test completed in 0.003083 seconds
timelimit_min_max/ac230fa0: Test completed with returncode: 2
timelimit_min_max/ac230fa0: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0/timelimit_min_max.out
timelimit_min_max/ac230fa0: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_max/ac230fa0/timelimit_min_max.err
timelimit_min_max/ac230fa0: Checking mintime < runtime < maxtime: 1.0 < 0.003083 < 3.0
timelimit_max_fail/a1ea884e: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e/stage
timelimit_max_fail/a1ea884e: Running Test via command: sh --norc --noprofile -eo pipefail timelimit_max_fail_build.sh
timelimit_max_fail/a1ea884e: Test completed in 0.003348 seconds
timelimit_max_fail/a1ea884e: Test completed with returncode: 2
timelimit_max_fail/a1ea884e: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e/timelimit_max_fail.out
timelimit_max_fail/a1ea884e: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max_fail/a1ea884e/timelimit_max_fail.err
timelimit_max_fail/a1ea884e: Checking runtime < maxtime: 0.003348 < 1.0 
timelimit_max/ef8fd070: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070/stage
timelimit_max/ef8fd070: Running Test via command: sh --norc --noprofile -eo pipefail timelimit_max_build.sh
timelimit_max/ef8fd070: Test completed in 0.003274 seconds
timelimit_max/ef8fd070: Test completed with returncode: 2
timelimit_max/ef8fd070: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070/timelimit_max.out
timelimit_max/ef8fd070: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_max/ef8fd070/timelimit_max.err
timelimit_max/ef8fd070: Checking runtime < maxtime: 0.003274 < 5.0 
timelimit_min_fail/5d864671: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671/stage
timelimit_min_fail/5d864671: Running Test via command: sh --norc --noprofile -eo pipefail timelimit_min_fail_build.sh
timelimit_min_fail/5d864671: Test completed in 0.003208 seconds
timelimit_min_fail/5d864671: Test completed with returncode: 2
timelimit_min_fail/5d864671: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671/timelimit_min_fail.out
timelimit_min_fail/5d864671: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/runtime_status_test/timelimit_min_fail/5d864671/timelimit_min_fail.err
timelimit_min_fail/5d864671: Checking  mintime < runtime: 10.0 < 0.003208
In this iteration we are going to run the following tests: [timelimit_min/cd12365d, timelimit_min_max/ac230fa0, timelimit_max_fail/a1ea884e, timelimit_max/ef8fd070, timelimit_min_fail/5d864671]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ timelimit_mi │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.003225 │
│ n/cd12365d   │              │        │ False         │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ timelimit_mi │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.003208 │
│ n_fail/5d864 │              │        │ False         │            │          │
│ 671          │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ timelimit_ma │ generic.loc… │ PASS   │ False False   │ 2          │ 0.003274 │
│ x/ef8fd070   │              │        │ True          │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ timelimit_mi │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.003083 │
│ n_max/ac230f │              │        │ False         │            │          │
│ a0           │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ timelimit_ma │ generic.loc… │ PASS   │ False False   │ 2          │ 0.003348 │
│ x_fail/a1ea8 │              │        │ True          │            │          │
│ 84e          │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 2/5 Percentage: 40.000%
Failed Tests: 3/5 Percentage: 60.000%


Adding 5 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_1ki1cfy5.log

If we look at the test results, we expect the first three tests timelimit_min, timelimit_max, timelimit_min_max will pass while the last two tests fail because it fails to comply with runtime property.

buildtest report --filter buildspec=tutorials/test_status/runtime_status_test.yml --format name,id,state,runtime --latest
$ buildtest report --filter buildspec=tutorials/test_status/runtime_status_test.yml --format name,id,state,runtime --latest
Report File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ name                           ┃ id             ┃ state      ┃ runtime       ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ timelimit_min                  │ cd12365d       │ FAIL       │ 0.003225      │
├────────────────────────────────┼────────────────┼────────────┼───────────────┤
│ timelimit_min_fail             │ 5d864671       │ FAIL       │ 0.003208      │
├────────────────────────────────┼────────────────┼────────────┼───────────────┤
│ timelimit_max                  │ ef8fd070       │ PASS       │ 0.003274      │
├────────────────────────────────┼────────────────┼────────────┼───────────────┤
│ timelimit_min_max              │ ac230fa0       │ FAIL       │ 0.003083      │
├────────────────────────────────┼────────────────┼────────────┼───────────────┤
│ timelimit_max_fail             │ a1ea884e       │ PASS       │ 0.003348      │
└────────────────────────────────┴────────────────┴────────────┴───────────────┘

Explicitly Declaring Status of Test

You can explicitly define status of test regardless of what buildtest does for checking status of test. This can be useful if you want to explicitly mark a test as PASS or FAIL regardless of how test behaves. This can be done via state property which expects one of two types PASS or FAIL. If state property is specified, buildtest will ignore any checks including returncode, regex, or runtime match.

In this next example we will demonstrate how one can use state property for marking test state. In this example we have four tests. The first test always_pass will PASS even though we have a non-zero returncode. The second test always_fail will FAIL even though it has a 0 returncode. The last two test demonstrate how one can define state regardless of what is specified for returncode match. buildtest will honor the state property even if their is a match on the returncode.

buildspecs:
  always_pass:
    type: script
    executor: 'generic.local.sh'
    description: This test will always 'PASS'
    run: exit 1
    status:
      state: PASS

  always_fail:
    type: script
    executor: 'generic.local.sh'
    description: This test will always 'FAIL'
    run: exit 0
    status:
      state: FAIL

  test_fail_returncode_match:
    type: script
    executor: 'generic.local.sh'
    description: This test will 'FAIL' even if we have returncode match
    run: exit 1
    status:
      state: FAIL
      returncode: 1

  test_pass_returncode_mismatch:
    type: script
    executor: 'generic.local.sh'
    description: This test will 'PASS' even if we have returncode mismatch
    run: exit 1
    status:
      state: PASS
      returncode: 2

If we build this test, we expect buildtest to honor the value of state property

buildtest build -b tutorials/test_status/explicit_state.yml
$ buildtest build -b tutorials/test_status/explicit_state.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:32                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/explicit_state.yml: VALID
Total builder objects created: 4
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ always_… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ will     │         │
│          │        │          │          │       │       │ always   │         │
│          │        │          │          │       │       │ 'PASS'   │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ always_… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ will     │         │
│          │        │          │          │       │       │ always   │         │
│          │        │          │          │       │       │ 'FAIL'   │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ test_fa… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ will     │         │
│          │        │          │          │       │       │ 'FAIL'   │         │
│          │        │          │          │       │       │ even if  │         │
│          │        │          │          │       │       │ we have  │         │
│          │        │          │          │       │       │ returnc… │         │
│          │        │          │          │       │       │ match    │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ test_pa… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ will     │         │
│          │        │          │          │       │       │ 'PASS'   │         │
│          │        │          │          │       │       │ even if  │         │
│          │        │          │          │       │       │ we have  │         │
│          │        │          │          │       │       │ returnc… │         │
│          │        │          │          │       │       │ mismatch │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
always_pass/4943519d: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d
always_pass/4943519d: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d/stage
always_pass/4943519d: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d/always_pass_build.sh
always_fail/af6cd9be: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be
always_fail/af6cd9be: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be/stage
always_fail/af6cd9be: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be/always_fail_build.sh
test_fail_returncode_match/8b2e1722: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722
test_fail_returncode_match/8b2e1722: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722/stage
test_fail_returncode_match/8b2e1722: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722/test_fail_returncode_match_build.sh
test_pass_returncode_mismatch/f4dc3fa1: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1
test_pass_returncode_mismatch/f4dc3fa1: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1/stage
test_pass_returncode_mismatch/f4dc3fa1: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1/test_pass_returncode_mismatch_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
test_pass_returncode_mismatch/f4dc3fa1 does not have any dependencies adding test to queue
test_fail_returncode_match/8b2e1722 does not have any dependencies adding test to queue
always_fail/af6cd9be does not have any dependencies adding test to queue
always_pass/4943519d does not have any dependencies adding test to queue
test_fail_returncode_match/8b2e1722: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722/stage
test_fail_returncode_match/8b2e1722: Running Test via command: sh --norc --noprofile -eo pipefail test_fail_returncode_match_build.sh
test_fail_returncode_match/8b2e1722: Test completed in 0.003228 seconds
test_fail_returncode_match/8b2e1722: Test completed with returncode: 2
test_fail_returncode_match/8b2e1722: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722/test_fail_returncode_match.out
test_fail_returncode_match/8b2e1722: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_fail_returncode_match/8b2e1722/test_fail_returncode_match.err
test_fail_returncode_match/8b2e1722: Checking returncode - 2 is matched in list [1]
always_fail/af6cd9be: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be/stage
always_fail/af6cd9be: Running Test via command: sh --norc --noprofile -eo pipefail always_fail_build.sh
always_fail/af6cd9be: Test completed in 0.002999 seconds
always_fail/af6cd9be: Test completed with returncode: 2
always_fail/af6cd9be: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be/always_fail.out
always_fail/af6cd9be: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_fail/af6cd9be/always_fail.err
always_pass/4943519d: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d/stage
always_pass/4943519d: Running Test via command: sh --norc --noprofile -eo pipefail always_pass_build.sh
always_pass/4943519d: Test completed in 0.0029 seconds
always_pass/4943519d: Test completed with returncode: 2
always_pass/4943519d: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d/always_pass.out
always_pass/4943519d: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/always_pass/4943519d/always_pass.err
test_pass_returncode_mismatch/f4dc3fa1: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1/stage
test_pass_returncode_mismatch/f4dc3fa1: Running Test via command: sh --norc --noprofile -eo pipefail test_pass_returncode_mismatch_build.sh
test_pass_returncode_mismatch/f4dc3fa1: Test completed in 0.002963 seconds
test_pass_returncode_mismatch/f4dc3fa1: Test completed with returncode: 2
test_pass_returncode_mismatch/f4dc3fa1: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1/test_pass_returncode_mismatch.out
test_pass_returncode_mismatch/f4dc3fa1: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.sh/explicit_state/test_pass_returncode_mismatch/f4dc3fa1/test_pass_returncode_mismatch.err
test_pass_returncode_mismatch/f4dc3fa1: Checking returncode - 2 is matched in list [2]
In this iteration we are going to run the following tests: [test_fail_returncode_match/8b2e1722, always_fail/af6cd9be, always_pass/4943519d, test_pass_returncode_mismatch/f4dc3fa1]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ test_pass_re │ generic.loc… │ PASS   │ True False    │ 2          │ 0.002963 │
│ turncode_mis │              │        │ False         │            │          │
│ match/f4dc3f │              │        │               │            │          │
│ a1           │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ test_fail_re │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.003228 │
│ turncode_mat │              │        │ False         │            │          │
│ ch/8b2e1722  │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ always_fail/ │ generic.loc… │ FAIL   │ False False   │ 2          │ 0.002999 │
│ af6cd9be     │              │        │ False         │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ always_pass/ │ generic.loc… │ PASS   │ False False   │ 2          │ 0.0029   │
│ 4943519d     │              │        │ False         │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 2/4 Percentage: 50.000%
Failed Tests: 2/4 Percentage: 50.000%


Adding 4 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_zznwaxo9.log

File Checks

buildtest supports various file checks that can be used as means for passing test.

For instance, if you want to check for file existence, you can use exists property which expects a list of file or directory names to check. This can be useful if your test will write some output file or directory and test will pass based on existence of file/directory.

In the example below we have two tests, first test will pass, where all files exist. We check for files and directory path, note variable and shell expansion is supported.

In the second example, we expect this test to fail because filename bar does not exist.

buildspecs:
  status_exists:
   type: script
   executor: generic.local.bash
   description: status check based for file and directory
   run: |
      mkdir -p $HOME/dirA
      mkdir -p /tmp/ABC
      touch file1
   status:
     exists:
       - $HOME/dirA
       - ~/.bashrc
       - /tmp/ABC
       - file1
  status_exists_failure:
    type: script
    executor: generic.local.bash
    description: status check failure for existence
    run: touch foo
    status:
      exists:
        - bar

We can run this test by running the following, take note of the output.

buildtest build -b tutorials/test_status/exists.yml
$ buildtest build -b tutorials/test_status/exists.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:33                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/exists.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ status_… │ script │ generic… │ None     │ None  │ None  │ status   │ /home/… │
│          │        │          │          │       │       │ check    │         │
│          │        │          │          │       │       │ based    │         │
│          │        │          │          │       │       │ for file │         │
│          │        │          │          │       │       │ and      │         │
│          │        │          │          │       │       │ directo… │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ status_… │ script │ generic… │ None     │ None  │ None  │ status   │ /home/… │
│          │        │          │          │       │       │ check    │         │
│          │        │          │          │       │       │ failure  │         │
│          │        │          │          │       │       │ for      │         │
│          │        │          │          │       │       │ existen… │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
status_exists/63682a54: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54
status_exists/63682a54: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/stage
status_exists/63682a54: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/status_exists_build.sh
status_exists_failure/6b14a7c6: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6
status_exists_failure/6b14a7c6: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6/stage
status_exists_failure/6b14a7c6: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6/status_exists_failure_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
status_exists/63682a54 does not have any dependencies adding test to queue
status_exists_failure/6b14a7c6 does not have any dependencies adding test to queue
status_exists/63682a54: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/stage
status_exists/63682a54: Running Test via command: bash --norc --noprofile -eo pipefail status_exists_build.sh
status_exists/63682a54: Test completed in 0.008485 seconds
status_exists/63682a54: Test completed with returncode: 0
status_exists/63682a54: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/status_exists.out
status_exists/63682a54: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/status_exists.err
status_exists/63682a54: Test all files:  ['$HOME/dirA', '~/.bashrc', '/tmp/ABC', 'file1']  existences
status_exists/63682a54: file: /home/docs/dirA exists
status_exists/63682a54: file: /home/docs/.bashrc exists
status_exists/63682a54: file: /tmp/ABC exists
status_exists/63682a54: file: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists/63682a54/stage/file1 exists
status_exists/63682a54: Exist Check: True
status_exists_failure/6b14a7c6: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6/stage
status_exists_failure/6b14a7c6: Running Test via command: bash --norc --noprofile -eo pipefail status_exists_failure_build.sh
status_exists_failure/6b14a7c6: Test completed in 0.00616 seconds
status_exists_failure/6b14a7c6: Test completed with returncode: 0
status_exists_failure/6b14a7c6: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6/status_exists_failure.out
status_exists_failure/6b14a7c6: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/exists/status_exists_failure/6b14a7c6/status_exists_failure.err
status_exists_failure/6b14a7c6: Test all files:  ['bar']  existences 
status_exists_failure/6b14a7c6: file: bar does not exist
status_exists_failure/6b14a7c6: Exist Check: False
In this iteration we are going to run the following tests: [status_exists/63682a54, status_exists_failure/6b14a7c6]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ status_exist │ generic.loc… │ PASS   │ False False   │ 0          │ 0.008485 │
│ s/63682a54   │              │        │ False         │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ status_exist │ generic.loc… │ FAIL   │ False False   │ 0          │ 0.00616  │
│ s_failure/6b │              │        │ False         │            │          │
│ 14a7c6       │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/2 Percentage: 50.000%
Failed Tests: 1/2 Percentage: 50.000%


Adding 2 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_pv79q0a8.log

Each item in the exists field must be a string, which can lead to issue in example below let’s assume we want a test to pass based on a directory name 1, if we specify as follows, this test will fail validation.

buildspecs:
  file_exists_failure:
   type: script
   executor: generic.local.bash
   description: this test will fail validation, because item must be a string
   run: mkdir -p 1
   status:
     exists: [1]

We can validate this buildspec by running the following

buildtest bc validate -b tutorials/test_status/file_exists_exception.yml
$ buildtest bc validate -b tutorials/test_status/file_exists_exception.yml
─ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ─
1 is not of type 'string'

Failed validating 'type' in schema['properties']['status']['properties']['exists']['items']:
    {'type': 'string'}

On instance['status']['exists'][0]:
    1


1 buildspecs failed to validate

In order to run this test, we need to enclose each item in quotes. Shown below is the same test with quotations.

buildspecs:
  file_exists_pass:
    type: script
    executor: generic.local.bash
    description: this test will pass
    run: mkdir -p 1
    status:
      exists: [ '1' ]

Let’s validate and build this test.

buildtest bc validate -b tutorials/test_status/file_exists_with_number.yml
$ buildtest bc validate -b tutorials/test_status/file_exists_with_number.yml
buildspec: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/file_exists_with_number.yml is valid
All buildspecs passed validation!!!
buildtest build -b tutorials/test_status/file_exists_with_number.yml
$ buildtest build -b tutorials/test_status/file_exists_with_number.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:34                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/file_exists_with_number.yml: VALID
Total builder objects created: 1
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ file_ex… │ script │ generic… │ None     │ None  │ None  │ this     │ /home/… │
│          │        │          │          │       │       │ test     │         │
│          │        │          │          │       │       │ will     │         │
│          │        │          │          │       │       │ pass     │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
file_exists_pass/cc978d36: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36
file_exists_pass/cc978d36: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/stage
file_exists_pass/cc978d36: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/file_exists_pass_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
file_exists_pass/cc978d36 does not have any dependencies adding test to queue
file_exists_pass/cc978d36: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/stage
file_exists_pass/cc978d36: Running Test via command: bash --norc --noprofile -eo pipefail file_exists_pass_build.sh
file_exists_pass/cc978d36: Test completed in 0.006572 seconds
file_exists_pass/cc978d36: Test completed with returncode: 0
file_exists_pass/cc978d36: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/file_exists_pass.out
file_exists_pass/cc978d36: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/file_exists_pass.err
file_exists_pass/cc978d36: Test all files:  ['1']  existences 
file_exists_pass/cc978d36: file: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_exists_with_number/file_exists_pass/cc978d36/stage/1 exists
file_exists_pass/cc978d36: Exist Check: True
In this iteration we are going to run the following tests: [file_exists_pass/cc978d36]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ file_exists_ │ generic.loc… │ PASS   │ False False   │ 0          │ 0.006572 │
│ pass/cc978d3 │              │        │ False         │            │          │
│ 6            │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%


Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_sa6l_55z.log

In the next example, we introduce checks for files and directory via is_file and is_dir property, which behaves similar to exists except they will check if each item is a file or directory. We expect the first test to fail, because $HOME/.bashrc is not a directory but a file. The second test will incorporate the same test and use is_file for status check.

buildspecs:
  file_and_dir_checks:
   type: script
   executor: generic.local.bash
   description: status check for files and directories
   run: hostname
   status:
     is_dir:
       - $HOME
       - $HOME/.bashrc
       - /tmp
  combined_file_and_dir_checks:
    type: script
    executor: generic.local.bash
    description: status check for files and directories
    run: hostname
    status:
      is_dir:
        - $HOME
        - /tmp
      is_file:
        - $HOME/.bashrc

Let’s build the test and see the output.

buildtest build -b tutorials/test_status/file_and_dir_check.yml
$ buildtest build -b tutorials/test_status/file_and_dir_check.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:35                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/test_status/file_and_dir_check.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ file_an… │ script │ generic… │ None     │ None  │ None  │ status   │ /home/… │
│          │        │          │          │       │       │ check    │         │
│          │        │          │          │       │       │ for      │         │
│          │        │          │          │       │       │ files    │         │
│          │        │          │          │       │       │ and      │         │
│          │        │          │          │       │       │ directo… │         │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ combine… │ script │ generic… │ None     │ None  │ None  │ status   │ /home/… │
│          │        │          │          │       │       │ check    │         │
│          │        │          │          │       │       │ for      │         │
│          │        │          │          │       │       │ files    │         │
│          │        │          │          │       │       │ and      │         │
│          │        │          │          │       │       │ directo… │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
file_and_dir_checks/2b5627e9: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9
file_and_dir_checks/2b5627e9: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9/stage
file_and_dir_checks/2b5627e9: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9/file_and_dir_checks_build.sh
combined_file_and_dir_checks/add12f86: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86
combined_file_and_dir_checks/add12f86: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86/stage
combined_file_and_dir_checks/add12f86: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86/combined_file_and_dir_checks_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
combined_file_and_dir_checks/add12f86 does not have any dependencies adding test to queue
file_and_dir_checks/2b5627e9 does not have any dependencies adding test to queue
file_and_dir_checks/2b5627e9: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9/stage
file_and_dir_checks/2b5627e9: Running Test via command: bash --norc --noprofile -eo pipefail file_and_dir_checks_build.sh
file_and_dir_checks/2b5627e9: Test completed in 0.006296 seconds
file_and_dir_checks/2b5627e9: Test completed with returncode: 0
file_and_dir_checks/2b5627e9: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9/file_and_dir_checks.out
file_and_dir_checks/2b5627e9: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/file_and_dir_checks/2b5627e9/file_and_dir_checks.err
file_and_dir_checks/2b5627e9: Test all files:  ['$HOME', '$HOME/.bashrc', '/tmp']  existences
file_and_dir_checks/2b5627e9: file: /home/docs is a directory 
file_and_dir_checks/2b5627e9: file: $HOME/.bashrc is not a directory
file_and_dir_checks/2b5627e9: file: /tmp is a directory 
file_and_dir_checks/2b5627e9: Directory Existence Check: False
combined_file_and_dir_checks/add12f86: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86/stage
combined_file_and_dir_checks/add12f86: Running Test via command: bash --norc --noprofile -eo pipefail combined_file_and_dir_checks_build.sh
combined_file_and_dir_checks/add12f86: Test completed in 0.00582 seconds
combined_file_and_dir_checks/add12f86: Test completed with returncode: 0
combined_file_and_dir_checks/add12f86: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86/combined_file_and_dir_checks.out
combined_file_and_dir_checks/add12f86: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/file_and_dir_check/combined_file_and_dir_checks/add12f86/combined_file_and_dir_checks.err
combined_file_and_dir_checks/add12f86: Test all files:  ['$HOME', '/tmp']  existences
combined_file_and_dir_checks/add12f86: file: /home/docs is a directory 
combined_file_and_dir_checks/add12f86: file: /tmp is a directory 
combined_file_and_dir_checks/add12f86: Directory Existence Check: True
combined_file_and_dir_checks/add12f86: Test all files:  ['$HOME/.bashrc']  existences
combined_file_and_dir_checks/add12f86: file: /home/docs/.bashrc is a file 
combined_file_and_dir_checks/add12f86: File Existence Check: True
In this iteration we are going to run the following tests: [file_and_dir_checks/2b5627e9, combined_file_and_dir_checks/add12f86]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ combined_fil │ generic.loc… │ PASS   │ False False   │ 0          │ 0.00582  │
│ e_and_dir_ch │              │        │ False         │            │          │
│ ecks/add12f8 │              │        │               │            │          │
│ 6            │              │        │               │            │          │
├──────────────┼──────────────┼────────┼───────────────┼────────────┼──────────┤
│ file_and_dir │ generic.loc… │ FAIL   │ False False   │ 0          │ 0.006296 │
│ _checks/2b56 │              │        │ False         │            │          │
│ 27e9         │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/2 Percentage: 50.000%
Failed Tests: 1/2 Percentage: 50.000%


Adding 2 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_gm4j6qnt.log

Skipping test

By default, buildtest will run all tests defined in buildspecs section, if you want to skip a test use the skip field which expects a boolean value. Shown below is an example test.

buildspecs:
  skip:
    type: script
    executor: generic.local.bash
    description: This test is skipped
    skip: Yes
    tags: [tutorials]
    run: hostname

  unskipped:
    type: script
    executor: generic.local.bash
    description: This test is not skipped
    skip: No
    tags: [tutorials]
    run: hostname

The first test skip will be ignored by buildtest because skip: true is defined while unskipped will be processed as usual.

Note

YAML and JSON have different representation for boolean. For json schema valid values are true and false see https://json-schema.org/understanding-json-schema/reference/boolean.html however YAML has many more representation for boolean see https://yaml.org/type/bool.html. You may use any of the YAML boolean, however it’s best to stick with json schema values true and false.

Here is an example build, notice message [skip] test is skipped during the build stage

buildtest build -b tutorials/skip_tests.yml
$ buildtest build -b tutorials/skip_tests.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:35                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
skip: skipping test due to 'skip' property.
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/skip_tests.yml: VALID
Total builder objects created: 1
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ descrip… ┃ builds… ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ unskipp… │ script │ generic… │ None     │ None  │ None  │ This     │ /home/… │
│          │        │          │          │       │       │ test is  │         │
│          │        │          │          │       │       │ not      │         │
│          │        │          │          │       │       │ skipped  │         │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
unskipped/bead163f: Creating test directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f
unskipped/bead163f: Creating the stage directory: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f/stage
unskipped/bead163f: Writing build script: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f/unskipped_build.sh
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
unskipped/bead163f does not have any dependencies adding test to queue
unskipped/bead163f: Current Working Directory : /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f/stage
unskipped/bead163f: Running Test via command: bash --norc --noprofile -eo pipefail unskipped_build.sh
unskipped/bead163f: Test completed in 0.005917 seconds
unskipped/bead163f: Test completed with returncode: 0
unskipped/bead163f: Writing output file -  /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f/unskipped.out
unskipped/bead163f: Writing error file - /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/tests/generic.local.bash/skip_tests/unskipped/bead163f/unskipped.err
In this iteration we are going to run the following tests: [unskipped/bead163f]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┓
┃              ┃              ┃        ┃ checks        ┃            ┃          ┃
┃              ┃              ┃        ┃ (ReturnCode,  ┃            ┃          ┃
┃              ┃              ┃        ┃ Regex,        ┃            ┃          ┃
┃ builder      ┃ executor     ┃ status ┃ Runtime)      ┃ returncode ┃ runtime  ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━┩
│ unskipped/be │ generic.loc… │ PASS   │ N/A N/A N/A   │ 0          │ 0.005917 │
│ ad163f       │              │        │               │            │          │
└──────────────┴──────────────┴────────┴───────────────┴────────────┴──────────┘



Passed Tests: 1/1 Percentage: 100.000%
Failed Tests: 0/1 Percentage: 0.000%


Adding 1 test results to /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/report.json
Writing Logfile to: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/logs/buildtest_e2611bj3.log

Skipping a buildspec

Sometimes you may want to skip all test in a buildspec instead of updating every test with skip property, this can be done by setting skip at the top-level. This can be useful if you are running several test in a directory such as buildtest build -b dir1/ and you don’t want to explicitly exclude file via -x option every time, instead you can hardcode this into the buildspec. A typical use-case of skipping test is when a test is broken and you don’t want to run it then its good idea to set skip: yes on the buildspec and fix it later.

In this next example we set skip: yes, buildtest will skip the buildspec and no test will be processed even if skip is set in each test.

skip: yes
buildspecs:
  skip_all_tests:
    type: script
    executor: generic.local.bash
    description: "All test in this buildspec are skipped"
    tags: [tutorials]
    run: hostname

  this_test_is_also_skipped:
    type: script
    skip: no
    executor: generic.local.bash
    description: "This test is also skipped even if skip is defined in test"
    tags: [ tutorials ]
    run: hostname

If you try building this buildspec, you will see buildtest will skip the buildspec and terminate.

buildtest build -b tutorials/skip_buildspec.yml
$ buildtest build -b tutorials/skip_buildspec.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-19096927-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2023/01/06 20:00:36                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.1                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.7.15                                                   │
│ Configuration File: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Test Directory:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Report File:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/skip_buildspec.yml: skipping all test since 'skip' is defined
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/tutorials/skip_buildspec.yml: VALID
                            Buildspecs Filtered out                             
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ buildspecs                                                                   ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable… │
└──────────────────────────────────────────────────────────────────────────────┘

buildtest is unable to create any tests because there are no valid buildspecs. 

Please see logfile: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/stable/var/buildtest.log