config_parser_unittest.cc 217 KB
Newer Older
Francis Dupont's avatar
Francis Dupont committed
1
// Copyright (C) 2012-2018 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>
13
#include <dhcp4/dhcp4_srv.h>
14
#include <dhcp4/ctrl_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 29 30 31
#include <hooks/hooks_manager.h>

#include "marker_file.h"
#include "test_libraries.h"
32
#include "test_data_files_config.h"
33
#include "dhcp4_test_utils.h"
34
#include "get_config_unittest.h"
35

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

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

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

namespace {
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
const char* PARSER_CONFIGS[] = {
    // CONFIGURATION 0: one subnet with one pool, no user contexts
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\" }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
    "}",

    // Configuration 1: one pool with empty user context
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\","
    "                \"user-context\": {"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
    "}",

    // Configuration 2: one pool with user context containing lw4over6 parameters
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\","
    "                \"user-context\": {"
    "                    \"integer-param\": 42,"
    "                    \"string-param\": \"Sagittarius\","
    "                    \"bool-param\": true"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    "}",

    // Configuration 3: one min-max pool with user context containing lw4over6 parameters
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0 - 192.0.2.15\","
    "                \"user-context\": {"
    "                    \"integer-param\": 42,"
    "                    \"string-param\": \"Sagittarius\","
    "                    \"bool-param\": true"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
Francis Dupont's avatar
Francis Dupont committed
132 133
    "}",

Francis Dupont's avatar
Francis Dupont committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    // Configuration 4: two host databases
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"hosts-databases\": [ {"
    "        \"type\": \"mysql\","
    "        \"name\": \"keatest1\","
    "        \"user\": \"keatest\","
    "        \"password\": \"keatest\""
    "      },{"
    "        \"type\": \"mysql\","
    "        \"name\": \"keatest2\","
    "        \"user\": \"keatest\","
    "        \"password\": \"keatest\""
    "      }"
    "    ]"
    "}",

Francis Dupont's avatar
Francis Dupont committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    // Last Configuration for comments
    "{"
    "    \"comment\": \"A DHCPv4 server\","
    "    \"interfaces-config\": {"
    "        \"comment\": \"Use wildcard\","
    "        \"interfaces\": [ \"*\" ] },"
    "    \"option-def\": [ {"
    "        \"comment\": \"An option definition\","
    "        \"name\": \"foo\","
    "        \"code\": 100,"
    "        \"type\": \"ipv4-address\","
    "        \"space\": \"isc\""
    "     } ],"
    "    \"option-data\": [ {"
    "        \"comment\": \"Set option value\","
    "        \"name\": \"dhcp-message\","
    "        \"data\": \"ABCDEF0105\","
    "        \"csv-format\": false"
    "     } ],"
    "    \"client-classes\": ["
    "        {"
    "           \"comment\": \"match all\","
    "           \"name\": \"all\","
    "           \"test\": \"'' == ''\""
    "        },"
    "        {"
    "           \"name\": \"none\""
    "        },"
    "        {"
    "           \"comment\": \"a comment\","
    "           \"name\": \"both\","
    "           \"user-context\": {"
    "               \"version\": 1"
    "           }"
    "        }"
    "        ],"
    "    \"control-socket\": {"
    "        \"socket-type\": \"unix\","
    "        \"socket-name\": \"/tmp/kea4-ctrl-socket\","
    "        \"user-context\": { \"comment\": \"Indirect comment\" }"
    "    },"
    "    \"shared-networks\": [ {"
    "        \"comment\": \"A shared network\","
    "        \"name\": \"foo\","
    "        \"subnet4\": ["
    "        { "
    "            \"comment\": \"A subnet\","
    "            \"subnet\": \"192.0.1.0/24\","
    "            \"id\": 100,"
    "            \"pools\": ["
    "            {"
    "                 \"comment\": \"A pool\","
    "                 \"pool\": \"192.0.1.1-192.0.1.10\""
    "            }"
    "            ],"
    "            \"reservations\": ["
    "            {"
    "                 \"comment\": \"A host reservation\","
    "                 \"hw-address\": \"AA:BB:CC:DD:EE:FF\","
    "                 \"hostname\": \"foo.example.com\","
    "                 \"option-data\": [ {"
    "                     \"comment\": \"An option in a reservation\","
    "                     \"name\": \"domain-name\","
    "                     \"data\": \"example.com\""
    "                 } ]"
    "            }"
    "            ]"
    "        }"
    "        ]"
    "     } ],"
    "    \"dhcp-ddns\": {"
    "        \"comment\": \"No dynamic DNS\","
    "        \"enable-updates\": false"
    "    }"
230 231
    "}"
};
232 233

class Dhcp4ParserTest : public ::testing::Test {
234 235 236 237 238 239 240 241 242 243
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());
    }

