summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChelsea H. Komlo <chelsea.komlo@gmail.com>2016-10-14 10:27:21 -0400
committerNick Mathewson <nickm@torproject.org>2016-10-14 10:27:21 -0400
commit1a2aa4e3f8628e5d1343414e0034d2136ad26672 (patch)
tree6007e173bad2099549be6bb48cc5c540b7651d1a
parentac707ae70a100ab838c4b65f31cbf130b4bef583 (diff)
downloadtor-1a2aa4e3f8628e5d1343414e0034d2136ad26672.tar.gz
tor-1a2aa4e3f8628e5d1343414e0034d2136ad26672.zip
adding instructions how to include new test files
-rw-r--r--doc/HACKING/WritingTests.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/HACKING/WritingTests.md b/doc/HACKING/WritingTests.md
index 7bcadc6087..de80bbdef2 100644
--- a/doc/HACKING/WritingTests.md
+++ b/doc/HACKING/WritingTests.md
@@ -152,6 +152,11 @@ or create a new C file there. Each test is a single function that must
be indexed in the table at the end of the file. We use the label "done:" as
a cleanup point for all test functions.
+If you have created a new test file, you will need to:
+1. Add the new test file to include.am
+2. In `test.h`, include the new test cases (testcase_t)
+3. In `test.c`, add the new test cases to testgroup_t testgroups
+
(Make sure you read `tinytest-manual.md` before proceeding.)
I use the term "unit test" and "regression tests" very sloppily here.