buildtest

HPC System and Software Testing Framework

https://github.com/buildtesters/buildtest

Keywords

Keywords from Contributors

Repository

HPC System and Software Testing Framework

README.rst

.. image:: https://github.com/buildtesters/buildtest/blob/devel/logos/BuildTest_Primary_Center_4x3.png
   :width: 400
   
.. |docs| image:: https://readthedocs.org/projects/buildtest/badge/?version=devel
    :alt: Documentation Status
    :scale: 100%
    :target: https://readthedocs.org/projects/buildtest/builds/

.. |license| image:: https://img.shields.io/github/license/buildtesters/buildtest.svg
   :target: https://github.com/buildtesters/buildtest/blob/devel/LICENSE

.. |release| image:: https://img.shields.io/github/v/release/buildtesters/buildtest.svg
   :target: https://github.com/buildtesters/buildtest/releases
   
.. |issues| image:: https://img.shields.io/github/issues/buildtesters/buildtest.svg 
    :target: https://github.com/buildtesters/buildtest/issues
    
.. |open_pr| image:: https://img.shields.io/github/issues-pr/buildtesters/buildtest.svg
    :target: https://github.com/buildtesters/buildtest/pulls
    
.. |commit_activity_yearly| image:: https://img.shields.io/github/commit-activity/y/buildtesters/buildtest.svg
   :target: https://github.com/buildtesters/buildtest/pulse

.. |commit_activity_monthly| image:: https://img.shields.io/github/commit-activity/m/buildtesters/buildtest.svg
   :target: https://github.com/buildtesters/buildtest/pulse

.. |core_infrastructure| image:: https://bestpractices.coreinfrastructure.org/projects/3469/badge
   :target: https://bestpractices.coreinfrastructure.org/projects/3469

.. |codecov| image:: https://codecov.io/gh/buildtesters/buildtest/branch/devel/graph/badge.svg
    :target: https://codecov.io/gh/buildtesters/buildtest

.. |codefactor| image:: https://www.codefactor.io/repository/github/buildtesters/buildtest/badge
    :target: https://www.codefactor.io/repository/github/buildtesters/buildtest
    :alt: CodeFactor

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |checkurls| image:: https://github.com/buildtesters/buildtest/workflows/Check%20URLs/badge.svg
    :target: https://github.com/buildtesters/buildtest/actions

.. |style| image:: https://github.com/buildtesters/buildtest/workflows/Style%20Checks/badge.svg
    :target: https://github.com/buildtesters/buildtest/actions
    
.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
    :target: https://pycqa.github.io/isort/

.. |installation| image:: https://github.com/buildtesters/buildtest/workflows/installation/badge.svg
   :target: https://github.com/buildtesters/buildtest/actions

.. |regressiontest| image:: https://github.com/buildtesters/buildtest/workflows/regressiontest/badge.svg
    :target: https://github.com/buildtesters/buildtest/actions

.. |nightly_regression_test| image:: https://github.com/buildtesters/buildtest/actions/workflows/nightly_regression.yml/badge.svg
    :target: https://github.com/buildtesters/buildtest/actions

.. |gh_pages_devel| image:: https://github.com/buildtesters/buildtest/workflows/Schema%20Documentation/badge.svg
    :target: https://github.com/buildtesters/buildtest/actions

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3967143.svg
   :target: https://doi.org/10.5281/zenodo.3967143

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|
=======

`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 `_.

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 `_.


Schema Development
-------------------

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.

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 `_  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 `_.

Source Code
------------

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
------

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.

Contributing Back
-------------------

We would love to get your feedback and contribution, for more details see
`contribution guide `_.

Author
-------

buildtest was founded by `Shahzeb Siddiqui `_.

LICENSE
--------

buildtest is released under the MIT License. See
`LICENSE `_ for more details.

Owner

GitHub Events

Committers

Last synced: 7 months ago

Issues and Pull Requests

Last synced: 7 months ago