config_parser_unittest.cc 171 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>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
13
#include <config/module_spec.h>
14
#include <dhcp4/dhcp4_srv.h>
15
#include <dhcp4/json_config_parser.h>
16
#include <dhcp/option4_addrlst.h>
17 18
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
19
#include <dhcp/docsis3_option_defs.h>
20
#include <dhcp/classify.h>
21
#include <dhcp/tests/iface_mgr_test_config.h>
22 23
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
24
#include <dhcpsrv/cfg_expiration.h>
25
#include <dhcpsrv/cfg_hosts.h>
26
#include <dhcpsrv/cfg_subnets4.h>
27
#include <dhcpsrv/testutils/config_result_check.h>
28 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

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 135 136 137 138 139 140 141 142 143
/// @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.
144
/// Verifies that the Kea DHCPv4 configuration specification file is valid.
145
TEST(Dhcp4SpecTest, basicSpec) {
146
    (isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
147 148 149
    ASSERT_NO_THROW(isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
}

150
class Dhcp4ParserTest : public ::testing::Test {
151 152 153 154 155 156 157 158 159 160
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());
    }

161 162
public:
    Dhcp4ParserTest()
163
    : rcode_(-1) {
164 165 166
        // 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.
167
        srv_.reset(new Dhcpv4Srv(0));
168 169
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
170
        resetConfiguration();
171 172
    }

173
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
174 175
    // Checks if global parameter of name have expected_value
    void checkGlobalUint32(string name, uint32_t expected_value) {
176
        const Uint32StoragePtr uint32_defaults =
177
                                        globalContext()->uint32_values_;
178
        try {
179
            uint32_t actual_value = uint32_defaults->getParam(name);
180 181
            EXPECT_EQ(expected_value, actual_value);
        } catch (DhcpConfigError) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
182 183 184 185 186
            ADD_FAILURE() << "Expected uint32 with name " << name
                          << " not found";
        }
    }

187
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
188 189 190 191 192 193 194 195
    // 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_);
    }

196
    ~Dhcp4ParserTest() {
197
        resetConfiguration();
198 199

        // ... and delete the hooks library marker files if present
200 201
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
202 203
    };

204 205 206 207 208 209 210 211
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

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

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

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

        // 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.
348 349
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
350 351 352 353 354 355 356
            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) {
357
            return (OptionDescriptor(OptionPtr(), false));
358 359 360 361 362
        }

        return (*range.first);
    }

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

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

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

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

474 475 476 477 478 479 480 481 482 483 484 485 486
    /// @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) {
487
        CfgMgr::instance().clear();
488
        ConstElementPtr json;
489 490
        ConstElementPtr status;
        try {
491
            json = parseJSON(config);
492 493 494 495 496 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
            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);
    }

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

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

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

585 586 587 588 589 590 591 592 593 594 595

    /// @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;
596
        ConstElementPtr json;
597

598
        EXPECT_NO_THROW(json = parseDHCP4(config, true));
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        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);
    }

617 618 619 620
    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
621 622 623 624
};

/// 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
625
TEST_F(Dhcp4ParserTest, bogusCommand) {
626 627 628 629

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
630
                    parseJSON("{\"bogus\": 5}")));
631 632

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
633
    checkResult(x, 1);
634 635 636

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

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
/// 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);
}

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

659 660
    ConstElementPtr json;
    EXPECT_NO_THROW(json = parseDHCP4("{ " + genIfaceConfig() + "," +
661 662 663
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
664 665 666 667
                                      "\"valid-lifetime\": 4000 }"));

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

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
670
    checkResult(status, 0);
671 672
}

673 674 675 676
/// 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) {

677
    string config = "{ " + genIfaceConfig() + "," +
678 679
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
680
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
681 682 683
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

684 685
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
686

687
    ConstElementPtr status;
688 689 690 691 692
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

693
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
694
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
695
    ASSERT_TRUE(subnet);
696
    EXPECT_FALSE(subnet->getT1().unspecified());
697
    EXPECT_FALSE(subnet->getT2().unspecified());
698
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
699 700 701 702 703 704 705 706 707 708 709 710
    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) {

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

718 719
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(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 730 731
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
732 733
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
734 735 736 737 738 739
    EXPECT_EQ(4000, subnet->getValid());

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

740 741
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
742
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
743

744
    string config = "{ " + genIfaceConfig() + "," +
745 746 747
        "\"rebind-timer\": 2000, "
        "\"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

755
    ConstElementPtr status;
756 757 758
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
759
    checkResult(status, 0);
760 761 762

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
763
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
764
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
765 766 767 768
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
769 770 771

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

774 775 776 777 778
// 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;
779 780
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
781
    string config = "{ " + genIfaceConfig() + "," +
782 783 784
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
785
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
786 787 788
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
789
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
790 791
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
792 793
        " },"
        " {"
794
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
795 796 797
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
798
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
799 800 801 802
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

803 804
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
805 806 807 808 809

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
810
        checkResult(x, 0);
811

812 813 814 815
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
        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);
}

832 833 834
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
835
    // Four subnets with arbitrary subnet ids.
836
    string config = "{ " + genIfaceConfig() + "," +
837 838 839
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
840
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
841 842 843 844
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
845
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
846 847 848 849
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
850
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
851 852 853 854
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
855
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
856 857 858 859 860
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

861 862
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
863 864 865 866

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

869 870 871 872
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
873 874 875 876 877 878 879 880 881 882 883
        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.
884
    } while (++cnt < 3);
885 886 887 888 889
}

// Check that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
890
    // Four subnets, two of them having the same id.
891
    string config = "{ " + genIfaceConfig() + "," +
892 893 894
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
895
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
896 897 898 899
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
900
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
901 902 903 904
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
905
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
906 907 908 909
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
910
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
911 912 913 914 915
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

916 917
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
918 919

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
920
    checkResult(x, 1);
921
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
922 923
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
924 925 926 927 928 929
// 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
930
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
931 932 933
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
934
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
935 936
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
937 938
        " },"
        " {"
939
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
940 941
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
942 943
        " },"
        " {"
944
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
945 946
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
947 948
        " },"
        " {"
949
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
950 951
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
952 953 954 955
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
956
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
957 958 959
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
960
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
961 962
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
963 964
        " },"
        " {"
965
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
966 967
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
968 969
        " },"
        " {"
970
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
971 972
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
973 974 975 976
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
977
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
978 979 980
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "