buildtest <https://buildtest.rtfd.io/> 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 <https://yaml.org/> used by buildtest for generating shell-scripts and run them on your system. Buildtest will validate buildspecs using jsonschema <https://json-schema.org/>_ which helps define structure of buildspec when writing test. buildtest can support batch submission to job schedulers including: IBM Spectrum LSF <https://www.ibm.com/support/knowledgecenter/SSWRJV_10.1.0/lsf_welcome/lsf_welcome.html>, Slurm <https://slurm.schedmd.com/>, PBS <https://www.openpbs.org/> and Cobalt <https://trac.mcs.anl.gov/projects/cobalt> .

If you want to learn more about buildtest please read Summary of Buildtest <https://buildtest.readthedocs.io/en/latest/what_is_buildtest.html>_.

Installation

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 <https://buildtest.readthedocs.io/en/latest/installing_buildtest.html>_.

Schema Development

The schemas are found in top-level folder buildtest/schemas/ <https://github.com/buildtesters/buildtest/tree/devel/buildtest/schemas> and published via Github Pages at https://buildtesters.github.io/buildtest/. Each schema has a unique URI defined by $id <https://json-schema.org/understanding-json-schema/structuring.html#the-id-property>.

For any issues with schema, please create an issue <https://github.com/buildtesters/buildtest/issues/new/choose>_ in buildtest.

References

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/

Documentation

buildtest documentation <http://buildtest.readthedocs.io/en/latest/> is your source for getting help with buildtest. If you get stuck check out the current issues <https://github.com/buildtesters/buildtest/issues> to see if you face similar issue. If all else fails please create an issue <https://github.com/buildtesters/buildtest/issues/new/choose>_.

Source Code

buildtest source code is under buildtest <https://github.com/buildtesters/buildtest/tree/devel/buildtest> directory found in the root of this repository. The documentation pages are located in docs <https://github.com/buildtesters/buildtest/tree/devel/docs> folder which consist of Makefile <https://github.com/buildtesters/buildtest/blob/devel/docs/Makefile> and conf.py <https://github.com/buildtesters/buildtest/blob/devel/docs/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 <https://github.com/buildtesters/buildtest/tree/devel/tests> and the test suite is run via pytest <https://docs.pytest.org/en/stable/>.

Slack

Slack is the preferred method for communication and user support with buildtest. If you haven't joined slack click the link <https://communityinviter.com/apps/hpcbuildtest/buildtest-slack-invitation>_ 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.

Contributing Back

We would love to get your feedback and contribution, for more details see contribution guide <https://buildtest.readthedocs.io/en/latest/contributing.html>_.

Author

buildtest was founded by Shahzeb Siddiqui <https://github.com/shahzebsiddiqui>_.

LICENSE

buildtest is released under the MIT License. See LICENSE <https://github.com/buildtesters/buildtest/blob/master/LICENSE>_ for more details.

buildtesters / buildtest

readme

buildtest

| |license| |docs| |codecov| |release| |installation| |regressiontest| |nightly_regression_test| |gh_pages_devel| |checkurls| |codefactor| |style| |black| |isort| |issues| |open_pr| |commit_activity_yearly| |commit_activity_monthly| |core_infrastructure| |zenodo|