config_parser_unittest.cc 148 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 <cc/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_expiration.h>
33
#include <dhcpsrv/cfg_hosts.h>
34
#include <dhcpsrv/cfg_subnets4.h>
35
#include <dhcpsrv/testutils/config_result_check.h>
36
#include <hooks/hooks_manager.h>
37
#include <defaults.h>
38
39
40

#include "marker_file.h"
#include "test_libraries.h"
41
#include "test_data_files_config.h"
42

43
#include <boost/foreach.hpp>
44
45
#include <boost/scoped_ptr.hpp>

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

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

namespace {

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

78
class Dhcp4ParserTest : public ::testing::Test {
79
80
81
82
83
84
85
86
87
88
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());
    }

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

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

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

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

        // ... and delete the hooks library marker files if present
128
129
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
130
131
    };

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

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

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

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

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

        return (*range.first);
    }

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

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

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

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

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

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

474

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

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

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

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

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

    ConstElementPtr status;

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

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

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

530
531
532
533
534
/// 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;

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

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

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

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

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

    ConstElementPtr status;

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

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

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

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

668
669
670
671
        CfgMgr::instance().commit();

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

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

724
725
726
727
        CfgMgr::instance().commit();

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

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

    ElementPtr json = Element::fromJSON(config);

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

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

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

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

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

863
864
    CfgMgr::instance().clear();

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

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

879
880
    CfgMgr::instance().clear();

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

889
890
    CfgMgr::instance().clear();

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

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

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

    ConstElementPtr status;

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

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

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

    ConstElementPtr status;

    // Config with junk instead of next-server address
977
    string config_bogus1 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
978
979
980
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
981
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
982
983
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
984
985
986
987
988
        "    \"next-server\": \"a.b.c.d\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with IPv6 next server address
989
    string config_bogus2 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
990
991
992
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
993
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
994
995
        "    \"rebind-timer\": 2000, "
        "    \"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
996
997
998
999
1000
        "    \"next-server\": \"2001:db8::1\", "
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

    // Config with empty next server address