commit 4e71fc92c867823495d97539a09564b0b611b7b6 Author: Nick Mathewson nickm@torproject.org Date: Tue Jul 28 22:59:47 2020 -0400

WritingTests.md: add a section about shells

Closes #29485 --- doc/HACKING/WritingTests.md | 12 ++++++++++++ 1 file changed, 12 insertions(+)

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.