config_parser_unittest.cc 119 KB
Newer Older
1
// Copyright (C) 2012-2014 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14 15
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#include <config.h>
16 17 18 19

#include <config/ccsession.h>
#include <dhcp/libdhcp++.h>
#include <dhcp/option6_ia.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
20
#include <dhcp/iface_mgr.h>
21 22
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
23
#include <dhcp6/json_config_parser.h>
24
#include <dhcp6/dhcp6_srv.h>
25
#include <dhcpsrv/addr_utilities.h>
26 27
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/subnet.h>
28
#include <dhcpsrv/testutils/config_result_check.h>
29 30
#include <hooks/hooks_manager.h>

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

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

38 39
#include <fstream>
#include <iostream>
40
#include <fstream>
41
#include <sstream>
42 43
#include <string>
#include <vector>
44

45
#include <arpa/inet.h>
46
#include <unistd.h>
47 48 49 50

using namespace isc;
using namespace isc::asiolink;
using namespace isc::config;
51 52
using namespace isc::data;
using namespace isc::dhcp;
53
using namespace isc::dhcp::test;
54
using namespace isc::hooks;
55
using namespace std;
56 57 58

namespace {

59 60 61 62 63 64 65 66 67 68 69
std::string specfile(const std::string& name) {
    return (std::string(DHCP6_SRC_DIR) + "/" + name);
}

/// @brief Tests that the spec file is valid.
/// Verifies that the DHCP6 configuration specification file is valid.
TEST(Dhcp6SpecTest, basicSpec) {
    ASSERT_NO_THROW(isc::config::
                    moduleSpecFromFile(specfile("dhcp6.spec")));
}

70 71
class Dhcp6ParserTest : public ::testing::Test {
public:
Stephen Morris's avatar
Stephen Morris committed
72 73
    Dhcp6ParserTest() :rcode_(-1), srv_(0) {
        // srv_(0) means to not open any sockets. We don't want to
74 75
        // deal with sockets here, just check if configuration handling
        // is sane.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
76 77 78 79 80

        const IfaceMgr::IfaceCollection& ifaces = IfaceMgr::instance().getIfaces();

        // There must be some interface detected
        if (ifaces.empty()) {
81
            // We can't use ASSERT in constructor
Tomek Mrugalski's avatar
Tomek Mrugalski committed
82 83 84 85 86
            ADD_FAILURE() << "No interfaces detected.";
        }

        valid_iface_ = ifaces.begin()->getName();
        bogus_iface_ = "nonexisting0";
87 88 89

        if (IfaceMgr::instance().getIface(bogus_iface_)) {
            ADD_FAILURE() << "The '" << bogus_iface_ << "' exists on this system"
90 91
                          << " while the test assumes that it doesn't, to execute"
                          << " some negative scenarios. Can't continue this test.";
92
        }
93 94 95

        // Reset configuration for each test.
        resetConfiguration();
96 97
    }

98 99 100 101 102 103 104 105 106
    // 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.
    void SetUp() {
        std::vector<std::string> libraries = HooksManager::getLibraryNames();
        ASSERT_TRUE(libraries.empty());
    }

107
    ~Dhcp6ParserTest() {
108 109
        // Reset configuration database after each test.
        resetConfiguration();
110 111 112 113

        // ... and delete the hooks library marker files if present
        unlink(LOAD_MARKER_FILE);
        unlink(UNLOAD_MARKER_FILE);
114 115
    };

116 117 118 119 120 121 122 123 124
    // Checks if config_result (result of DHCP server configuration) has
    // 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_);
    }

125 126 127
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
128 129
    /// option value. These parameters are: "name", "code", "data" and
    /// "csv-format".
130
    ///
131
    /// @param param_value string holding option parameter value to be
132 133 134 135 136
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
    std::string createConfigWithOption(const std::string& param_value,
                                       const std::string& parameter) {
137 138 139
        std::map<std::string, std::string> params;
        if (parameter == "name") {
            params["name"] = param_value;
140 141
            params["space"] = "dhcp6";
            params["code"] = "38";
142
            params["data"] = "ABCDEF0105";
143
            params["csv-format"] = "False";
144
        } else if (parameter == "space") {
145 146 147
            params["name"] = "subscriber-id";
            params["space"] = param_value;
            params["code"] = "38";
148
            params["data"] = "ABCDEF0105";
149
            params["csv-format"] = "False";
150
        } else if (parameter == "code") {
151 152
            params["name"] = "subscriber-id";
            params["space"] = "dhcp6";
153
            params["code"] = param_value;
154
            params["data"] = "ABCDEF0105";
155
            params["csv-format"] = "False";
156
        } else if (parameter == "data") {
157 158 159
            params["name"] = "subscriber-id";
            params["space"] = "dhcp6";
            params["code"] = "38";
160
            params["data"] = param_value;
161 162
            params["csv-format"] = "False";
        } else if (parameter == "csv-format") {
163 164 165
            params["name"] = "subscriber-id";
            params["space"] = "dhcp6";
            params["code"] = "38";
166
            params["data"] = "ABCDEF0105";
167
            params["csv-format"] = param_value;
168 169 170 171
        }
        return (createConfigWithOption(params));
    }

172 173 174 175 176 177 178 179
    /// @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.
Mukund Sivaraman's avatar
Mukund Sivaraman committed
180 181 182
    std::string createConfigWithOption(const std::map<std::string,
                                       std::string>& params)
    {
183
        std::ostringstream stream;
184
        stream << "{ \"interfaces\": [ \"*\" ],"
185 186 187
            "\"preferred-lifetime\": 3000,"
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
188 189 190 191 192 193 194 195 196
            "\"option-def\": [ {"
            "  \"name\": \"bool-option\","
            "  \"code\": 1000,"
            "  \"type\": \"boolean\","
            "  \"array\": False,"
            "  \"record-types\": \"\","
            "  \"space\": \"dhcp6\","
            "  \"encapsulate\": \"\""
            "} ],"
197 198 199 200
            "\"subnet6\": [ { "
            "    \"pool\": [ \"2001:db8:1::/80\" ],"
            "    \"subnet\": \"2001:db8:1::/64\", "
            "    \"option-data\": [ {";
201 202 203 204 205 206
        bool first = true;
        typedef std::pair<std::string, std::string> ParamPair;
        BOOST_FOREACH(ParamPair param, params) {
            if (!first) {
                stream << ", ";
            } else {
207
                // cppcheck-suppress unreadVariable
208 209 210 211
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
212 213
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
214
            } else if (param.first == "code") {
215
                stream << "\"code\": " << param.second;;
216 217
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
218 219
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
220
            }
221 222 223 224 225 226 227 228
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    /// @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.
    Subnet::OptionDescriptor
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
248 249
        Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(subnet_address,
                                                          classify_);
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
        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";
        }
        Subnet::OptionContainerPtr options =
            subnet->getOptionDescriptors("dhcp6");
        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.
        const Subnet::OptionContainerTypeIndex& idx = options->get<1>();

        // 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.
        std::pair<Subnet::OptionContainerTypeIndex::const_iterator,
                  Subnet::OptionContainerTypeIndex::const_iterator> range =
            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) {
            return (Subnet::OptionDescriptor(OptionPtr(), false));
        }

