[#3419] Added a DB test mode

Author: fxdupont

src/lib/database/database_connection.cc

@@ -283,5 +283,7 @@ DbCallback DatabaseConnection::db_failed_callback_ = 0;
 bool DatabaseConnection::retry_ = false;
 IOServicePtr DatabaseConnection::io_service_ = IOServicePtr();
 
+bool DatabaseConnection::test_mode_ = false;
+
 }  // namespace db
 }  // namespace isc

src/lib/database/database_connection.h

@@ -277,6 +277,26 @@ class DatabaseConnection : public boost::noncopyable {
         return (unusable_);
     }
 
+    /// @brief Test mode flag (default false).
+    static bool test_mode_;
+
+    /// @brief RAII device to set the test mode.
+    class EnterTest {
+    public:
+
+        /// @brief Constructor.
+        /// Set the test mode to true.
+        EnterTest() {
+            DatabaseConnection::test_mode_ = true;
+        }
+
+        /// @brief Destructor.
+        /// Reset the test mode to false.
+        ~EnterTest() {
+            DatabaseConnection::test_mode_ = false;
+        }
+    };
+
 protected:
 
     /// @brief Sets the unusable flag to true.

src/lib/database/tests/database_connection_unittest.cc

@@ -641,3 +641,13 @@ TEST(DatabaseConnection, toElementDbAccessStringEmpty) {
     ASSERT_TRUE(elements);
     ASSERT_EQ(0, elements->size());
 }
+
+// Check that the test mode works as expected.
+TEST(DatabaseConnection, testMode) {
+    ASSERT_FALSE(DatabaseConnection::test_mode_);
+    {
+        DatabaseConnection::EnterTest et;
+        EXPECT_TRUE(DatabaseConnection::test_mode_);
+    }
+    EXPECT_FALSE(DatabaseConnection::test_mode_);
+}

src/lib/dhcpsrv/tests/mysql_host_data_source_unittest.cc

@@ -166,6 +166,9 @@ TEST(MySqlHostDataSource, OpenDatabase) {
     destroyMySQLSchema();
     createMySQLSchema();
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that host manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {
@@ -254,6 +257,9 @@ TEST(MySqlHostDataSource, OpenDatabaseMultiThreading) {
     destroyMySQLSchema();
     createMySQLSchema();
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that host manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {

src/lib/dhcpsrv/tests/mysql_lease_mgr_unittest.cc

@@ -121,6 +121,9 @@ TEST(MySqlOpenTest, OpenDatabase) {
     // Schema needs to be created for the test to work.
     createMySQLSchema(true);
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that lease manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {

src/lib/dhcpsrv/tests/pgsql_host_data_source_unittest.cc

@@ -164,6 +164,9 @@ TEST(PgSqlHostDataSource, OpenDatabase) {
     destroyPgSQLSchema();
     createPgSQLSchema();
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that host manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {
@@ -263,6 +266,9 @@ TEST(PgSqlHostDataSource, OpenDatabaseMultiThreading) {
     destroyPgSQLSchema();
     createPgSQLSchema();
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that host manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {

src/lib/dhcpsrv/tests/pgsql_lease_mgr_unittest.cc

@@ -121,6 +121,9 @@ TEST(PgSqlOpenTest, OpenDatabase) {
     // Schema needs to be created for the test to work.
     createPgSQLSchema();
 
+    // Enter test mode to avoid ensureSchemaVersion to invole kea-admin.
+    DatabaseConnection::EnterTest et;
+
     // Check that lease manager opens the database correctly and tidy up.  If it
     // fails, print the error message.
     try {

src/lib/mysql/mysql_connection.cc

@@ -415,6 +415,10 @@ MySqlConnection::ensureSchemaVersion(const ParameterMap& parameters,
     } catch (DbOpenErrorWithRetry const& exception) {
         throw;
     } catch (exception const& exception) {
+        // Disable the recovery mechanism in test mode.
+        if (DatabaseConnection::test_mode_) {
+            throw;
+        }
         // This failure may occur for a variety of reasons. We are looking at
         // initializing schema as the only potential mitigation. We could narrow
         // down on the error that would suggest an uninitialized schema

src/lib/pgsql/pgsql_connection.cc

@@ -191,6 +191,10 @@ PgSqlConnection::ensureSchemaVersion(const ParameterMap& parameters,
     } catch (DbOpenErrorWithRetry const& exception) {
         throw;
     } catch (exception const& exception) {
+        // Disable the recovery mechanism in test mode.
+        if (DatabaseConnection::test_mode_) {
+            throw;
+        }
         // This failure may occur for a variety of reasons. We are looking at
         // initializing schema as the only potential mitigation. We could narrow
         // down on the error that would suggest an uninitialized schema