aboutsummaryrefslogtreecommitdiff
path: root/test/README
diff options
context:
space:
mode:
authorJani Nikula <jani@nikula.org>2017-02-26 15:43:00 +0200
committerDavid Bremner <david@tethera.net>2017-03-09 09:01:21 -0400
commitd0cd253b37646d9364d046e1d3edb022a58c105a (patch)
treeff9af83a8bd1e3380e81c3e3d73389fc98d190a7 /test/README
parentb8f12bd3717aa446ef04197734af7a055e6909fe (diff)
test: require test_begin_subtest before test_expect_success
Unify the subtests by requiring test_begin_subtest before test_expect_success. (Similar change for test_expect_code will follow.) This increases clarity in the test scripts by having a separate line for the start of the subtest with the heading, and makes it possible to simplify the test infrastructure by making all subtests similar.
Diffstat (limited to 'test/README')
-rw-r--r--test/README14
1 files changed, 7 insertions, 7 deletions
diff --git a/test/README b/test/README
index 104a120e..7acdb4b8 100644
--- a/test/README
+++ b/test/README
@@ -189,17 +189,17 @@ Test harness library
There are a handful helper functions defined in the test harness
library for your script to use.
- test_expect_success <message> <script>
-
- This takes two strings as parameter, and evaluates the
- <script>. If it yields success, test is considered
- successful. <message> should state what it is testing.
-
test_begin_subtest <message>
- Set the test description message for a subsequent test_expect_equal
+ Set the test description message for a subsequent test_expect_*
invocation (see below).
+ test_expect_success <script>
+
+ This takes a string as parameter, and evaluates the
+ <script>. If it yields success, test is considered
+ successful.
+
test_subtest_known_broken
Mark the current test as broken. Such tests are expected to fail.