        return (*range.first);
    }

286
    /// @brief Parse and Execute configuration
287
    ///
288 289 290 291 292 293 294 295 296 297 298
    /// 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) {
299 300 301
        ConstElementPtr status;
        try {
            ElementPtr json = Element::fromJSON(config);
302
            status = configureDhcp6Server(srv_, json);
303
        } catch (const std::exception& ex) {
304 305
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The following configuration was used: " << std::endl
306 307 308
                   << config << std::endl
                   << " and the following error message was returned:"
                   << ex.what() << std::endl;
309
            return (false);
310 311
        }

312
        // The status object must not be NULL
313
        if (!status) {
314 315 316
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned a null pointer.";
            return (false);
317
        }
318 319 320 321

        // Store the answer if we need it.

        // Returned value should be 0 (configuration success)
322 323
        comment_ = parseAnswer(rcode_, status);
        if (rcode_ != 0) {
324 325 326 327 328 329 330 331
            string reason = "";
            if (comment_) {
                reason = string(" (") + comment_->stringValue() + string(")");
            }
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned error code "
                   << rcode_ << reason;
            return (false);
332
        }
333 334 335 336 337 338 339 340 341 342 343

        return (true);
    }

    /// @brief Reset configuration database.
    ///
    /// This function resets configuration data base by removing all subnets
    /// option-data, and hooks libraries. The reset must be performed after each
    /// test to make sure that contents of the database do not affect the
    /// results of subsequent tests.
    void resetConfiguration() {
344
        string config = "{ \"interfaces\": [ \"all\" ],"
345 346 347 348 349 350
            "\"hooks-libraries\": [ ],"
            "\"preferred-lifetime\": 3000,"
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"valid-lifetime\": 4000, "
            "\"subnet6\": [ ], "
351
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
352 353 354 355
            "\"option-def\": [ ], "
            "\"option-data\": [ ] }";
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
356 357 358 359 360
        // The default setting is to listen on all interfaces. In order to
        // properly test interface configuration we disable listening on
        // all interfaces before each test and later check that this setting
        // has been overriden by the configuration used in the test.
        CfgMgr::instance().deleteActiveIfaces();
361 362
        // Create fresh context.
        globalContext()->copyContext(ParserContext(Option::V6));
363 364
    }

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    /// @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);
        ElementPtr json = Element::fromJSON(config);
