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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
// Copyright (C) 2018-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/.
#include <config.h>
#include <dhcp/libdhcp++.h>
#include <dhcp/option_vendor.h>
#include <dhcpsrv/cb_ctl_dhcp.h>
#include <dhcpsrv/testutils/generic_backend_unittest.h>
#include <util/buffer.h>
#include <typeinfo>
#include <testutils/gtest_utils.h>
#include <boost/range/adaptor/reversed.hpp>
using namespace isc::data;
using namespace isc::db;
namespace isc {
namespace dhcp {
namespace test {
GenericBackendTest::GenericBackendTest()
: timestamps_(), audit_entries_() {
LibDHCP::clearRuntimeOptionDefs();
initTimestamps();
}
GenericBackendTest::~GenericBackendTest() {
LibDHCP::clearRuntimeOptionDefs();
}
OptionDescriptor
GenericBackendTest::createEmptyOption(const Option::Universe& universe,
const uint16_t option_type,
const bool persist,
const bool cancel) const {
OptionPtr option(new Option(universe, option_type));
OptionDescriptor desc(option, persist, cancel);
return (desc);
}
OptionDescriptor
GenericBackendTest::createVendorOption(const Option::Universe& universe,
const bool persist,
const bool cancel,
const bool formatted,
const uint32_t vendor_id) const {
OptionVendorPtr option(new OptionVendor(universe, vendor_id));
std::ostringstream s;
if (formatted) {
// Vendor id comprises vendor-id field, for which we need to
// assign a value in the textual (formatted) format.
s << vendor_id;
}
OptionDescriptor desc(option, persist, cancel, s.str());
return (desc);
}
void
GenericBackendTest::testOptionsEquivalent(const OptionDescriptor& ref_option,
const OptionDescriptor& tested_option) const {
// Make sure that all pointers are non-null.
ASSERT_TRUE(ref_option.option_);
ASSERT_TRUE(tested_option.option_);
// Get the reference to the tested option. Make should it has
// generic type.
Option& tested_option_reference = *tested_option.option_;
EXPECT_TRUE(typeid(tested_option_reference) == typeid(Option));
// Only test the binary data if the formatted value is not provided.
if (tested_option.formatted_value_.empty()) {
// Prepare on-wire data of the option under test.
isc::util::OutputBuffer tested_option_buf(1);
tested_option.option_->pack(tested_option_buf);
const uint8_t* tested_option_buf_data = static_cast<const uint8_t*>
(tested_option_buf.getData());
std::vector<uint8_t> tested_option_buf_vec(tested_option_buf_data,
tested_option_buf_data + tested_option_buf.getLength());
// Prepare on-wire data of the reference option.
isc::util::OutputBuffer ref_option_buf(1);
ref_option.option_->pack(ref_option_buf);
const uint8_t* ref_option_buf_data = static_cast<const uint8_t*>
(ref_option_buf.getData());
std::vector<uint8_t> ref_option_buf_vec(ref_option_buf_data,
ref_option_buf_data + ref_option_buf.getLength());
// Compare the on-wire data.
EXPECT_EQ(ref_option_buf_vec, tested_option_buf_vec);
} else {
// If the formatted value is non-empty the buffer should be empty.
EXPECT_TRUE(tested_option.option_->getData().empty());
}
// Compare other members of the @c OptionDescriptor, e.g. the
// tested option may contain formatted option data which can be
// later used to turn this option instance into a formatted
// option when an option definition is available.
EXPECT_EQ(ref_option.formatted_value_, tested_option.formatted_value_);
EXPECT_EQ(ref_option.persistent_, tested_option.persistent_);
EXPECT_EQ(ref_option.cancelled_, tested_option.cancelled_);
EXPECT_EQ(ref_option.space_name_, tested_option.space_name_);
}
void
GenericBackendTest::checkConfiguredGlobal(const SrvConfigPtr& srv_cfg,
const std::string &name,
ConstElementPtr exp_value) {
ConstCfgGlobalsPtr globals = srv_cfg->getConfiguredGlobals();
std::string param_name;
std::string sub_param_name;
bool translated = CBControlDHCP<bool>::translateName(name, param_name, sub_param_name);
ConstElementPtr found_global = globals->get(param_name);
ASSERT_TRUE(found_global) << "expected global: "
<< param_name << " not found";
if (translated) {
ASSERT_EQ(Element::map, found_global->getType())
<< "expected global: " << param_name << " has wrong type";
found_global = found_global->get(sub_param_name);
ASSERT_TRUE(found_global) << "expected global: "
<< name << " not found";
}
ASSERT_EQ(exp_value->getType(), found_global->getType())
<< "expected global: " << name << " has wrong type";
ASSERT_EQ(*exp_value, *found_global)
<< "expected global: " << name << " has wrong value";
}
void
GenericBackendTest::checkConfiguredGlobal(const SrvConfigPtr& srv_cfg,
StampedValuePtr& exp_global) {
checkConfiguredGlobal(srv_cfg, exp_global->getName(), exp_global->getElementValue());
}
void
GenericBackendTest::testNewAuditEntry(const std::string& exp_object_type,
const AuditEntry::ModificationType& exp_modification_type,
const std::string& exp_log_message,
const ServerSelector& server_selector,
const size_t new_entries_num,
const size_t max_tested_entries) {
// Get the server tag for which the entries are fetched.
std::string tag;
if (server_selector.getType() == ServerSelector::Type::ALL) {
// Server tag is 'all'.
tag = "all";
} else {
auto const& tags = server_selector.getTags();
// This test is not meant to handle multiple server tags all at once.
if (tags.size() > 1) {
ADD_FAILURE() << "Test error: do not use multiple server tags";
} else if (tags.size() == 1) {
// Get the server tag for which we run the current test.
tag = tags.begin()->get();
}
}
auto audit_entries_size_save = audit_entries_[tag].size();
// Audit entries for different server tags are stored in separate
// containers.
ASSERT_NO_THROW_LOG(audit_entries_[tag]
= getRecentAuditEntries(server_selector, timestamps_["two days ago"], 0));
ASSERT_EQ(audit_entries_size_save + new_entries_num, audit_entries_[tag].size())
<< logExistingAuditEntries(tag);
auto& mod_time_idx = audit_entries_[tag].get<AuditEntryModificationTimeIdTag>();
// Iterate over specified number of entries starting from the most recent
// one and check they have correct values.
size_t count = 0;
for (auto const& audit_entry_it : boost::adaptors::reverse(mod_time_idx)) {
if (count >= new_entries_num || count >= max_tested_entries) {
break;
}
count++;
auto audit_entry = audit_entry_it;
EXPECT_EQ(exp_object_type, audit_entry->getObjectType())
<< logExistingAuditEntries(tag);
EXPECT_EQ(exp_modification_type, audit_entry->getModificationType())
<< logExistingAuditEntries(tag);
EXPECT_EQ(exp_log_message, audit_entry->getLogMessage())
<< logExistingAuditEntries(tag);
}
}
void
GenericBackendTest::testNewAuditEntry(const std::vector<ExpAuditEntry>& exp_entries,
const ServerSelector& server_selector) {
// Get the server tag for which the entries are fetched.
std::string tag;
if (server_selector.getType() == ServerSelector::Type::ALL) {
// Server tag is 'all'.
tag = "all";
} else {
auto const& tags = server_selector.getTags();
// This test is not meant to handle multiple server tags all at once.
if (tags.size() != 1) {
ADD_FAILURE() << "Test error: tags.size(): " << tags.size()
<< ", you must specify one and only one server tag";
}
// Get the server tag for which we run the current test.
tag = tags.begin()->get();
}
size_t new_entries_num = exp_entries.size();
auto audit_entries_size_save = audit_entries_[tag].size();
// Audit entries for different server tags are stored in separate
// containers.
ASSERT_NO_THROW_LOG(audit_entries_[tag]
= getRecentAuditEntries(server_selector, timestamps_["two days ago"], 0));
ASSERT_EQ(audit_entries_size_save + new_entries_num, audit_entries_[tag].size())
<< logExistingAuditEntries(tag);
auto& mod_time_idx = audit_entries_[tag].get<AuditEntryModificationTimeIdTag>();
// Iterate over specified number of entries starting from the most recent
// one and check they have correct values.
auto exp_entry = exp_entries.rbegin();
size_t count = 0;
for (auto const& audit_entry_it : boost::adaptors::reverse(mod_time_idx)) {
if (count >= new_entries_num) {
break;
}
count++;
auto audit_entry = audit_entry_it;
EXPECT_EQ((*exp_entry).object_type, audit_entry->getObjectType())
<< logExistingAuditEntries(tag);
EXPECT_EQ((*exp_entry).modification_type, audit_entry->getModificationType())
<< logExistingAuditEntries(tag);
EXPECT_EQ((*exp_entry).log_message, audit_entry->getLogMessage())
<< logExistingAuditEntries(tag);
++exp_entry;
}
}
void
GenericBackendTest::initTimestamps() {
// Current time minus 1 hour to make sure it is in the past.
timestamps_["today"] = boost::posix_time::second_clock::local_time()
- boost::posix_time::hours(1);
// One second after today.
timestamps_["after today"] = timestamps_["today"] + boost::posix_time::seconds(1);
// Yesterday.
timestamps_["yesterday"] = timestamps_["today"] - boost::posix_time::hours(24);
// One second after yesterday.
timestamps_["after yesterday"] = timestamps_["yesterday"] + boost::posix_time::seconds(1);
// Two days ago.
timestamps_["two days ago"] = timestamps_["today"] - boost::posix_time::hours(48);
// Tomorrow.
timestamps_["tomorrow"] = timestamps_["today"] + boost::posix_time::hours(24);
// One second after tomorrow.
timestamps_["after tomorrow"] = timestamps_["tomorrow"] + boost::posix_time::seconds(1);
}
std::string
GenericBackendTest::logExistingAuditEntries(const std::string& server_tag) {
std::ostringstream s;
auto& mod_time_idx = audit_entries_[server_tag].get<AuditEntryModificationTimeIdTag>();
for (auto const& audit_entry_it : mod_time_idx) {
auto audit_entry = audit_entry_it;
s << audit_entry->getObjectType() << ", "
<< audit_entry->getObjectId() << ", "
<< static_cast<int>(audit_entry->getModificationType()) << ", "
<< audit_entry->getModificationTime() << ", "
<< audit_entry->getRevisionId() << ", "
<< audit_entry->getLogMessage()
<< std::endl;
}
return (s.str());
}
AuditEntryCollection
GenericBackendTest::getRecentAuditEntries(const ServerSelector&, const boost::posix_time::ptime&,
const uint64_t&) const {
return (AuditEntryCollection());
}
} // end of namespace isc::dhcp::test
} // end of namespace isc::dhcp
} // end of namespace isc
|