+++ /dev/null
-// Copyright (C) 2015-2018 Internet Systems Consortium, Inc. ("ISC")
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-#include <config.h>
-#include <exceptions/exceptions.h>
-#include <database/database_connection.h>
-#include <gtest/gtest.h>
-
-#include <boost/bind.hpp>
-
-// using namespace isc::dhcp;
-using namespace isc::db;
-
-/// @brief Test fixture for exercising DbLostCallback invocation
-class DatabaseConnectionCallbackTest : public ::testing::Test {
-public:
- /// Constructor
- DatabaseConnectionCallbackTest()
- : db_reconnect_ctl_(0) {
- DatabaseConnection::db_lost_callback = 0;
- }
-
- /// @brief Callback to register with a DatabaseConnection
- ///
- /// @param db_reconnect_ctl ReconnectCtl containing reconnect
- /// parameters
- bool dbLostCallback(ReconnectCtlPtr db_reconnect_ctl) {
- if (!db_reconnect_ctl) {
- isc_throw(isc::BadValue, "db_reconnect_ctl should not be null");
- }
-
- db_reconnect_ctl_ = db_reconnect_ctl;
- return (true);
- }
-
- /// @brief Retainer for the control passed into the callback
- ReconnectCtlPtr db_reconnect_ctl_;
-};
-
-/// @brief getParameter test
-///
-/// This test checks if the LeaseMgr can be instantiated and that it
-/// parses parameters string properly.
-TEST(DatabaseConnectionTest, getParameter) {
-
- DatabaseConnection::ParameterMap pmap;
- pmap[std::string("param1")] = std::string("value1");
- pmap[std::string("param2")] = std::string("value2");
- DatabaseConnection datasrc(pmap);
-
- EXPECT_EQ("value1", datasrc.getParameter("param1"));
- EXPECT_EQ("value2", datasrc.getParameter("param2"));
- EXPECT_THROW(datasrc.getParameter("param3"), isc::BadValue);
-}
-
-/// @brief NoDbLostCallback
-///
-/// This test verifies that DatabaseConnection::invokeDbLostCallback
-/// returns a false if there is connection has no registered
-/// DbLostCallback.
-TEST_F(DatabaseConnectionCallbackTest, NoDbLostCallback) {
- DatabaseConnection::ParameterMap pmap;
- pmap[std::string("type")] = std::string("test");
- pmap[std::string("max-reconnect-tries")] = std::string("3");
- pmap[std::string("reconnect-wait-time")] = std::string("60");
- DatabaseConnection datasrc(pmap);
-
- bool ret = false;
- ASSERT_NO_THROW(ret = datasrc.invokeDbLostCallback());
- EXPECT_FALSE(ret);
- EXPECT_FALSE(db_reconnect_ctl_);
-}
-
-/// @brief dbLostCallback
-///
-/// This test verifies that DatabaseConnection::invokeDbLostCallback
-/// safely invokes the registered DbLostCallback. It also tests
-/// operation of DbReconnectCtl retry accounting methods.
-TEST_F(DatabaseConnectionCallbackTest, dbLostCallback) {
- /// Create a Database configuration that includes the reconnect
- /// control parameters.
- DatabaseConnection::ParameterMap pmap;
- pmap[std::string("type")] = std::string("test");
- pmap[std::string("max-reconnect-tries")] = std::string("3");
- pmap[std::string("reconnect-wait-time")] = std::string("60");
-
- /// Install the callback.
- DatabaseConnection::db_lost_callback =
- boost::bind(&DatabaseConnectionCallbackTest::dbLostCallback, this, _1);
- /// Create the connection..
- DatabaseConnection datasrc(pmap);
-
- /// We should be able to invoke the callback and glean
- /// the correct reconnect contorl parameters from it.
- bool ret = false;
- ASSERT_NO_THROW(ret = datasrc.invokeDbLostCallback());
- EXPECT_TRUE(ret);
- ASSERT_TRUE(db_reconnect_ctl_);
- ASSERT_EQ("test", db_reconnect_ctl_->backendType());
- ASSERT_EQ(3, db_reconnect_ctl_->maxRetries());
- ASSERT_EQ(3, db_reconnect_ctl_->retriesLeft());
- EXPECT_EQ(60, db_reconnect_ctl_->retryInterval());
-
- /// Verify that checkRetries() correctly decrements
- /// down to zero, and that retriesLeft() returns
- /// the correct value.
- for (int i = 3; i > 1 ; --i) {
- ASSERT_EQ(i, db_reconnect_ctl_->retriesLeft());
- ASSERT_TRUE(db_reconnect_ctl_->checkRetries());
- }
-
- /// Retries are exhausted, verify that's reflected.
- EXPECT_FALSE(db_reconnect_ctl_->checkRetries());
- EXPECT_EQ(0, db_reconnect_ctl_->retriesLeft());
- EXPECT_EQ(3, db_reconnect_ctl_->maxRetries());
-}
-
-// This test checks that a database access string can be parsed correctly.
-TEST(DatabaseConnectionTest, parse) {
-
- DatabaseConnection::ParameterMap parameters = DatabaseConnection::parse(
- "user=me password=forbidden name=kea somethingelse= type=mysql");
-
- EXPECT_EQ(5, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("forbidden", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
- EXPECT_EQ("", parameters["somethingelse"]);
-}
-
-// This test checks that an invalid database access string behaves as expected.
-TEST(DatabaseConnectionTest, parseInvalid) {
-
- // No tokens in the string, so we expect no parameters
- std::string invalid = "";
- DatabaseConnection::ParameterMap parameters = DatabaseConnection::parse(invalid);
- EXPECT_EQ(0, parameters.size());
-
- // With spaces, there are some tokens so we expect invalid parameter
- // as there are no equals signs.
- invalid = " \t ";
- EXPECT_THROW(DatabaseConnection::parse(invalid), isc::InvalidParameter);
-
- invalid = " noequalshere ";
- EXPECT_THROW(DatabaseConnection::parse(invalid), isc::InvalidParameter);
-
- // A single "=" is valid string, but is placed here as the result is
- // expected to be nothing.
- invalid = "=";
- parameters = DatabaseConnection::parse(invalid);
- EXPECT_EQ(1, parameters.size());
- EXPECT_EQ("", parameters[""]);
-}
-
-/// @brief redactConfigString test
-///
-/// Checks that the redacted configuration string includes the password only
-/// as a set of asterisks.
-TEST(DatabaseConnectionTest, redactAccessString) {
-
- DatabaseConnection::ParameterMap parameters =
- DatabaseConnection::parse("user=me password=forbidden name=kea type=mysql");
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("forbidden", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-
- // Redact the result. To check, break the redacted string down into its
- // components.
- std::string redacted = DatabaseConnection::redactedAccessString(parameters);
- parameters = DatabaseConnection::parse(redacted);
-
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("*****", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-}
-
-/// @brief redactConfigString test - empty password
-///
-/// Checks that the redacted configuration string includes the password only
-/// as a set of asterisks, even if the password is null.
-TEST(DatabaseConnectionTest, redactAccessStringEmptyPassword) {
-
- DatabaseConnection::ParameterMap parameters =
- DatabaseConnection::parse("user=me name=kea type=mysql password=");
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-
- // Redact the result. To check, break the redacted string down into its
- // components.
- std::string redacted = DatabaseConnection::redactedAccessString(parameters);
- parameters = DatabaseConnection::parse(redacted);
-
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("*****", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-
- // ... and again to check that the position of the empty password in the
- // string does not matter.
- parameters = DatabaseConnection::parse("user=me password= name=kea type=mysql");
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-
- redacted = DatabaseConnection::redactedAccessString(parameters);
- parameters = DatabaseConnection::parse(redacted);
-
- EXPECT_EQ(4, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("*****", parameters["password"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-}
-
-/// @brief redactConfigString test - no password
-///
-/// Checks that the redacted configuration string excludes the password if there
-/// was no password to begin with.
-TEST(DatabaseConnectionTest, redactAccessStringNoPassword) {
-
- DatabaseConnection::ParameterMap parameters =
- DatabaseConnection::parse("user=me name=kea type=mysql");
- EXPECT_EQ(3, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-
- // Redact the result. To check, break the redacted string down into its
- // components.
- std::string redacted = DatabaseConnection::redactedAccessString(parameters);
- parameters = DatabaseConnection::parse(redacted);
-
- EXPECT_EQ(3, parameters.size());
- EXPECT_EQ("me", parameters["user"]);
- EXPECT_EQ("kea", parameters["name"]);
- EXPECT_EQ("mysql", parameters["type"]);
-}