Running Test Across Multiple Executors

The executor property can support regular expression to search for compatible executors, this can be used if you want to run a test across multiple executors. In buildtest, we use re.fullmatch with the input pattern defined by executor property against a list of available executors defined in configuration file. You can retrieve a list of executors by running buildtest config executors list.

In example below we will run this test on generic.local.bash and generic.local.sh executor based on the regular expression.

buildspecs:
  multiple_executors:
    type: script
    executor: 'generic.local.(bash|sh)'
    description: run test with executor generic.local.bash and generic.local.sh executor
    tags: [tutorials]
    run: date

If we build this test, notice that there are two tests, one for each executor.

buildtest build -b tutorials/multi_executors/executor_regex_script.yml
$ buildtest build -b tutorials/multi_executors/executor_regex_script.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-23532485-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/02/22 20:32:48                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.8                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.8.18                                                   │
│ Configuration File: /tmp/tmpq07_ocbs/config.yml                              │
│ Test Directory:     /tmp/tmpq07_ocbs/var/tests                               │
│ Report File:        /tmp/tmpq07_ocbs/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/t ║
║ utorials/multi_executors/executor_regex_script.yml                           ║
╚══════════════════════════════════════════════════════════════════════════════╝


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/devel/tutorials/multi_executors/executor_regex_script.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ multiple │ script │ generic. │ None     │ None  │ None  │ run test │ /home/d │
│ _executo │        │ local.ba │          │       │       │ with     │ ocs/che │
│ rs/a6d3e │        │ sh       │          │       │       │ executor │ ckouts/ │
│ f55      │        │          │          │       │       │ generic. │ readthe │
│          │        │          │          │       │       │ local.ba │ docs.or │
│          │        │          │          │       │       │ sh and   │ g/user_ │
│          │        │          │          │       │       │ generic. │ builds/ │
│          │        │          │          │       │       │ local.sh │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │ executor │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utor_re │
│          │        │          │          │       │       │          │ gex_scr │
│          │        │          │          │       │       │          │ ipt.yml │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ multiple │ script │ generic. │ None     │ None  │ None  │ run test │ /home/d │
│ _executo │        │ local.sh │          │       │       │ with     │ ocs/che │
│ rs/78588 │        │          │          │       │       │ executor │ ckouts/ │
│ 13b      │        │          │          │       │       │ generic. │ readthe │
│          │        │          │          │       │       │ local.ba │ docs.or │
│          │        │          │          │       │       │ sh and   │ g/user_ │
│          │        │          │          │       │       │ generic. │ builds/ │
│          │        │          │          │       │       │ local.sh │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │ executor │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utor_re │
│          │        │          │          │       │       │          │ gex_scr │
│          │        │          │          │       │       │          │ ipt.yml │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
multiple_executors/a6d3ef55: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_regex_script/multiple_executors/a6d3ef55
multiple_executors/7858813b: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_regex_script/multiple_executors/7858813b
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
multiple_executors/a6d3ef55 does not have any dependencies adding test to queue
multiple_executors/7858813b does not have any dependencies adding test to queue
   Builders Eligible to Run    
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                     ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ multiple_executors/a6d3ef55 │
│ multiple_executors/7858813b │
└─────────────────────────────┘
multiple_executors/a6d3ef55: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_regex_script/multiple_executors/a6d3ef55/stage
multiple_executors/a6d3ef55: Running Test via command: bash multiple_executors_build.sh
multiple_executors/a6d3ef55: Test completed in 0.007013 seconds with returncode: 0
multiple_executors/a6d3ef55: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_regex_script/multiple_executors/a6d3ef55/multiple_executors.out
multiple_executors/a6d3ef55: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_regex_script/multiple_executors/a6d3ef55/multiple_executors.err
multiple_executors/7858813b: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_regex_script/multiple_executors/7858813b/stage
multiple_executors/7858813b: Running Test via command: bash multiple_executors_build.sh
multiple_executors/7858813b: Test completed in 0.005672 seconds with returncode: 0
multiple_executors/7858813b: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_regex_script/multiple_executors/7858813b/multiple_executors.out
multiple_executors/7858813b: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_regex_script/multiple_executors/7858813b/multiple_executors.err
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ multiple_executors/7858 │ generic.local.sh   │ PASS   │ 0          │ 0.006   │
│ 813b                    │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ multiple_executors/a6d3 │ generic.local.bash │ PASS   │ 0          │ 0.007   │
│ ef55                    │                    │        │            │         │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



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


