Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.59 KB

Testing.md

File metadata and controls

55 lines (39 loc) · 1.59 KB
Raw

Testing

Builder and its planfiles can be tested by running the [BATS test-suite][bats-doc]. Similar to Builder itself, BATS is an all-bash test environment. The tests are automatically collected and can be run jointly or by single file with

cd path/to/Builder

bats tests/
# or
bats "tests/modulefile.bats"

This testing framework is aimed at developers testing during the development of Builder. The packages installed are explicitly not tested, and should be checked in a higher level integration testing.

For an overview description of the possibilities and context of BATS see for example [this article][bats-os].

Installation

If you do not have BATS installed, you can get the latest development version by downloading the [BATS git repository][bats-git]. An even simpler aproach is to install the last release with Builder itself:

module load Builder
build bats

In this case you can just load the BATS module and run the tests as mentioned above:

module load bats
cd path/to/Builder
bats tests/

Continuous Testing

The tests are automatically run using GitHub Actions. The workflow descriptions are stored in .github/workflows/* and are executed on push or pull-request. The corresponding results can be seen on the Actions page.

[bats-doc]: https://bats-core.readthedocs.io BATS Documentation [bats-git]: https://github.com/bats-core/bats-core BATS Repository [bats-os]: https://opensource.com/article/19/2/testing-bash-bats Testing Bash with BATS