extern/boxes
1
0
Fork 0
mirror of https://github.com/ascii-boxes/boxes.git synced 2025-08-12 16:17:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document environment requirements for test suites

Browse Source
This commit is contained in:
Thomas Jensen
2024-02-29 21:35:06 +01:00
parent a348095bc2
commit e362ed58c5
1 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
pages/testing.md
View File

@ -56,9 +56,16 @@ New unit tests can be added in the *utest* folder. We use [cmocka](https://cmock
Sunny-day tests are a suite of tests which simply creates, mends, and removes every box from our official config file. Sunny-day tests are a suite of tests which simply creates, mends, and removes every box from our official config file.
This is to make sure that regular operations work with all of our box designs. This is to make sure that regular operations work with all of our box designs.
In order to invoke the sunny-day test suite, simply call `make test-sunny`. This is valid for all operating systems. In order to run the sunny-day test suite, make sure the `TERM` and `LANG` environment variables are set to indicate a
Calling `make covtest-sunny` will also calculate test coverage, but this requires that the binary was instrumented color-capable terminal and a system encoding of UTF-8. For example:
before, as per `make cov`.
```
export TERM=xterm-color
export LANG=en_US.UTF-8
```
Then, simply call `make test-sunny`. This is valid for all operating systems.
Calling `make cov && make covtest-sunny` instead will do the same, but also calculate test coverage.
<div class="alert alert-info"> <div class="alert alert-info">
For every new box design, a corresponding sunny-day test must be created. For every new box design, a corresponding sunny-day test must be created.
@ -94,8 +101,16 @@ be created:
Black-box tests invoke boxes with all kinds of different arguments, inputs, and configurations in order to test the Black-box tests invoke boxes with all kinds of different arguments, inputs, and configurations in order to test the
application as a whole. application as a whole.
In order to invoke the black-box test suite, simply call `make && make test` from the top level directory. This is In order to run the black-box test suite, make sure the `TERM` and `LANG` environment variables are set to indicate a
valid for all operating systems. Calling `make cov && make covtest` will also calculate test coverage. color-capable terminal and a system encoding of UTF-8. For example:
```
export TERM=xterm-color
export LANG=en_US.UTF-8
```
Then, simply call `make && make test` from the top level directory. This is valid for all operating systems. Calling
`make cov && make covtest` instead will do the same, but also calculate test coverage.
Run an individual test by calling `./testrunner.sh testcase.txt` from the *test* directory. Run an individual test by calling `./testrunner.sh testcase.txt` from the *test* directory.