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-26220538-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2024/11/08 18:06:11 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 2.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.10.14 │
│ Configuration File: /tmp/tmpg3p4j9in/config.yml │
│ Test Directory: /tmp/tmpg3p4j9in/var/tests │
│ Report File: /tmp/tmpg3p4j9in/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: 1 ║
╚══════════════════════════════════════════════════════════════════════════════╝
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/42cb1 │ │ sh │ │ │ │ executor │ ckouts/ │
│ d92 │ │ │ │ │ │ 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/bc84f │ │ │ │ │ │ executor │ ckouts/ │
│ 85a │ │ │ │ │ │ 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/42cb1d92: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_regex_script/multiple_executors/42cb1d92
multiple_executors/bc84f85a: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_regex_script/multiple_executors/bc84f85a
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
multiple_executors/bc84f85a does not have any dependencies adding test to queue
multiple_executors/42cb1d92 does not have any dependencies adding test to queue
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ multiple_executors/bc84f85a │
│ multiple_executors/42cb1d92 │
└─────────────────────────────┘
multiple_executors/bc84f85a: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_regex_script/multiple_executors/bc84f85a/stage
multiple_executors/bc84f85a: Running Test via command: bash multiple_executors_build.sh
multiple_executors/bc84f85a: Test completed in 0.007042 seconds with returncode: 0
multiple_executors/bc84f85a: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_regex_script/multiple_executors/bc84f85a/multiple_executors.out
multiple_executors/bc84f85a: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_regex_script/multiple_executors/bc84f85a/multiple_executors.err
multiple_executors/42cb1d92: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_regex_script/multiple_executors/42cb1d92/stage
multiple_executors/42cb1d92: Running Test via command: bash multiple_executors_build.sh
multiple_executors/42cb1d92: Test completed in 0.005202 seconds with returncode: 0
multiple_executors/42cb1d92: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_regex_script/multiple_executors/42cb1d92/multiple_executors.out
multiple_executors/42cb1d92: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_regex_script/multiple_executors/42cb1d92/multiple_executors.err
Test Summary
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ executor ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ multiple_executors/42cb │ generic.local.bash │ PASS │ 0 │ 0.005 │
│ 1d92 │ │ │ │ │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ multiple_executors/bc84 │ generic.local.sh │ PASS │ 0 │ 0.007 │
│ f85a │ │ │ │ │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘
Passed Tests: 2/2 Percentage: 100.000%
Failed Tests: 0/2 Percentage: 0.000%
Adding 2 test results to report file: /tmp/tmpg3p4j9in/var/report.json
Writing Logfile to /tmp/tmpg3p4j9in/var/logs/buildtest_oj3xunec.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, 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-26220538-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2024/11/08 18:06:11 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 2.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.10.14 │
│ Configuration File: /tmp/tmpg3p4j9in/config.yml │
│ Test Directory: /tmp/tmpg3p4j9in/var/tests │
│ Report File: /tmp/tmpg3p4j9in/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: 1 ║
╚══════════════════════════════════════════════════════════════════════════════╝
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/f │ │ │ │ │ │ by │ readthe │
│ c58538d │ │ │ │ │ │ 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/e │ │ │ │ │ │ by │ readthe │
│ c648ad8 │ │ │ │ │ │ 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/fc58538d: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d
executors_vars_env_declaration/ec648ad8: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
executors_vars_env_declaration/fc58538d does not have any dependencies adding test to queue
executors_vars_env_declaration/ec648ad8 does not have any dependencies adding test to queue
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ executors_vars_env_declaration/fc58538d │
│ executors_vars_env_declaration/ec648ad8 │
└─────────────────────────────────────────┘
executors_vars_env_declaration/fc58538d: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/stage
executors_vars_env_declaration/fc58538d: Running Test via command: bash executors_vars_env_declaration_build.sh
executors_vars_env_declaration/fc58538d: Test completed in 0.004636 seconds with returncode: 0
executors_vars_env_declaration/fc58538d: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/executors_vars_env_declaration.out
executors_vars_env_declaration/fc58538d: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/executors_vars_env_declaration.err
executors_vars_env_declaration/ec648ad8: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/stage
executors_vars_env_declaration/ec648ad8: Running Test via command: bash executors_vars_env_declaration_build.sh
executors_vars_env_declaration/ec648ad8: Test completed in 0.003477 seconds with returncode: 0
executors_vars_env_declaration/ec648ad8: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/executors_vars_env_declaration.out
executors_vars_env_declaration/ec648ad8: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/executors_vars_env_declaration.err
Test Summary
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ executor ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ executors_vars_env_decl │ generic.local.sh │ PASS │ 0 │ 0.003 │
│ aration/ec648ad8 │ │ │ │ │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ executors_vars_env_decl │ generic.local.bash │ PASS │ 0 │ 0.005 │
│ aration/fc58538d │ │ │ │ │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘
Passed Tests: 2/2 Percentage: 100.000%
Failed Tests: 0/2 Percentage: 0.000%
Adding 2 test results to report file: /tmp/tmpg3p4j9in/var/report.json
Writing Logfile to /tmp/tmpg3p4j9in/var/logs/buildtest_399a5qqr.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/ec648ad8-af67-439f-9857-d90dbc448d52 ──────
Executor: generic.local.sh
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.003477 sec
Starttime: 2024/11/08 18:06:11
Endtime: 2024/11/08 18:06:11
Command: bash executors_vars_env_declaration_build.sh
Test Script: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/stage/executors_vars_env_declaration.sh
Build Script: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/executors_vars_env_declaration_build.sh
Output File: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/executors_vars_env_declaration.out
Error File: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executors_var_env_declaration/executors_vars_env_declaration/ec648ad8/executors_vars_env_declaration.err
Log File: /tmp/tmpg3p4j9in/var/logs/buildtest_399a5qqr.log
─ Buildspec File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/… ─
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
────────────────────────────────────────────────────────────────────────────────
────────────────────────────────── Test File ──────────────────────────────────
#!/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/fc58538d-8bbd-4748-97c4-d1ef7b0005fb ──────
Executor: generic.local.bash
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.004636 sec
Starttime: 2024/11/08 18:06:11
Endtime: 2024/11/08 18:06:11
Command: bash executors_vars_env_declaration_build.sh
Test Script: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/stage/executors_vars_env_declaration.sh
Build Script: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/executors_vars_env_declaration_build.sh
Output File: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/executors_vars_env_declaration.out
Error File: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executors_var_env_declaration/executors_vars_env_declaration/fc58538d/executors_vars_env_declaration.err
Log File: /tmp/tmpg3p4j9in/var/logs/buildtest_399a5qqr.log
─ Buildspec File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/… ─
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
────────────────────────────────────────────────────────────────────────────────
────────────────────────────────── Test File ──────────────────────────────────
#!/usr/bin/bash
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-26220538-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2024/11/08 18:06:13 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 2.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.10.14 │
│ Configuration File: /tmp/tmpg3p4j9in/config.yml │
│ Test Directory: /tmp/tmpg3p4j9in/var/tests │
│ Report File: /tmp/tmpg3p4j9in/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: 1 ║
╚══════════════════════════════════════════════════════════════════════════════╝
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/10c │ │ │ │ │ │ by │ readthe │
│ a6bdd │ │ │ │ │ │ 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/31c │ │ │ │ │ │ by │ readthe │
│ 2ae85 │ │ │ │ │ │ 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/10ca6bdd: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd
executors_sbatch_declaration/31c2ae85: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
executors_sbatch_declaration/10ca6bdd does not have any dependencies adding test to queue
executors_sbatch_declaration/31c2ae85 does not have any dependencies adding test to queue
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ executors_sbatch_declaration/10ca6bdd │
│ executors_sbatch_declaration/31c2ae85 │
└───────────────────────────────────────┘
executors_sbatch_declaration/10ca6bdd: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/stage
executors_sbatch_declaration/10ca6bdd: Running Test via command: bash executors_sbatch_declaration_build.sh
executors_sbatch_declaration/10ca6bdd: Test completed in 0.00513 seconds with returncode: 0
executors_sbatch_declaration/10ca6bdd: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/executors_sbatch_declaration.out
executors_sbatch_declaration/10ca6bdd: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/executors_sbatch_declaration.err
executors_sbatch_declaration/31c2ae85: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/stage
executors_sbatch_declaration/31c2ae85: Running Test via command: bash executors_sbatch_declaration_build.sh
executors_sbatch_declaration/31c2ae85: Test completed in 0.004208 seconds with returncode: 0
executors_sbatch_declaration/31c2ae85: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/executors_sbatch_declaration.out
executors_sbatch_declaration/31c2ae85: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/executors_sbatch_declaration.err
Test Summary
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ executor ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ executors_sbatch_declar │ generic.local.bash │ PASS │ 0 │ 0.005 │
│ ation/10ca6bdd │ │ │ │ │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ executors_sbatch_declar │ generic.local.sh │ PASS │ 0 │ 0.004 │
│ ation/31c2ae85 │ │ │ │ │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘
Passed Tests: 2/2 Percentage: 100.000%
Failed Tests: 0/2 Percentage: 0.000%
Adding 2 test results to report file: /tmp/tmpg3p4j9in/var/report.json
Writing Logfile to /tmp/tmpg3p4j9in/var/logs/buildtest_l_x_4ef3.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/31c2ae85-9341-485a-9960-5c9728bc6703 ───────
Executor: generic.local.sh
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.004208 sec
Starttime: 2024/11/08 18:06:13
Endtime: 2024/11/08 18:06:13
Command: bash executors_sbatch_declaration_build.sh
Test Script: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/stage/executors_sbatch_declaration.sh
Build Script: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/executors_sbatch_declaration_build.sh
Output File: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/executors_sbatch_declaration.out
Error File: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/executor_scheduler/executors_sbatch_declaration/31c2ae85/executors_sbatch_declaration.err
Log File: /tmp/tmpg3p4j9in/var/logs/buildtest_l_x_4ef3.log
─ Buildspec File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/… ─
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"]
────────────────────────────────────────────────────────────────────────────────
────────────────────────────────── Test File ──────────────────────────────────
#!/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/10ca6bdd-fc72-4a9a-92ba-3364f20dc25c ───────
Executor: generic.local.bash
Description: Declaring env and vars by executors section
State: PASS
Returncode: 0
Runtime: 0.00513 sec
Starttime: 2024/11/08 18:06:13
Endtime: 2024/11/08 18:06:13
Command: bash executors_sbatch_declaration_build.sh
Test Script: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/stage/executors_sbatch_declaration.sh
Build Script: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/executors_sbatch_declaration_build.sh
Output File: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/executors_sbatch_declaration.out
Error File: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/executor_scheduler/executors_sbatch_declaration/10ca6bdd/executors_sbatch_declaration.err
Log File: /tmp/tmpg3p4j9in/var/logs/buildtest_l_x_4ef3.log
─ Buildspec File: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/… ─
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"]
────────────────────────────────────────────────────────────────────────────────
────────────────────────────────── Test File ──────────────────────────────────
#!/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
# 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-26220538-project-280831-buildtest │
│ Platform: Linux │
│ Current Time: 2024/11/08 18:06:14 │
│ buildtest path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version: 2.1 │
│ python path: /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version: 3.10.14 │
│ Configuration File: /tmp/tmpg3p4j9in/config.yml │
│ Test Directory: /tmp/tmpg3p4j9in/var/tests │
│ Report File: /tmp/tmpg3p4j9in/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: 1 ║
╚══════════════════════════════════════════════════════════════════════════════╝
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/0 │ │ │ │ │ │ executor │ readthe │
│ 00def09 │ │ │ │ │ │ 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/f │ │ │ │ │ │ executor │ readthe │
│ efa6764 │ │ │ │ │ │ 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/000def09: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/000def09
status_returncode_by_executors/fefa6764: Creating Test Directory: /tmp/tmpg3p4j9in/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/fefa6764
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
status_returncode_by_executors/000def09 does not have any dependencies adding test to queue
status_returncode_by_executors/fefa6764 does not have any dependencies adding test to queue
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ status_returncode_by_executors/000def09 │
│ status_returncode_by_executors/fefa6764 │
└─────────────────────────────────────────┘
status_returncode_by_executors/000def09: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/000def09/stage
status_returncode_by_executors/000def09: Running Test via command: bash status_returncode_by_executors_build.sh
status_returncode_by_executors/000def09: Test completed in 0.004322 seconds with returncode: 0
status_returncode_by_executors/000def09: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/000def09/status_returncode_by_executors.out
status_returncode_by_executors/000def09: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.bash/status_by_executors/status_returncode_by_executors/000def09/status_returncode_by_executors.err
status_returncode_by_executors/000def09: Checking returncode - 0 is matched in list [0, 2]
status_returncode_by_executors/fefa6764: Current Working Directory : /tmp/tmpg3p4j9in/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/fefa6764/stage
status_returncode_by_executors/fefa6764: Running Test via command: bash status_returncode_by_executors_build.sh
status_returncode_by_executors/fefa6764: Test completed in 0.00335 seconds with returncode: 0
status_returncode_by_executors/fefa6764: Writing output file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/fefa6764/status_returncode_by_executors.out
status_returncode_by_executors/fefa6764: Writing error file - /tmp/tmpg3p4j9in/var/tests/generic.local.sh/status_by_executors/status_returncode_by_executors/fefa6764/status_returncode_by_executors.err
status_returncode_by_executors/fefa6764: Checking returncode - 0 is matched in list [1]
Test Summary
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder ┃ executor ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ status_returncode_by_ex │ generic.local.sh │ FAIL │ 0 │ 0.003 │
│ ecutors/fefa6764 │ │ │ │ │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ status_returncode_by_ex │ generic.local.bash │ PASS │ 0 │ 0.004 │
│ ecutors/000def09 │ │ │ │ │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘
Passed Tests: 1/2 Percentage: 50.000%
Failed Tests: 1/2 Percentage: 50.000%
Adding 2 test results to report file: /tmp/tmpg3p4j9in/var/report.json
Writing Logfile to /tmp/tmpg3p4j9in/var/logs/buildtest_foi5diy4.log