Stephen Morris's avatar
Stephen Morris committed
380
        EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
381 382
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
383 384
    }

385 386 387 388 389 390 391 392 393 394 395 396 397
    /// @brief Test invalid option paramater 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 params Map of parameters defining an option.
    void
    testInvalidOptionParam(const std::map<std::string, std::string>& params) {
        ConstElementPtr x;
        std::string config = createConfigWithOption(params);
        ElementPtr json = Element::fromJSON(config);
        EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
398 399
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
400 401
    }

402 403 404 405 406 407 408
    /// @brief Test option against given code and data.
    ///
    /// @param option_desc option descriptor that carries the option to
    /// be tested.
    /// @param expected_code expected code of the option.
    /// @param expected_data expected data in the option.
    /// @param expected_data_len length of the reference data.
409 410
    /// @param extra_data if true extra data is allowed in an option
    /// after tested data.
411 412
    void testOption(const Subnet::OptionDescriptor& option_desc,
                    uint16_t expected_code, const uint8_t* expected_data,
413 414
                    size_t expected_data_len,
                    bool extra_data = false) {
415 416 417 418 419 420 421 422 423 424 425
        // Check if option descriptor contains valid option pointer.
        ASSERT_TRUE(option_desc.option);
        // Verify option type.
        EXPECT_EQ(expected_code, option_desc.option->getType());
        // 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.
        util::OutputBuffer buf(option_desc.option->getData().size());
        option_desc.option->pack(buf);
426 427 428 429 430 431 432 433 434 435 436
        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.
            ASSERT_GE(buf.getLength() - option_desc.option->getHeaderLen(),
                      expected_data_len);
        } else {
            ASSERT_EQ(buf.getLength() - option_desc.option->getHeaderLen(),
                      expected_data_len);
        }
437
        // Verify that the data is correct. Do not verify suboptions and a header.
438
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
439 440
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option->getHeaderLen(),
                            expected_data_len));
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 468 469 470 471 472 473 474 475
    /// @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"));
        // The subnet should now hold one option with the specified code.
        Subnet::OptionDescriptor desc =
            getOptionFromSubnet(IOAddress("2001:db8:1::5"), option_code);
        ASSERT_TRUE(desc.option);
        testOption(desc, option_code, expected_data, expected_data_len);
    }

476 477 478 479 480
    int rcode_;          ///< Return code (see @ref isc::config::parseAnswer)
    Dhcpv6Srv srv_;      ///< Instance of the Dhcp6Srv used during tests
    ConstElementPtr comment_; ///< Comment (see @ref isc::config::parseAnswer)
    string valid_iface_; ///< Valid network interface name (present in system)
    string bogus_iface_; ///< invalid network interface name (not in system)
