also fix one typo --- test/README | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/test/README b/test/README index 81c232d..d12cff2 100644 --- a/test/README +++ b/test/README @@ -178,11 +178,18 @@ library for your script to use. test_expect_equal_file <file1> <file2> - Identical to test_exepect_equal, except that <file1> and <file2> + Identical to test_expect_equal, except that <file1> and <file2> are files instead of strings. This is a much more robust method to compare formatted textual information, since it also notices whitespace and closing newline differences. + test_expect_equal_json <output> <expected> + + Identical to test_expect_equal, except that the two strings are + treated as JSON and canonicalized before equality testing. This is + useful to abstract away from whitespace differences in the expected + output and that generated by running a notmuch command. + test_debug <script> This takes a single argument, <script>, and evaluates it only @@ -253,3 +260,16 @@ variables which are useful in writing tests: generated script that should be called instead of notmuch to do the counting. The notmuch_counter_value() function prints the current counter value. + +There are also functions which remove various environment-dependent +values from notmuch output; these are useful to ensure that test +results remain consistent across different machines. + + notmuch_search_sanitize + notmuch_show_sanitize + notmuch_show_sanitize_all + notmuch_json_show_sanitize + + All these functions should receive the text to be sanitized as the + input of a pipe, e.g. + output=`notmuch search "..." | notmuch_search_sanitize` -- 1.8.1.5