[#101,!202] Added log messages and more unit tests

src/bin/dhcp4/tests/config_backend_unittest.cc
    Added DISABLED tests for option definitions and options.

src/bin/dhcp4/dhcp4_messages.mes
src/bin/dhcp4/json_config_parser.cc
    Added two log messages

diff --git a/src/bin/dhcp4/dhcp4_messages.mes b/src/bin/dhcp4/dhcp4_messages.mes
index f0d486a6c30f11712fb343c4c092f442ae939a57..38dd3b37c8d590e39f20206661f8f1d48a2aafa5 100644 (file)
--- a/src/bin/dhcp4/dhcp4_messages.mes
+++ b/src/bin/dhcp4/dhcp4_messages.mes
@@ -120,12 +120,21 @@ new configuration. It is output during server startup, and when an updated
 configuration is committed by the administrator.  Additional information
 may be provided.
 
+% DHCP4_CONFIG_FETCH Fetching configuration data from config backends.
+This is an informational message emitted when the DHCPv4 server about to begin
+retrieving configuration data from one or more configuration backends.
+
 % DHCP4_CONFIG_LOAD_FAIL configuration error using file: %1, reason: %2
 This error message indicates that the DHCPv4 configuration has failed.
 If this is an initial configuration (during server's startup) the server
 will fail to start. If this is a dynamic reconfiguration attempt the
 server will continue to use an old configuration.
 
+% DHCP4_CONFIG_MERGED Configuration backend data has been merged.
+This is an informational message emitted when the DHCPv4 server has
+successfully merged configuration data retrieved from its configuration
+backends into the current configuration.
+
 % DHCP4_CONFIG_NEW_SUBNET a new subnet has been added to configuration: %1
 This is an informational message reporting that the configuration has
 been extended to include the specified IPv4 subnet.

diff --git a/src/bin/dhcp4/json_config_parser.cc b/src/bin/dhcp4/json_config_parser.cc
index 802508d9c1b3a4ebb931bbf33935531ccf1b5c2c..f66900a6f85256e2f9083149d74aa91ab2c67031 100644 (file)
--- a/src/bin/dhcp4/json_config_parser.cc
+++ b/src/bin/dhcp4/json_config_parser.cc
@@ -666,6 +666,8 @@ void databaseConfigFetch(const SrvConfigPtr& srv_cfg) {
         return;
     }
 
+    LOG_INFO(dhcp4_logger, DHCP4_CONFIG_FETCH);
+
     // For now we find data based on first backend that has it.
     BackendSelector backend_selector(BackendSelector::Type::UNSPEC);
 
@@ -708,8 +710,8 @@ void databaseConfigFetch(const SrvConfigPtr& srv_cfg) {
     }
 
     // Now we merge the fecthed configuration into the staging configuration.
-    // Probably a good place for a log message
     CfgMgr::instance().mergeIntoStagingCfg(external_cfg->getSequence());
+    LOG_INFO(dhcp4_logger, DHCP4_CONFIG_MERGED);
 }
 
 bool databaseConfigConnect(const SrvConfigPtr& srv_cfg) {

diff --git a/src/bin/dhcp4/tests/config_backend_unittest.cc b/src/bin/dhcp4/tests/config_backend_unittest.cc
index 9f7246b55063acee5e24ebeb60d42a3aabbd2ad2..1688d5d62e5d8d56a1efd9369d5c17e00c5a48d4 100644 (file)
--- a/src/bin/dhcp4/tests/config_backend_unittest.cc
+++ b/src/bin/dhcp4/tests/config_backend_unittest.cc
@@ -14,11 +14,10 @@
 #include <dhcp4/dhcp4_srv.h>
 #include <dhcp4/ctrl_dhcp4_srv.h>
 #include <dhcp4/json_config_parser.h>
-//#include <dhcp/option_custom.h>
-//#include <dhcp/option_int.h>
 #include <dhcpsrv/subnet.h>
 #include <dhcpsrv/cfgmgr.h>
 #include <dhcpsrv/cfg_subnets4.h>
+#include <dhcpsrv/testutils/generic_backend_unittest.h>
 #include <dhcpsrv/testutils/test_config_backend_dhcp4.h>
 
 #include "dhcp4_test_utils.h"
@@ -32,7 +31,6 @@
 #include <sstream>
 #include <limits.h>
 
-using namespace isc;
 using namespace isc::asiolink;
 using namespace isc::config;
 using namespace isc::data;
@@ -44,7 +42,7 @@ using namespace std;
 namespace {
 
 /// @brief Test fixture for testing external configuration merging
-class Dhcp4CBTest : public ::testing::Test {
+class Dhcp4CBTest : public GenericBackendTest {
 protected:
     /// @brief Pre test set up
     /// Called prior to each test.  It creates two configuration backends
@@ -65,8 +63,8 @@ protected:
         db2_.reset(new TestConfigBackendDHCPv4(params));
 
         ConfigBackendDHCPv4Mgr::instance().registerBackendFactory("memfile",
-            [this](const db::DatabaseConnection::ParameterMap& params)
-                -> dhcp::ConfigBackendDHCPv4Ptr {
+            [this](const DatabaseConnection::ParameterMap& params)
+                -> ConfigBackendDHCPv4Ptr {
                     auto host = params.find("host");
                     if (host != params.end()) {
                         if (host->second == "db1") {
@@ -81,6 +79,12 @@ protected:
                 });
     }
 
+    /// @brief Clean up after each test
+    virtual void TearDown() {
+        // Unregister the factory to be tidy.
+        ConfigBackendDHCPv4Mgr::instance().unregisterBackendFactory("memfile");
+    }
+
 public:
 
     /// Constructor
@@ -96,10 +100,16 @@ public:
     }
 
     /// Destructor
-    ~Dhcp4CBTest() {
+    virtual ~Dhcp4CBTest() {
         resetConfiguration();
     };
 
+    /// @brief Reset configuration singletons.
+    void resetConfiguration() {
+        CfgMgr::instance().clear();
+        ConfigBackendDHCPv4Mgr::destroy();
+    }
+
     /// @brief Convenience method for running configuration
     ///
     /// This method does not throw, but signals errors using gtest macros.
@@ -139,26 +149,6 @@ public:
         }
     }
 
-    /// @brief Reset configuration database.
-    ///
-    /// This function resets configuration data base by
-    /// removing all subnets and option-data. Reset must
-    /// be performed after each test to make sure that
-    /// contents of the database do not affect result of
-    /// subsequent tests.
-    void resetConfiguration() {
-        string config =
-            "{ \n"
-            "\"hooks-libraries\": [ ], \n"
-            "\"valid-lifetime\": 4000, \n"
-            "\"subnet4\": [ ], \n"
-            "\"dhcp-ddns\": { \"enable-updates\" : false }, \n"
-            "\"option-def\": [ ], \n"
-            "\"option-data\": [ ] }\n";
-        configure(config, CONTROL_RESULT_SUCCESS, "");
-        CfgMgr::instance().clear();
-    }
-
     /// @brief Tests that a given global is in the staged configured globals
     ///
     /// @param name name of the global parameter
@@ -219,6 +209,7 @@ public:
 
 // This test verifies that externally configured globals are
 // merged correctly into staging configuration.
+// @todo enable test when SrvConfig can merge globals.
 TEST_F(Dhcp4CBTest, DISABLED_mergeGlobals) {
     string base_config =
         "{ \n"
@@ -284,6 +275,119 @@ TEST_F(Dhcp4CBTest, DISABLED_mergeGlobals) {
     ASSERT_NO_FATAL_FAILURE(checkConfiguredGlobal(renewTimer, Element::integer));
 }
 
+// This test verifies that externally configured option definitions
+// merged correctly into staging configuration.
+// @todo enable test when SrvConfig can merge option definitions.
+TEST_F(Dhcp4CBTest, DISABLED_mergeOptionDefs) {
+    string base_config =
+        "{ \n"
+        "    \"option-def\": [ {"
+        "        \"name\": \"one\","
+        "        \"code\": 100,"
+        "        \"type\": \"ipv4-address\","
+        "        \"space\": \"isc\""
+        "     } ],"
+        "    \"config-control\": { \n"
+        "       \"config-databases\": [ { \n"
+        "               \"type\": \"memfile\", \n"
+        "               \"host\": \"db1\" \n"
+        "           },{ \n"
+        "               \"type\": \"memfile\", \n"
+        "               \"host\": \"db2\" \n"
+        "           } \n"
+        "       ] \n"
+        "   } \n"
+        "} \n";
+
+    extractConfig(base_config);
+
+    // Create option two and add it to first backend.
+    OptionDefinitionPtr def_two(new OptionDefinition("two", 234, "string"));
+    def_two->setOptionSpaceName("dhcp4");
+    db1_->createUpdateOptionDef4(ServerSelector::ALL(), def_two);
+
+    // Create option three and add it to second backend.
+    OptionDefinitionPtr def_three(new OptionDefinition("three", 235, "string"));
+    def_three->setOptionSpaceName("dhcp4");
+    db2_->createUpdateOptionDef4(ServerSelector::ALL(), def_two);
+
+    // Should parse and merge without error.
+    ASSERT_NO_FATAL_FAILURE(configure(base_config, CONTROL_RESULT_SUCCESS, ""));
+
+    // Verify the composite staging is correct.
+    SrvConfigPtr staging_cfg = CfgMgr::instance().getStagingCfg();
+
+    // Option definition from JSON should be there.
+    ConstCfgOptionDefPtr option_defs = staging_cfg->getCfgOptionDef();
+    OptionDefinitionPtr found_def = option_defs->get("isc", 100);
+    ASSERT_TRUE(found_def);
+
+    // Option definition from db1 should be there.
+    found_def = option_defs->get("dhcp4", 234);
+    ASSERT_TRUE(found_def);
+
+    // Option definition from db2 should not be there.
+    found_def = option_defs->get("dhcp4", 235);
+    ASSERT_FALSE(found_def);
+}
+
+// This test verifies that externally configured options
+// merged correctly into staging configuration.
+// @todo enable test when SrvConfig can merge options.
+TEST_F(Dhcp4CBTest, DISABLED_mergeOptions) {
+    string base_config =
+        "{ \n"
+        "    \"option-data\": [ {"
+        "        \"name\": \"dhcp-message\","
+        "        \"data\": \"0A0B0C0D\","
+        "        \"csv-format\": false"
+        "     } ],"
+        "    \"config-control\": { \n"
+        "       \"config-databases\": [ { \n"
+        "               \"type\": \"memfile\", \n"
+        "               \"host\": \"db1\" \n"
+        "           },{ \n"
+        "               \"type\": \"memfile\", \n"
+        "               \"host\": \"db2\" \n"
+        "           } \n"
+        "       ] \n"
+        "   } \n"
+        "} \n";
+
+    extractConfig(base_config);
+
+    // Create option two and add it to first backend.
+    OptionDescriptorPtr opt_two(new OptionDescriptor(
+        createOption<OptionString>(Option::V4, DHO_BOOT_FILE_NAME,
+                                   true, false, "my-boot-file")));
+    opt_two->space_name_ = DHCP4_OPTION_SPACE;
+    db1_->createUpdateOption4(ServerSelector::ALL(), opt_two);
+
+    // Create option three and add it to second backend.
+    OptionDescriptorPtr opt_three(new OptionDescriptor(
+        createOption<OptionString>(Option::V4, DHO_BOOT_FILE_NAME,
+                                   true, false, "your-boot-file")));
+    opt_three->space_name_ = DHCP4_OPTION_SPACE;
+    db2_->createUpdateOption4(ServerSelector::ALL(), opt_three);
+
+    // Should parse and merge without error.
+    ASSERT_NO_FATAL_FAILURE(configure(base_config, CONTROL_RESULT_SUCCESS, ""));
+
+    // Verify the composite staging is correct.
+    SrvConfigPtr staging_cfg = CfgMgr::instance().getStagingCfg();
+
+    // Option definition from JSON should be there.
+    CfgOptionPtr options = staging_cfg->getCfgOption();
+
+    OptionDescriptor found_opt = options->get("dhcp4", DHO_DHCP_MESSAGE);
+    ASSERT_TRUE(found_opt.option_);
+    EXPECT_EQ("0x0A0B0C0D", found_opt.option_->toHexString());
+
+    found_opt = options->get("dhcp4", DHO_BOOT_FILE_NAME);
+    ASSERT_TRUE(found_opt.option_);
+    EXPECT_EQ("my-boot-file", found_opt.formatted_value_);
+}
+
 // This test verifies that externally configured shared-networks are
 // merged correctly into staging configuration.
 TEST_F(Dhcp4CBTest, DISABLED_mergeSharedNetworks) {