481
    isc::dhcp::ClientClasses classify_; ///< used in client classification
482 483
};

484 485 486
// 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.
487 488 489 490
TEST_F(Dhcp6ParserTest, version) {

    ConstElementPtr x;

Stephen Morris's avatar
Stephen Morris committed
491
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_,
492 493 494
                    Element::fromJSON("{\"version\": 0}")));

    // returned value must be 0 (configuration accepted)
495
    checkResult(x, 0);
496 497
}

498 499
/// The goal of this test is to verify that the code accepts only
/// valid commands and malformed or unsupported parameters are rejected.
500
TEST_F(Dhcp6ParserTest, bogusCommand) {
501 502 503

    ConstElementPtr x;

Stephen Morris's avatar
Stephen Morris committed
504
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_,
505 506 507
                    Element::fromJSON("{\"bogus\": 5}")));

    // returned value must be 1 (configuration parse error)
508
    checkResult(x, 1);
509 510
}

511 512
/// The goal of this test is to verify if configuration without any
/// subnets defined can be accepted.
513
TEST_F(Dhcp6ParserTest, emptySubnet) {
514

515
    ConstElementPtr status;
516

Stephen Morris's avatar
Stephen Morris committed
517
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_,
518
                    Element::fromJSON("{ \"interfaces\": [ \"*\" ],"
519 520 521 522 523 524
                                      "\"preferred-lifetime\": 3000,"
                                      "\"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"subnet6\": [  ], "
                                      "\"valid-lifetime\": 4000 }")));

525
    // returned value should be 0 (success)
526
    checkResult(status, 0);
527 528
}

529 530
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
531
TEST_F(Dhcp6ParserTest, subnetGlobalDefaults) {
532

533
    ConstElementPtr status;
534

535
    string config = "{ \"interfaces\": [ \"*\" ],"
536 537 538 539 540 541 542 543 544 545
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

Stephen Morris's avatar
Stephen Morris committed
546
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));
547

548
    // check if returned status is OK
549
    checkResult(status, 0);
550

551 552
    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
553 554
    Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(IOAddress("2001:db8:1::5"),
        classify_);
555 556 557 558 559
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(3000, subnet->getPreferred());
    EXPECT_EQ(4000, subnet->getValid());
560 561 562 563 564 565 566

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

TEST_F(Dhcp6ParserTest, multipleSubnets) {
    ConstElementPtr x;
567 568
    // Collection of four subnets for which ids should be autogenerated
    // - ids are unspecified or set to 0.
569 570 571 572 573 574 575 576 577 578
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
        "    \"subnet\": \"2001:db8:1::/64\" "
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:2::/80\" ],"
579 580
        "    \"subnet\": \"2001:db8:2::/64\", "
        "    \"id\": 0"
581 582 583 584 585 586 587 588 589 590 591 592 593
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
        "    \"subnet\": \"2001:db8:3::/64\" "
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:4::/80\" ],"
        "    \"subnet\": \"2001:db8:4::/64\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

    int cnt = 0; // Number of reconfigurations

594
    ElementPtr json = Element::fromJSON(config);
595

596
    do {
597
        EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
598
        checkResult(x, 0);
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614

        const Subnet6Collection* subnets = CfgMgr::instance().getSubnets6();
        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);
615 616
}

617 618 619
// This checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp6ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
620
    // Four subnets with arbitrary subnet ids.
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
        "    \"subnet\": \"2001:db8:1::/64\", "
        "    \"id\": 1024"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:2::/80\" ],"
        "    \"subnet\": \"2001:db8:2::/64\", "
        "    \"id\": 100"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
        "    \"subnet\": \"2001:db8:3::/64\", "
        "    \"id\": 1"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:4::/80\" ],"
        "    \"subnet\": \"2001:db8:4::/64\", "
        "    \"id\": 34"
        " } ],"
        "\"valid-lifetime\": 4000 }";

    int cnt = 0; // Number of reconfigurations

