diff options
| author | Steve Kemp <steve@steve.org.uk> | 2012-11-13 11:51:00 +0000 |
|---|---|---|
| committer | Steve Kemp <steve@steve.org.uk> | 2012-11-13 11:51:00 +0000 |
| commit | d6e4f11141a3317efc335d01f7e6eb7120fecd51 (patch) | |
| tree | 9af0cc6f12db857be08d028f1c46a31beaaee1a3 | |
| parent | 5a2a191588b8bfee0c0c62ff0b3ccedff3314989 (diff) | |
Document class API
| -rw-r--r-- | worker/tests/README | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/worker/tests/README b/worker/tests/README index f40031b..ff3e25d 100644 --- a/worker/tests/README +++ b/worker/tests/README @@ -1,15 +1,18 @@ This directory contains the protocol-tests. - For the protocol "XXX" we must have: + For the protocol "xxx" we must have: - - The file called XXX.rb + - The file called xxx.rb - - The definition of the single method XXX_test + - The definition of class "XXXTest" - note upper-case - The test will make use of "target_host", and "test_port" (other keys may be optionally - used) and will return the single result: + The class must implement the methods: - false: The test failed. + run_test - true: The test succeeded.
\ No newline at end of file + get_details + + 'run_test' will be called to run the test, returning true if passed, and false + otherwise. In the event of a test failure 'get_details' will return + something useful. |