[5211] libkea-process is no longer dependent on cryptolink

DControllerBase was modified to support a means for derivations to
contribute additional information to extended version info returned
by DControllerBase::getVersion(true).  This removes the need to link
process lib with libraries it does not need.

src/bin/d2/d2_controller.h
src/bin/d2/d2_controller.cc
    D2Controller::getVersionAddendum() - new method which reports
    D2 dependencies (currently only cryptolink)

src/lib/process/Makefile.am
    Removed temporary link to cryptolink

src/lib/process/d_controller.h
src/lib/process/d_controller.cc
    DControllerBase::getVersionAddendum() - new virtual method so
    derivations can contribute to extended version information

    DControllerBase::getVersion(bool extended) - modified to call
    getVersionAddendum(), removed explict calls for crypto and
    RDBMs versions

Added unit test support

diff --git a/src/bin/d2/d2_controller.cc b/src/bin/d2/d2_controller.cc
index 9b601223d27b25cb32951ed0c38e25c30a11723c..a830722af3d331935b626abf1fc7b316dd5bb43a 100644 (file)
--- a/src/bin/d2/d2_controller.cc
+++ b/src/bin/d2/d2_controller.cc
@@ -72,5 +72,14 @@ D2Controller::parseFile(const std::string& file_name) {
 D2Controller::~D2Controller() {
 }
 
+std::string
+D2Controller::getVersionAddendum() {
+    std::stringstream stream;
+    // Currently the only dependency D2 adds to base is cryptolink
+    stream << isc::cryptolink::CryptoLink::getVersion() << std::endl;
+    return (stream.str());
+
+}
+
 }; // end namespace isc::d2
 }; // end namespace isc

diff --git a/src/bin/d2/d2_controller.h b/src/bin/d2/d2_controller.h
index be00bde52f147ef6182a5f52f412a57d3b77b197..0c0fcb3e00a9af7fd3d00d630db08092da5b2d3b 100644 (file)
--- a/src/bin/d2/d2_controller.h
+++ b/src/bin/d2/d2_controller.h
@@ -42,6 +42,10 @@ public:
     /// by convention this should match the executable name.
     static const char* d2_bin_name_;
 
+protected:
+    /// @brief Returns version info specific to D2
+    virtual std::string getVersionAddendum();
+
 private:
     /// @brief Creates an instance of the DHCP-DDNS specific application
     /// process.  This method is invoked during the process initialization

diff --git a/src/lib/process/Makefile.am b/src/lib/process/Makefile.am
index a1cff21c3f5905afa43df421ddd3cd0745ad2c43..d6ed1c7d1f2a1849cbc20620a9e948a1c3c1cf1e 100644 (file)
--- a/src/lib/process/Makefile.am
+++ b/src/lib/process/Makefile.am
@@ -57,11 +57,10 @@ libkea_process_la_LIBADD += $(top_builddir)/src/lib/dhcp/libkea-dhcp++.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/asiolink/libkea-asiolink.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/cc/libkea-cc.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/hooks/libkea-hooks.la
-libkea_process_la_LIBADD += $(top_builddir)/src/lib/cryptolink/libkea-cryptolink.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/log/libkea-log.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/util/libkea-util.la
 libkea_process_la_LIBADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
-libkea_process_la_LIBADD += $(LOG4CPLUS_LIBS) $(CRYPTO_LIBS) $(BOOST_LIBS)
+libkea_process_la_LIBADD += $(LOG4CPLUS_LIBS) $(BOOST_LIBS)
 
 # Specify the headers for copying into the installation directory tree.
 libkea_process_includedir = $(pkgincludedir)/process

diff --git a/src/lib/process/d_controller.cc b/src/lib/process/d_controller.cc
index fd024b6e650f595d5550955ad47fcef0e587a169..3e05aab24d200c821be685802f87c36426faa7c1 100644 (file)
--- a/src/lib/process/d_controller.cc
+++ b/src/lib/process/d_controller.cc
@@ -7,7 +7,6 @@
 #include <config.h>
 #include <cc/command_interpreter.h>
 #include <cfgrpt/config_report.h>
-#include <cryptolink/cryptolink.h>
 #include <dhcpsrv/cfgmgr.h>
 #include <exceptions/exceptions.h>
 #include <log/logger.h>
