config_parser_unittest.cc 154 KB
Newer Older
1
// Copyright (C) 2012-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3
4
5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7
8
9
10
11

#include <config.h>

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

12
#include <cc/command_interpreter.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
13
#include <config/module_spec.h>
14
#include <dhcp4/dhcp4_srv.h>
15
#include <dhcp4/json_config_parser.h>
16
#include <dhcp/option4_addrlst.h>
17
18
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
19
#include <dhcp/docsis3_option_defs.h>
20
#include <dhcp/classify.h>
21
#include <dhcp/tests/iface_mgr_test_config.h>
22
23
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
24
#include <dhcpsrv/cfg_expiration.h>
25
#include <dhcpsrv/cfg_hosts.h>
26
#include <dhcpsrv/cfg_subnets4.h>
27
#include <dhcpsrv/testutils/config_result_check.h>
28
#include <hooks/hooks_manager.h>
29
#include <defaults.h>
30
31
32

#include "marker_file.h"
#include "test_libraries.h"
33
#include "test_data_files_config.h"
34

35
#include <boost/foreach.hpp>
36
37
#include <boost/scoped_ptr.hpp>

Tomek Mrugalski's avatar
Tomek Mrugalski committed
38
39
40
41
#include <iostream>
#include <fstream>
#include <sstream>
#include <limits.h>
42
43
44
45

using namespace isc;
using namespace isc::asiolink;
using namespace isc::config;
46
47
using namespace isc::data;
using namespace isc::dhcp;
48
using namespace isc::dhcp::test;
49
50
using namespace isc::hooks;
using namespace std;
51
52
53

namespace {

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

70
class Dhcp4ParserTest : public ::testing::Test {
71
72
73
74
75
76
77
78
79
80
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());
    }

81
82
public:
    Dhcp4ParserTest()
83
    : rcode_(-1) {
84
85
86
        // 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.
87
        srv_.reset(new Dhcpv4Srv(0));
88
89
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
90
        resetConfiguration();
91
92
    }

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

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

116
    ~Dhcp4ParserTest() {
117
        resetConfiguration();
118
119

        // ... and delete the hooks library marker files if present
120
121
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
122
123
    };

124
125
126
127
128
129
130
131
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

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

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

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

        // 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.
268
269
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
270
271
272
273
274
275
276
            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) {
277
            return (OptionDescriptor(OptionPtr(), false));
278
279
280
281
282
        }

        return (*range.first);
    }

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    /// @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));
299
300
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
301
302
    }

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

320
321
322
323
324
325
326
327
328
    /// @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.
329
    void testOption(const OptionDescriptor& option_desc,
330
331
332
333
                    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.
334
        ASSERT_TRUE(option_desc.option_);
335
        // Verify option type.
336
        EXPECT_EQ(expected_code, option_desc.option_->getType());
337
338
339
340
341
        // 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.
342
343
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
344
345
346
347
348
        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.
349
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
350
351
                      expected_data_len);
        } else {
352
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
353
354
                      expected_data_len);
        }
355
        // Verify that the data is correct. Do not verify suboptions and a header.
356
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
357
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
358
                            expected_data_len));
359
360
    }

361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
    /// @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"));
387
        // The subnet should now hold one option with the specified option code.
388
        OptionDescriptor desc =
389
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
390
        ASSERT_TRUE(desc.option_);
391
392
393
        testOption(desc, option_code, expected_data, expected_data_len);
    }

394
395
396
397
398
399
400
401
402
403
404
405
406
    /// @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) {
407
        CfgMgr::instance().clear();
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
        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);
    }

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

466
467
    /// @brief Retrieve an option associated with a host.
    ///
468
469
    /// The option is retrieved from the "dhcp4" option space.
    ///
470
471
472
473
474
475
476
477
    /// @param host Reference to a host for which an option should be retrieved.
    /// @param option_code Option code.
    /// @tparam ReturnType Type of the pointer object returned.
    ///
    /// @return Pointer to an option or NULL if not found.
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
        return (retrieveOption<ReturnType>(host, "dhcp4", option_code));
    }

    /// @brief Retrieve an option associated with a host.
    ///
    /// @param host Reference to a host for which an option should be retrieved.
    /// @param space Option space from which option should be retrieved.
    /// @param option_code Option code.
    /// @tparam ReturnType Type of the pointer object returned.
    ///
    /// @return Pointer to an option or NULL if not found.
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
493
494
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
495
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
496
497
498
499
500
501
502
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
503

504
505
506
507
    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
508
509
510
511
512
513
514
515
516
517
518
519
520
};

