Skip to content

Commit 5ac348b

Browse files
committed
SR-3237: Document libdispatch testsuite
Add brief documentation on how to run tests and note assumption that /usr/bin/vi is present to use as input for IO test cases.
1 parent 92773e0 commit 5ac348b

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ We are currently early in the development of this project. We began with a mirro
1818
## Build and Install
1919

2020
For detailed instructions on building and installing libdispatch, see [INSTALL.md](INSTALL.md)
21+
22+
## Testing
23+
24+
For detailed instructions on testing libdispatch, see [TESTING.md](TESTING.md)

TESTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Testing libdispatch
2+
3+
### Running tests
4+
5+
A C-based test suite can be found in the tests subdirectory.
6+
It uses the automake testing harness to execute the tests.
7+
8+
A default set of tests that are always expected to pass can
9+
be executed by doing
10+
11+
```
12+
make check
13+
```
14+
15+
An extended test suite that includes some tests that may fail
16+
occasionally can be enabled at configure time:
17+
18+
```
19+
./configure --enable-extended-test-suite
20+
make check
21+
```
22+
23+
### Additional prerequisites
24+
25+
A few test cases require additional packages to be installed.
26+
In particular, several IO tests assume /usr/bin/vi is available
27+
as an input file and will fail if it is not present.

0 commit comments

Comments
 (0)