@@ -674,20 +673,7 @@ DControllerBase::getVersion(bool extended) {
         tmp << std::endl << EXTENDED_VERSION << std::endl;
         tmp << "linked with:" << std::endl;
         tmp << isc::log::Logger::getVersion() << std::endl;
-        tmp << isc::cryptolink::CryptoLink::getVersion() << std::endl;
-        tmp << "database:" << std::endl;
-#ifdef HAVE_MYSQL
-        tmp << isc::dhcp::MySqlLeaseMgr::getDBVersion() << std::endl;
-#endif
-#ifdef HAVE_PGSQL
-        tmp << isc::dhcp::PgSqlLeaseMgr::getDBVersion() << std::endl;
-#endif
-#ifdef HAVE_CQL
-        tmp << isc::dhcp::CqlLeaseMgr::getDBVersion() << std::endl;
-#endif
-        tmp << isc::dhcp::Memfile_LeaseMgr::getDBVersion();
-
-        // @todo: more details about database runtime
+        tmp << getVersionAddendum();
     }
 
     return (tmp.str());

diff --git a/src/lib/process/d_controller.h b/src/lib/process/d_controller.h
index c7c3aa11fe7352fb3d27077f542497ba85def37a..63d00c87be58c49d36bb95850071b129f6eca946 100644 (file)
--- a/src/lib/process/d_controller.h
+++ b/src/lib/process/d_controller.h
@@ -115,7 +115,7 @@ public:
 
     /// @brief returns Kea version on stdout and exit.
     /// redeclaration/redefinition. @ref isc::dhcp::Daemon::getVersion()
-    static std::string getVersion(bool extended);
+    std::string getVersion(bool extended);
 
     /// @brief Acts as the primary entry point into the controller execution
     /// and provides the outermost application control logic:
@@ -587,6 +587,15 @@ protected:
     /// This is intended to be used for specific usage violation messages.
     void usage(const std::string& text);
 
+    /// @brief Fetches text containing additional version specifics
+    ///
+    /// This method is provided so derivations can append any additional
+    /// desired information such as library dependencies to the extended
+    /// version text returned when DControllerBase::getVersion(true) is
+    /// invoked.
+    /// @return a string containing additonal version info
+    virtual std::string getVersionAddendum() { return (""); }
+
 private:
     /// @brief Name of the service under control.
     /// This name is used as the configuration module name and appears in log

diff --git a/src/lib/process/tests/d_controller_unittests.cc b/src/lib/process/tests/d_controller_unittests.cc
index 1858e31628091d297354fbadc35cbba51520e057..e6e96ab6c23e441a6935764401fb4fa1b1e5bf85 100644 (file)
--- a/src/lib/process/tests/d_controller_unittests.cc
+++ b/src/lib/process/tests/d_controller_unittests.cc
@@ -418,6 +418,17 @@ TEST_F(DStubControllerTest, sigintShutdown) {
     EXPECT_TRUE(elapsed_time.total_milliseconds() < 300);
 }
 
+// Verifies that version and extended version information is correct
+TEST_F(DStubControllerTest, getVersion) {
+    std::string text = controller_->getVersion(false);
+    EXPECT_EQ(text,VERSION);
+
+    text = controller_->getVersion(true);
+    EXPECT_NE(std::string::npos, text.find(VERSION));
+    EXPECT_NE(std::string::npos, text.find(EXTENDED_VERSION));
+    EXPECT_NE(std::string::npos, text.find(controller_->getVersionAddendum()));
+}
+
 // Tests that the SIGTERM triggers a normal shutdown.
 TEST_F(DStubControllerTest, sigtermShutdown) {
     // Setup to raise SIGHUP in 1 ms.

diff --git a/src/lib/process/testutils/d_test_stubs.h b/src/lib/process/testutils/d_test_stubs.h
index 334adac7bf95cf3f5902cb8a7c6503a6172d82c1..cbdfc6ee74c8d69d9deb1ebee142abf7b77ffa99 100644 (file)
--- a/src/lib/process/testutils/d_test_stubs.h
+++ b/src/lib/process/testutils/d_test_stubs.h
@@ -275,6 +275,17 @@ protected:
     /// otherwise it return an empty pointer.
     virtual isc::data::ConstElementPtr parseFile(const std::string&);
 
+public:
+
+    /// @brief Provides addtional extended version text
+    ///
+    /// Overrides the base class implementation so we can
+    /// verify the getting the extended version text
+    /// contains derivaiton specific contributions.
+    virtual std::string getVersionAddendum() {
+        return ("StubController Version Text");
+    }
+
 private:
     /// @brief Constructor is private to protect singleton integrity.
     DStubController();