Adding 2 test results to /tmp/tmpq07_ocbs/var/report.json
Writing Logfile to /tmp/tmpq07_ocbs/var/logs/buildtest_nd39f1t6.log

Multiple Executors

Note

This feature is in active development

Note

This feature is compatible with type: script and type: spack.

The executors property can be used to define executor specific configuration for each test, currently this field can be used with vars, env , scheduler directives: sbatch, bsub, pbs, cobalt and cray burst buffer/data warp. The executors field is a JSON object that expects name of executor followed by property set per executor. In this next example, we define variables X, Y and environment SHELL based on executors generic.local.sh and generic.local.bash.

buildspecs:
  executors_vars_env_declaration:
    type: script
    executor: 'generic.local.(bash|sh)'
    description: Declaring env and vars by executors section
    tags: [tutorials]
    run: |
      echo "X:" $X
      echo "Y:" $Y
      echo $SHELL
    executors:
      generic.local.bash:
        vars:
          X: 1
          Y: 3
        env:
          SHELL: bash
      generic.local.sh:
        vars:
          X: 2
          Y: 4
        env:
          SHELL: sh

Let’s build this test.

buildtest build -b tutorials/multi_executors/executors_var_env_declaration.yml
$ buildtest build -b tutorials/multi_executors/executors_var_env_declaration.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-23532485-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/02/22 20:32:48                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.8                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.8.18                                                   │
│ Configuration File: /tmp/tmpq07_ocbs/config.yml                              │
│ Test Directory:     /tmp/tmpq07_ocbs/var/tests                               │
│ Report File:        /tmp/tmpq07_ocbs/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/t ║
║ utorials/multi_executors/executors_var_env_declaration.yml                   ║
╚══════════════════════════════════════════════════════════════════════════════╝


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/devel/tutorials/multi_executors/executors_var_env_declaration.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ executor │ script │ generic. │ None     │ None  │ None  │ Declarin │ /home/d │
│ s_vars_e │        │ local.ba │          │       │       │ g env    │ ocs/che │
│ nv_decla │        │ sh       │          │       │       │ and vars │ ckouts/ │
│ ration/1 │        │          │          │       │       │ by       │ readthe │
│ c9002df  │        │          │          │       │       │ executor │ docs.or │
│          │        │          │          │       │       │ s        │ g/user_ │
│          │        │          │          │       │       │ section  │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utors_v │
│          │        │          │          │       │       │          │ ar_env_ │
│          │        │          │          │       │       │          │ declara │
│          │        │          │          │       │       │          │ tion.ym │
│          │        │          │          │       │       │          │ l       │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ executor │ script │ generic. │ None     │ None  │ None  │ Declarin │ /home/d │
│ s_vars_e │        │ local.sh │          │       │       │ g env    │ ocs/che │
│ nv_decla │        │          │          │       │       │ and vars │ ckouts/ │
│ ration/d │        │          │          │       │       │ by       │ readthe │
│ b14c6ad  │        │          │          │       │       │ executor │ docs.or │
│          │        │          │          │       │       │ s        │ g/user_ │
│          │        │          │          │       │       │ section  │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utors_v │
│          │        │          │          │       │       │          │ ar_env_ │
│          │        │          │          │       │       │          │ declara │
│          │        │          │          │       │       │          │ tion.ym │
│          │        │          │          │       │       │          │ l       │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
executors_vars_env_declaration/1c9002df: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df
executors_vars_env_declaration/db14c6ad: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
executors_vars_env_declaration/1c9002df does not have any dependencies adding test to queue
executors_vars_env_declaration/db14c6ad does not have any dependencies adding test to queue
         Builders Eligible to Run          
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                                 ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ executors_vars_env_declaration/1c9002df │
│ executors_vars_env_declaration/db14c6ad │
└─────────────────────────────────────────┘
executors_vars_env_declaration/1c9002df: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/stage
executors_vars_env_declaration/1c9002df: Running Test via command: bash executors_vars_env_declaration_build.sh
executors_vars_env_declaration/1c9002df: Test completed in 0.006492 seconds with returncode: 0
executors_vars_env_declaration/1c9002df: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration.out
executors_vars_env_declaration/1c9002df: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration.err
executors_vars_env_declaration/db14c6ad: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/stage
executors_vars_env_declaration/db14c6ad: Running Test via command: bash executors_vars_env_declaration_build.sh
executors_vars_env_declaration/db14c6ad: Test completed in 0.005542 seconds with returncode: 0
executors_vars_env_declaration/db14c6ad: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration.out
executors_vars_env_declaration/db14c6ad: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration.err
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ executors_vars_env_decl │ generic.local.bash │ PASS   │ 0          │ 0.006   │
│ aration/1c9002df        │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ executors_vars_env_decl │ generic.local.sh   │ PASS   │ 0          │ 0.006   │
│ aration/db14c6ad        │                    │        │            │         │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



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