244 245
public:
    Dhcp4ParserTest()
246
    : rcode_(-1) {
247 248 249
        // 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.
250
        srv_.reset(new ControlledDhcpv4Srv(0));
251
        // Create fresh context.
252
        resetConfiguration();
253 254
    }

255
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
256

257
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
258 259 260 261 262 263 264 265
    // 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_);
    }

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
    /// @brief Convenience method for running configuration
    ///
    /// This method does not throw, but signals errors using gtest macros.
    ///
    /// @param config text to be parsed as JSON
    /// @param expected_code expected code (see cc/command_interpreter.h)
    /// @param exp_error expected text error (check skipped if empty)
    void configure(std::string config, int expected_code,
                   std::string exp_error = "") {
        ConstElementPtr json;
        ASSERT_NO_THROW(json = parseDHCP4(config, true));

        ConstElementPtr status;
        EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));
        ASSERT_TRUE(status);

        int rcode;
        ConstElementPtr comment = parseAnswer(rcode, status);
        EXPECT_EQ(expected_code, rcode);

        string text;
        ASSERT_NO_THROW(text = comment->stringValue());

        if (expected_code != rcode) {
            std::cout << "Reported status: " << text << std::endl;
        }

        if ((rcode != 0)) {
            if (!exp_error.empty()) {
                EXPECT_EQ(exp_error, text);
            }
        }
    }

300
    ~Dhcp4ParserTest() {
301
        resetConfiguration();
302 303

        // ... and delete the hooks library marker files if present
304 305
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
306 307
    };

308 309 310 311 312 313 314 315
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

316 317 318
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
319 320
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
321
    ///
322
    /// @param param_value string holding option parameter value to be
323 324 325
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
326 327
    /// @return configuration string containing custom values of parameters
    /// describing an option.
328 329 330 331 332
    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;
333
            params["space"] = DHCP4_OPTION_SPACE;
334
            params["code"] = "56";
335
            params["data"] = "ABCDEF0105";
336
            params["csv-format"] = "false";
337 338 339
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
340
            params["code"] = "56";
341
            params["data"] = "ABCDEF0105";
342
            params["csv-format"] = "false";
343
        } else if (parameter == "code") {
344
            params["name"] = "dhcp-message";
345
            params["space"] = DHCP4_OPTION_SPACE;
346
            params["code"] = param_value;
347
            params["data"] = "ABCDEF0105";
348
            params["csv-format"] = "false";
349
        } else if (parameter == "data") {
350
            params["name"] = "dhcp-message";
351
            params["space"] = DHCP4_OPTION_SPACE;
352 353
            params["code"] = "56";
            params["data"] = param_value;
354
            params["csv-format"] = "false";
355
        } else if (parameter == "csv-format") {
356
            params["name"] = "dhcp-message";
357
            params["space"] = DHCP4_OPTION_SPACE;
358
            params["code"] = "56";
359
            params["data"] = "ABCDEF0105";
360
            params["csv-format"] = param_value;
361 362 363 364
        }
        return (createConfigWithOption(params));
    }

365 366 367 368 369 370 371 372
    /// @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.
373 374
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
375
        stream << "{ " << genIfaceConfig() << "," <<
376 377 378
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
379
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
380 381 382 383 384 385 386 387
            "    \"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 {
388
                // cppcheck-suppress unreadVariable
389 390 391 392
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
393 394
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
395 396 397 398
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
399 400
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
401 402 403 404 405 406 407 408 409
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    /// @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.
425
    OptionDescriptor
426 427 428
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
429
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
430
            getCfgSubnets4()->selectSubnet(subnet_address);
431 432 433 434 435 436
        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";
        }
437
        OptionContainerPtr options =
438
            subnet->getCfgOption()->getAll(DHCP4_OPTION_SPACE);
439 440 441 442 443 444 445 446
        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.
447
        const OptionContainerTypeIndex& idx = options->get<1>();
448 449 450 451

        // 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.
452 453
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
454 455 456 457 458 459 460
            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) {
461
            return (OptionDescriptor(OptionPtr(), false));
462 463 464 465 466
        }

        return (*range.first);
    }

467 468 469 470 471 472 473 474 475 476 477 478 479 480
    /// @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);
481
        ConstElementPtr json = parseDHCP4(config);
482
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
483 484
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
485 486
    }

