config_parser_unittest.cc 119 KB
Newer Older
1
// Copyright (C) 2012-2014 Internet Systems Consortium, Inc. ("ISC")
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#include <config.h>

#include <arpa/inet.h>
#include <gtest/gtest.h>

20
#include <config/ccsession.h>
21
#include <dhcp4/dhcp4_srv.h>
22
#include <dhcp4/json_config_parser.h>
23
#include <dhcp/option4_addrlst.h>
24
25
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
26
#include <dhcp/docsis3_option_defs.h>
27
#include <dhcp/classify.h>
28
#include <dhcp/tests/iface_mgr_test_config.h>
29
30
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
31
#include <dhcpsrv/cfg_subnets4.h>
32
#include <dhcpsrv/testutils/config_result_check.h>
33
34
35
36
#include <hooks/hooks_manager.h>

#include "marker_file.h"
#include "test_libraries.h"
37
#include "test_data_files_config.h"
38

39
#include <boost/foreach.hpp>
40
41
#include <boost/scoped_ptr.hpp>

Tomek Mrugalski's avatar
Tomek Mrugalski committed
42
43
44
45
#include <iostream>
#include <fstream>
#include <sstream>
#include <limits.h>
46
47
48
49

using namespace isc;
using namespace isc::asiolink;
using namespace isc::config;
50
51
using namespace isc::data;
using namespace isc::dhcp;
52
using namespace isc::dhcp::test;
53
54
using namespace isc::hooks;
using namespace std;
55
56
57

namespace {

58
59
60
61
62
63
64
65
66
67
/// @brief Prepends the given name with the DHCP4 source directory
///
/// @param name file name of the desired file
/// @return string containing the absolute path of the file in the DHCP source
/// directory.
std::string specfile(const std::string& name) {
    return (std::string(DHCP4_SRC_DIR) + "/" + name);
}

/// @brief Tests that the spec file is valid.
68
/// Verifies that the Kea DHCPv4 configuration specification file is valid.
69
TEST(Dhcp4SpecTest, basicSpec) {
70
    (isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
71
72
73
    ASSERT_NO_THROW(isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
}

74
75
76
77
78
79
80
class Dhcp4ParserTest : public ::testing::Test {
public:
    Dhcp4ParserTest()
    :rcode_(-1) {
        // Open port 0 means to not do anything at all. We don't want to
        // deal with sockets here, just check if configuration handling
        // is sane.
81
        srv_.reset(new Dhcpv4Srv(0));
82
83
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
84
        resetConfiguration();
85
86
    }

87
88
89
90
91
92
93
94
95
    // Check that no hooks libraries are loaded.  This is a pre-condition for
    // a number of tests, so is checked in one place.  As this uses an
    // ASSERT call - and it is not clear from the documentation that Gtest
    // predicates can be used in a constructor - the check is placed in SetUp.
    void SetUp() {
        std::vector<std::string> libraries = HooksManager::getLibraryNames();
        ASSERT_TRUE(libraries.empty());
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
96
97
    // Checks if global parameter of name have expected_value
    void checkGlobalUint32(string name, uint32_t expected_value) {
98
        const Uint32StoragePtr uint32_defaults =
99
                                        globalContext()->uint32_values_;
100
        try {
101
            uint32_t actual_value = uint32_defaults->getParam(name);
102
103
            EXPECT_EQ(expected_value, actual_value);
        } catch (DhcpConfigError) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
104
105
106
107
108
            ADD_FAILURE() << "Expected uint32 with name " << name
                          << " not found";
        }
    }

109
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
110
111
112
113
114
115
116
117
    // expected code (0 for success, other for failures).
    // Also stores result in rcode_ and comment_.
    void checkResult(ConstElementPtr status, int expected_code) {
        ASSERT_TRUE(status);
        comment_ = parseAnswer(rcode_, status);
        EXPECT_EQ(expected_code, rcode_);
    }

118
    ~Dhcp4ParserTest() {
119
        resetConfiguration();
120
121
122
123

        // ... and delete the hooks library marker files if present
        unlink(LOAD_MARKER_FILE);
        unlink(UNLOAD_MARKER_FILE);
124
125
    };

126
127
128
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
129
130
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
131
    ///
132
    /// @param param_value string holding option parameter value to be
133
134
135
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
136
137
    /// @return configuration string containing custom values of parameters
    /// describing an option.
138
139
140
141
142
    std::string createConfigWithOption(const std::string& param_value,
                                       const std::string& parameter) {
        std::map<std::string, std::string> params;
        if (parameter == "name") {
            params["name"] = param_value;
143
144
            params["space"] = "dhcp4";
            params["code"] = "56";
145
            params["data"] = "ABCDEF0105";
146
147
148
149
            params["csv-format"] = "False";
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
150
            params["code"] = "56";
151
            params["data"] = "ABCDEF0105";
152
            params["csv-format"] = "False";
153
        } else if (parameter == "code") {
154
155
            params["name"] = "dhcp-message";
            params["space"] = "dhcp4";
156
            params["code"] = param_value;
157
            params["data"] = "ABCDEF0105";
158
            params["csv-format"] = "False";
159
        } else if (parameter == "data") {
160
161
            params["name"] = "dhcp-message";
            params["space"] = "dhcp4";
162
163
            params["code"] = "56";
            params["data"] = param_value;
164
165
            params["csv-format"] = "False";
        } else if (parameter == "csv-format") {
166
167
            params["name"] = "dhcp-message";
            params["space"] = "dhcp4";
168
            params["code"] = "56";
169
            params["data"] = "ABCDEF0105";
170
            params["csv-format"] = param_value;
171
172
173
174
        }
        return (createConfigWithOption(params));
    }

175
176
177
178
179
180
181
182
    /// @brief Create simple configuration with single option.
    ///
    /// This function creates a configuration for a single option with
    /// custom values for all parameters that describe the option.
    ///
    /// @params params map holding parameters and their values.
    /// @return configuration string containing custom values of parameters
    /// describing an option.
183
184
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
185
        stream << "{ \"interfaces\": [ \"*\" ],"
186
187
188
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
189
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
190
191
192
193
194
195
196
197
            "    \"subnet\": \"192.0.2.0/24\", "
            "    \"option-data\": [ {";
        bool first = true;
        typedef std::pair<std::string, std::string> ParamPair;
        BOOST_FOREACH(ParamPair param, params) {
            if (!first) {
                stream << ", ";
            } else {
198
                // cppcheck-suppress unreadVariable
199
200
201
202
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
203
204
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
205
206
207
208
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
209
210
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
211
212
213
214
215
216
217
218
219
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    /// @brief Returns an option from the subnet.
    ///
    /// This function returns an option from a subnet to which the
    /// specified subnet address belongs. The option is identified
    /// by its code.
    ///
    /// @param subnet_address Address which belongs to the subnet from
    /// which the option is to be returned.
    /// @param option_code Code of the option to be returned.
    /// @param expected_options_count Expected number of options in
    /// the particular subnet.
    ///
    /// @return Descriptor of the option. If the descriptor holds a
    /// NULL option pointer, it means that there was no such option
    /// in the subnet.
235
    OptionDescriptor
236
237
238
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
239
240
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
            getCfgSubnets4()->get(subnet_address);
241
242
243
244
245
246
        if (!subnet) {
            /// @todo replace toText() with the use of operator <<.
            ADD_FAILURE() << "A subnet for the specified address "
                          << subnet_address.toText()
                          << "does not exist in Config Manager";
        }
247
        OptionContainerPtr options =
248
            subnet->getCfgOption()->getAll("dhcp4");
249
250
251
252
253
254
255
256
        if (expected_options_count != options->size()) {
            ADD_FAILURE() << "The number of options in the subnet '"
                          << subnet_address.toText() << "' is different "
                " than expected number of options '"
                          << expected_options_count << "'";
        }

        // Get the search index. Index #1 is to search using option code.
257
        const OptionContainerTypeIndex& idx = options->get<1>();
258
259
260
261

        // Get the options for specified index. Expecting one option to be
        // returned but in theory we may have multiple options with the same
        // code so we get the range.
262
263
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
264
265
266
267
268
269
270
            idx.equal_range(option_code);
        if (std::distance(range.first, range.second) > 1) {
            ADD_FAILURE() << "There is more than one option having the"
                " option code '" << option_code << "' in a subnet '"
                          << subnet_address.toText() << "'. Expected "
                " at most one option";
        } else if (std::distance(range.first, range.second) == 0) {
271
            return (OptionDescriptor(OptionPtr(), false));
272
273
274
275
276
        }

        return (*range.first);
    }

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    /// @brief Test invalid option parameter value.
    ///
    /// This test function constructs the simple configuration
    /// string and injects invalid option configuration into it.
    /// It expects that parser will fail with provided option code.
    ///
    /// @param param_value string holding invalid option parameter value
    /// to be injected into configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param_value (can be any of "name", "code", "data")
    void testInvalidOptionParam(const std::string& param_value,
                                const std::string& parameter) {
        ConstElementPtr x;
        std::string config = createConfigWithOption(param_value, parameter);
        ElementPtr json = Element::fromJSON(config);
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
293
294
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
295
296
    }

297
298
299
300
301
302
303
304
305
306
307
308
309
    /// @brief Test invalid option paramater value.
    ///
    /// This test function constructs the simple configuration
    /// string and injects invalid option configuration into it.
    /// It expects that parser will fail with provided option code.
    ///
    /// @param params Map of parameters defining an option.
    void
    testInvalidOptionParam(const std::map<std::string, std::string>& params) {
        ConstElementPtr x;
        std::string config = createConfigWithOption(params);
        ElementPtr json = Element::fromJSON(config);
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
310
311
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
312
313
    }

314
315
316
317
318
319
320
321
322
    /// @brief Test option against given code and data.
    ///
    /// @param option_desc option descriptor that carries the option to
    /// be tested.
    /// @param expected_code expected code of the option.
    /// @param expected_data expected data in the option.
    /// @param expected_data_len length of the reference data.
    /// @param extra_data if true extra data is allowed in an option
    /// after tested data.
323
    void testOption(const OptionDescriptor& option_desc,
324
325
326
327
                    uint16_t expected_code, const uint8_t* expected_data,
                    size_t expected_data_len,
                    bool extra_data = false) {
        // Check if option descriptor contains valid option pointer.
328
        ASSERT_TRUE(option_desc.option_);
329
        // Verify option type.
330
        EXPECT_EQ(expected_code, option_desc.option_->getType());
331
332
333
334
335
        // We may have many different option types being created. Some of them
        // have dedicated classes derived from Option class. In such case if
        // we want to verify the option contents against expected_data we have
        // to prepare raw buffer with the contents of the option. The easiest
        // way is to call pack() which will prepare on-wire data.
336
337
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
338
339
340
341
342
        if (extra_data) {
            // The length of the buffer must be at least equal to size of the
            // reference data but it can sometimes be greater than that. This is
            // because some options carry suboptions that increase the overall
            // length.
343
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
344
345
                      expected_data_len);
        } else {
346
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
347
348
                      expected_data_len);
        }
349
        // Verify that the data is correct. Do not verify suboptions and a header.
350
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
351
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
352
                            expected_data_len));
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
    /// @brief Test option configuration.
    ///
    /// This function creates a configuration for a specified option using
    /// a map of parameters specified as the argument. The map holds
    /// name/value pairs which identifies option's configuration parameters:
    /// - name
    /// - space
    /// - code
    /// - data
    /// - csv-format.
    /// This function applies a new server configuration and checks that the
    /// option being configured is inserted into CfgMgr. The raw contents of
    /// this option are compared with the binary data specified as expected
    /// data passed to this function.
    ///
    /// @param params Map of parameters defining an option.
    /// @param option_code Option code.
    /// @param expected_data Array containing binary data expected to be stored
    /// in the configured option.
    /// @param expected_data_len Length of the array holding reference data.
    void testConfiguration(const std::map<std::string, std::string>& params,
                           const uint16_t option_code,
                           const uint8_t* expected_data,
                           const size_t expected_data_len) {
        std::string config = createConfigWithOption(params);
        ASSERT_TRUE(executeConfiguration(config, "parse option configuration"));
381
        // The subnet should now hold one option with the specified option code.
382
        OptionDescriptor desc =
383
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
384
        ASSERT_TRUE(desc.option_);
385
386
387
        testOption(desc, option_code, expected_data, expected_data_len);
    }

388
389
390
391
392
393
394
395
396
397
398
399
400
    /// @brief Parse and Execute configuration
    ///
    /// Parses a configuration and executes a configuration of the server.
    /// If the operation fails, the current test will register a failure.
    ///
    /// @param config Configuration to parse
    /// @param operation Operation being performed.  In the case of an error,
    ///        the error text will include the string "unable to <operation>.".
    ///
    /// @return true if the configuration succeeded, false if not.  In the
    ///         latter case, a failure will have been added to the current test.
    bool
    executeConfiguration(const std::string& config, const char* operation) {
401
        CfgMgr::instance().clear();
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
        ConstElementPtr status;
        try {
            ElementPtr json = Element::fromJSON(config);
            status = configureDhcp4Server(*srv_, json);
        } catch (const std::exception& ex) {
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The following configuration was used: " << std::endl
                   << config << std::endl
                   << " and the following error message was returned:"
                   << ex.what() << std::endl;
            return (false);
        }

        // The status object must not be NULL
        if (!status) {
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned a null pointer.";
            return (false);
        }

        // Store the answer if we need it.

        // Returned value should be 0 (configuration success)
        comment_ = parseAnswer(rcode_, status);
        if (rcode_ != 0) {
            string reason = "";
            if (comment_) {
                reason = string(" (") + comment_->stringValue() + string(")");
            }
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned error code "
                   << rcode_ << reason;
            return (false);
        }

        return (true);
    }

440
441
442
443
444
445
446
447
    /// @brief Reset configuration database.
    ///
    /// This function resets configuration data base by
    /// removing all subnets and option-data. Reset must
    /// be performed after each test to make sure that
    /// contents of the database do not affect result of
    /// subsequent tests.
    void resetConfiguration() {
448
        string config = "{ \"interfaces\": [ \"*\" ],"
449
            "\"hooks-libraries\": [ ], "
450
451
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
452
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
453
            "\"option-def\": [ ], "
454
            "\"option-data\": [ ] }";
455
456
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
457
        CfgMgr::instance().clear();
458
    }
459

460

461
462
463
464
    boost::scoped_ptr<Dhcpv4Srv> srv_;  ///< DHCP4 server under test
    int rcode_;                         ///< Return code from element parsing
    ConstElementPtr comment_;           ///< Reason for parse fail
    isc::dhcp::ClientClasses classify_; ///< used in client classification
465
466
467
468
469
470
471
472
473
474
475
476
477
};

// Goal of this test is a verification if a very simple config update
// with just a bumped version number. That's the simplest possible
// config update.
TEST_F(Dhcp4ParserTest, version) {

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
                    Element::fromJSON("{\"version\": 0}")));

    // returned value must be 0 (configuration accepted)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
