From d6e4f11141a3317efc335d01f7e6eb7120fecd51 Mon Sep 17 00:00:00 2001 From: Steve Kemp Date: Tue, 13 Nov 2012 11:51:00 +0000 Subject: Document class API --- worker/tests/README | 17 ++++++++++------- 1 file 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. -- cgit v1.2.1