config_parser_unittest.cc 209 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
#include "get_config_unittest.h"
35

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

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

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

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

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

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

    // Configuration 3: one min-max pool with user context containing lw4over6 parameters
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0 - 192.0.2.15\","
    "                \"user-context\": {"
    "                    \"integer-param\": 42,"
    "                    \"string-param\": \"Sagittarius\","
    "                    \"bool-param\": true"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
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
        // Create fresh context.
170
        resetConfiguration();
171 172
    }

173
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
174

175
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
176 177 178 179 180 181 182 183
    // 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_);
    }

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    /// @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);
            }
        }
    }

218
    ~Dhcp4ParserTest() {
219
        resetConfiguration();
220 221

        // ... and delete the hooks library marker files if present
222 223
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
224 225
    };

226 227 228 229 230 231 232 233
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

234 235 236
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
237 238
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
239
    ///
240
    /// @param param_value string holding option parameter value to be
241 242 243
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
244 245
    /// @return configuration string containing custom values of parameters
    /// describing an option.
246 247 248 249 250
    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;
251
            params["space"] = DHCP4_OPTION_SPACE;
252
            params["code"] = "56";
253
            params["data"] = "ABCDEF0105";
254
            params["csv-format"] = "false";
255 256 257
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
258
            params["code"] = "56";
259
            params["data"] = "ABCDEF0105";
260
            params["csv-format"] = "false";
261
        } else if (parameter == "code") {
262
            params["name"] = "dhcp-message";
263
            params["space"] = DHCP4_OPTION_SPACE;
264
            params["code"] = param_value;
265
            params["data"] = "ABCDEF0105";
266
            params["csv-format"] = "false";
267
        } else if (parameter == "data") {
268
            params["name"] = "dhcp-message";
269
            params["space"] = DHCP4_OPTION_SPACE;
270 271
            params["code"] = "56";
            params["data"] = param_value;
272
            params["csv-format"] = "false";
273
        } else if (parameter == "csv-format") {
274
            params["name"] = "dhcp-message";
275
            params["space"] = DHCP4_OPTION_SPACE;
276
            params["code"] = "56";
277
            params["data"] = "ABCDEF0105";
278
            params["csv-format"] = param_value;
279 280 281 282
        }
        return (createConfigWithOption(params));
    }

283 284 285 286 287 288 289 290
    /// @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.
291 292
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
293
        stream << "{ " << genIfaceConfig() << "," <<
294 295 296
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
297
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
298 299 300 301 302 303 304 305
            "    \"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 {
306
                // cppcheck-suppress unreadVariable
307 308 309 310
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
311 312
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
313 314 315 316
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
317 318
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
319 320 321 322 323 324 325 326 327
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    /// @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.
343
    OptionDescriptor
344 345 346
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
347
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
348
            getCfgSubnets4()->selectSubnet(subnet_address);
349 350 351 352 353 354
        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";
        }
355
        OptionContainerPtr options =
356
            subnet->getCfgOption()->getAll(DHCP4_OPTION_SPACE);
357 358 359 360 361 362 363 364
        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.
365
        const OptionContainerTypeIndex& idx = options->get<1>();
366 367 368 369

        // 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.
370 371
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
372 373 374 375 376 377 378
            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) {
379
            return (OptionDescriptor(OptionPtr(), false));
380 381 382 383 384
        }

        return (*range.first);
    }

385 386 387 388 389 390 391 392 393 394 395 396 397 398
    /// @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);
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
    }

Francis Dupont's avatar
Francis Dupont committed
405
    /// @brief Test invalid option parameter value.
406 407 408 409 410 411 412 413 414 415
    ///
    /// 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);
416
        ConstElementPtr json = parseDHCP4(config);
417
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
418 419
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
420 421
    }

422 423 424 425 426 427 428 429 430
    /// @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.
431
    void testOption(const OptionDescriptor& option_desc,
432 433 434 435
                    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.
436
        ASSERT_TRUE(option_desc.option_);
437
        // Verify option type.
438
        EXPECT_EQ(expected_code, option_desc.option_->getType());
439 440 441 442 443
        // 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.
444 445
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
446 447 448 449 450
        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.
451
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
452 453
                      expected_data_len);
        } else {
454
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
455 456
                      expected_data_len);
        }
457
        // Verify that the data is correct. Do not verify suboptions and a header.
458
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
459
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
460
                            expected_data_len));
461 462
    }

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
    /// @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"));
489
        // The subnet should now hold one option with the specified option code.
490
        OptionDescriptor desc =
491
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
492
        ASSERT_TRUE(desc.option_);
493 494 495
        testOption(desc, option_code, expected_data, expected_data_len);
    }

496 497 498 499 500 501 502 503 504 505 506 507 508
    /// @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) {
509
        CfgMgr::instance().clear();
510
        ConstElementPtr json;
511 512
        ConstElementPtr status;
        try {
513
            json = parseJSON(config);
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
            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);
    }

549 550 551 552 553 554 555 556
    /// @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() {
557
        string config = "{ " + genIfaceConfig() + "," +
558
            "\"hooks-libraries\": [ ], "
559 560
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
561
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
562
            "\"option-def\": [ ], "
563
            "\"option-data\": [ ] }";
564 565
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
566
        CfgMgr::instance().clear();
567
    }
