From: Stephen Morris <stephen@isc.org>
Date: Tue, 6 Nov 2012 14:11:17 +0000 (+0000)
Subject: [2342] Extended documentation to discuss running of unit tests
X-Git-Tag: trac2487_base~1^2~38
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3edde39acb177b96c1aaa74f42562c4b7ab0488f;p=thirdparty%2Fkea.git

[2342] Extended documentation to discuss running of unit tests
---

diff --git a/src/lib/dhcp/database_backends.dox b/src/lib/dhcp/database_backends.dox
index 27b4c249da..7736ccb32d 100644
--- a/src/lib/dhcp/database_backends.dox
+++ b/src/lib/dhcp/database_backends.dox
@@ -44,4 +44,15 @@
     no password is used.
   - user - database user ID under which the database is accessed.  If not
     specified, no user ID is used - the database is assumed to be open.
+
+  @section dhcp-backend-unittest Running Unit Tests
+
+  With the use of databases requiring separate authorisation, there are
+  certain pre-requisties for scuccessfully running the unit tests.  These are
+  database-specific:
+
+  MySQL: a database called keatest needs to be set up.  A database user, also
+  called keatest (with a password keatest) must be given full privileges in
+  that database.  The unit tests create the database schema in the database
+  before each test, and delete it afterwards.
   */