tests: Update README files and add new README files where missing

[vlendec/samba-autobuild/.git] / ctdb / tests / tool / README

diff --git a/ctdb/tests/tool/README b/ctdb/tests/tool/README
new file mode 100644 (file)
index 0000000..d4a4a34
--- /dev/null
+++ b/ctdb/tests/tool/README
@@ -0,0 +1,19 @@
+Unit tests for the ctdb tool (i.e. tools/ctdb).
+
+Test case filenames can take 2 forms:
+
+* func.<some_function>.NNN.sh
+
+  Run <some_function> in the ctdb tool code using the
+  ctdb_tool_libctdb test program.  This test program uses test stubs
+  for libctdb functions.
+
+* stubby.<command>.NNN.sh
+
+  Run the ctdb_tool_stubby test program with <command> as the 1st
+  argument - subsequent are passed to simple_test().  ctdb_tool_stubby
+  is linked against the test stubs for libctdb functions.
+
+To add tests here you may need to change commands/functions in the
+ctdb tool so that they use libctdb.  You will also need to add the
+appropriate test stubs.