buildtest¶
This documentation was last rebuild on Dec 17, 2021 and is intended for version 0.12.0.
If you are working off a latest release please see https://buildtest.readthedocs.io/en/latest/ for documentation. If you are working off devel branch then please refer to https://buildtest.readthedocs.io/en/devel/ which references the devel branch.
Useful Links¶
Source Code: https://github.com/buildtesters/buildtest
Documentation: http://buildtest.rtfd.io/
Schema Docs: https://buildtesters.github.io/buildtest/
ReadTheDocs: https://readthedocs.org/projects/buildtest/
Slack Channel: http://hpcbuildtest.slack.com
Slack Invite: https://hpcbuildtest.herokuapp.com
CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest
Cori Test Repository: https://github.com/buildtesters/buildtest-cori
Description¶
buildtest is a testing framework to help HPC sites write test for their system as part of their routine acceptance & regression test. buildtest provides a YAML interface to write tests which buildtest can validate and generate shell scripts that can run on your HPC system. The test template (YAML) is called buildspec which can define one or more test instance that is validated by a json schema. buildtest supports the following batch schedulers: IBM Spectrum LSF, Slurm, PBS and Cobalt. We publish the schema documentation, json schemas, and schema examples at https://buildtesters.github.io/buildtest/ which is useful when you are writing buildspecs.
To get started with buildtest, please see Installing buildtest and getting started guide.
A spin-off project called lmodule is a Python API for Lmod. The buildtest module features were deprecated and moved to lmodule with the main objective is to automate module load testing. For more details on lmodule see https://github.com/buildtesters/lmodule
- Configuring buildtest
- Batch Scheduler Support
- Build and Test Process
- Additional Features
- Accessing build history (
buildtest history
) - Accessing buildtest documentation
- Disabling Colored Output
- CDASH Integration (
buildtest cdash
) - Cleaning buildtest files (
buildtest clean
) - Changing Directories (
buildtest cd
) - Get Path for Test (
buildtest path
) - Buildtest Debug Report (
buildtest debugreport
) - Command Line Interface to buildtest configuration
- Accessing build history (
- Buildtest Schemas
- Using buildtest at HPC sites
- Conference and Publications
License¶
buildtest is released under the MIT license