config_parser_unittest.cc 131 KB
Newer Older
1
// Copyright (C) 2012-2015 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/command_interpreter.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
21
#include <config/module_spec.h>
22
#include <dhcp4/dhcp4_srv.h>
23
#include <dhcp4/json_config_parser.h>
24
#include <dhcp/option4_addrlst.h>
25
26
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
27
#include <dhcp/docsis3_option_defs.h>
28
#include <dhcp/classify.h>
29
#include <dhcp/tests/iface_mgr_test_config.h>
30
31
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
32
#include <dhcpsrv/cfg_hosts.h>
33
#include <dhcpsrv/cfg_subnets4.h>
34
#include <dhcpsrv/testutils/config_result_check.h>
35
36
37
38
#include <hooks/hooks_manager.h>

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

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

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

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

namespace {

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

76
class Dhcp4ParserTest : public ::testing::Test {
77
78
79
80
81
82
83
84
85
86
protected:
    // 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.
    virtual void SetUp() {
        std::vector<std::string> libraries = HooksManager::getLibraryNames();
        ASSERT_TRUE(libraries.empty());
    }

87
88
public:
    Dhcp4ParserTest()
89
    : rcode_(-1) {
90
91
92
        // 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.
93
        srv_.reset(new Dhcpv4Srv(0));
94
95
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
96
        resetConfiguration();
97
98
    }

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

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

122
    ~Dhcp4ParserTest() {
123
        resetConfiguration();
124
125
126
127

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

130
131
132
133
134
135
136
137
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

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

187
188
189
190
191
192
193
194
    /// @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.
195
196
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
197
        stream << "{ " << genIfaceConfig() << "," <<
198
199
200
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
201
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
202
203
204
205
206
207
208
209
            "    \"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 {
210
                // cppcheck-suppress unreadVariable
211
212
213
214
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
215
216
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
217
218
219
220
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
221
222
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
223
224
225
226
227
228
229
230
231
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
    /// @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.
247
    OptionDescriptor
248
249
250
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
251
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
252
            getCfgSubnets4()->selectSubnet(subnet_address);
253
254
255
256
257
258
        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";
        }
259
        OptionContainerPtr options =
260
            subnet->getCfgOption()->getAll("dhcp4");
261
262
263
264
265
266
267
268
        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.
269
        const OptionContainerTypeIndex& idx = options->get<1>();
270
271
272
273

        // 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.
274
275
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
276
277
278
279
280
281
282
            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) {
283
            return (OptionDescriptor(OptionPtr(), false));
284
285
286
287
288
        }

        return (*range.first);
    }

289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
    /// @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));
305
306
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
307
308
    }

Francis Dupont's avatar
Francis Dupont committed
309
    /// @brief Test invalid option parameter value.
310
311
312
313
314
315
316
317
318
319
320
321
    ///
    /// 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));
322
323
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
324
325
    }

326
327
328
329
330
331
332
333
334
    /// @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.
335
    void testOption(const OptionDescriptor& option_desc,
336
337
338
339
                    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.
340
        ASSERT_TRUE(option_desc.option_);
341
        // Verify option type.
342
        EXPECT_EQ(expected_code, option_desc.option_->getType());
343
344
345
346
347
        // 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.
348
349
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
350
351
352
353
354
        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.
355
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
356
357
                      expected_data_len);
        } else {
358
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
359
360
                      expected_data_len);
        }
361
        // Verify that the data is correct. Do not verify suboptions and a header.
362
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
363
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
364
                            expected_data_len));
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
    /// @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"));
393
        // The subnet should now hold one option with the specified option code.
394
        OptionDescriptor desc =
395
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
396
        ASSERT_TRUE(desc.option_);
397
398
399
        testOption(desc, option_code, expected_data, expected_data_len);
    }

400
401
402
403
404
405
406
407
408
409
410
411
412
    /// @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) {
413
        CfgMgr::instance().clear();
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
        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);
    }

452
453
454
455
456
457
458
459
    /// @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() {
460
        string config = "{ " + genIfaceConfig() + "," +
461
            "\"hooks-libraries\": [ ], "
462
463
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
464
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
465
            "\"option-def\": [ ], "
466
            "\"option-data\": [ ] }";
467
468
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
469
        CfgMgr::instance().clear();
470
    }
471

472

473
474
475
476
    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
477
478
479
480
481
482
483
484
485
486
487
488
489
};

// 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
490
    checkResult(x, 0);
491
492
493
494
}

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

    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
503
    checkResult(x, 1);
504
505
506
507
508
}

/// 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
509
TEST_F(Dhcp4ParserTest, emptySubnet) {
510
511
512
513

    ConstElementPtr status;

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_,
514
                    Element::fromJSON("{ " + genIfaceConfig() + "," +
515
516
517
518
519
520
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
                                      "\"valid-lifetime\": 4000 }")));

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
521
522
523
524
525
    checkResult(status, 0);

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

528
529
530
531
532
/// 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;

533
    string config = "{ " + genIfaceConfig() + "," +
534
535
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
536
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
537
538
539
540
541
542
543
544
545
546
547
548
        "    \"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);

549
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
550
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
    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;

567
    string config = "{ " + genIfaceConfig() + "," +
568
569
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
570
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
571
572
573
574
575
576
577
578
579
580
581
582
        "    \"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);

583
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
584
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
585
586
587
588
589
590
591
592
593
594
    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());
}

595
596
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
597
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
598
599
600

    ConstElementPtr status;

601
    string config = "{ " + genIfaceConfig() + "," +
602
603
604
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
605
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
606
607
608
609
610
611
612
613
        "    \"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
614
    checkResult(status, 0);
615
616
617

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
618
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
619
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
620
621
622
623
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
624
625
626

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

629
630
631
632
633
// 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;
634
635
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
636
    string config = "{ " + genIfaceConfig() + "," +
637
638
639
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
640
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
641
642
643
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
644
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
645
646
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
647
648
        " },"
        " {"
649
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
650
651
652
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
653
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
654
655
656
657
658
659
660
661
662
663
        "    \"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));
664
        checkResult(x, 0);
665

666
667
668
669
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
        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);
}

686
687
688
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
689
    // Four subnets with arbitrary subnet ids.
690
    string config = "{ " + genIfaceConfig() + "," +
691
692
693
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
694
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
695
696
697
698
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
699
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
700
701
702
703
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
704
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
705
706
707
708
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
709
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
710
711
712
713
714
715
716
717
718
719
        "    \"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));
720
        checkResult(x, 0);
721

722
723
724
725
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
726
727
728
729
730
731
732
733
734
735
736
        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.
737
    } while (++cnt < 3);
738
739
740
741
742
}

// Check that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
743
    // Four subnets, two of them having the same id.
744
    string config = "{ " + genIfaceConfig() + "," +
745
746
747
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
748
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
749
750
751
752
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
753
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
754
755
756
757
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
758
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
759
760
761
762
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
763
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
764
765
766
767
768
769
770
771
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
772
    checkResult(x, 1);
773
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
774
775
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
776
777
778
779
780
781
// 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
782
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
783
784
785
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
786
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
787
788
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
789
790
        " },"
        " {"
791
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
792
793
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
794
795
        " },"
        " {"
796
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
797
798
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
799
800
        " },"
        " {"
801
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
802
803
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
804
805
806
807
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
808
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
809
810
811
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
812
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
813
814
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
815
816
        " },"
        " {"
817
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
818
819
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
820
821
        " },"
        " {"
822
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
823
824
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
825
826
827
828
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
829
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
830
831
832
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
833
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
834
835
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
836
837
        " },"
        " {"
838
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
839
840
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
841
842
        " },"
        " {"
843
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
844
845
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
846
847
848
849
850
851
852
853
        " } ],"
        "\"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));
854
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
855

856
857
    const Subnet4Collection* subnets =
        CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
858
859
860
    ASSERT_TRUE(subnets);
    ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

861
862
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
863
864
865
    // Do the reconfiguration (the last subnet is removed)
    json = Element::fromJSON(config_first3);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
866
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
867

868
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
869
870
871
872
873
874
875
876
    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());

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
879
880
881
882
883
884
    /// 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));
885
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
886

887
888
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
889
890
891
    // Do reconfiguration
    json = Element::fromJSON(config_second_removed);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
892
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
893

894
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
895
896
897
898
899
900
901
902
903
904
905
    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.
906

907
908
909
910
911
912
// Checks if the next-server defined as global parameter is taken into
// consideration.
TEST_F(Dhcp4ParserTest, nextServerGlobal) {

    ConstElementPtr status;

913
    string config = "{ " + genIfaceConfig() + "," +
914
915
916
917
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"next-server\": \"1.2.3.4\", "
        "\"subnet4\": [ { "
918
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
919
920
921
922
923
924
925
926
927
928
929
930
        "    \"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.
931
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
932
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
933
934
935
936
937
938
939
940
941
942
    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;

943
    string config = "{ " + genIfaceConfig() + "," +
944
945
946
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
947
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
948
949
950
951
952
953
954
955
956
957
958
959
960
        "    \"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.
961
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
962
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
963
964
965
966
    ASSERT_TRUE(subnet);
    EXPECT_EQ("1.2.3.4", subnet->getSiaddr().toText());
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
967
968
969
// Test checks several negative scenarios for next-server configuration: bogus
// address, IPv6 adddress and empty string.
TEST_F(Dhcp4ParserTest, nextServerNegative) {
970
    IfaceMgrTestConfig test_config(true);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
971
972
973
974

    ConstElementPtr status;

    // Config with junk instead of next-server address
975
    string config_bogus1 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
976
977
978
        "\"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
        "    \"next-server\": \"a.b.c.d\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with IPv6 next server address
987
    string config_bogus2 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
988
989
990
        "\"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
        "    \"next-server\": \"2001:db8::1\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with empty next server address
999
    string config_bogus3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1000
        "\"rebind-timer\": 2000, "