Adding 2 test results to /tmp/tmpq07_ocbs/var/report.json
Writing Logfile to /tmp/tmpq07_ocbs/var/logs/buildtest_b_42rjyo.log

Now let’s look at the generated content of the test as follows. We will see that buildtest will set X=1, Y=3 and SHELL=bash for generic.local.bash and X=2, Y=4 and SHELL=sh for generic.local.sh

buildtest inspect query -t executors_vars_env_declaration/
$ buildtest inspect query -t executors_vars_env_declaration/
───── executors_vars_env_declaration/db14c6ad-489a-4c2a-a625-96befd5ab7da ──────
Executor: generic.local.sh
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.005542 sec
Starttime: 2024/02/22 20:32:48
Endtime: 2024/02/22 20:32:48
Command: bash executors_vars_env_declaration_build.sh
Test Script: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration.sh
Build Script: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration_build.sh
Output File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration.out
Error File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/db14c6ad/executors_vars_env_declaration.err
Log File: /tmp/tmpq07_ocbs/var/logs/buildtest_b_42rjyo.log
─ Test File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executors_var_env_de… ─
#!/usr/bin/sh                                                                   
                                                                                
export SHELL="sh"                                                               
X="2"                                                                           
Y="4"                                                                           
# Content of run section                                                        
echo "X:" $X                                                                    
echo "Y:" $Y                                                                    
echo $SHELL                                                                     
                                                                                
───── executors_vars_env_declaration/1c9002df-0bfd-426d-9333-7ae2df9256d8 ──────
Executor: generic.local.bash
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.006492 sec
Starttime: 2024/02/22 20:32:48
Endtime: 2024/02/22 20:32:48
Command: bash executors_vars_env_declaration_build.sh
Test Script: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration.sh
Build Script: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration_build.sh
Output File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration.out
Error File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/1c9002df/executors_vars_env_declaration.err
Log File: /tmp/tmpq07_ocbs/var/logs/buildtest_b_42rjyo.log
─ Test File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executors_var_env_… ─
#!/usr/bin/bash                                                                 
set -eo pipefail                                                                
export SHELL="bash"                                                             
X="1"                                                                           
Y="3"                                                                           
# Content of run section                                                        
echo "X:" $X                                                                    
echo "Y:" $Y                                                                    
echo $SHELL

Scheduler Directives

We can also define scheduler directives based on executor type, in this example we define sbatch property per executor type. Note that sbatch property in the executors section will override the sbatch property defined in the top-level file otherwise it will use the default.

buildspecs:
  executors_sbatch_declaration:
    type: script
    executor: 'generic.local.(bash|sh)'
    description: Declaring env and vars by executors section
    tags: [tutorials]
    run: hostname
    sbatch: ["-N 4"]
    executors:
      generic.local.bash:
        sbatch: ["-n 4", "-N 1", "-t 30"]
      generic.local.sh:
        sbatch: ["-n 8", "-N 1", "-t 60"]
