Skip to content
Permalink
Browse files

Clarify how to run unit tests

Recent changes require a `ninja install` step before `meson test`.
Update the documentation.
  • Loading branch information
krader1961 committed Jan 11, 2020
1 parent 031d73a commit 078cb99a7e7027aa408b4d4911c35fbb09c8838e
Showing with 6 additions and 5 deletions.
  1. +6 −5 CONTRIBUTING.md
@@ -264,17 +264,20 @@ make sure the behavior remains consistent and regressions are not
introduced. Even if you don't run the tests they will be run via the
[Travis CI](https://travis-ci.org/att/ast) service.

You are strongly encouraged to add tests when changing the functionality
of ksh. Especially if you are fixing a bug to help ensure there are no
regressions in the future (i.e., we don't reintroduce the bug).
You are strongly encouraged to add tests when changing the functionality of
ksh or fixing bugs. Especially if you are fixing a bug to help ensure there
are no regressions in the future; i.e., we don't reintroduce the bug.

### Local testing

The tests can be run on your local computer on all operating systems supported
by the project. To run the tests:

```
mkdir build
cd build
meson --prefix=/tmp/ksh
ninja install
meson test --setup=malloc
```

@@ -316,8 +319,6 @@ tests, by doing

### Testing with ASAN -- AddressSanitizer

At the moment this only works on Linux using gcc.

Configure with `meson -DASAN=true`. Then build with `ninja` as usual. Run
the tests with `meson test --setup=asan`.

0 comments on commit 078cb99

Please sign in to comment.
You can’t perform that action at this time.