Francis Dupont's avatar
Francis Dupont committed
487
    /// @brief Test invalid option parameter value.
488 489 490 491 492 493 494 495 496 497
    ///
    /// 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);
498
        ConstElementPtr json = parseDHCP4(config);
499
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
500 501
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
502 503
    }

504 505 506 507 508 509 510 511 512
    /// @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.
513
    void testOption(const OptionDescriptor& option_desc,
514 515 516 517
                    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.
518
        ASSERT_TRUE(option_desc.option_);
519
        // Verify option type.
520
        EXPECT_EQ(expected_code, option_desc.option_->getType());
521 522 523 524 525
        // 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.
526 527
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
528 529 530 531 532
        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.
533
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
534 535
                      expected_data_len);
        } else {
536
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
537 538
                      expected_data_len);
        }
539
        // Verify that the data is correct. Do not verify suboptions and a header.
540
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
541
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
542
                            expected_data_len));
543 544
    }

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
    /// @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"));
571
        // The subnet should now hold one option with the specified option code.
572
        OptionDescriptor desc =
573
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
574
        ASSERT_TRUE(desc.option_);
575 576 577
        testOption(desc, option_code, expected_data, expected_data_len);
    }

578 579 580 581 582 583 584 585 586 587 588 589 590
    /// @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) {
591
        CfgMgr::instance().clear();
592
        ConstElementPtr json;
593 594
        ConstElementPtr status;
        try {
595
            json = parseJSON(config);
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
            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);
    }

631 632 633 634 635 636 637 638
    /// @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() {
639
        string config = "{ " + genIfaceConfig() + "," +
640
            "\"hooks-libraries\": [ ], "
641 642
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
643
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
644
            "\"option-def\": [ ], "
645
            "\"option-data\": [ ] }";
646 647
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
648
        CfgMgr::instance().clear();
649
    }
650

651 652
    /// @brief Retrieve an option associated with a host.
    ///
653 654
    /// The option is retrieved from the "dhcp4" option space.
    ///
655 656 657 658
    /// @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.
    ///
659
    /// @return Pointer to an option or NULL pointer if not found.
660 661 662
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
663
        return (retrieveOption<ReturnType>(host, DHCP4_OPTION_SPACE, option_code));
664 665 666 667 668 669 670 671 672
    }

    /// @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.
    ///
673
    /// @return Pointer to an option or NULL pointer if not found.
674 675 676 677
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
678 679
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
680
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
681 682 683 684 685 686 687
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
688

689 690 691 692 693 694 695
    /// @brief Checks if specified subnet is part of the collection
    ///
    /// @param col collection of subnets to be inspected
    /// @param subnet text notation (e.g. 192.0.2.0/24)
    /// @param t1 expected renew-timer value
    /// @param t2 expected rebind-timer value
    /// @param valid expected valid-lifetime value
696 697
    /// @return the subnet that was examined
    Subnet4Ptr
698 699 700 701
    checkSubnet(const Subnet4Collection& col, std::string subnet,
                uint32_t t1, uint32_t t2, uint32_t valid) {
        const auto& index = col.get<SubnetPrefixIndexTag>();
        auto subnet_it = index.find(subnet);
702 703 704 705
        if (subnet_it == index.cend()) {
            ADD_FAILURE() << "Unable to find expected subnet " << subnet;
            return (Subnet4Ptr());
        }
706 707 708 709 710
        Subnet4Ptr s = *subnet_it;

        EXPECT_EQ(t1, s->getT1());
        EXPECT_EQ(t2, s->getT2());
        EXPECT_EQ(valid, s->getValid());
711 712

        return (s);
713
    }
714 715 716 717 718 719 720 721 722 723 724

    /// @brief This utility method attempts to configure using specified
    ///        config and then returns requested pool from requested subnet
    ///
    /// @param config configuration to be applied
    /// @param subnet_index index of the subnet to be returned (0 - the first subnet)
    /// @param pool_index index of the pool within a subnet (0 - the first pool)
    /// @param pool [out] Pool pointer will be stored here (if found)
    void getPool(const std::string& config, size_t subnet_index,
                 size_t pool_index, PoolPtr& pool) {
        ConstElementPtr status;
725
        ConstElementPtr json;
726

727
        EXPECT_NO_THROW(json = parseDHCP4(config, true));
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
        EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));
        ASSERT_TRUE(status);
        checkResult(status, 0);

        ConstCfgSubnets4Ptr subnets4 = CfgMgr::instance().getStagingCfg()->getCfgSubnets4();
        ASSERT_TRUE(subnets4);

        const Subnet4Collection* subnets = subnets4->getAll();
        ASSERT_TRUE(subnets);
        ASSERT_GE(subnets->size(), subnet_index + 1);

        const PoolCollection pools = subnets->at(subnet_index)->getPools(Lease::TYPE_V4);
        ASSERT_GE(pools.size(), pool_index + 1);

        pool = pools.at(pool_index);
        EXPECT_TRUE(pool);
    }