buildtest build -b tutorials/multi_executors/executor_scheduler.yml
$ buildtest build -b tutorials/multi_executors/executor_scheduler.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-23532485-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/02/22 20:32:49                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.8                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.8.18                                                   │
│ Configuration File: /tmp/tmpq07_ocbs/config.yml                              │
│ Test Directory:     /tmp/tmpq07_ocbs/var/tests                               │
│ Report File:        /tmp/tmpq07_ocbs/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/t ║
║ utorials/multi_executors/executor_scheduler.yml                              ║
╚══════════════════════════════════════════════════════════════════════════════╝


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/devel/tutorials/multi_executors/executor_scheduler.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ executor │ script │ generic. │ None     │ None  │ None  │ Declarin │ /home/d │
│ s_sbatch │        │ local.ba │          │       │       │ g env    │ ocs/che │
│ _declara │        │ sh       │          │       │       │ and vars │ ckouts/ │
│ tion/b5a │        │          │          │       │       │ by       │ readthe │
│ 52faf    │        │          │          │       │       │ executor │ docs.or │
│          │        │          │          │       │       │ s        │ g/user_ │
│          │        │          │          │       │       │ section  │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utor_sc │
│          │        │          │          │       │       │          │ heduler │
│          │        │          │          │       │       │          │ .yml    │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ executor │ script │ generic. │ None     │ None  │ None  │ Declarin │ /home/d │
│ s_sbatch │        │ local.sh │          │       │       │ g env    │ ocs/che │
│ _declara │        │          │          │       │       │ and vars │ ckouts/ │
│ tion/307 │        │          │          │       │       │ by       │ readthe │
│ a49be    │        │          │          │       │       │ executor │ docs.or │
│          │        │          │          │       │       │ s        │ g/user_ │
│          │        │          │          │       │       │ section  │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/exec │
│          │        │          │          │       │       │          │ utor_sc │
│          │        │          │          │       │       │          │ heduler │
│          │        │          │          │       │       │          │ .yml    │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
executors_sbatch_declaration/b5a52faf: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf
executors_sbatch_declaration/307a49be: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
executors_sbatch_declaration/b5a52faf does not have any dependencies adding test to queue
executors_sbatch_declaration/307a49be does not have any dependencies adding test to queue
        Builders Eligible to Run         
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                               ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ executors_sbatch_declaration/b5a52faf │
│ executors_sbatch_declaration/307a49be │
└───────────────────────────────────────┘
executors_sbatch_declaration/b5a52faf: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/stage
executors_sbatch_declaration/b5a52faf: Running Test via command: bash executors_sbatch_declaration_build.sh
executors_sbatch_declaration/b5a52faf: Test completed in 0.00708 seconds with returncode: 0
executors_sbatch_declaration/b5a52faf: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration.out
executors_sbatch_declaration/b5a52faf: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration.err
executors_sbatch_declaration/307a49be: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/stage
executors_sbatch_declaration/307a49be: Running Test via command: bash executors_sbatch_declaration_build.sh
executors_sbatch_declaration/307a49be: Test completed in 0.005719 seconds with returncode: 0
executors_sbatch_declaration/307a49be: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration.out
executors_sbatch_declaration/307a49be: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration.err
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ executors_sbatch_declar │ generic.local.sh   │ PASS   │ 0          │ 0.006   │
│ ation/307a49be          │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ executors_sbatch_declar │ generic.local.bash │ PASS   │ 0          │ 0.007   │
│ ation/b5a52faf          │                    │        │            │         │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



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


Adding 2 test results to /tmp/tmpq07_ocbs/var/report.json
Writing Logfile to /tmp/tmpq07_ocbs/var/logs/buildtest_ycsltwys.log

If we inspect this test, we will see each each test have different #SBATCH directives for each test based on the sbatch property defined in the executors field.

