summaryrefslogtreecommitdiff
path: root/unittest/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'unittest/README.txt')
-rw-r--r--unittest/README.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/unittest/README.txt b/unittest/README.txt
new file mode 100644
index 00000000000..35e930a7951
--- /dev/null
+++ b/unittest/README.txt
@@ -0,0 +1,33 @@
+
+
+Unit test structure
+-------------------
+
+This is the current structure of the unit tests. All directories does
+not currently exist, and more directories will be added over time.
+
++ mysys Tests for mysys components
++ examples Example unit tests
++ sql Unit tests for server code
+ + rpl Unit tests for replication code
+ + log Unit tests for logging
+
+Executing unit tests
+--------------------
+
+To make and execute all unit tests in the directory:
+
+ make test
+
+
+Adding unit tests
+-----------------
+
+Add a file with a name of the format "foo.t.c" to the appropriate
+directory and add the following to the Makefile.am in that directory
+(where ... denotes stuff already there):
+
+ noinst_PROGRAMS = ... foo.t
+ foo_t_c_SOURCES = foo.t.c
+
+