nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-10 05:03:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

WritingTests.md: add a section about shells

Browse Source 
Closes #29485
This commit is contained in:
Nick Mathewson 2020-07-28 22:59:47 -04:00
parent 86de51feaf
commit 4e71fc92c8
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/HACKING/WritingTests.md
View File

@ -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.