568

569 570
    /// @brief Retrieve an option associated with a host.
    ///
571 572
    /// The option is retrieved from the "dhcp4" option space.
    ///
573 574 575 576
    /// @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.
    ///
577
    /// @return Pointer to an option or NULL pointer if not found.
578 579 580
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
581
        return (retrieveOption<ReturnType>(host, DHCP4_OPTION_SPACE, option_code));
582 583 584 585 586 587 588 589 590
    }

    /// @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.
    ///
591
    /// @return Pointer to an option or NULL pointer if not found.
592 593 594 595
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
596 597
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
598
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
599 600 601 602 603 604 605
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
606

607 608 609 610 611 612 613
    /// @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
614 615
    /// @return the subnet that was examined
    Subnet4Ptr
616 617 618 619
    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);
620 621 622 623
        if (subnet_it == index.cend()) {
            ADD_FAILURE() << "Unable to find expected subnet " << subnet;
            return (Subnet4Ptr());
        }
624 625 626 627 628
        Subnet4Ptr s = *subnet_it;

        EXPECT_EQ(t1, s->getT1());
        EXPECT_EQ(t2, s->getT2());
        EXPECT_EQ(valid, s->getValid());
629 630

        return (s);
631
    }
632 633 634 635 636 637 638 639 640 641 642

    /// @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;
643
        ConstElementPtr json;
644

645
        EXPECT_NO_THROW(json = parseDHCP4(config, true));
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
        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);
    }

664 665 666 667
    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
668 669 670 671
};

/// 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
672
TEST_F(Dhcp4ParserTest, bogusCommand) {
673 674 675 676

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
677
                    parseJSON("{\"bogus\": 5}")));
678 679

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
680
    checkResult(x, 1);
681 682 683

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

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
/// 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);
}

701 702 703
/// 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
704
TEST_F(Dhcp4ParserTest, emptySubnet) {
705

706 707 708 709 710 711
    std::string config = "{ " + genIfaceConfig() + "," +
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [  ], "
        "\"valid-lifetime\": 4000 }";

712
    ConstElementPtr json;
713 714
    EXPECT_NO_THROW(json = parseDHCP4(config));
    extractConfig(config);
715 716 717

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

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
720
    checkResult(status, 0);
721 722
}

723 724 725 726
/// 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) {

727
    string config = "{ " + genIfaceConfig() + "," +
728 729
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
730
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
731 732 733
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

734 735
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
736
    extractConfig(config);
737

738
    ConstElementPtr status;
739 740 741 742 743
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

744
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
745
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
746
    ASSERT_TRUE(subnet);
747
    EXPECT_FALSE(subnet->getT1().unspecified());
748
    EXPECT_FALSE(subnet->getT2().unspecified());
749
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
750 751 752 753 754 755 756 757 758 759 760 761
    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) {

762
    string config = "{ " + genIfaceConfig() + "," +
763 764
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
765
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
766 767 768
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

769 770
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
771
    extractConfig(config);
772

773
    ConstElementPtr status;
774 775 776 777 778
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

779
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
780
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
781 782 783
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
784 785
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
786 787 788 789 790 791
    EXPECT_EQ(4000, subnet->getValid());

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

792 793
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
794
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
795

796
    string config = "{ " + genIfaceConfig() + "," +
797 798 799
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
800
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
801 802 803
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

804 805
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
806
    extractConfig(config);
807

808
    ConstElementPtr status;
809 810 811
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
812
    checkResult(status, 0);
813 814 815

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
816
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
817
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
818 819 820 821
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
822 823 824

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

827 828 829 830 831
// 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;
832 833
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
834
    string config = "{ " + genIfaceConfig() + "," +
835 836 837
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
838
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
839 840 841
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
842
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
843 844
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
845 846
        " },"
        " {"
847
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
848 849 850
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
851
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
852 853 854 855
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

856 857
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
858
    extractConfig(config);
859 860 861 862 863

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
864
        checkResult(x, 0);
865

866 867 868 869
        CfgMgr::instance().commit();

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

886 887 888
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
889
    // Four subnets with arbitrary subnet ids.
890
    string config = "{ " + genIfaceConfig() + "," +
891 892 893
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
894
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
895 896 897 898
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
899
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
900 901 902 903
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
904
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
905 906 907 908
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
909
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
910 911 912 913 914
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

915 916
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
917
    extractConfig(config);
918 919 920 921

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

924 925 926 927
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
928 929 930 931 932 933 934 935 936 937 938
        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.
939
    } while (++cnt < 3);
940 941 942
}

// Check that the configuration with two subnets having the same id is rejected.
Josh Soref's avatar
Josh Soref committed
943
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlappingIDs) {
944
    ConstElementPtr x;
945
    // Four subnets, two of them having the same id.
946
    string config = "{ " + genIfaceConfig() + "," +
947 948 949
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
950
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
951 952 953 954
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
955
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
956 957 958 959
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
960
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
961 962 963 964
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
965
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
966 967 968 969 970
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

971 972
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
973 974

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
975
    checkResult(x, 1);
976
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
977 978
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
979 980 981 982 983 984
// 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
985
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
986 987 988
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
989
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
990 991
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
992 993
        " },"
        " {"
994
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
995 996
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
997 998
        " },"
        " {"
999
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
1000 1001
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1002