1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
// Copyright (C) 2022 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 {
/// @brief Test fixture for testing loading and unloading of hook libraries.
class LibLoadTest : public ::testing::Test {
public:
/// @brief Constructor. Unloads any previously loaded libraries.
///
/// @param lib_so_name_ full pathname to the library so file under test
LibLoadTest(const std::string lib_so_name = "no-lib-specified")
: lib_so_name_(lib_so_name) {
unloadLibraries();
}
virtual void SetUp() {
valid_params_ = validConfigParams();
}
/// @brief Destructor. Unloads any previously loaded libraries.
~LibLoadTest() {
unloadLibraries();
}
/// @brief Adds a library along with its parameters to the list of
/// libraries to be loaded.
///
/// @param library the path to the library to be loaded
/// @param parameters the library's parameters in Element format
void addLibrary(const std::string& library,
isc::data::ConstElementPtr parameters) {
libraries_.push_back({library, parameters});
}
void clearLibraries() {
libraries_.clear();
}
/// @brief Load all libraries.
///
/// @return true if all libraries loaded successfully, false if one or more
/// libraries failed to load.
bool loadLibraries() {
bool result(false);
EXPECT_NO_THROW(result = isc::hooks::HooksManager::loadLibraries(libraries_));
return result;
}
/// @brief Unloads all libraries.
///
/// @return true if all libraries unloaded successfully, false if they
/// are still in memory.
bool unloadLibraries() {
bool result(false);
EXPECT_NO_THROW(result = isc::hooks::HooksManager::unloadLibraries());
return result;
}
/// @brief Verifies that a valid daemon can load and unload a
/// library multiple times.
///
/// @param daemon_name name of the daemon that should try to load the library
/// @param family Protocol family of the loading daemon, either
/// AF_INET or AF_INET6. Defaults to AF_INET.
/// @param params ElementPtr to set of parameters that are valid for the library.
/// Defaults to an empty pointer.
///
/// @note: implemented here to avoid dependency with the dhcpsrv library.
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());
}
/// @brief Verifies that an invalid daemon cannot load the library.
///
/// @param libname full path to the library's SO. Typically this
/// value is defined in the Makefile (e.g. -DLIBDHCP_BOOTP_SO=...)
/// @param daemon_name name of the daemon that should try to load the library
/// @param family Protocol family of the loading daemon, either
/// AF_INET or AF_INET6. Defaults to AF_INET.
/// @param params ElementPtr to set of parameters that are valid
/// for the library. Defaults to an empty pointer.
///
/// @note: implemented here to avoid dependency with the dhcpsrv library.
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;
}
/// @brief Creates a set configuration parameters valid for the library.
virtual isc::data::ElementPtr validConfigParams() {
return (isc::data::Element::createMap());
}
/// @brief full pathname to the library so file under test;
std::string lib_so_name_;
/// @brief Libraries
isc::hooks::HookLibsCollection libraries_;
/// @brief Contains a set configuration parameters valid for the library.
isc::data::ElementPtr valid_params_;
};
} // namespace test
} // namespace isc
#endif // ISC_TESTUTILS_LIB_LOAD_TEST_FIXTURE_H
|
