[2653] Added documentation as to how to create the test DHCP database

1 files changed, 38 insertions, 5 deletions

diff --git a/src/lib/dhcpsrv/database_backends.dox b/src/lib/dhcpsrv/database_backends.dox
index 43594fd608..baab1dddd6 100644
--- a/src/lib/dhcpsrv/database_backends.dox
+++ b/src/lib/dhcpsrv/database_backends.dox
@@ -83,9 +83,42 @@
 
   @subsection dhcp-mysql-unittest MySQL
 
-  A database called <i>keatest</i> needs to be set up using the MySQL
-  <b>CREATE DATABASE</b> command.  A database user, also called <i>keatest</i>
-  (with a password <i>keatest</i>) must be given full privileges in that
-  database.  The unit tests create the schema in the database before each test
-  and delete it afterwards.
+  A database called <i>keatest</i> must be created. A database user, also called
+  <i>keatest</i> (and with a password <i>keatest</i>) must also be created and
+  be given full privileges in that database.  The unit tests create the schema
+  in the database before each test and delete it afterwards.
+
+  In detail, the steps to create the database and user are:
+
+  -# Log into MySQL as root:
+  @verbatim
+  % mysql -u root -p
+  Enter password:
+     :
+  mysql>@endverbatim\n
+  -# Create the test database.  This must be called "keatest":
+  @verbatim
+  mysql> CREATE DATABASE keatest;
+  mysql>@endverbatim\n
+  -# Create the user under which the test client will connect to the database
+  (the apostrophes around the words <i>keatest</i> and <i>localhost</i> are
+  required):
+  @verbatim
+  mysql> CREATE USER 'keatest'@'localhost' IDENTIFIED BY 'keatest';
+  mysql>@endverbatim\n
+  -# Grant the created user permissions to access the <i>keatest</i> database
+  (again, the apostrophes around the words <i>keatest</i> and <i>localhost</i>
+  are required):
+  @verbatim
+  mysql> GRANT ALL ON keatest.* TO 'keatest'@'localhost';
+  mysql>@endverbatim\n
+  -# Exit MySQL:
+  @verbatim
+  mysql> quit
+  Bye
+  %@endverbatim
+
+  The unit tests are run automatically when "make check" is executed (providing
+  that BIND 10 has been build with the --with-dhcp-mysql switch (see the installation
+  section in the <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND 10 Guide</a>).
   */