649
    ElementPtr json = Element::fromJSON(config);
650

651
    do {
652
        EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
653
        checkResult(x, 0);
654 655 656 657 658 659 660 661 662 663 664 665 666

        const Subnet6Collection* subnets = CfgMgr::instance().getSubnets6();
        ASSERT_TRUE(subnets);
        ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

        // Check 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.
667
    } while (++cnt < 3);
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
}

// CHeck that the configuration with two subnets having the same id is rejected.
TEST_F(Dhcp6ParserTest, multipleSubnetsOverlapingIDs) {
    ConstElementPtr x;
    // Four subnets, two of them have the same id.
    string config = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
        "    \"subnet\": \"2001:db8:1::/64\", "
        "    \"id\": 1024"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:2::/80\" ],"
        "    \"subnet\": \"2001:db8:2::/64\", "
        "    \"id\": 100"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
        "    \"subnet\": \"2001:db8:3::/64\", "
        "    \"id\": 1024"
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:4::/80\" ],"
        "    \"subnet\": \"2001:db8:4::/64\", "
        "    \"id\": 34"
        " } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
703
    checkResult(x, 1);
704
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
705 706 707
}


Tomek Mrugalski's avatar
Tomek Mrugalski committed
708 709 710 711 712 713 714 715 716 717 718 719
// Goal of this test is to verify that a previously configured subnet can be
// deleted in subsequent reconfiguration.
TEST_F(Dhcp6ParserTest, reconfigureRemoveSubnet) {
    ConstElementPtr x;

    // All four subnets
    string config4 = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
720 721
        "    \"subnet\": \"2001:db8:1::/64\", "
        "    \"id\": 1"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
722 723 724
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:2::/80\" ],"
725 726
        "    \"subnet\": \"2001:db8:2::/64\", "
        "    \"id\": 2"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
727 728 729
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
730 731
        "    \"subnet\": \"2001:db8:3::/64\", "
        "    \"id\": 3"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
732 733 734
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:4::/80\" ],"
735 736
        "    \"subnet\": \"2001:db8:4::/64\", "
        "    \"id\": 4"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
737 738 739 740 741 742 743 744 745 746
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
    string config_first3 = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
747 748
        "    \"subnet\": \"2001:db8:1::/64\", "
        "    \"id\": 1"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
749 750 751
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:2::/80\" ],"
752 753
        "    \"subnet\": \"2001:db8:2::/64\", "
        "    \"id\": 2"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
754 755 756
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
757 758
        "    \"subnet\": \"2001:db8:3::/64\", "
        "    \"id\": 3"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
759 760 761 762 763 764 765 766 767 768
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
    string config_second_removed = "{ \"interfaces\": [ \"*\" ],"
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::/80\" ],"
769 770
        "    \"subnet\": \"2001:db8:1::/64\", "
        "    \"id\": 1"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
771 772 773
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:3::/80\" ],"
774 775
        "    \"subnet\": \"2001:db8:3::/64\", "
        "    \"id\": 3"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
776 777 778
        " },"
        " {"
        "    \"pool\": [ \"2001:db8:4::/80\" ],"
779 780
        "    \"subnet\": \"2001:db8:4::/64\", "
        "    \"id\": 4"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
781 782 783 784 785 786 787 788
        " } ],"
        "\"valid-lifetime\": 4000 }";

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

    ElementPtr json = Element::fromJSON(config4);
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
789
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
790 791 792 793 794 795 796 797

    const Subnet6Collection* subnets = CfgMgr::instance().getSubnets6();
    ASSERT_TRUE(subnets);
    ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

    // Do the reconfiguration (the last subnet is removed)
    json = Element::fromJSON(config_first3);
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
798
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812

    subnets = CfgMgr::instance().getSubnets6();
    ASSERT_TRUE(subnets);
    ASSERT_EQ(3, subnets->size()); // We expect 3 subnets now (4th is removed)

    EXPECT_EQ(1, subnets->at(0)->getID());
    EXPECT_EQ(2, subnets->at(1)->getID());
    EXPECT_EQ(3, subnets->at(2)->getID());

    /// CASE 2: Configure 4 subnets, then reconfigure and remove one
    /// from in between (not first, not last)

    json = Element::fromJSON(config4);
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
813
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
814 815 816 817

    // Do reconfiguration
    json = Element::fromJSON(config_second_removed);
    EXPECT_NO_THROW(x = configureDhcp6Server(srv_, json));
818
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
819 820 821 822 823 824 825 826 827 828 829 830 831

    subnets = CfgMgr::instance().getSubnets6();
    ASSERT_TRUE(subnets);
    ASSERT_EQ(3, subnets->size()); // We expect 4 subnets

    EXPECT_EQ(1, subnets->at(0)->getID());
    // The second subnet (with subnet-id = 2) is no longer there
    EXPECT_EQ(3, subnets->at(1)->getID());
    EXPECT_EQ(4, subnets->at(2)->getID());
}