478
    checkResult(x, 0);
479
480
481
482
}

/// The goal of this test is to verify that the code accepts only
/// valid commands and malformed or unsupported parameters are rejected.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
483
TEST_F(Dhcp4ParserTest, bogusCommand) {
484
485
486
487
488
489
490

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
                    Element::fromJSON("{\"bogus\": 5}")));

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
491
    checkResult(x, 1);
492
493
494
495
496
}

/// The goal of this test is to verify if wrongly defined subnet will
/// be rejected. Properly defined subnet must include at least one
/// pool definition.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
497
TEST_F(Dhcp4ParserTest, emptySubnet) {
498
499
500
501

    ConstElementPtr status;

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_,
502
                    Element::fromJSON("{ \"interfaces\": [ \"*\" ],"
503
504
505
506
507
508
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
                                      "\"valid-lifetime\": 4000 }")));

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
509
510
511
512
513
    checkResult(status, 0);

    checkGlobalUint32("rebind-timer", 2000);
    checkGlobalUint32("renew-timer", 1000);
    checkGlobalUint32("valid-lifetime", 4000);
514
515
}

516
517
518
519
520
521
522
523
/// Check that the renew-timer doesn't have to be specified, in which case
/// it is marked unspecified in the Subnet.
TEST_F(Dhcp4ParserTest, unspecifiedRenewTimer) {
    ConstElementPtr status;

    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
524
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
525
526
527
528
529
530
531
532
533
534
535
536
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
    checkGlobalUint32("rebind-timer", 2000);
    checkGlobalUint32("valid-lifetime", 4000);

537
538
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
        getCfgSubnets4()->get(IOAddress("192.0.2.200"));
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
    ASSERT_TRUE(subnet);
    EXPECT_TRUE(subnet->getT1().unspecified());
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());

}

