config_parser_unittest.cc 163 KB
Newer Older
1
// Copyright (C) 2012-2016 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 110 111
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\""
    "     } ]"
    "}"
};
112

113 114 115 116 117 118 119 120 121 122
/// @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.
123
/// Verifies that the Kea DHCPv4 configuration specification file is valid.
124
TEST(Dhcp4SpecTest, basicSpec) {
125
    (isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
126 127 128
    ASSERT_NO_THROW(isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
}

129
class Dhcp4ParserTest : public ::testing::Test {
130 131 132 133 134 135 136 137 138 139
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());
    }

140 141
public:
    Dhcp4ParserTest()
142
    : rcode_(-1) {
143 144 145
        // 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.
146
        srv_.reset(new Dhcpv4Srv(0));
147 148
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V4));
149
        resetConfiguration();
150 151
    }

152
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
153 154
    // Checks if global parameter of name have expected_value
    void checkGlobalUint32(string name, uint32_t expected_value) {
155
        const Uint32StoragePtr uint32_defaults =
156
                                        globalContext()->uint32_values_;
157
        try {
158
            uint32_t actual_value = uint32_defaults->getParam(name);
159 160
            EXPECT_EQ(expected_value, actual_value);
        } catch (DhcpConfigError) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
161 162 163 164 165
            ADD_FAILURE() << "Expected uint32 with name " << name
                          << " not found";
        }
    }

166
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
167 168 169 170 171 172 173 174
    // 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_);
    }

175
    ~Dhcp4ParserTest() {
176
        resetConfiguration();
177 178

        // ... and delete the hooks library marker files if present
179 180
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
181 182
    };

183 184 185 186 187 188 189 190
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

191 192 193
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
194 195
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
196
    ///
197
    /// @param param_value string holding option parameter value to be
198 199 200
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
201 202
    /// @return configuration string containing custom values of parameters
    /// describing an option.
203 204 205 206 207
    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;
208
            params["space"] = DHCP4_OPTION_SPACE;
209
            params["code"] = "56";
210
            params["data"] = "ABCDEF0105";
211
            params["csv-format"] = "false";
212 213 214
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
215
            params["code"] = "56";
216
            params["data"] = "ABCDEF0105";
217
            params["csv-format"] = "false";
218
        } else if (parameter == "code") {
219
            params["name"] = "dhcp-message";
220
            params["space"] = DHCP4_OPTION_SPACE;
221
            params["code"] = param_value;
222
            params["data"] = "ABCDEF0105";
223
            params["csv-format"] = "false";
224
        } else if (parameter == "data") {
225
            params["name"] = "dhcp-message";
226
            params["space"] = DHCP4_OPTION_SPACE;
227 228
            params["code"] = "56";
            params["data"] = param_value;
229
            params["csv-format"] = "false";
230
        } else if (parameter == "csv-format") {
231
            params["name"] = "dhcp-message";
232
            params["space"] = DHCP4_OPTION_SPACE;
233
            params["code"] = "56";
234
            params["data"] = "ABCDEF0105";
235
            params["csv-format"] = param_value;
236 237 238 239
        }
        return (createConfigWithOption(params));
    }

240 241 242 243 244 245 246 247
    /// @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.
248 249
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
250
        stream << "{ " << genIfaceConfig() << "," <<
251 252 253
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
254
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
255 256 257 258 259 260 261 262
            "    \"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 {
263
                // cppcheck-suppress unreadVariable
264 265 266 267
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
268 269
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
270 271 272 273
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
274 275
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
276 277 278 279 280 281 282 283 284
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
    /// @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.
300
    OptionDescriptor
301 302 303
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
304
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
305
            getCfgSubnets4()->selectSubnet(subnet_address);
306 307 308 309 310 311
        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";
        }
312
        OptionContainerPtr options =
313
            subnet->getCfgOption()->getAll(DHCP4_OPTION_SPACE);
314 315 316 317 318 319 320 321
        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.
322
        const OptionContainerTypeIndex& idx = options->get<1>();
323 324 325 326

        // 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.
327 328
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
329 330 331 332 333 334 335
            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) {
336
            return (OptionDescriptor(OptionPtr(), false));
337 338 339 340 341
        }

        return (*range.first);
    }

342 343 344 345 346 347 348 349 350 351 352 353 354 355
    /// @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);
356
        ConstElementPtr json = parseDHCP4(config);
357
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
358 359
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
360 361
    }

Francis Dupont's avatar
Francis Dupont committed
362
    /// @brief Test invalid option parameter value.
363 364 365 366 367 368 369 370 371 372
    ///
    /// 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);
373
        ConstElementPtr json = parseDHCP4(config);
374
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
375 376
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
377 378
    }

379 380 381 382 383 384 385 386 387
    /// @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.
388
    void testOption(const OptionDescriptor& option_desc,
389 390 391 392
                    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.
393
        ASSERT_TRUE(option_desc.option_);
394
        // Verify option type.
395
        EXPECT_EQ(expected_code, option_desc.option_->getType());
396 397 398 399 400
        // 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.
401 402
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
403 404 405 406 407
        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.
408
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
409 410
                      expected_data_len);
        } else {
411
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
412 413
                      expected_data_len);
        }
414
        // Verify that the data is correct. Do not verify suboptions and a header.
415
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
416
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
417
                            expected_data_len));
418 419
    }

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
    /// @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"));
446
        // The subnet should now hold one option with the specified option code.
447
        OptionDescriptor desc =
448
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
449
        ASSERT_TRUE(desc.option_);
