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

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

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

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

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

namespace {

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

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

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

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

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

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

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

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

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

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

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

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

        return (*range.first);
    }

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

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

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

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

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

473

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

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

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

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

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

    ConstElementPtr status;

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

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

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

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

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

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

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

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

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

    ConstElementPtr status;

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

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

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

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

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

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

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

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

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

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

    ElementPtr json = Element::fromJSON(config);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    ConstElementPtr status;

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

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

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

    ConstElementPtr status;

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

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

    // Config with empty next server address
1000
    string config_bogus3 = "{ " + genIfaceConfig() + "," +