/// Check that the rebind-timer doesn't have to be specified, in which case
/// it is marked unspecified in the Subnet.
TEST_F(Dhcp4ParserTest, unspecifiedRebindTimer) {
    ConstElementPtr status;

    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
558
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
559
560
561
562
563
564
565
566
567
568
569
570
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
    checkGlobalUint32("renew-timer", 1000);
    checkGlobalUint32("valid-lifetime", 4000);

571
572
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
        getCfgSubnets4()->get(IOAddress("192.0.2.200"));
573
574
575
576
577
578
579
580
581
582
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_TRUE(subnet->getT2().unspecified());
    EXPECT_EQ(4000, subnet->getValid());

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());
}

583
584
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
585
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
586
587
588

    ConstElementPtr status;

589
    string config = "{ \"interfaces\": [ \"*\" ],"
590
591
592
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
593
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
594
595
596
597
598
599
600
601
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
602
    checkResult(status, 0);
603
604
605

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
606
607
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
        getCfgSubnets4()->get(IOAddress("192.0.2.200"));
608
609
610
611
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
612
613
614

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());
615
616
}

617
618
619
620
621
// Goal of this test is to verify that multiple subnets get unique
// subnet-ids. Also, test checks that it's possible to do reconfiguration
// multiple times.
TEST_F(Dhcp4ParserTest, multipleSubnets) {
    ConstElementPtr x;
622
623
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
624
625
626
627
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
628
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
629
630
631
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
632
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
633
634
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
635
636
        " },"
        " {"
637
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
638
639
640
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
641
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
642
643
644
645
646
647
648
649
650
651
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
652
        checkResult(x, 0);
653

654
655
656
657
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
        ASSERT_TRUE(subnets);
        ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

        // Check subnet-ids of each subnet (it should be monotonously increasing)
        EXPECT_EQ(1, subnets->at(0)->getID());
        EXPECT_EQ(2, subnets->at(1)->getID());
        EXPECT_EQ(3, subnets->at(2)->getID());
        EXPECT_EQ(4, subnets->at(3)->getID());

        // Repeat reconfiguration process 10 times and check that the subnet-id
        // is set to the same value. Technically, just two iterations would be
        // sufficient, but it's nice to have a test that exercises reconfiguration
        // a bit.
    } while (++cnt < 10);
}