832 833
// This test checks if it is possible to override global values
// on a per subnet basis.
834
TEST_F(Dhcp6ParserTest, subnetLocal) {
835

836
    ConstElementPtr status;
837

838
    string config = "{ \"interfaces\": [ \"*\" ],"
839 840 841 842 843 844 845 846 847 848 849 850 851 852
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"renew-timer\": 1, "
        "    \"rebind-timer\": 2, "
        "    \"preferred-lifetime\": 3,"
        "    \"valid-lifetime\": 4,"
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

Stephen Morris's avatar
Stephen Morris committed
853
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));
854

855
    // returned value should be 0 (configuration success)
856
    checkResult(status, 0);
857

858 859
    Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(IOAddress("2001:db8:1::5"),
                                                      classify_);
860 861 862 863 864 865 866
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1, subnet->getT1());
    EXPECT_EQ(2, subnet->getT2());
    EXPECT_EQ(3, subnet->getPreferred());
    EXPECT_EQ(4, subnet->getValid());
}

867 868 869 870 871 872
// This test checks if it is possible to define a subnet with an
// interface defined.
TEST_F(Dhcp6ParserTest, subnetInterface) {

    ConstElementPtr status;

Tomek Mrugalski's avatar
Tomek Mrugalski committed
873 874
    // There should be at least one interface

875
    string config = "{ \"interfaces\": [ \"*\" ],"
876 877 878 879 880
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
881
        "    \"interface\": \"" + valid_iface_ + "\","
882 883 884 885 886 887 888 889 890
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";
    cout << config << endl;

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

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

893 894
    Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(IOAddress("2001:db8:1::5"),
                                                      classify_);
895
    ASSERT_TRUE(subnet);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
896 897 898 899 900 901 902 903 904 905 906
    EXPECT_EQ(valid_iface_, subnet->getIface());
}

