diff --git a/tests/README b/tests/README index 514c0a5..7e748fa 100644 --- a/tests/README +++ b/tests/README @@ -176,6 +176,23 @@ Test harness library There are a handful helper functions defined in the test harness library for your script to use. + - test_todo_session < transcript + + This takes a single string as a parameter, which is treated + as a base description of what is being tested, and then + reads from standard input a transcript of todo.sh commands + and expected output. Each command is run in the current + test environment and the output is compared with the + expected output. (See below for how to generate transcripts + easily.) + + - test_tick [interval] + + The test harness has an internal view of time which is + implemented by wrapping the date command. This takes a single + optional positive integer parameter which indicates how much + to advance the internal time. The default value is one day. + - test_expect_success