config_parser_unittest.cc 164 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
#include <hooks/hooks_manager.h>
29
#include <defaults.h>
30 31 32

#include "marker_file.h"
#include "test_libraries.h"
33
#include "test_data_files_config.h"
34
#include "dhcp4_test_utils.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\""
    "     } ]"
132 133
    "}"
};
134

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

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

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

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

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

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

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

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

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

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

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

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

        return (*range.first);
    }

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

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

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

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

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

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

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

586 587 588 589 590 591 592 593 594 595 596

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

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

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

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

    ConstElementPtr x;

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

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

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

/// 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
643
TEST_F(Dhcp4ParserTest, emptySubnet) {
644

645 646
    ConstElementPtr json;
    EXPECT_NO_THROW(json = parseDHCP4("{ " + genIfaceConfig() + "," +
647 648 649
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
650 651 652 653
                                      "\"valid-lifetime\": 4000 }"));

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

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
656 657 658 659 660
    checkResult(status, 0);

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

663 664 665 666
/// 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) {

667
    string config = "{ " + genIfaceConfig() + "," +
668 669
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
670
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
671 672 673
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

674 675
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
676

677
    ConstElementPtr status;
678 679 680 681 682 683 684
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
    checkGlobalUint32("rebind-timer", 2000);
    checkGlobalUint32("valid-lifetime", 4000);

685
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
686
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
687
    ASSERT_TRUE(subnet);
688
    EXPECT_FALSE(subnet->getT1().unspecified());
689
    EXPECT_FALSE(subnet->getT2().unspecified());
690
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
691 692 693 694 695 696 697 698 699 700 701 702
    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) {

703
    string config = "{ " + genIfaceConfig() + "," +
704 705
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
706
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
707 708 709
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

710 711
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
712

713
    ConstElementPtr status;
714 715 716 717 718 719 720
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
    checkGlobalUint32("renew-timer", 1000);
    checkGlobalUint32("valid-lifetime", 4000);

721
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
722
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
723 724 725
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
726 727
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
728 729 730 731 732 733
    EXPECT_EQ(4000, subnet->getValid());

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

734 735
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
736
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
737

738
    string config = "{ " + genIfaceConfig() + "," +
739 740 741
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
742
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
743 744 745
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

746 747
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
748

749
    ConstElementPtr status;
750 751 752
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
753
    checkResult(status, 0);
754 755 756

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
757
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
758
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
759 760 761 762
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
763 764 765

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

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

797 798
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
799 800 801 802 803

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
804
        checkResult(x, 0);
805

806 807 808 809
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
        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);
}

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

855 856
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
857 858 859 860

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

863 864 865 866
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
867 868 869 870 871 872 873 874 875 876 877
        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.
878
    } while (++cnt < 3);
879 880 881 882 883
}

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

910 911
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
912 913

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
914
    checkResult(x, 1);
915
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
916 917
}

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

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

    // Second subnet removed
971
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
972 973 974
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
975
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"