buildtest is a testing framework that automates build/execution of tests which allows HPC facilities to develop test for their system. In buildtest, tests are written as test recipes called Buildspecs which is a YAML used by buildtest for generating shell-scripts and run them on your system. Buildtest will validate buildspecs using jsonschema which helps define structure of buildspec when writing test. buildtest can support batch submission to job schedulers including: IBM Spectrum LSF, Slurm, PBS and Cobalt .
If you want to learn more about buildtest please read Summary of Buildtest.
Installing buildtest, is relatively easy. Just clone this repo and source the setup script:
git clone https://github.com/buildtesters/buildtest.git cd buildtest source setup.sh
For more details see Installing buildtest.
The schemas are found in top-level folder buildtest/schemas/ and published via Github Pages at https://buildtesters.github.io/buildtest/. Each schema has a unique URI defined by $id.
For any issues with schema, please create an issue in buildtest.
- Documentation: http://buildtest.rtfd.io/
- Schema Docs: https://buildtesters.github.io/buildtest/
- ReadTheDocs: https://readthedocs.org/projects/buildtest/
- CodeCov: https://codecov.io/gh/buildtesters/buildtest
- CodeFactor: https://www.codefactor.io/repository/github/buildtesters/buildtest
- Snyk: https://app.snyk.io/org/buildtesters/
buildtest documentation is your source for getting help with buildtest. If you get stuck check out the current issues to see if you face similar issue. If all else fails please create an issue.
buildtest source code is under buildtest directory found in the root of this repository. The documentation pages are located in docs folder which consist of Makefile and conf.py to build the sphinx project along with documentation pages in ReStructuredText (rst). The regression test are found in top-level directory named tests and the test suite is run via pytest.
Slack is the preferred method for communication and user support with buildtest. If you haven't joined slack click the link to register your account. Once you have an account you can access slack channel at https://hpcbuildtest.slack.com and post your questions in #general channel.
We would love to get your feedback and contribution, for more details see contribution guide.
buildtest was founded by Shahzeb Siddiqui.
buildtest is released under the MIT License. See LICENSE for more details.
