lib_load_test_fixture.h

Go to the documentation of this file.

// Copyright (C) 2022-2024 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/.
 
#ifndef ISC_TESTUTILS_LIB_LOAD_TEST_FIXTURE_H
#define ISC_TESTUTILS_LIB_LOAD_TEST_FIXTURE_H
 
#include <cc/data.h>
#include <dhcpsrv/cfgmgr.h>
#include <process/daemon.h>
#include <testutils/gtest_utils.h>
 
namespace isc {
namespace test {
 
class LibLoadTest : public ::testing::Test {
public:
    LibLoadTest(const std::string lib_so_name = "no-lib-specified")
        : lib_so_name_(lib_so_name) {
        unloadLibraries();
    }
 
    virtual void SetUp() {
        valid_params_ = validConfigParams();
    }
 
    ~LibLoadTest() {
        unloadLibraries();
    }
 
    void addLibrary(const std::string& library,
                    isc::data::ConstElementPtr parameters) {
        libraries_.push_back({library, parameters});
    }
 
    void clearLibraries() {
        libraries_.clear();
    }
 
    bool loadLibraries() {
        bool result(false);
        EXPECT_NO_THROW(result = isc::hooks::HooksManager::loadLibraries(libraries_));
        return result;
    }
 
    bool unloadLibraries() {
        bool result(false);
        EXPECT_NO_THROW(result = isc::hooks::HooksManager::unloadLibraries());
        return result;
    }
 
    void validDaemonTest(const std::string& daemon_name,
                         uint16_t family = AF_INET,
                         const isc::data::ElementPtr& params = isc::data::ElementPtr()) {
            // Set family and daemon's proc name.
        isc::dhcp::CfgMgr::instance().setFamily(family);
        isc::process::Daemon::setProcName(daemon_name);
 
        clearLibraries();
 
        // Adding the library to the list of libraries should work.
        ASSERT_NO_THROW_LOG(addLibrary(lib_so_name_, params));
 
        // Should be able to load and unload the library more than once.
        ASSERT_NO_THROW_LOG(loadLibraries());
        ASSERT_NO_THROW_LOG(unloadLibraries());
 
        ASSERT_NO_THROW_LOG(loadLibraries());
        ASSERT_NO_THROW_LOG(unloadLibraries());
    }
 
    void invalidDaemonTest(const std::string& daemon_name,
                           uint16_t family = AF_INET,
                           const isc::data::ElementPtr& params = isc::data::ElementPtr()) {
        // Set family and daemon's proc name.
        isc::dhcp::CfgMgr::instance().setFamily(family);
        isc::process::Daemon::setProcName(daemon_name);
 
        clearLibraries();
 
        // Adding the library to the list of libraries should work.
        ASSERT_NO_THROW_LOG(addLibrary(lib_so_name_, params));
 
        // Loading the library should fail.
        ASSERT_FALSE(loadLibraries()) << "library: " << lib_so_name_
            << ", should not have loaded for: " << daemon_name;
    }
 
    virtual isc::data::ElementPtr validConfigParams() {
        return (isc::data::Element::createMap());
    }
 
    std::string lib_so_name_;
 
    isc::hooks::HookLibsCollection libraries_;
 
    isc::data::ElementPtr valid_params_;
};
 
}  // namespace test
}  // namespace isc
 
#endif // ISC_TESTUTILS_LIB_LOAD_TEST_FIXTURE_H