summaryrefslogtreecommitdiff
path: root/worker/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'worker/tests/README')
-rw-r--r--worker/tests/README15
1 files changed, 15 insertions, 0 deletions
diff --git a/worker/tests/README b/worker/tests/README
new file mode 100644
index 0000000..f40031b
--- /dev/null
+++ b/worker/tests/README
@@ -0,0 +1,15 @@
+
+ This directory contains the protocol-tests.
+
+ For the protocol "XXX" we must have:
+
+ - The file called XXX.rb
+
+ - The definition of the single method XXX_test
+
+ The test will make use of "target_host", and "test_port" (other keys may be optionally
+ used) and will return the single result:
+
+ false: The test failed.
+
+ true: The test succeeded. \ No newline at end of file