summaryrefslogtreecommitdiff
path: root/lib/README
diff options
context:
space:
mode:
authorSteve Kemp <steve@steve.org.uk>2012-11-13 17:22:43 +0000
committerSteve Kemp <steve@steve.org.uk>2012-11-13 17:22:43 +0000
commitab3961ec0603140ac5730f90b067c01e9d73d070 (patch)
treeeacbf6a3573759ea0f1ee8348a09ca39d60028b7 /lib/README
parenta977d57759bbe20ae6a6eff6ef1af29a6b7ff936 (diff)
Renamed and moved files around.
--HG-- rename : util/multi-ping => bin/multi-ping rename : parser/parser.rb => bin/parser.rb rename : worker/worker => bin/worker rename : worker/tests/README => lib/README rename : worker/tests/ftp.rb => lib/custodian/protocol-tests/ftp.rb rename : worker/tests/http.rb => lib/custodian/protocol-tests/http.rb rename : worker/tests/https.rb => lib/custodian/protocol-tests/https.rb rename : worker/tests/jabber.rb => lib/custodian/protocol-tests/jabber.rb rename : worker/tests/ldap.rb => lib/custodian/protocol-tests/ldap.rb rename : worker/tests/ping.rb => lib/custodian/protocol-tests/ping.rb rename : worker/tests/rsync.rb => lib/custodian/protocol-tests/rsync.rb rename : worker/tests/smtp.rb => lib/custodian/protocol-tests/smtp.rb rename : worker/tests/ssh.rb => lib/custodian/protocol-tests/ssh.rb
Diffstat (limited to 'lib/README')
-rw-r--r--lib/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/README b/lib/README
new file mode 100644
index 0000000..5d8b6d3
--- /dev/null
+++ b/lib/README
@@ -0,0 +1,17 @@
+
+ This directory contains the protocol-tests.
+
+ For the protocol "xxx" we must have:
+
+ - The file called xxx.rb
+
+ - The definition of class "XXXTest" - note upper-case
+
+ The class must implement the methods:
+
+ run_test()
+
+ error()
+
+ 'run_test' will be called to run the test, returning true if passed, and false
+ otherwise. In the event of a test failure 'error' will return something useful.