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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465 | // 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 <dhcpsrv/testutils/host_data_source_utils.h>
#include <asiolink/io_address.h>
#include <cc/data.h>
#include <gtest/gtest.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <boost/foreach.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace std;
using namespace isc::data;
using namespace isc::asiolink;
using namespace isc::util;
namespace isc {
namespace dhcp {
namespace test {
std::vector<uint8_t>
HostDataSourceUtils::generateHWAddr(const bool new_identifier) {
// Let's use something that is easily printable. That's convenient
// if you need to enter MySQL queries by hand.
static uint8_t hwaddr[] = {65, 66, 67, 68, 69, 70};
if (new_identifier) {
// Increase the address for the next time we use it.
// This is primitive, but will work for 65k unique
// addresses.
hwaddr[sizeof(hwaddr) - 1]++;
if (hwaddr[sizeof(hwaddr) - 1] == 0) {
hwaddr[sizeof(hwaddr) - 2]++;
}
}
return (std::vector<uint8_t>(hwaddr, hwaddr + sizeof(hwaddr)));
}
std::vector<uint8_t>
HostDataSourceUtils::generateIdentifier(const bool new_identifier) {
// Let's use something that is easily printable. That's convenient
// if you need to enter MySQL queries by hand.
static uint8_t ident[] = {65, 66, 67, 68, 69, 70, 71, 72, 73, 74};
if (new_identifier) {
// Increase the identifier for the next time we use it.
// This is primitive, but will work for 65k unique identifiers.
ident[sizeof(ident) - 1]++;
if (ident[sizeof(ident) - 1] == 0) {
ident[sizeof(ident) - 2]++;
}
}
return (std::vector<uint8_t>(ident, ident + sizeof(ident)));
}
HostPtr
HostDataSourceUtils::initializeHost4(const std::string& address,
const Host::IdentifierType& id,
const bool new_identifier) {
std::vector<uint8_t> ident;
if (id == Host::IDENT_HWADDR) {
ident = generateHWAddr(new_identifier);
} else {
ident = generateIdentifier(new_identifier);
}
// Let's create ever increasing subnet-ids. Let's keep those different,
// so subnet4 != subnet6. Useful for catching cases if the code confuses
// subnet4 with subnet6.
static SubnetID subnet4 = 0;
static SubnetID subnet6 = 100;
++subnet4;
++subnet6;
IOAddress addr(address);
HostPtr host(new Host(&ident[0], ident.size(), id, subnet4, subnet6, addr));
return (host);
}
HostPtr
HostDataSourceUtils::initializeHost6(std::string address,
Host::IdentifierType identifier,
bool prefix,
bool new_identifier,
const std::string auth_key) {<--- Function parameter 'auth_key' should be passed by const reference.
std::vector<uint8_t> ident;
switch (identifier) {
case Host::IDENT_HWADDR:
ident = generateHWAddr(new_identifier);
break;
case Host::IDENT_DUID:
ident = generateIdentifier(new_identifier);
break;
default:
ADD_FAILURE() << "Unknown IdType: " << identifier;
return HostPtr();
}
// Let's create ever increasing subnet-ids. Let's keep those different,
// so subnet4 != subnet6. Useful for catching cases if the code confuses
// subnet4 with subnet6.
static SubnetID subnet4 = 0;
static SubnetID subnet6 = 100;
++subnet4;
++subnet6;
HostPtr host(new Host(&ident[0], ident.size(), identifier, subnet4, subnet6,
IOAddress("0.0.0.0")));
host->setKey(AuthKey(auth_key));
if (!prefix) {
// Create IPv6 reservation (for an address)
IPv6Resrv resv(IPv6Resrv::TYPE_NA, IOAddress(address), 128);
host->addReservation(resv);
} else {
// Create IPv6 reservation for a /64 prefix
IPv6Resrv resv(IPv6Resrv::TYPE_PD, IOAddress(address), 64);
host->addReservation(resv);
}
return (host);
}
HostPtr
HostDataSourceUtils::initializeHost6(std::string prefix,
std::string exclude,
Host::IdentifierType identifier,
bool new_identifier,
const std::string auth_key) {<--- Function parameter 'auth_key' should be passed by const reference.
std::vector<uint8_t> ident;
switch (identifier) {
case Host::IDENT_HWADDR:
ident = generateHWAddr(new_identifier);
break;
case Host::IDENT_DUID:
ident = generateIdentifier(new_identifier);
break;
default:
ADD_FAILURE() << "Unknown IdType: " << identifier;
return HostPtr();
}
// Let's create ever increasing subnet-ids. Let's keep those different,
// so subnet4 != subnet6. Useful for catching cases if the code confuses
// subnet4 with subnet6.
static SubnetID subnet4 = 0;
static SubnetID subnet6 = 100;
++subnet4;
++subnet6;
HostPtr host(new Host(&ident[0], ident.size(), identifier, subnet4, subnet6,
IOAddress("0.0.0.0")));
host->setKey(AuthKey(auth_key));
// Create IPv6 reservation for a /48 prefix
IPv6Resrv resv(IPv6Resrv::TYPE_PD, IOAddress(prefix), 48);
resv.setPDExclude(IOAddress(exclude), 64);
host->addReservation(resv);
return (host);
}
bool
HostDataSourceUtils::reservationExists(const IPv6Resrv& resrv,
const IPv6ResrvRange& range) {
BOOST_FOREACH(auto const& it, range) {
if (resrv == it.second) {
return true;
}
}
return false;
}
void
HostDataSourceUtils::compareHwaddrs(const ConstHostPtr& host1,
const ConstHostPtr& host2,
bool expect_match) {
ASSERT_TRUE(host1);
ASSERT_TRUE(host2);
// Compare if both have or have not HWaddress set.
if ((host1->getHWAddress() && !host2->getHWAddress()) ||
(!host1->getHWAddress() && host2->getHWAddress())) {
// One host has hardware address set while the other has not.
// Let's see if it's a problem.
if (expect_match) {
ADD_FAILURE() << "Host comparison failed: host1 hwaddress="
<< host1->getHWAddress()
<< ", host2 hwaddress=" << host2->getHWAddress();
}
return;
}
// Now we know that either both or neither have hw address set.
// If host1 has it, we can proceed to value comparison.
if (host1->getHWAddress()) {
if (expect_match) {
// Compare the actual address if they match.
EXPECT_TRUE(*host1->getHWAddress() == *host2->getHWAddress());
} else {
EXPECT_FALSE(*host1->getHWAddress() == *host2->getHWAddress());
}
if (*host1->getHWAddress() != *host2->getHWAddress()) {
cout << host1->getHWAddress()->toText(true) << endl;
cout << host2->getHWAddress()->toText(true) << endl;
}
}
}
void
HostDataSourceUtils::compareDuids(const ConstHostPtr& host1,
const ConstHostPtr& host2,
bool expect_match) {
ASSERT_TRUE(host1);
ASSERT_TRUE(host2);
// compare if both have or have not DUID set
if ((host1->getDuid() && !host2->getDuid()) ||
(!host1->getDuid() && host2->getDuid())) {
// One host has a DUID and the other doesn't.
// Let's see if it's a problem.
if (expect_match) {
ADD_FAILURE() << "DUID comparison failed: host1 duid="
<< host1->getDuid()
<< ", host2 duid=" << host2->getDuid();
}
return;
}
// Now we know that either both or neither have DUID set.
// If host1 has it, we can proceed to value comparison.
if (host1->getDuid()) {
if (expect_match) {
EXPECT_TRUE(*host1->getDuid() == *host2->getDuid());
} else {
EXPECT_FALSE(*host1->getDuid() == *host2->getDuid());
}
if (*host1->getDuid() != *host2->getDuid()) {
cout << host1->getDuid()->toText() << endl;
cout << host2->getDuid()->toText() << endl;
}
}
}
void
HostDataSourceUtils::compareHosts(const ConstHostPtr& host1,
const ConstHostPtr& host2) {
ASSERT_TRUE(host1);
ASSERT_TRUE(host2);
// Let's compare HW addresses and expect match.
compareHwaddrs(host1, host2, true);
// Now compare DUIDs
compareDuids(host1, host2, true);
// Now check that the identifiers returned as vectors are the same
EXPECT_EQ(host1->getIdentifierType(), host2->getIdentifierType());
EXPECT_TRUE(host1->getIdentifier() == host2->getIdentifier());
// Check host parameters
EXPECT_EQ(host1->getIPv4SubnetID(), host2->getIPv4SubnetID());
EXPECT_EQ(host1->getIPv6SubnetID(), host2->getIPv6SubnetID());
EXPECT_EQ(host1->getIPv4Reservation(), host2->getIPv4Reservation());
EXPECT_EQ(host1->getHostname(), host2->getHostname());
EXPECT_EQ(host1->getNextServer(), host2->getNextServer());
EXPECT_EQ(host1->getServerHostname(), host2->getServerHostname());
EXPECT_EQ(host1->getBootFileName(), host2->getBootFileName());
EXPECT_TRUE(host1->getKey() == host2->getKey());
ConstElementPtr ctx1 = host1->getContext();
ConstElementPtr ctx2 = host2->getContext();
if (ctx1) {
EXPECT_TRUE(ctx2);
if (ctx2) {
EXPECT_EQ(*ctx1, *ctx2);
}
} else {
EXPECT_FALSE(ctx2);
}
// Compare IPv6 reservations
compareReservations6(host1->getIPv6Reservations(),
host2->getIPv6Reservations());
// Compare client classification details
compareClientClasses(host1->getClientClasses4(),
host2->getClientClasses4());
compareClientClasses(host1->getClientClasses6(),
host2->getClientClasses6());
// Compare DHCPv4 and DHCPv6 options.
compareOptions(host1->getCfgOption4(), host2->getCfgOption4());
compareOptions(host1->getCfgOption6(), host2->getCfgOption6());
}
void
HostDataSourceUtils::compareReservations6(IPv6ResrvRange resrv1,
IPv6ResrvRange resrv2) {
// Compare number of reservations for both hosts
if (std::distance(resrv1.first, resrv1.second) !=
std::distance(resrv2.first, resrv2.second)) {
ADD_FAILURE() << "Reservation comparison failed, "
"hosts got different number of reservations.";
return;
}
// Iterate over the range of reservations to find a match in the
// reference range.
for (IPv6ResrvIterator r1 = resrv1.first; r1 != resrv1.second; ++r1) {
IPv6ResrvIterator r2 = resrv2.first;
for (; r2 != resrv2.second; ++r2) {
// IPv6Resrv object implements equality operator.
if (r1->second == r2->second) {
// but this operator does not check Prefix Exclude options.
auto const& p1 = r1->second.getPDExclude();
auto const& p2 = r2->second.getPDExclude();
if (!p1 && !p2) {
break;
} else if (p1 && p2 &&
(p1->getExcludedPrefixLength() ==
p2->getExcludedPrefixLength()) &&
(p1->getExcludedPrefixSubnetID() ==
p2->getExcludedPrefixSubnetID())) {
break;
}
}
}
// If r2 iterator reached the end of the range it means that there
// is no match.
if (r2 == resrv2.second) {
ADD_FAILURE() << "No match found for reservation: "
<< r1->second.getPrefix().toText();
return;
}
}
// Same with 1 and 2 swapped role.
for (IPv6ResrvIterator r2 = resrv2.first; r2 != resrv2.second; ++r2) {
IPv6ResrvIterator r1 = resrv1.first;
for (; r1 != resrv1.second; ++r1) {
// IPv6Resrv object implements equality operator.
if (r1->second == r2->second) {
// but this operator does not check Prefix Exclude options.
auto const& p1 = r1->second.getPDExclude();
auto const& p2 = r2->second.getPDExclude();
if (!p1 && !p1) {<--- Same expression on both sides of '&&'. [+]Finding the same expression on both sides of an operator is suspicious and might indicate a cut and paste or logic error. Please examine this code carefully to determine if it is correct.
break;
} else if (p1 && p2 &&
(p1->getExcludedPrefixLength() ==
p2->getExcludedPrefixLength()) &&
(p1->getExcludedPrefixSubnetID() ==
p2->getExcludedPrefixSubnetID())) {
break;
}
}
}
// If r1 iterator reached the end of the range it means that there
// is no match.
if (r1 == resrv1.second) {
ADD_FAILURE() << "No match found for reservation: "
<< r2->second.getPrefix().toText();
return;
}
}
}
void
HostDataSourceUtils::compareClientClasses(const ClientClasses& classes1,
const ClientClasses& classes2) {
EXPECT_TRUE(std::equal(classes1.cbegin(), classes1.cend(), classes2.cbegin()));
}
void
HostDataSourceUtils::compareOptions(const ConstCfgOptionPtr& cfg1,
const ConstCfgOptionPtr& cfg2) {
ASSERT_TRUE(cfg1);
ASSERT_TRUE(cfg2);
// Combine option space names with vendor space names in a single list.
std::list<std::string> option_spaces = cfg2->getOptionSpaceNames();
std::list<std::string> vendor_spaces = cfg2->getVendorIdsSpaceNames();
// Make sure that the number of option spaces is equal in both
// configurations.
EXPECT_EQ(option_spaces.size(), cfg1->getOptionSpaceNames().size());
EXPECT_EQ(vendor_spaces.size(), cfg1->getVendorIdsSpaceNames().size());
// Iterate over all option spaces existing in cfg2.
for (auto const& space : option_spaces) {
// Retrieve options belonging to the current option space.
OptionContainerPtr options1 = cfg1->getAll(space);
OptionContainerPtr options2 = cfg2->getAll(space);
ASSERT_TRUE(options1) << "failed for option space " << space;
ASSERT_TRUE(options2) << "failed for option space " << space;
// If number of options doesn't match, the test fails.
ASSERT_EQ(options1->size(), options2->size())
<< "failed for option space " << space;
// Iterate over all options within this option space.
for (auto const& desc1 : *options1) {
OptionDescriptor desc2 = cfg2->get(space, desc1.option_->getType());
// Compare persistent flag.
EXPECT_EQ(desc1.persistent_, desc2.persistent_)
<< "failed for option " << space << "."
<< desc1.option_->getType();
// Compare formatted value.
EXPECT_EQ(desc1.formatted_value_, desc2.formatted_value_)
<< "failed for option " << space << "."
<< desc1.option_->getType();
// Compare user context.
ConstElementPtr ctx1 = desc1.getContext();
ConstElementPtr ctx2 = desc2.getContext();
if (ctx1) {
EXPECT_TRUE(ctx2);
if (ctx2) {
EXPECT_EQ(*ctx1, *ctx2)
<< "failed for option " << space << "." << desc1.option_->getType();
}
} else {
EXPECT_FALSE(ctx2);
}
// Retrieve options.
Option* option1 = desc1.option_.get();<--- Variable 'option1' can be declared as pointer to const
Option* option2 = desc2.option_.get();<--- Variable 'option2' can be declared as pointer to const
// Options must be represented by the same C++ class derived from
// the Option class.
EXPECT_TRUE(typeid(*option1) == typeid(*option2))
<< "Compared DHCP options, having option code "
<< desc1.option_->getType() << " and belonging to the " << space
<< " option space, are represented "
"by different C++ classes: "
<< typeid(*option1).name() << " vs " << typeid(*option2).name();
// Because we use different C++ classes to represent different
// options, the simplest way to make sure that the options are
// equal is to simply compare them in wire format.
OutputBuffer buf1(option1->len());
ASSERT_NO_THROW(option1->pack(buf1));
OutputBuffer buf2(option2->len());
ASSERT_NO_THROW(option2->pack(buf2));
ASSERT_EQ(buf1.getLength(), buf2.getLength())
<< "failed for option " << space << "."
<< desc1.option_->getType();
EXPECT_EQ(0,
memcmp(buf1.getData(), buf2.getData(), buf1.getLength()))
<< "failed for option " << space << "."
<< desc1.option_->getType();
}
}
}
}
}
}
|