746 747 748 749
    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
750 751 752 753
};

/// 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
754
TEST_F(Dhcp4ParserTest, bogusCommand) {
755 756 757 758

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
759
                    parseJSON("{\"bogus\": 5}")));
760 761

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
762
    checkResult(x, 1);
763 764 765

    // it should be refused by syntax too
    EXPECT_THROW(parseDHCP4("{\"bogus\": 5}"), Dhcp4ParseError);
766 767
}

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
/// The goal of this test is to verify empty interface-config is accepted.
TEST_F(Dhcp4ParserTest, emptyInterfaceConfig) {

    ConstElementPtr json;
    EXPECT_NO_THROW(json = parseDHCP4("{ \"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"valid-lifetime\": 4000 }"));

    ConstElementPtr status;
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
}

783 784 785
/// 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
786
TEST_F(Dhcp4ParserTest, emptySubnet) {
787

788 789 790 791 792 793
    std::string config = "{ " + genIfaceConfig() + "," +
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [  ], "
        "\"valid-lifetime\": 4000 }";

794
    ConstElementPtr json;
795 796
    EXPECT_NO_THROW(json = parseDHCP4(config));
    extractConfig(config);
797 798 799

    ConstElementPtr status;
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));
800 801

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
802
    checkResult(status, 0);
803 804
}

805 806 807 808
/// 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) {

809
    string config = "{ " + genIfaceConfig() + "," +
810 811
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
812
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
813 814 815
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

816 817
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
818
    extractConfig(config);
819

820
    ConstElementPtr status;
821 822 823 824 825
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);

826
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
827
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
828
    ASSERT_TRUE(subnet);
829
    EXPECT_FALSE(subnet->getT1().unspecified());
830
    EXPECT_FALSE(subnet->getT2().unspecified());
831
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
832 833 834 835 836 837 838 839 840 841 842 843
    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) {

844
    string config = "{ " + genIfaceConfig() + "," +
845 846
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
847
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
848 849 850
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

851 852
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
853
    extractConfig(config);
854

855
    ConstElementPtr status;
856 857 858 859 860
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);

861
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
862
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
863 864 865
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
866 867
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
868 869 870 871 872 873
    EXPECT_EQ(4000, subnet->getValid());

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

874 875
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
876
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
877

878
    string config = "{ " + genIfaceConfig() + "," +
879 880 881
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
882
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
883 884 885
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

886 887
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
888
    extractConfig(config);
889

890
    ConstElementPtr status;
891 892 893
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
894
    checkResult(status, 0);
895 896 897

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
898
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
899
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
900 901 902 903
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
904 905 906

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

909 910 911 912 913
// 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;
914 915
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
916
    string config = "{ " + genIfaceConfig() + "," +
917 918 919
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
920
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
921 922 923
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
924
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
925 926
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
927 928
        " },"
        " {"
929
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
930 931 932
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
933
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
934 935 936 937
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

938 939
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
940
    extractConfig(config);
941 942 943 944 945

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
946
        checkResult(x, 0);
947

948 949 950 951
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
        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);
}

968 969 970
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
971
    // Four subnets with arbitrary subnet ids.
972
    string config = "{ " + genIfaceConfig() + "," +
973 974 975
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
976
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
977 978 979 980
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
981
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
982 983 984 985
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
986
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
987 988 989 990
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
991
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
992 993 994 995 996
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

997 998
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
999
    extractConfig(config);
1000 1001 1002 1003

    int cnt = 0; // Number of reconfigurations
    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
1004
        checkResult(x, 0);
1005

1006 1007 1008 1009
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
        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.
1021
    } while (++cnt < 3);
1022 1023 1024
}

// Check that the configuration with two subnets having the same id is rejected.
Josh Soref's avatar
Josh Soref committed
1025
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlappingIDs) {
1026
    ConstElementPtr x;
1027
    // Four subnets, two of them having the same id.
1028
    string config = "{ " + genIfaceConfig() + "," +
1029 1030 1031
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
1032
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
1033 1034 1035 1036
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
1037
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
1038 1039 1040 1041
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
1042
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
1043 1044 1045 1046
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
1047
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
1048 1049 1050 1051 1052
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

1053 1054
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
1055 1056

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));