buildtest inspect query -t executors_sbatch_declaration/
$ buildtest inspect query -t executors_sbatch_declaration/
────── executors_sbatch_declaration/307a49be-ffe2-4a2a-a453-5f58fa3ff703 ───────
Executor: generic.local.sh
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.005719 sec
Starttime: 2024/02/22 20:32:49
Endtime: 2024/02/22 20:32:49
Command: bash executors_sbatch_declaration_build.sh
Test Script: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration.sh
Build Script: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration_build.sh
Output File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration.out
Error File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/307a49be/executors_sbatch_declaration.err
Log File: /tmp/tmpq07_ocbs/var/logs/buildtest_ycsltwys.log
─ Test File: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/executor_scheduler/e… ─
#!/usr/bin/sh                                                                   
#SBATCH -n 8                                                                    
#SBATCH -N 1                                                                    
#SBATCH -t 60                                                                   
#SBATCH --job-name=executors_sbatch_declaration                                 
#SBATCH --output=executors_sbatch_declaration.out                               
#SBATCH --error=executors_sbatch_declaration.err                                
                                                                                
# Content of run section                                                        
hostname                                                                        
────── executors_sbatch_declaration/b5a52faf-7ec4-400c-ae4e-ba58bf716b31 ───────
Executor: generic.local.bash
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.00708 sec
Starttime: 2024/02/22 20:32:49
Endtime: 2024/02/22 20:32:49
Command: bash executors_sbatch_declaration_build.sh
Test Script: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration.sh
Build Script: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration_build.sh
Output File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration.out
Error File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/b5a52faf/executors_sbatch_declaration.err
Log File: /tmp/tmpq07_ocbs/var/logs/buildtest_ycsltwys.log
─ Test File: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/executor_scheduler… ─
#!/usr/bin/bash                                                                 
#SBATCH -n 4                                                                    
#SBATCH -N 1                                                                    
#SBATCH -t 30                                                                   
#SBATCH --job-name=executors_sbatch_declaration                                 
#SBATCH --output=executors_sbatch_declaration.out                               
#SBATCH --error=executors_sbatch_declaration.err                                
set -eo pipefail                                                                
# Content of run section                                                        
hostname

Cray Burst Buffer and Data Warp

You can also define BB and DW directives in the executors field to override cray burst buffer and data warp settings per executor. buildtest will use the fields BB and DW and insert the #BB and #DW directives in the job script. For more details see Cray Burst Buffer & Data Warp.

buildspecs:
  create_burst_buffer_executors:
    type: script
    executor: "generic.local.(sh|bash)"
    sbatch: ["-N 1", "-t 10", "-C knl"]
    description: Create a burst buffer for multiple executors
    tags: [jobs]
    executors:
      generic.local.sh:
        BB:
          - create_persistent name=buffer1 capacity=10GB access_mode=striped type=scratch
        DW:
          - persistentdw name=buffer1
      generic.local.bash:
        BB:
        - create_persistent name=buffer2 capacity=10GB access_mode=striped type=scratch
        DW:
          - persistentdw name=buffer2
    run: hostname

Custom Status by Executor

The status and metrics field are supported in executors which can be defined within the named executor. In this next example, we will define executor generic.local.bash to match for returncode 0 or 2 while second test will use executor generic.local.sh to match returncode of 1.

buildspecs:
  status_returncode_by_executors:
    type: script
    executor: "generic.local.(bash|sh)"
    description: define status per executor type.
    tags: [tutorials]
    run: exit 0
    executors:
      generic.local.bash:
        status:
          returncode: [0, 2]
      generic.local.sh:
        status:
          returncode: 1

Now let’s run this test and we will see the test using executor generic.local.sh will fail because we have a returncode mismatch even though both tests got a 0 returncode as its actual value.

