This documentation was rebuilt on Nov 08, 2024 and is intended for version 2.1.
If you are working off the latest release please see https://buildtest.readthedocs.io/en/latest/ for documentation. If you are working off the devel branch then please refer to https://buildtest.readthedocs.io/en/devel/ for documentation.
buildtest
buildtest is a testing framework to help HPC sites write test for their system as part of their routine acceptance and regression testing. Buildtest provides a YAML interface to write tests which buildtest can validate and then use to generate shell scripts that run on your HPC system. The test template (YAML) is called a buildspec which can define one or more test instances and is validated by a json schema. Buildtest supports the following batch schedulers: IBM Spectrum LSF, Slurm, PBS and Cobalt.
To learn more about buildtest, see the What is buildtest?
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.
Getting Started
If you are interested in trying out buildtest, first install buildtest and check out the quick start guide. Next, go through the Getting Started Guide which will walk you through the basic features of buildtest. Once you are ready to write tests, check out the writing buildspecs guide which will discuss how to write buildspecs.
If you are first time user of buildtest, we recommend you to go through the command line tutorial and buildspec tutorial.
Useful Links
Source Code: https://github.com/buildtesters/buildtest
Documentation: http://buildtest.rtfd.io/
Buildtest Home Page: https://buildtesters.github.io/buildtest.io/
ReadTheDocs: https://readthedocs.org/projects/buildtest/
Slack Channel: http://hpcbuildtest.slack.com
Slack Invite: https://communityinviter.com/apps/hpcbuildtest/buildtest-slack-invitation
CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest
NERSC Test Repository: https://github.com/buildtesters/buildtest-nersc
- Buildtest Command Line Reference
- Writing Buildspecs
- Additional Features
- Accessing build history (
buildtest history
) - Buildtest Info (
buildtest info
) - Accessing buildtest documentation
- Enabling colored output for table entries
- Listing available color options (
buildtest --helpcolor
) - Disabling Colored Output
- CDASH Integration (
buildtest cdash
) - Cleaning buildtest files (
buildtest clean
) - Changing Directories (
buildtest cd
) - Get Path for Test (
buildtest path
) - Test Statistics (
buildtest stats
) - Buildtest Debug Report (
buildtest debugreport
) - Accessing Log File
- Show All Options and Commands
- Accessing build history (
- Facility Test Examples
- buildtest API Reference
- Buildtest Command Reference
- Conference and Publications
License
buildtest is released under the MIT license