450 451 452
        testOption(desc, option_code, expected_data, expected_data_len);
    }

453 454 455 456 457 458 459 460 461 462 463 464 465
    /// @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) {
466
        CfgMgr::instance().clear();
467
        ConstElementPtr json;
468 469
        ConstElementPtr status;
        try {
470
            json = parseJSON(config);
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
            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);
    }

506 507 508 509 510 511 512 513
    /// @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() {
514
        string config = "{ " + genIfaceConfig() + "," +
515
            "\"hooks-libraries\": [ ], "
516 517
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
518
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
519
            "\"option-def\": [ ], "
520
            "\"option-data\": [ ] }";
521 522
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
523
        CfgMgr::instance().clear();
524
    }
525

526 527
    /// @brief Retrieve an option associated with a host.
    ///
528 529
    /// The option is retrieved from the "dhcp4" option space.
    ///
530 531 532 533
    /// @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.
    ///
534
    /// @return Pointer to an option or NULL pointer if not found.
535 536 537
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
538
        return (retrieveOption<ReturnType>(host, DHCP4_OPTION_SPACE, option_code));
539 540 541 542 543 544 545 546 547
    }

    /// @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.
    ///
548
    /// @return Pointer to an option or NULL pointer if not found.
549 550 551 552
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
553 554
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
555
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
556 557 558 559 560 561 562
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
563

564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

    /// @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;
        ElementPtr json = Element::fromJSON(config);

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

595 596 597 598
    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
599 600 601 602 603 604 605
};

// Goal of this test is a verification if a very simple config update
// with just a bumped version number. That's the simplest possible
// config update.
TEST_F(Dhcp4ParserTest, version) {

606 607
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4("{\"version\": 0}"));
608

609 610
    ConstElementPtr x;
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
611
    // returned value must be 0 (configuration accepted)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
612
    checkResult(x, 0);
613 614 615 616
}

/// 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
617
TEST_F(Dhcp4ParserTest, bogusCommand) {
618 619 620 621

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
622
                    parseJSON("{\"bogus\": 5}")));
623 624

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
625
    checkResult(x, 1);
626 627 628

    // it should be refused by syntax too
    EXPECT_THROW(parseDHCP4("{\"bogus\": 5}"), Dhcp4ParseError);
629 630 631 632 633
}

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

636 637
    ConstElementPtr json;
    EXPECT_NO_THROW(json = parseDHCP4("{ " + genIfaceConfig() + "," +
638 639 640
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet4\": [  ], "
641 642 643 644
                                      "\"valid-lifetime\": 4000 }"));

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

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
647 648 649 650 651
    checkResult(status, 0);

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

654 655 656 657
/// 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) {

658
    string config = "{ " + genIfaceConfig() + "," +
659 660
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
661
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
662 663 664
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

665 666
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
667

668
    ConstElementPtr status;
669 670 671 672 673 674 675
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

676
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
677
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    ASSERT_TRUE(subnet);
    EXPECT_TRUE(subnet->getT1().unspecified());
    EXPECT_FALSE(subnet->getT2().unspecified());
    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) {

693
    string config = "{ " + genIfaceConfig() + "," +
694 695
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
696
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
697 698 699
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

700 701
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
702

703
    ConstElementPtr status;
704 705 706 707 708 709 710
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

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

711
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
712
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
713 714 715 716 717 718 719 720 721 722
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_TRUE(subnet->getT2().unspecified());
    EXPECT_EQ(4000, subnet->getValid());

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

723 724
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
725
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
726

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

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

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

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
742
    checkResult(status, 0);
743 744 745

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
746
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
747
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
748 749 750 751
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
752 753 754

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

757 758 759 760 761
// 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;
762 763
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
764
    string config = "{ " + genIfaceConfig() + "," +
765 766 767
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
768
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
769 770 771
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
772
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
773 774
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
775 776
        " },"
        " {"
777
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
778 779 780
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
781
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
782 783 784 785
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

786 787
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
788 789 790 791 792

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
793
        checkResult(x, 0);
794

795 796 797 798
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
        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);
}

815 816 817
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
818
    // Four subnets with arbitrary subnet ids.
819
    string config = "{ " + genIfaceConfig() + "," +
820 821 822
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
823
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
824 825 826 827
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
828
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
829 830 831 832
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
833
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
834 835 836 837
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
838
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
839 840 841 842 843
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

844 845
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
846 847 848 849

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

852 853 854 855
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
856 857 858 859 860 861 862 863 864 865 866
        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.
867
    } while (++cnt < 3);
868 869 870 871 872
}

// Check that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
873
    // Four subnets, two of them having the same id.
874
    string config = "{ " + genIfaceConfig() + "," +
875 876 877
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
878
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
879 880 881 882
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
883
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
884 885 886 887
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
888
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
889 890 891 892
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
893
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
894 895 896 897 898
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

899 900
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
901 902

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
903
    checkResult(x, 1);
904
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
905 906
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
907 908 909 910 911 912
// 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
913
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
914 915 916
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
917
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
918 919
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
920 921
        " },"
        " {"
922
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
923 924
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
925 926
        " },"
        " {"
927
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
928 929
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
930 931
        " },"
        " {"
932
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
933 934
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
935 936 937 938
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
939
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
940 941 942
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
943
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
944 945
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
946 947
        " },"
        " {"
948
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
949 950
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
951 952
        " },"
        " {"
953
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
954 955
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
956 957 958 959
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
960
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
961 962 963
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
964
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
965 966
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
967 968
        " },"
        " {"
969
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
970 971
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
972 973
        " },"
        " {"
974
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
975 976
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed