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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531 | // Copyright (C) 2014-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/iface_mgr.h>
#include <dhcp4/json_config_parser.h>
#include <dhcp4/tests/d2_unittest.h>
#include <dhcpsrv/cfgmgr.h>
#include <gtest/gtest.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <string><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc;
using namespace isc::asiolink;
using namespace isc::data;
namespace isc {
namespace dhcp {
namespace test {
void
D2Dhcpv4Srv::d2ClientErrorHandler(const
dhcp_ddns::NameChangeSender::Result result,
dhcp_ddns::NameChangeRequestPtr& ncr) {
++error_count_;
// call base class error handler
Dhcpv4Srv::d2ClientErrorHandler(result, ncr);
}
const bool Dhcp4SrvD2Test::SHOULD_PASS;
const bool Dhcp4SrvD2Test::SHOULD_FAIL;
Dhcp4SrvD2Test::Dhcp4SrvD2Test() : rcode_(-1) {
}
Dhcp4SrvD2Test::~Dhcp4SrvD2Test() {
reset();
}
dhcp_ddns::NameChangeRequestPtr
Dhcp4SrvD2Test::buildTestNcr(uint32_t dhcid_id_num) {
// Build an NCR from json string.
std::ostringstream stream;
stream <<
"{"
" \"change-type\" : 0 , "
" \"forward-change\" : true , "
" \"reverse-change\" : false , "
" \"fqdn\" : \"myhost.example.com.\" , "
" \"ip-address\" : \"192.168.2.1\" , "
" \"dhcid\" : \""
<< std::hex << std::setfill('0') << std::setw(16)
<< dhcid_id_num << "\" , "
" \"lease-expires-on\" : \"20140121132405\" , "
" \"lease-length\" : 1300, "
" \"conflict-resolution-mode\" : \"check-with-dhcid\""
"}";
return (dhcp_ddns::NameChangeRequest::fromJSON(stream.str()));
}
void
Dhcp4SrvD2Test::reset() {
CfgMgr::instance().clear();
std::string config = "{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"hooks-libraries\": [ ], "
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"valid-lifetime\": 4000, "
"\"subnet4\": [ ], "
"\"dhcp-ddns\": { \"enable-updates\" : false }, "
"\"option-def\": [ ], "
"\"option-data\": [ ] }";
configure(config, SHOULD_PASS);
}
void
Dhcp4SrvD2Test::configureD2(bool enable_d2, const bool exp_result,
const std::string& server_ip,
const size_t port,
const std::string& sender_ip,
const size_t sender_port,
const size_t max_queue_size) {
std::ostringstream config;
config <<
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"ddns-override-no-update\" : true, "
"\"ddns-override-client-update\" : true, "
"\"ddns-replace-client-name\" : \"when-present\", "
"\"ddns-generated-prefix\" : \"test.prefix\", "
"\"ddns-qualifying-suffix\" : \"test.suffix.\", "
"\"subnet4\": [ { "
" \"id\": 1,"
" \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
" \"subnet\": \"192.0.2.0/24\" } ],"
" \"dhcp-ddns\" : {"
" \"enable-updates\" : " << (enable_d2 ? "true" : "false") << ", "
" \"server-ip\" : \"" << server_ip << "\", "
" \"server-port\" : " << port << ", "
" \"sender-ip\" : \"" << sender_ip << "\", "
" \"sender-port\" : " << sender_port << ", "
" \"max-queue-size\" : " << max_queue_size << ", "
" \"ncr-protocol\" : \"UDP\", "
" \"ncr-format\" : \"JSON\"},"
"\"valid-lifetime\": 4000 }";
configure(config.str(), exp_result);
}
void
Dhcp4SrvD2Test::configure(const std::string& config, bool exp_result) {
ElementPtr json = Element::fromJSON(config);
ConstElementPtr status;
// Configure the server and make sure the config is accepted
EXPECT_NO_THROW(status = configureDhcp4Server(srv_, json));
ASSERT_TRUE(status);
int rcode;
ConstElementPtr comment = config::parseAnswer(rcode, status);
if (exp_result == SHOULD_PASS) {
ASSERT_EQ(0, rcode) << "parse comment: " << comment->stringValue();
} else {
ASSERT_EQ(1, rcode) << "parse comment: " << comment->stringValue();
}
if (rcode == 0) {
CfgMgr::instance().commit();
}
}
// Tests ability to turn on and off ddns updates by submitting
// by submitting the appropriate configuration to Dhcp4 server
// and then invoking its startD2() method.
TEST_F(Dhcp4SrvD2Test, enableDisable) {<--- syntax error
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
// Verify a valid config with ddns enabled configures ddns properly,
// but does not start the sender.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
// Verify that calling start does not throw and starts the sender.
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Verify a valid config with ddns disabled configures ddns properly.
// Sender should not have been started.
ASSERT_NO_FATAL_FAILURE(configureD2(false));
ASSERT_FALSE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
// Verify that the sender does NOT get started when ddns is disabled.
srv_.startD2();
ASSERT_FALSE(mgr.amSending());
}
// Tests Dhcp4 server's ability to correctly handle a flawed dhcp-ddns
// configuration. It does so by first enabling updates by submitting a valid
// configuration and then ensuring they remain on after submitting a flawed
// configuration and then invoking its startD2() method.
TEST_F(Dhcp4SrvD2Test, badConfig) {
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
// Configure it enabled and start it.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Now attempt to give it an invalid configuration.
// Result should indicate failure.
ASSERT_NO_FATAL_FAILURE(configureD2(false, SHOULD_FAIL, "bogus_ip"));
// Configure was not altered, so ddns should be enabled and still sending.
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_TRUE(mgr.amSending());
// Verify that calling start does not throw or stop the sender.
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
}
// Checks that submitting an identical dhcp-ddns configuration
// is handled properly. Not effect should be no change in
// status for ddns updating. Updates should still enabled and
// in send mode. This indicates that the sender was not stopped.
TEST_F(Dhcp4SrvD2Test, sameConfig) {
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
// Configure it enabled and start it.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Now submit an identical configuration.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
// Configuration was not altered, so ddns should still enabled and sending.
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_TRUE(mgr.amSending());
// Verify that calling start does not throw or stop the sender.
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
}
// Checks that submitting an different, but valid dhcp-ddns configuration
// is handled properly. Updates should be enabled, however they should
// not yet be running. This indicates that the sender was stopped and
// replaced, but not yet started.
TEST_F(Dhcp4SrvD2Test, differentConfig) {
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
// Configure it enabled and start it.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Now enable it on a different port.
ASSERT_NO_FATAL_FAILURE(configureD2(true, SHOULD_PASS, "127.0.0.1", 54001));
// Configuration was altered, so ddns should still enabled but not sending.
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
// Verify that calling start starts the sender.
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
}
// Checks that given a valid, enabled configuration and placing
// sender in send mode, permits NCR requests to be sent via UPD
// socket. Note this test does not employ any sort of receiving
// client to verify actual transmission. These types of tests
// are including under dhcp_ddns and d2 unit testing.
TEST_F(Dhcp4SrvD2Test, simpleUDPSend) {
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
// Configure it enabled and start it.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(mgr.clearQueue());
EXPECT_EQ(0, mgr.getQueueSize());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Verify that we can queue up a message.
dhcp_ddns::NameChangeRequestPtr ncr = buildTestNcr();
ASSERT_NO_THROW(mgr.sendRequest(ncr));
EXPECT_EQ(1, mgr.getQueueSize());
// Calling receive should detect the ready IO on the sender's select-fd,
// and invoke callback, which should complete the send.
ASSERT_NO_THROW(IfaceMgr::instance().receive4(0,0));
// Verify the queue is now empty.
EXPECT_EQ(0, mgr.getQueueSize());
}
// Checks that an IO error in sending a request to D2, results in ddns updates
// being suspended. This indicates that Dhcp4Srv's error handler has been
// invoked as expected. Note that this unit test relies on an attempt to send
// to a server address of 0.0.0.0 port 0 fails, which it does under all OSes
// except Solaris 11 and macOS 15.0.
/// @todo Eventually we should find a way to test this under Solaris.
#if (!defined(OS_SOLARIS) && !defined(OS_OSX))
TEST_F(Dhcp4SrvD2Test, forceUDPSendFailure) {
#else
TEST_F(Dhcp4SrvD2Test, DISABLED_forceUDPSendFailure) {
#endif
// Grab the manager and verify that be default ddns is off
// and a sender was not started.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_FALSE(mgr.ddnsEnabled());
// Configure it enabled and start it.
// Using server address of 0.0.0.0/0 should induce failure on send.
// Pass in a non-zero sender port to avoid validation error when
// server-ip/port are same as sender-ip/port
ASSERT_NO_FATAL_FAILURE(configureD2(true, SHOULD_PASS, "0.0.0.0", 0,
"0.0.0.0", 53001));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(mgr.clearQueue());
EXPECT_EQ(0, mgr.getQueueSize());
try {
srv_.startD2();
} catch (const std::exception& ex) {
FAIL() << "startD2 failed with " << ex.what();
} catch (...) {
FAIL() << "startD2 failed";
}
ASSERT_TRUE(mgr.amSending());
// Queue up 3 messages.
for (int i = 0; i < 3; i++) {
dhcp_ddns::NameChangeRequestPtr ncr = buildTestNcr(i + 1);
ASSERT_NO_THROW(mgr.sendRequest(ncr));
}
EXPECT_EQ(3, mgr.getQueueSize());
// Calling receive should detect the ready IO on the sender's select-fd,
// and invoke callback, which should complete the send, which should
// fail.
ASSERT_NO_THROW(IfaceMgr::instance().receive4(0,0));
// Verify the error handler was invoked.
EXPECT_EQ(1, srv_.error_count_);
// Verify that updates are disabled and we are no longer sending.
ASSERT_FALSE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
// Verify message is still in the queue.
EXPECT_EQ(3, mgr.getQueueSize());
// Verify that we can't just restart it.
/// @todo This may change if we add ability to resume.
ASSERT_NO_THROW(srv_.startD2());
ASSERT_FALSE(mgr.amSending());
// Configure it enabled and start it.
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Verify message is still in the queue.
EXPECT_EQ(3, mgr.getQueueSize());
// This will finish sending the 1st message in queue
// and initiate send of 2nd message.
ASSERT_NO_THROW(IfaceMgr::instance().receive4(0,0));
EXPECT_EQ(1, srv_.error_count_);
// First message is off the queue.
EXPECT_EQ(2, mgr.getQueueSize());
mgr.stop();
}
// Tests error handling of D2ClientMgr::sendRequest() failure
// by attempting to queue maximum number of messages.
TEST_F(Dhcp4SrvD2Test, queueMaxError) {
// Configure it enabled and start it.
dhcp::D2ClientMgr& mgr = CfgMgr::instance().getD2ClientMgr();
ASSERT_NO_FATAL_FAILURE(configureD2(true));
ASSERT_TRUE(mgr.ddnsEnabled());
ASSERT_NO_THROW(mgr.clearQueue());
EXPECT_EQ(0, mgr.getQueueSize());
ASSERT_NO_THROW(srv_.startD2());
ASSERT_TRUE(mgr.amSending());
// Attempt to queue more then the maximum allowed.
int max_msgs = mgr.getQueueMaxSize();
for (int i = 0; i < max_msgs + 1; i++) {
dhcp_ddns::NameChangeRequestPtr ncr = buildTestNcr(i + 1);
ASSERT_NO_THROW(mgr.sendRequest(ncr));
}
// Stopping sender will complete the first message so there
// should be max less one.
EXPECT_EQ(max_msgs - 1, mgr.getQueueSize());
// Verify the error handler was invoked.
EXPECT_EQ(1, srv_.error_count_);
// Verify that updates are disabled and we are no longer sending.
ASSERT_FALSE(mgr.ddnsEnabled());
ASSERT_FALSE(mgr.amSending());
mgr.clearQueue();
}
// Tests invalid config with TCP protocol
TEST_F(Dhcp4SrvD2Test, badTCP) {
std::string config =
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"ddns-override-no-update\" : true, "
"\"ddns-override-client-update\" : true, "
"\"ddns-replace-client-name\" : \"when-present\", "
"\"ddns-generated-prefix\" : \"test.prefix\", "
"\"ddns-qualifying-suffix\" : \"test.suffix.\", "
"\"subnet4\": [ { "
" \"id\": 1,"
" \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
" \"subnet\": \"192.0.2.0/24\" } ],"
" \"dhcp-ddns\" : {"
" \"enable-updates\" : true, "
" \"server-ip\" : \"127.0.0.1\", "
" \"server-port\" : 53001, "
" \"sender-ip\" : \"0.0.0.0\", "
" \"sender-port\" : 0, "
" \"max-queue-size\" : 1024, "
" \"ncr-protocol\" : \"TCP\", "
" \"ncr-format\" : \"JSON\"},"
"\"valid-lifetime\": 4000 }";
ElementPtr json = Element::fromJSON(config);
ConstElementPtr status;
CfgMgr::instance().clear();
EXPECT_NO_THROW(status = configureDhcp4Server(srv_, json));
ASSERT_TRUE(status);
int rcode;
ConstElementPtr comment = config::parseAnswer(rcode, status);
EXPECT_EQ(1, rcode);
}
// Tests invalid config with bad sender family
TEST_F(Dhcp4SrvD2Test, badFamily) {
std::string config =
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"ddns-override-no-update\" : true, "
"\"ddns-override-client-update\" : true, "
"\"ddns-replace-client-name\" : \"when-present\", "
"\"ddns-generated-prefix\" : \"test.prefix\", "
"\"ddns-qualifying-suffix\" : \"test.suffix.\", "
"\"subnet4\": [ { "
" \"id\": 1,"
" \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
" \"subnet\": \"192.0.2.0/24\" } ],"
" \"dhcp-ddns\" : {"
" \"enable-updates\" : true, "
" \"server-ip\" : \"127.0.0.1\", "
" \"server-port\" : 53001, "
" \"sender-ip\" : \"::\", "
" \"sender-port\" : 0, "
" \"max-queue-size\" : 1024, "
" \"ncr-protocol\" : \"UDP\", "
" \"ncr-format\" : \"JSON\"},"
"\"valid-lifetime\": 4000 }";
ElementPtr json = Element::fromJSON(config);
ConstElementPtr status;
CfgMgr::instance().clear();
EXPECT_NO_THROW(status = configureDhcp4Server(srv_, json));
ASSERT_TRUE(status);
int rcode;
ConstElementPtr comment = config::parseAnswer(rcode, status);
EXPECT_EQ(1, rcode);
}
// Tests invalid config with server == sender
TEST_F(Dhcp4SrvD2Test, senderEqServer) {
std::string config =
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"ddns-override-no-update\" : true, "
"\"ddns-override-client-update\" : true, "
"\"ddns-replace-client-name\" : \"when-present\", "
"\"ddns-generated-prefix\" : \"test.prefix\", "
"\"ddns-qualifying-suffix\" : \"test.suffix.\", "
"\"subnet4\": [ { "
" \"id\": 1,"
" \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
" \"subnet\": \"192.0.2.0/24\" } ],"
" \"dhcp-ddns\" : {"
" \"enable-updates\" : true, "
" \"server-ip\" : \"127.0.0.1\", "
" \"server-port\" : 53001, "
" \"sender-ip\" : \"127.0.0.1\", "
" \"sender-port\" : 53001, "
" \"max-queue-size\" : 1024, "
" \"ncr-protocol\" : \"UDP\", "
" \"ncr-format\" : \"JSON\"},"
"\"valid-lifetime\": 4000 }";
ElementPtr json = Element::fromJSON(config);
ConstElementPtr status;
CfgMgr::instance().clear();
EXPECT_NO_THROW(status = configureDhcp4Server(srv_, json));
ASSERT_TRUE(status);
int rcode;
ConstElementPtr comment = config::parseAnswer(rcode, status);
EXPECT_EQ(1, rcode);
}
} // namespace test
} // namespace dhcp
} // namespace isc
|