// 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
521
    checkResult(x, 0);
522
523
524
525
}

/// 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
526
TEST_F(Dhcp4ParserTest, bogusCommand) {
527
528
529
530
531
532
533

    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
534
    checkResult(x, 1);
535
536
537
538
539
}

/// 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
540
TEST_F(Dhcp4ParserTest, emptySubnet) {
541
542
543
544

    ConstElementPtr status;

    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_,
545
                    Element::fromJSON("{ " + genIfaceConfig() + "," +
546
547
548
549
550
551
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
                                      "\"valid-lifetime\": 4000 }")));

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
552
553
554
555
556
    checkResult(status, 0);

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

559
560
561
562
563
/// 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;

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

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

598
    string config = "{ " + genIfaceConfig() + "," +
599
600
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
601
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
602
603
604
605
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));

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

614
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
615
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
616
617
618
619
620
621
622
623
624
625
    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());
}

626
627
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
628
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
629
630
631

    ConstElementPtr status;

632
    string config = "{ " + genIfaceConfig() + "," +
633
634
635
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
636
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
637
638
639
640
641
642
643
644
        "    \"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
645
    checkResult(status, 0);
646
647
648

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
649
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
650
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
651
652
653
654
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
655
656
657

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

660
661
662
663
664
// 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;
665
666
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
667
    string config = "{ " + genIfaceConfig() + "," +
668
669
670
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
671
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
672
673
674
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
675
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
676
677
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
678
679
        " },"
        " {"
680
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
681
682
683
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
684
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
685
686
687
688
689
690
691
692
693
694
        "    \"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));
695
        checkResult(x, 0);
696

697
698
699
700
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
        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);
}

717
718
719
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
720
    // Four subnets with arbitrary subnet ids.
721
    string config = "{ " + genIfaceConfig() + "," +
722
723
724
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
725
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
726
727
728
729
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
730
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
731
732
733
734
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
735
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
736
737
738
739
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
740
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
741
742
743
744
745
746
747
748
749
750
        "    \"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));
751
        checkResult(x, 0);
752

753
754
755
756
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
757
758
759
760
761
762
763
764
765
766
767
        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.
768
    } while (++cnt < 3);
769
770
771
772
773
}

// Check that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
774
    // Four subnets, two of them having the same id.
775
    string config = "{ " + genIfaceConfig() + "," +
776
777
778
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
779
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
780
781
782
783
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
784
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
785
786
787
788
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
789
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
790
791
792
793
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
794
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
795
796
797
798
799
800
801
802
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
803
    checkResult(x, 1);
804
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
805
806
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
807
808
809
810
811
812
// 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
813
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
814
815
816
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
817
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
818
819
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
820
821
        " },"
        " {"
822
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
823
824
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
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
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
839
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
840
841
842
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
843
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
844
845
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
846
847
        " },"
        " {"
848
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
849
850
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
851
852
        " },"
        " {"
853
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
854
855
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
856
857
858
859
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
860
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
861
862
863
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
864
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
865
866
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
867
868
        " },"
        " {"
869
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
870
871
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
872
873
        " },"
        " {"
874
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
875
876
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
877
878
879
880
881
882
883
884
        " } ],"
        "\"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));
885
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
886

887
888
    const Subnet4Collection* subnets =
        CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
889
890
891
    ASSERT_TRUE(subnets);
    ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

892
893
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
894
895
896
    // Do the reconfiguration (the last subnet is removed)
    json = Element::fromJSON(config_first3);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
897
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
898

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

908
909
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
910
911
912
913
914
915
    /// 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));
916
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
917

918
919
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
920
921
922
    // Do reconfiguration
    json = Element::fromJSON(config_second_removed);
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
923
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
924

925
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
926
927
928
929
930
931
932
933
934
935
936
    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.
937

938
939
940
941
942
943
// Checks if the next-server defined as global parameter is taken into
// consideration.
TEST_F(Dhcp4ParserTest, nextServerGlobal) {

    ConstElementPtr status;

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

974
    string config = "{ " + genIfaceConfig() + "," +
975
976
977
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
978
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
979
980
981
982
983
984
985
986
987
988
989
990
991
        "    \"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.
992
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
993
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
994
995
996
997
    ASSERT_TRUE(subnet);
    EXPECT_EQ("1.2.3.4", subnet->getSiaddr().toText());
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
998
999
1000
// Test checks several negative scenarios for next-server configuration: bogus
// address, IPv6 adddress and empty string.
TEST_F(Dhcp4ParserTest, nextServerNegative) {