674
675
676
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
677
    // Four subnets with arbitrary subnet ids.
678
679
680
681
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
682
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
683
684
685
686
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
687
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
688
689
690
691
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
692
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
693
694
695
696
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
697
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
698
699
700
701
702
703
704
705
706
707
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    int cnt = 0; // Number of reconfigurations
    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
708
        checkResult(x, 0);
709

710
711
712
713
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
714
715
716
717
718
719
720
721
722
723
724
        ASSERT_TRUE(subnets);
        ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

        // Verify that subnet ids are as expected.
        EXPECT_EQ(1024, subnets->at(0)->getID());
        EXPECT_EQ(100, subnets->at(1)->getID());
        EXPECT_EQ(1, subnets->at(2)->getID());
        EXPECT_EQ(34, subnets->at(3)->getID());

        // Repeat reconfiguration process 10 times and check that the subnet-id
        // is set to the same value.
725
    } while (++cnt < 3);
726
727
728
729
730
}

// Check that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
731
    // Four subnets, two of them having the same id.
732
733
734
735
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
736
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
737
738
739
740
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
741
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
742
743
744
745
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
746
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
747
748
749
750
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
751
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
752
753
754
755
756
757
758
759
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
760
    checkResult(x, 1);
761
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
762
763
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
764
765
766
767
768
769
770
771
772
773
// Goal of this test is to verify that a previously configured subnet can be
// deleted in subsequent reconfiguration.
TEST_F(Dhcp4ParserTest, reconfigureRemoveSubnet) {
    ConstElementPtr x;

    // All four subnets
    string config4 = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
774
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
775
776
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
777
778
        " },"
        " {"
779
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
780
781
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
782
783
        " },"
        " {"
784
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
785
786
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
787
788
        " },"
        " {"
789
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
790
791
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
792
793
794
795
796
797
798
799
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
    string config_first3 = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
800
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
801
802
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
803
804
        " },"
        " {"
805
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
806
807
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
808
809
        " },"
        " {"
810
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
811
812
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
813
814
815
816
817
818
819
820
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
    string config_second_removed = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
821
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
822
823
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
824
825
        " },"
        " {"
826
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
827
828
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
829
830
        " },"
        " {"
831
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
832
833
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
834
835
836
837
838
839
840
841
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // CASE 1: Configure 4 subnets, then reconfigure and remove the
    // last one.

    ElementPtr json = Element::fromJSON(config4);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
842
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
843

844
845
    const Subnet4Collection* subnets =
        CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
846
847
848
    ASSERT_TRUE(subnets);
    ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

849
850
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
851
852
853
    // Do the reconfiguration (the last subnet is removed)
    json = Element::fromJSON(config_first3);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
854
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
855

856
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
857
858
859
860
861
862
863
864
    ASSERT_TRUE(subnets);
    ASSERT_EQ(3, subnets->size()); // We expect 3 subnets now (4th is removed)

    // Check subnet-ids of each subnet (it should be monotonously increasing)
    EXPECT_EQ(1, subnets->at(0)->getID());
    EXPECT_EQ(2, subnets->at(1)->getID());
    EXPECT_EQ(3, subnets->at(2)->getID());

865
866
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
867
868
869
870
871
872
    /// CASE 2: Configure 4 subnets, then reconfigure and remove one
    /// from in between (not first, not last)

    /// @todo: Uncomment subnet removal test as part of #3281.
    json = Element::fromJSON(config4);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
873
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
874

875
876
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
877
878
879
    // Do reconfiguration
    json = Element::fromJSON(config_second_removed);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
880
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
881

882
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
883
884
885
886
887
888
889
890
891
892
893
    ASSERT_TRUE(subnets);
    ASSERT_EQ(3, subnets->size()); // We expect 4 subnets

    EXPECT_EQ(1, subnets->at(0)->getID());
    // The second subnet (with subnet-id = 2) is no longer there
    EXPECT_EQ(3, subnets->at(1)->getID());
    EXPECT_EQ(4, subnets->at(2)->getID());

}

/// @todo: implement subnet removal test as part of #3281.
894

895
896
897
898
899
900
901
902
903
904
905
// Checks if the next-server defined as global parameter is taken into
// consideration.
TEST_F(Dhcp4ParserTest, nextServerGlobal) {

    ConstElementPtr status;

    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"next-server\": \"1.2.3.4\", "
        "\"subnet4\": [ { "
906
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
907
908
909
910
911
912
913
914
915
916
917
918
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
    checkResult(status, 0);

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
919
920
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
        getCfgSubnets4()->get(IOAddress("192.0.2.200"));
921
922
923
924
925
926
927
928
929
930
931
932
933
934
    ASSERT_TRUE(subnet);
    EXPECT_EQ("1.2.3.4", subnet->getSiaddr().toText());
}

// Checks if the next-server defined as subnet parameter is taken into
// consideration.
TEST_F(Dhcp4ParserTest, nextServerSubnet) {

    ConstElementPtr status;

    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
935
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
936
937
938
939
940
941
942
943
944
945
946
947
948
        "    \"next-server\": \"1.2.3.4\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
    checkResult(status, 0);

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
949
950
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
        getCfgSubnets4()->get(IOAddress("192.0.2.200"));
951
952
953
954
    ASSERT_TRUE(subnet);
    EXPECT_EQ("1.2.3.4", subnet->getSiaddr().toText());
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
955
956
957
958
959
960
961
962
963
964
965
// Test checks several negative scenarios for next-server configuration: bogus
// address, IPv6 adddress and empty string.
TEST_F(Dhcp4ParserTest, nextServerNegative) {

    ConstElementPtr status;

    // Config with junk instead of next-server address
    string config_bogus1 = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
966
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
967
968
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
969
970
971
972
973
974
975
976
977
        "    \"next-server\": \"a.b.c.d\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with IPv6 next server address
    string config_bogus2 = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
978
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
979
980
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
981
982
983
984
985
986
987
988
989
        "    \"next-server\": \"2001:db8::1\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with empty next server address
    string config_bogus3 = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
990
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
991
992
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
993
994
995
996
997
998
        "    \"next-server\": \"\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json1 = Element::fromJSON(config_bogus1);
    ElementPtr json2 = Element::fromJSON(config_bogus2);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
999
    ElementPtr json3 = Element::fromJSON(config_bogus3);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1000