buildtest build -b tutorials/multi_executors/status_by_executors.yml
$ buildtest build -b tutorials/multi_executors/status_by_executors.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-23532485-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/02/22 20:32:51                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  1.8                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.8.18                                                   │
│ Configuration File: /tmp/tmpq07_ocbs/config.yml                              │
│ Test Directory:     /tmp/tmpq07_ocbs/var/tests                               │
│ Report File:        /tmp/tmpq07_ocbs/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/t ║
║ utorials/multi_executors/status_by_executors.yml                             ║
╚══════════════════════════════════════════════════════════════════════════════╝


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/devel/tutorials/multi_executors/status_by_executors.yml: VALID
Total builder objects created: 2
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ status_r │ script │ generic. │ None     │ None  │ None  │ define   │ /home/d │
│ eturncod │        │ local.ba │          │       │       │ status   │ ocs/che │
│ e_by_exe │        │ sh       │          │       │       │ per      │ ckouts/ │
│ cutors/a │        │          │          │       │       │ executor │ readthe │
│ db989ae  │        │          │          │       │       │ type.    │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/stat │
│          │        │          │          │       │       │          │ us_by_e │
│          │        │          │          │       │       │          │ xecutor │
│          │        │          │          │       │       │          │ s.yml   │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ status_r │ script │ generic. │ None     │ None  │ None  │ define   │ /home/d │
│ eturncod │        │ local.sh │          │       │       │ status   │ ocs/che │
│ e_by_exe │        │          │          │       │       │ per      │ ckouts/ │
│ cutors/5 │        │          │          │       │       │ executor │ readthe │
│ a25bb0b  │        │          │          │       │       │ type.    │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/d │
│          │        │          │          │       │       │          │ evel/tu │
│          │        │          │          │       │       │          │ torials │
│          │        │          │          │       │       │          │ /multi_ │
│          │        │          │          │       │       │          │ executo │
│          │        │          │          │       │       │          │ rs/stat │
│          │        │          │          │       │       │          │ us_by_e │
│          │        │          │          │       │       │          │ xecutor │
│          │        │          │          │       │       │          │ s.yml   │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
status_returncode_by_executors/adb989ae: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/adb989ae
status_returncode_by_executors/5a25bb0b: Creating Test Directory: /tmp/tmpq07_ocbs/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/5a25bb0b
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
status_returncode_by_executors/5a25bb0b does not have any dependencies adding test to queue
status_returncode_by_executors/adb989ae does not have any dependencies adding test to queue
         Builders Eligible to Run          
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                                 ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ status_returncode_by_executors/5a25bb0b │
│ status_returncode_by_executors/adb989ae │
└─────────────────────────────────────────┘
status_returncode_by_executors/5a25bb0b: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/5a25bb0b/stage
status_returncode_by_executors/5a25bb0b: Running Test via command: bash status_returncode_by_executors_build.sh
status_returncode_by_executors/5a25bb0b: Test completed in 0.005364 seconds with returncode: 0
status_returncode_by_executors/5a25bb0b: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/5a25bb0b/status_returncode_by_executors.out
status_returncode_by_executors/5a25bb0b: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/5a25bb0b/status_returncode_by_executors.err
status_returncode_by_executors/5a25bb0b: Checking returncode - 0 is matched in list [1]
status_returncode_by_executors/adb989ae: Current Working Directory : /tmp/tmpq07_ocbs/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/adb989ae/stage
status_returncode_by_executors/adb989ae: Running Test via command: bash status_returncode_by_executors_build.sh
status_returncode_by_executors/adb989ae: Test completed in 0.005801 seconds with returncode: 0
status_returncode_by_executors/adb989ae: Writing output file -  /tmp/tmpq07_ocbs/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/adb989ae/status_returncode_by_executors.out
status_returncode_by_executors/adb989ae: Writing error file - /tmp/tmpq07_ocbs/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/adb989ae/status_returncode_by_executors.err
status_returncode_by_executors/adb989ae: Checking returncode - 0 is matched in list [0, 2]
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ status_returncode_by_ex │ generic.local.sh   │ FAIL   │ 0          │ 0.005   │
│ ecutors/5a25bb0b        │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ status_returncode_by_ex │ generic.local.bash │ PASS   │ 0          │ 0.006   │
│ ecutors/adb989ae        │                    │        │            │         │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



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


Adding 2 test results to /tmp/tmpq07_ocbs/var/report.json
Writing Logfile to /tmp/tmpq07_ocbs/var/logs/buildtest_pdga1jkh.log