From: Thomas Markwalder <tmark@isc.org>
Date: Tue, 12 Mar 2019 17:01:24 +0000 (-0400)
Subject: [#526,!269] Updated developer's guide.
X-Git-Tag: Kea-1.6.0-beta~391^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2de28db4aedfd3f306bb34864ab2fa351e07836a;p=thirdparty%2Fkea.git

[#526,!269] Updated developer's guide.

    doc/devel/unit-tests.dox - added
    discussion of the env var.
---

diff --git a/doc/devel/unit-tests.dox b/doc/devel/unit-tests.dox
index a7edb9fa05..05c977ef97 100644
--- a/doc/devel/unit-tests.dox
+++ b/doc/devel/unit-tests.dox
@@ -44,6 +44,20 @@ The following environment variable can affect the unit tests:
   under /tmp folder. KEA_SOCKET_TEST_DIR can be specified to instruct
   unit-tests to use a different directory. It must not end with slash.
 
+- KEA_TEST_DB_WIPE_DATA_ONLY - Unit tests which use a Kea unit test
+  database take steps to ensure they are starting with an empty database
+  of the correct schema version.  The first step taken is to simply
+  delete the transient data (such as leases, reservations, etc..), provided
+  the schema exists and is the expected version.  If the schema does not
+  exist, is not the expected version, or for some reason the data wipe fails,
+  the schema will be dropped and recreated. Setting this value to "false"
+  will cause the test setup logic to always drop and create the database
+  schema. The default value is "true". 
+  (Currently, this is only supported by MySQL and CQL).
+
+@note Setting KEA_TEST_DB_WIPE_DATA_ONLY to false may dramatically 
+increase the time it takes each unit test to execute. 
+
 @section unitTestsDatabaseConfig Databases Configuration for Unit Tests
 
   With the use of databases requiring separate authorisation, there are