// This test checks if invalid interface name will be rejected in
// Subnet6 definition.
TEST_F(Dhcp6ParserTest, subnetInterfaceBogus) {

    ConstElementPtr status;

    // There should be at least one interface

907
    string config = "{ \"interfaces\": [ \"*\" ],"
Tomek Mrugalski's avatar
Tomek Mrugalski committed
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"interface\": \"" + bogus_iface_ + "\","
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";
    cout << config << endl;

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

    // returned value should be 1 (configuration error)
923 924
    checkResult(status, 1);
    EXPECT_TRUE(errorContainsPosition(status, "<string>"));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
925

926 927
    Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(IOAddress("2001:db8:1::5"),
                                                      classify_);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
928
    EXPECT_FALSE(subnet);
929 930
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
931

932 933 934 935 936 937
// This test checks if it is not allowed to define global interface
// parameter.
TEST_F(Dhcp6ParserTest, interfaceGlobal) {

    ConstElementPtr status;

938
    string config = "{ \"interfaces\": [ \"*\" ],"
939 940 941
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
942
        "\"interface\": \"" + valid_iface_ + "\"," // Not valid. Can be defined in subnet only
943 944 945 946 947 948 949 950 951 952 953
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";
    cout << config << endl;

    ElementPtr json = Element::fromJSON(config);

    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

    // returned value should be 1 (parse error)
954 955
    checkResult(status, 1);
    EXPECT_TRUE(errorContainsPosition(status, "<string>"));
956 957
}

958 959 960 961 962 963 964 965 966 967

// This test checks if it is possible to define a subnet with an
// interface-id option defined.
TEST_F(Dhcp6ParserTest, subnetInterfaceId) {

    const string valid_interface_id = "foobar";
    const string bogus_interface_id = "blah";

    // There should be at least one interface

968
    const string config = "{ "
969 970 971 972 973 974 975 976 977 978 979
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"interface-id\": \"" + valid_interface_id + "\","
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

980
    ConstElementPtr status;
981 982
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

983
    // Returned value should be 0 (configuration success)
984
    checkResult(status, 0);
985

986
    // Try to get a subnet based on bogus interface-id option
987 988
    OptionBuffer tmp(bogus_interface_id.begin(), bogus_interface_id.end());
    OptionPtr ifaceid(new Option(Option::V6, D6O_INTERFACE_ID, tmp));
989
    Subnet6Ptr subnet = CfgMgr::instance().getSubnet6(ifaceid, classify_);
990 991
    EXPECT_FALSE(subnet);

992
    // Now try to get subnet for valid interface-id value
993 994
    tmp = OptionBuffer(valid_interface_id.begin(), valid_interface_id.end());
    ifaceid.reset(new Option(Option::V6, D6O_INTERFACE_ID, tmp));
995
    subnet = CfgMgr::instance().getSubnet6(ifaceid, classify_);
996 997 998 999 1000 1001 1002 1003 1004
    ASSERT_TRUE(subnet);
    EXPECT_TRUE(ifaceid->equal(subnet->getInterfaceId()));
}


// This test checks if it is not allowed to define global interface
// parameter.
TEST_F(Dhcp6ParserTest, interfaceIdGlobal) {

1005
    const string config = "{ \"interfaces\": [ \"*\" ],"
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"interface-id\": \"foobar\"," // Not valid. Can be defined in subnet only
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

1017
    ConstElementPtr status;
1018 1019
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

1020
    // Returned value should be 1 (parse error)
1021 1022
    checkResult(status, 1);
    EXPECT_TRUE(errorContainsPosition(status, "<string>"));
1023 1024 1025 1026 1027 1028
}

// This test checks if it is not possible to define a subnet with an
// interface (i.e. local subnet) and interface-id (remote subnet) defined.
TEST_F(Dhcp6ParserTest, subnetInterfaceAndInterfaceId) {

1029
    const string config = "{ \"preferred-lifetime\": 3000,"
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"2001:db8:1::1 - 2001:db8:1::ffff\" ],"
        "    \"interface\": \"" + valid_iface_ + "\","
        "    \"interface-id\": \"foobar\","
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";

    ElementPtr json = Element::fromJSON(config);

1041
    ConstElementPtr status;
1042 1043
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));

1044
    // Returned value should be 1 (configuration error)
1045 1046
    checkResult(status, 1);
    EXPECT_TRUE(errorContainsPosition(status, "<string>"));
1047 1048 1049 1050
}



1051 1052
// Test verifies that a subnet with pool values that do not belong to that
// pool are rejected.
1053
TEST_F(Dhcp6ParserTest, poolOutOfSubnet) {
1054

1055
    ConstElementPtr status;
1056

1057
    string config = "{ \"interfaces\": [ \"*\" ],"
1058 1059 1060 1061 1062 1063 1064
        "\"preferred-lifetime\": 3000,"
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet6\": [ { "
        "    \"pool\": [ \"4001:db8:1::/80\" ],"
        "    \"subnet\": \"2001:db8:1::/64\" } ],"
        "\"valid-lifetime\": 4000 }";
1065

1066 1067 1068

    ElementPtr json = Element::fromJSON(config);

Stephen Morris's avatar
Stephen Morris committed
1069
    EXPECT_NO_THROW(status = configureDhcp6Server(srv_, json));
1070

1071
    // returned value must be 1 (values error)
1072
    // as the pool does not belong to that subnet
1073 1074
    checkResult