config_parser_unittest.cc 127 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_hosts.h>
32
#include <dhcpsrv/cfg_subnets4.h>
33
#include <dhcpsrv/testutils/config_result_check.h>
34
35
36
37
#include <hooks/hooks_manager.h>

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

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

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

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

namespace {

59
60
61
62
63
64
65
66
67
68
/// @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.
69
/// Verifies that the Kea DHCPv4 configuration specification file is valid.
70
TEST(Dhcp4SpecTest, basicSpec) {
71
    (isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
72
73
74
    ASSERT_NO_THROW(isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
}

75
76
77
78
79
80
81
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.
82
        srv_.reset(new Dhcpv4Srv(0));
83
84
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
85
        resetConfiguration();
86
87
    }

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

110
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
111
112
113
114
115
116
117
118
    // 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_);
    }

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

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

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

176
177
178
179
180
181
182
183
    /// @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.
184
185
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
186
        stream << "{ \"interfaces\": [ \"*\" ],"
187
188
189
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
190
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
191
192
193
194
195
196
197
198
            "    \"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 {
199
                // cppcheck-suppress unreadVariable
200
201
202
203
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
204
205
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
206
207
208
209
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
210
211
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
212
213
214
215
216
217
218
219
220
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    /// @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.
236
    OptionDescriptor
237
238
239
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
240
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
241
            getCfgSubnets4()->selectSubnet(subnet_address);
242
243
244
245
246
247
        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";
        }
248
        OptionContainerPtr options =
249
            subnet->getCfgOption()->getAll("dhcp4");
250
251
252
253
254
255
256
257
        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.
258
        const OptionContainerTypeIndex& idx = options->get<1>();
259
260
261
262

        // 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.
263
264
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
265
266
267
268
269
270
271
            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) {
272
            return (OptionDescriptor(OptionPtr(), false));
273
274
275
276
277
        }

        return (*range.first);
    }

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
    /// @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));
294
295
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
296
297
    }

Francis Dupont's avatar
Francis Dupont committed
298
    /// @brief Test invalid option parameter value.
299
300
301
302
303
304
305
306
307
308
309
310
    ///
    /// 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));
311
312
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
313
314
    }

315
316
317
318
319
320
321
322
323
    /// @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.
324
    void testOption(const OptionDescriptor& option_desc,
325
326
327
328
                    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.
329
        ASSERT_TRUE(option_desc.option_);
330
        // Verify option type.
331
        EXPECT_EQ(expected_code, option_desc.option_->getType());
332
333
334
335
336
        // 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.
337
338
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
339
340
341
342
343
        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.
344
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
345
346
                      expected_data_len);
        } else {
347
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
348
349
                      expected_data_len);
        }
350
        // Verify that the data is correct. Do not verify suboptions and a header.
351
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
352
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
353
                            expected_data_len));
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
    /// @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"));
382
        // The subnet should now hold one option with the specified option code.
383
        OptionDescriptor desc =
384
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
385
        ASSERT_TRUE(desc.option_);
386
387
388
        testOption(desc, option_code, expected_data, expected_data_len);
    }

389
390
391
392
393
394
395
396
397
398
399
400
401
    /// @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) {
402
        CfgMgr::instance().clear();
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
        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);
    }

441
442
443
444
445
446
447
448
    /// @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() {
449
        string config = "{ \"interfaces\": [ \"*\" ],"
450
            "\"hooks-libraries\": [ ], "
451
452
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
453
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
454
            "\"option-def\": [ ], "
455
            "\"option-data\": [ ] }";
456
457
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
458
        CfgMgr::instance().clear();
459
    }
460

461

462
463
464
465
    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
466
467
468
469
470
471
472
473
474
475
476
477
478
};

// 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
479
    checkResult(x, 0);
480
481
482
483
}

/// 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
484
TEST_F(Dhcp4ParserTest, bogusCommand) {
485
486
487
488
489
490
491

    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
492
    checkResult(x, 1);
493
494
495
496
497
}

/// 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
498
TEST_F(Dhcp4ParserTest, emptySubnet) {
499
500
501
502

    ConstElementPtr status;

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

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

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

517
518
519
520
521
522
523
524
/// 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\": [ { "
525
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
526
527
528
529
530
531
532
533
534
535
536
537
        "    \"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);

538
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
539
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
    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\": [ { "
559
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
560
561
562
563
564
565
566
567
568
569
570
571
        "    \"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);

572
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
573
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
574
575
576
577
578
579
580
581
582
583
    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());
}

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

    ConstElementPtr status;

590
    string config = "{ \"interfaces\": [ \"*\" ],"
591
592
593
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
594
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
595
596
597
598
599
600
601
602
        "    \"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
603
    checkResult(status, 0);
604
605
606

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

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

618
619
620
621
622
// 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;
623
624
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
625
626
627
628
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
629
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
630
631
632
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
633
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
634
635
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
636
637
        " },"
        " {"
638
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
639
640
641
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
642
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
643
644
645
646
647
648
649
650
651
652
        "    \"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));
653
        checkResult(x, 0);
654

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

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
        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);
}

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

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

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
715
716
717
718
719
720
721
722
723
724
725
        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.
726
    } while (++cnt < 3);
727
728
729
730
731
}

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

    ElementPtr json = Element::fromJSON(config);

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
765
766
767
768
769
770
771
772
773
774
// 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\": [ { "
775
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
776
777
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
778
779
        " },"
        " {"
780
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
781
782
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
783
784
        " },"
        " {"
785
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
786
787
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
788
789
        " },"
        " {"
790
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
791
792
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
793
794
795
796
797
798
799
800
        " } ],"
        "\"valid-lifetime\": 4000 }";

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

    // Second subnet removed
    string config_second_removed = "{ \"interfaces\": [ \"*\" ],"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
822
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
823
824
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
825
826
        " },"
        " {"
827
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
828
829
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
830
831
        " },"
        " {"
832
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
833
834
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
835
836
837
838
839
840
841
842
        " } ],"
        "\"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));
843
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
844

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

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

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

857
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
858
859
860
861
862
863
864
865
    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());

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
868
869
870
871
872
873
    /// 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));
874
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
875

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

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

883
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
884
885
886
887
888
889
890
891
892
893
894
    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.
895

896
897
898
899
900
901
902
903
904
905
906
// 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\": [ { "
907
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
908
909
910
911
912
913
914
915
916
917
918
919
        "    \"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.
920
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
921
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
922
923
924
925
926
927
928
929
930
931
932
933
934
935
    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\": [ { "
936
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
937
938
939
940
941
942
943
944
945
946
947
948
949
        "    \"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.
950
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
951
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
952
953
954
955
    ASSERT_TRUE(subnet);
    EXPECT_EQ("1.2.3.4", subnet->getSiaddr().toText());
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
956
957
958
959
960
961
962
963
964
965
966
// 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\": [ { "
967
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
968
969
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
970
971
972
973
974
975
976
977
978
        "    \"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\": [ { "
979
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
980
981
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
982
983
984
985
986
987
988
989
990
        "    \"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\": [ { "
991
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
992
993
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
994
995
996
997
998
999
        "    \"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
1000
    ElementPtr json3 = Element::fromJSON(config_bogus3);