config_parser_unittest.cc 197 KB
Newer Older
1
// Copyright (C) 2012-2017 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/json_config_parser.h>
15
#include <dhcp/option4_addrlst.h>
16 17
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
18
#include <dhcp/docsis3_option_defs.h>
19
#include <dhcp/classify.h>
20
#include <dhcp/tests/iface_mgr_test_config.h>
21 22
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
23
#include <dhcpsrv/cfg_expiration.h>
24
#include <dhcpsrv/cfg_hosts.h>
25
#include <dhcpsrv/cfg_subnets4.h>
26
#include <dhcpsrv/testutils/config_result_check.h>
27 28 29 30
#include <hooks/hooks_manager.h>

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

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

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

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

namespace {
53 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
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\""
    "     } ]"
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
    "}",

    // 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\""
    "     } ]"
131 132
    "}"
};
133 134

class Dhcp4ParserTest : public ::testing::Test {
135 136 137 138 139 140 141 142 143 144
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());
    }

145 146
public:
    Dhcp4ParserTest()
147
    : rcode_(-1) {
148 149 150
        // 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.
151
        srv_.reset(new Dhcpv4Srv(0));
152
        // Create fresh context.
153
        resetConfiguration();
154 155
    }

156
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
157

158
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
159 160 161 162 163 164 165 166
    // 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_);
    }

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
    /// @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);
            }
        }
    }

201
    ~Dhcp4ParserTest() {
202
        resetConfiguration();
203 204

        // ... and delete the hooks library marker files if present
205 206
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
207 208
    };

209 210 211 212 213 214 215 216
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

217 218 219
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
220 221
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
222
    ///
223
    /// @param param_value string holding option parameter value to be
224 225 226
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
227 228
    /// @return configuration string containing custom values of parameters
    /// describing an option.
229 230 231 232 233
    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;
234
            params["space"] = DHCP4_OPTION_SPACE;
235
            params["code"] = "56";
236
            params["data"] = "ABCDEF0105";
237
            params["csv-format"] = "false";
238 239 240
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
241
            params["code"] = "56";
242
            params["data"] = "ABCDEF0105";
243
            params["csv-format"] = "false";
244
        } else if (parameter == "code") {
245
            params["name"] = "dhcp-message";
246
            params["space"] = DHCP4_OPTION_SPACE;
247
            params["code"] = param_value;
248
            params["data"] = "ABCDEF0105";
249
            params["csv-format"] = "false";
250
        } else if (parameter == "data") {
251
            params["name"] = "dhcp-message";
252
            params["space"] = DHCP4_OPTION_SPACE;
253 254
            params["code"] = "56";
            params["data"] = param_value;
255
            params["csv-format"] = "false";
256
        } else if (parameter == "csv-format") {
257
            params["name"] = "dhcp-message";
258
            params["space"] = DHCP4_OPTION_SPACE;
259
            params["code"] = "56";
260
            params["data"] = "ABCDEF0105";
261
            params["csv-format"] = param_value;
262 263 264 265
        }
        return (createConfigWithOption(params));
    }

266 267 268 269 270 271 272 273
    /// @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.
274 275
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
276
        stream << "{ " << genIfaceConfig() << "," <<
277 278 279
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
280
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
281 282 283 284 285 286 287 288
            "    \"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 {
289
                // cppcheck-suppress unreadVariable
290 291 292 293
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
294 295
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
296 297 298 299
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
300 301
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
302 303 304 305 306 307 308 309 310
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
    /// @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.
326
    OptionDescriptor
327 328 329
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
330
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
331
            getCfgSubnets4()->selectSubnet(subnet_address);
332 333 334 335 336 337
        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";
        }
338
        OptionContainerPtr options =
339
            subnet->getCfgOption()->getAll(DHCP4_OPTION_SPACE);
340 341 342 343 344 345 346 347
        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.
348
        const OptionContainerTypeIndex& idx = options->get<1>();
349 350 351 352

        // 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.
353 354
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
355 356 357 358 359 360 361
            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) {
362
            return (OptionDescriptor(OptionPtr(), false));
363 364 365 366 367
        }

        return (*range.first);
    }

368 369 370 371 372 373 374 375 376 377 378 379 380 381
    /// @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);
382
        ConstElementPtr json = parseDHCP4(config);
383
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
384 385
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
386 387
    }

