diff options
| author | Nick Mathewson <nickm@torproject.org> | 2020-07-28 22:59:47 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2020-07-28 22:59:47 -0400 |
| commit | 4e71fc92c867823495d97539a09564b0b611b7b6 (patch) | |
| tree | 546a5dbba92eaad9a340dea38ec54e812d1cda80 /doc | |
| parent | 86de51feaf42688b8d7bd3e5bc228afda420d1da (diff) | |
| download | tor-4e71fc92c867823495d97539a09564b0b611b7b6.tar.gz tor-4e71fc92c867823495d97539a09564b0b611b7b6.zip | |
WritingTests.md: add a section about shells
Closes #29485
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING/WritingTests.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/HACKING/WritingTests.md b/doc/HACKING/WritingTests.md index 01e80f3f66..e1497a77c2 100644 --- a/doc/HACKING/WritingTests.md +++ b/doc/HACKING/WritingTests.md @@ -504,3 +504,15 @@ targets in `Makefile.am`. (Adding new kinds of program to chutney will still require hacking the code.) + +## Other integration tests + +It's fine to write tests that use a POSIX shell to invoke Tor or test other +aspects of the system. When you do this, have a look at our existing tests +of this kind in `src/test/` to make sure that you haven't forgotten anything +important. For example: it can be tricky to make sure you're invoking Tor at +the right path in various build scenarios. + +We use a POSIX shell whenever possible here, and we use the shellcheck tool +to make sure that our scripts portable. We should only require bash for +scripts that are developer-only. |