Francis Dupont's avatar
Francis Dupont committed
388
    /// @brief Test invalid option parameter value.
389 390 391 392 393 394 395 396 397 398
    ///
    /// 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);
399
        ConstElementPtr json = parseDHCP4(config);
400
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
401 402
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
403 404
    }

405 406 407 408 409 410 411 412 413
    /// @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.
414
    void testOption(const OptionDescriptor& option_desc,
415 416 417 418
                    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.
419
        ASSERT_TRUE(option_desc.option_);
420
        // Verify option type.
421
        EXPECT_EQ(expected_code, option_desc.option_->getType());
422 423 424 425 426
        // 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.
427 428
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
429 430 431 432 433
        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.
434
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
435 436
                      expected_data_len);
        } else {
437
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
438 439
                      expected_data_len);
        }
440
        // Verify that the data is correct. Do not verify suboptions and a header.
441
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
442
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
443
                            expected_data_len));
444 445
    }

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
    /// @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"));
472
        // The subnet should now hold one option with the specified option code.
473
        OptionDescriptor desc =
474
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
475
        ASSERT_TRUE(desc.option_);
476 477 478
        testOption(desc, option_code, expected_data, expected_data_len);
    }

479 480 481 482 483 484 485 486 487 488 489 490 491
    /// @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) {
492
        CfgMgr::instance().clear();
493
        ConstElementPtr json;
494 495
        ConstElementPtr status;
        try {
496
            json = parseJSON(config);
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
            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);
    }

532 533 534 535 536 537 538 539
    /// @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() {
540
        string config = "{ " + genIfaceConfig() + "," +
541
            "\"hooks-libraries\": [ ], "
542 543
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
544
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
545
            "\"option-def\": [ ], "
546
            "\"option-data\": [ ] }";
547 548
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
549
        CfgMgr::instance().clear();
550
    }
551

552 553
    /// @brief Retrieve an option associated with a host.
    ///
554 555
    /// The option is retrieved from the "dhcp4" option space.
    ///
556 557 558 559
    /// @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.
    ///
560
    /// @return Pointer to an option or NULL pointer if not found.
561 562 563
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
564
        return (retrieveOption<ReturnType>(host, DHCP4_OPTION_SPACE, option_code));
565 566 567 568 569 570 571 572 573
    }

    /// @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.
    ///
574
    /// @return Pointer to an option or NULL pointer if not found.
575 576 577 578
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
579 580
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
581
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
582 583 584 585 586 587 588
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
589

590 591 592 593 594 595 596
    /// @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
597 598
    /// @return the subnet that was examined
    Subnet4Ptr
599 600 601 602
    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);
603 604 605 606
        if (subnet_it == index.cend()) {
            ADD_FAILURE() << "Unable to find expected subnet " << subnet;
            return (Subnet4Ptr());
        }
607 608 609 610 611
        Subnet4Ptr s = *subnet_it;

        EXPECT_EQ(t1, s->getT1());
        EXPECT_EQ(t2, s->getT2());
        EXPECT_EQ(valid, s->getValid());
612 613

        return (s);
614
    }
615 616 617 618 619 620 621 622 623 624 625

    /// @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;
626
        ConstElementPtr json;
627

628
        EXPECT_NO_THROW(json = parseDHCP4(config, true));
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
        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);
    }

647 648 649 650
    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
651 652 653 654
};

/// 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
655
TEST_F(Dhcp4ParserTest, bogusCommand) {
656 657 658 659

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
660
                    parseJSON("{\"bogus\": 5}")));
661 662

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
663
    checkResult(x, 1);
664 665 666

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

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
/// 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);
}

684 685 686
/// 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
687
TEST_F(Dhcp4ParserTest, emptySubnet) {
688

689 690 691 692 693 694
    std::string config = "{ " + genIfaceConfig() + "," +
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [  ], "
        "\"valid-lifetime\": 4000 }";

695
    ConstElementPtr json;
696 697
    EXPECT_NO_THROW(json = parseDHCP4(config));
    extractConfig(config);
698 699 700

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

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
703
    checkResult(status, 0);
704 705
}

706 707 708 709
/// 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) {

710
    string config = "{ " + genIfaceConfig() + "," +
711 712
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
713
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
714 715 716
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

717 718
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
719
    extractConfig(config);
720

721
    ConstElementPtr status;
722 723 724 725 726
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

727
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
728
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
729
    ASSERT_TRUE(subnet);
730
    EXPECT_FALSE(subnet->getT1().unspecified());
731
    EXPECT_FALSE(subnet->getT2().unspecified());
732
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
733 734 735 736 737 738 739 740 741 742 743 744
    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) {

745
    string config = "{ " + genIfaceConfig() + "," +
746 747
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
748
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
749 750 751
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

752 753
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
754
    extractConfig(config);
755

756
    ConstElementPtr status;
757 758 759 760 761
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

762
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
763
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
764 765 766
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
767 768
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
769 770 771 772 773 774
    EXPECT_EQ(4000, subnet->getValid());

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

775 776
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
777
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
778

779
    string config = "{ " + genIfaceConfig() + "," +
780 781 782
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
783
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
784 785 786
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

787 788
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
789
    extractConfig(config);
790

791
    ConstElementPtr status;
792 793 794
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
795
    checkResult(status, 0);
796 797 798

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
799
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
800
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
801 802 803 804
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
805 806 807

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

810 811 812 813 814
// 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;
815 816
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
817
    string config = "{ " + genIfaceConfig() + "," +
818 819 820
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
821
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
822 823 824
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
825
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
826 827
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
828 829
        " },"
        " {"
830
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
831 832 833
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
834
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
835 836 837 838
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

839 840
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
841
    extractConfig(config);
842 843 844 845 846

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
847
        checkResult(x, 0);
848

849 850 851 852
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
        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);
}

869 870 871
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
872
    // Four subnets with arbitrary subnet ids.
873
    string config = "{ " + genIfaceConfig() + "," +
874 875 876
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
877
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
878 879 880 881
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
882
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
883 884 885 886
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
887
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
888 889 890 891
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
892
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
893 894 895 896 897
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

898 899
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
900
    extractConfig(config);
901 902 903 904

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

907 908 909 910
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
911 912 913 914 915 916 917 918 919 920 921
        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.
922
    } while (++cnt < 3);
923 924 925
}

// Check that the configuration with two subnets having the same id is rejected.
Josh Soref's avatar
Josh Soref committed
926
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlappingIDs) {
927
    ConstElementPtr x;
928
    // Four subnets, two of them having the same id.
929
    string config = "{ " + genIfaceConfig() + "," +
930 931 932
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
933
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
934 935 936 937
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
938
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
939 940 941 942
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
943
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
944 945 946 947
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
948
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
949 950 951 952 953
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

954 955
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
956 957

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
958
    checkResult(x, 1);
959
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
960 961
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
962 963 964 965 966 967
// 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
968
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
969 970 971
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
972
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
973 974
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
975 976
        " },"
        " {"
977
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
978 979
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
980 981
        " },"
        " {"
982
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
983 984
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
985 986
        " },"
        " {"
987
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
988 989
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
990 991 992 993
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
994
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
995 996 997
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
998
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
999 1000
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1001 1002
        " },"
        " {"
1003
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
1004 1005
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1006 1007
        " },"
        " {"
1008
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
1009 1010
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1011 1012 1013 1014
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
1015
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1016 1017 1018
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
1019
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
1020 1021
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1022 1023
        " },"
        " {"
1024
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
1025 1026
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1027 1028
        " },"
        " {"
1029
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
1030 1031
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1032 1033 1034 1035 1036 1037
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // CASE 1: Configure 4 subnets, then reconfigure and remove the
    // last one.

1038 1039
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config4));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1040
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
1041
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1042

1043 1044
    const Subnet4Collection* subnets =
        CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1045 1046 1047
    ASSERT_TRUE(subnets);
    ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

1048 1049
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1050
    // Do the reconfiguration (the last subnet is removed)
1051
    ASSERT_NO_THROW(json = parseDHCP4(config_first3));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1052
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
1053
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1054

1055
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1056 1057 1058 1059 1060 1061 1062 1063
    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());

1064 1065
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1066 1067
    /// CASE 2: Configure 4 subnets, then reconfigure and remove one
    /// from in between (not first, not last)
1068
    ASSERT_NO_THROW(json = parseDHCP4(config4));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1069
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
1070
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1071

1072 1073
    CfgMgr::instance().clear();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1074
    // Do reconfiguration
1075
    ASSERT_NO_THROW(json = parseDHCP4(config_second_removed));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1076
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
1077
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1078

1079
    subnets = CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->getAll();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
    ASSERT_TRUE(s