dhcp_parsers_unittest.cc 62.9 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 16
//
// 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>
#include <config/ccsession.h>
17
#include <cc/data.h>
18 19 20
#include <dhcp/option.h>
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
21
#include <dhcp/tests/iface_mgr_test_config.h>
22
#include <dhcpsrv/cfgmgr.h>
23 24
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/dhcp_parsers.h>
Stephen Morris's avatar
Stephen Morris committed
25
#include <dhcpsrv/tests/test_libraries.h>
26
#include <dhcpsrv/testutils/config_result_check.h>
27
#include <exceptions/exceptions.h>
28
#include <hooks/hooks_manager.h>
29 30 31

#include <gtest/gtest.h>
#include <boost/foreach.hpp>
32
#include <boost/pointer_cast.hpp>
33 34 35 36 37 38 39

#include <map>
#include <string>

using namespace std;
using namespace isc;
using namespace isc::config;
40 41
using namespace isc::data;
using namespace isc::dhcp;
42
using namespace isc::dhcp::test;
43
using namespace isc::hooks;
44 45 46 47 48 49 50 51

namespace {

/// @brief DHCP Parser test fixture class
class DhcpParserTest : public ::testing::Test {
public:
    /// @brief Constructor
    DhcpParserTest() {
52 53 54 55 56 57 58 59 60 61 62 63
        resetIfaceCfg();
    }

    /// @brief Destructor.
    virtual ~DhcpParserTest() {
        resetIfaceCfg();
    }

    /// @brief Resets selection of the interfaces from previous tests.
    void resetIfaceCfg() {
        CfgMgr::instance().getConfiguration()->iface_cfg_.closeSockets();
        CfgMgr::instance().getConfiguration()->iface_cfg_.reset();
64 65 66 67 68
    }
};


/// @brief Check BooleanParser basic functionality.
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
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
/// 2. Rejects a non-boolean element.
/// 3. Builds with a valid true value.
/// 4. Bbuils with a valid false value.
/// 5. Updates storage upon commit.
TEST_F(DhcpParserTest, booleanParserTest) {

    const std::string name = "boolParm";

    // Verify that parser does not allow empty for storage.
    BooleanStoragePtr bs;
    EXPECT_THROW(BooleanParser(name, bs), isc::dhcp::DhcpConfigError);

    // Construct parser for testing.
    BooleanStoragePtr storage(new BooleanStorage());
    BooleanParser parser(name, storage);

    // Verify that parser with rejects a non-boolean element.
    ElementPtr wrong_element = Element::create("I am a string");
    EXPECT_THROW(parser.build(wrong_element), isc::BadValue);

    // Verify that parser will build with a valid true value.
    bool test_value = true;
    ElementPtr element = Element::create(test_value);
    ASSERT_NO_THROW(parser.build(element));

    // Verify that commit updates storage.
98
    bool actual_value = !test_value;
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
    parser.commit();
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ(test_value, actual_value);

    // Verify that parser will build with a valid false value.
    test_value = false;
    element->setValue(test_value);
    EXPECT_NO_THROW(parser.build(element));

    // Verify that commit updates storage.
    actual_value = ~test_value;
    parser.commit();
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ(test_value, actual_value);
}

/// @brief Check StringParser basic functionality
116
///
117 118
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
119
/// 2. Builds with a nont string value.
120 121 122 123 124 125 126 127 128 129 130 131 132 133
/// 3. Builds with a string value.
/// 4. Updates storage upon commit.
TEST_F(DhcpParserTest, stringParserTest) {

    const std::string name = "strParm";

    // Verify that parser does not allow empty for storage.
    StringStoragePtr bs;
    EXPECT_THROW(StringParser(name, bs), isc::dhcp::DhcpConfigError);

    // Construct parser for testing.
    StringStoragePtr storage(new StringStorage());
    StringParser parser(name, storage);

134 135 136
    // Verify that parser with accepts a non-string element.
    ElementPtr element = Element::create(9999);
    EXPECT_NO_THROW(parser.build(element));
137

138 139 140 141 142 143
    // Verify that commit updates storage.
    parser.commit();
    std::string actual_value;
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ("9999", actual_value);

144 145
    // Verify that parser will build with a string value.
    const std::string test_value = "test value";
146
    element = Element::create(test_value);
147 148 149 150 151 152 153 154 155
    ASSERT_NO_THROW(parser.build(element));

    // Verify that commit updates storage.
    parser.commit();
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ(test_value, actual_value);
}

/// @brief Check Uint32Parser basic functionality
156
///
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
/// 2. Rejects a non-integer element.
/// 3. Rejects a negative value.
/// 4. Rejects too large a value.
/// 5. Builds with value of zero.
/// 6. Builds with a value greater than zero.
/// 7. Updates storage upon commit.
TEST_F(DhcpParserTest, uint32ParserTest) {

    const std::string name = "intParm";

    // Verify that parser does not allow empty for storage.
    Uint32StoragePtr bs;
    EXPECT_THROW(Uint32Parser(name, bs), isc::dhcp::DhcpConfigError);

    // Construct parser for testing.
    Uint32StoragePtr storage(new Uint32Storage());
    Uint32Parser parser(name, storage);

    // Verify that parser with rejects a non-interger element.
    ElementPtr wrong_element = Element::create("I am a string");
    EXPECT_THROW(parser.build(wrong_element), isc::BadValue);

    // Verify that parser with rejects a negative value.
    ElementPtr int_element = Element::create(-1);
    EXPECT_THROW(parser.build(int_element), isc::BadValue);

185 186
    // Verify that parser with rejects too large a value provided we are on
    // 64-bit platform.
187 188 189 190 191
    if (sizeof(long) > sizeof(uint32_t)) {
        long max = (long)(std::numeric_limits<uint32_t>::max()) + 1;
        int_element->setValue(max);
        EXPECT_THROW(parser.build(int_element), isc::BadValue);
    }
192 193 194 195 196 197

    // Verify that parser will build with value of zero.
    int test_value = 0;
    int_element->setValue((long)test_value);
    ASSERT_NO_THROW(parser.build(int_element));

198 199 200 201 202 203
    // Verify that commit updates storage.
    parser.commit();
    uint32_t actual_value = 0;
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ(test_value, actual_value);

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
    // Verify that parser will build with a valid positive value.
    test_value = 77;
    int_element->setValue((long)test_value);
    ASSERT_NO_THROW(parser.build(int_element));

    // Verify that commit updates storage.
    parser.commit();
    EXPECT_NO_THROW((actual_value = storage->getParam(name)));
    EXPECT_EQ(test_value, actual_value);
}

/// @brief Check InterfaceListParser  basic functionality
///
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
219 220
/// 2. Does not allow name other than "interfaces"
/// 3. Parses list of interfaces and adds them to CfgMgr
221 222
/// 4. Parses wildcard interface name and sets a CfgMgr flag which indicates
/// that server will listen on all interfaces.
223
TEST_F(DhcpParserTest, interfaceListParserTest) {
224
    IfaceMgrTestConfig test_config(true);
225

226
    const std::string name = "interfaces";
227 228 229 230

    // Verify that parser constructor fails if parameter name isn't "interface"
    EXPECT_THROW(InterfaceListConfigParser("bogus_name"), isc::BadValue);

231 232
    boost::scoped_ptr<InterfaceListConfigParser>
        parser(new InterfaceListConfigParser(name));
233 234
    ElementPtr list_element = Element::createList();
    list_element->add(Element::create("eth0"));
235 236 237 238 239 240 241

    // This should parse the configuration and add eth0 and eth1 to the list
    // of interfaces that server should listen on.
    parser->build(list_element);

    // Use CfgMgr instance to check if eth0 and eth1 was added, and that
    // eth2 was not added.
242 243 244 245 246 247
    ConfigurationPtr cfg = CfgMgr::instance().getConfiguration();
    ASSERT_TRUE(cfg);
    ASSERT_NO_THROW(cfg->iface_cfg_.openSockets(10000));

    EXPECT_TRUE(test_config.socketOpen("eth0", AF_INET));
    EXPECT_FALSE(test_config.socketOpen("eth1", AF_INET));
248 249 250 251

    // Add keyword all to the configuration. This should activate all
    // interfaces, including eth2, even though it has not been explicitly
    // added.
252
    list_element->add(Element::create("*"));
253

254
    // Reset parser and configuration.
255
    parser.reset(new InterfaceListConfigParser(name));
256 257 258
    cfg->iface_cfg_.closeSockets();
    cfg->iface_cfg_.reset();

259
    parser->build(list_element);
260
    ASSERT_NO_THROW(cfg->iface_cfg_.openSockets(10000));
261

262 263
    EXPECT_TRUE(test_config.socketOpen("eth0", AF_INET));
    EXPECT_TRUE(test_config.socketOpen("eth1", AF_INET));
264 265
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
266 267 268 269 270 271 272 273 274 275
// Checks whether option space can be detected as vendor-id
TEST_F(DhcpParserTest, vendorOptionSpace) {
    EXPECT_EQ(0, SubnetConfigParser::optionSpaceToVendorId(""));
    EXPECT_EQ(0, SubnetConfigParser::optionSpaceToVendorId("dhcp4"));
    EXPECT_EQ(0, SubnetConfigParser::optionSpaceToVendorId("vendor-"));
    EXPECT_EQ(1, SubnetConfigParser::optionSpaceToVendorId("vendor-1"));
    EXPECT_EQ(4491, SubnetConfigParser::optionSpaceToVendorId("vendor-4491"));
    EXPECT_EQ(12345678, SubnetConfigParser::optionSpaceToVendorId("vendor-12345678"));
}

276
/// @brief Test Implementation of abstract OptionDataParser class. Allows
277
/// testing basic option parsing.
278 279 280
class UtestOptionDataParser : public OptionDataParser {
public:

281 282
    UtestOptionDataParser(const std::string&,
        OptionStoragePtr options, ParserContextPtr global_context)
283 284 285 286 287 288 289 290 291 292 293 294 295
        :OptionDataParser("", options, global_context) {
    }

    static OptionDataParser* factory(const std::string& param_name,
        OptionStoragePtr options, ParserContextPtr global_context) {
        return (new UtestOptionDataParser(param_name, options, global_context));
    }

protected:
    // Dummy out last two params since test derivation doesn't use them.
    virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
                std::string&, uint32_t) {
        OptionDefinitionPtr def;
296
        // always return empty
297 298 299 300
        return (def);
    }
};

301
/// @brief Test Fixture class which provides basic structure for testing
302 303 304 305 306 307 308 309 310
/// configuration parsing.  This is essentially the same structure provided
/// by dhcp servers.
class ParseConfigTest : public ::testing::Test {
public:
    /// @brief Constructor
    ParseConfigTest() {
        reset_context();
    }

311 312 313 314
    ~ParseConfigTest() {
        reset_context();
    }

315
    /// @brief Parses a configuration.
316 317
    ///
    /// Parse the given configuration, populating the context storage with
318 319
    /// the parsed elements.
    ///
320 321 322
    /// @param config_set is the set of elements to parse.
    /// @return returns an ConstElementPtr containing the numeric result
    /// code and outcome comment.
323
    isc::data::ConstElementPtr parseElementSet(isc::data::ConstElementPtr
324 325 326 327 328 329 330 331 332 333 334 335 336 337
                                           config_set) {
        // Answer will hold the result.
        ConstElementPtr answer;
        if (!config_set) {
            answer = isc::config::createAnswer(1,
                                 string("Can't parse NULL config"));
            return (answer);
        }

        // option parsing must be done last, so save it if we hit if first
        ParserPtr option_parser;

        ConfigPair config_pair;
        try {
338
            // Iterate over the config elements.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
            const std::map<std::string, ConstElementPtr>& values_map =
                                                      config_set->mapValue();
            BOOST_FOREACH(config_pair, values_map) {
                // Create the parser based on element name.
                ParserPtr parser(createConfigParser(config_pair.first));
                // Options must be parsed last
                if (config_pair.first == "option-data") {
                    option_parser = parser;
                } else {
                    // Anything else  we can call build straight away.
                    parser->build(config_pair.second);
                    parser->commit();
                }
            }

            // The option values parser is the next one to be run.
355
            std::map<std::string, ConstElementPtr>::const_iterator
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
                                option_config = values_map.find("option-data");
            if (option_config != values_map.end()) {
                option_parser->build(option_config->second);
                option_parser->commit();
            }

            // Everything was fine. Configuration is successful.
            answer = isc::config::createAnswer(0, "Configuration committed.");
        } catch (const isc::Exception& ex) {
            answer = isc::config::createAnswer(1,
                        string("Configuration parsing failed: ") + ex.what());

        } catch (...) {
            answer = isc::config::createAnswer(1,
                                        string("Configuration parsing failed"));
        }

        return (answer);
    }

    /// @brief Create an element parser based on the element name.
    ///
378 379 380 381 382
    /// Creates a parser for the appropriate element and stores a pointer to it
    /// in the appropriate class variable.
    ///
    /// Note that the method currently it only supports option-defs, option-data
    /// and hooks-libraries.
383 384
    ///
    /// @param config_id is the name of the configuration element.
385 386 387
    ///
    /// @return returns a shared pointer to DhcpConfigParser.
    ///
388
    /// @throw throws NotImplemented if element name isn't supported.
389 390
    ParserPtr createConfigParser(const std::string& config_id) {
        ParserPtr parser;
391
        if (config_id.compare("option-data") == 0) {
392 393
            parser.reset(new OptionDataListParser(config_id,
                                              parser_context_->options_,
394 395 396
                                              parser_context_,
                                              UtestOptionDataParser::factory));

397
        } else if (config_id.compare("option-def") == 0) {
398
            parser.reset(new OptionDefListParser(config_id,
399
                                                 parser_context_));
400 401 402 403 404

        } else if (config_id.compare("hooks-libraries") == 0) {
            parser.reset(new HooksLibrariesParser(config_id));
            hooks_libraries_parser_ =
                boost::dynamic_pointer_cast<HooksLibrariesParser>(parser);
405 406
        } else if (config_id.compare("dhcp-ddns") == 0) {
            parser.reset(new D2ClientConfigParser(config_id));
407 408 409 410 411 412 413 414 415
        } else {
            isc_throw(NotImplemented,
                "Parser error: configuration parameter not supported: "
                << config_id);
        }

        return (parser);
    }

416 417
    /// @brief Convenience method for parsing a configuration
    ///
418
    /// Given a configuration string, convert it into Elements
419
    /// and parse them.
420 421
    /// @param config is the configuration string to parse
    ///
422
    /// @return retuns 0 if the configuration parsed successfully,
423
    /// non-zero otherwise failure.
424
    int parseConfiguration(const std::string& config) {
425 426 427 428 429 430 431
        int rcode_ = 1;
        // Turn config into elements.
        // Test json just to make sure its valid.
        ElementPtr json = Element::fromJSON(config);
        EXPECT_TRUE(json);
        if (json) {
            ConstElementPtr status = parseElementSet(json);
432 433
            ConstElementPtr comment = parseAnswer(rcode_, status);
            error_text_ = comment->stringValue();
434 435 436 437 438
            // If error was reported, the error string should contain
            // position of the data element which caused failure.
            if (rcode_ != 0) {
                EXPECT_TRUE(errorContainsPosition(status, "<string>"));
            }
439 440 441 442 443
        }

        return (rcode_);
    }

444
    /// @brief Find an option definition for a given space and code within
445 446 447 448 449
    /// the parser context.
    /// @param space is the space name of the desired option.
    /// @param code is the numeric "type" of the desired option.
    /// @return returns an OptionDefinitionPtr which points to the found
    /// definition or is empty.
450
    /// ASSERT_ tests don't work inside functions that return values
451 452 453
    OptionDefinitionPtr getOptionDef(std::string space, uint32_t code)
    {
        OptionDefinitionPtr def;
454
        OptionDefContainerPtr defs =
455 456 457 458 459 460 461 462 463 464 465 466 467
                            parser_context_->option_defs_->getItems(space);
        // Should always be able to get definitions list even if it is empty.
        EXPECT_TRUE(defs);
        if (defs) {
            // Attempt to find desired definiton.
            const OptionDefContainerTypeIndex& idx = defs->get<1>();
            const OptionDefContainerTypeRange& range = idx.equal_range(code);
            int cnt = std::distance(range.first, range.second);
            EXPECT_EQ(1, cnt);
            if (cnt == 1) {
                def = *(idx.begin());
            }
        }
468
        return (def);
469 470
    }

471
    /// @brief Find an option for a given space and code within the parser
472 473 474 475 476
    /// context.
    /// @param space is the space name of the desired option.
    /// @param code is the numeric "type" of the desired option.
    /// @return returns an OptionPtr which points to the found
    /// option or is empty.
477
    /// ASSERT_ tests don't work inside functions that return values
478 479 480
    OptionPtr getOptionPtr(std::string space, uint32_t code)
    {
        OptionPtr option_ptr;
481
        Subnet::OptionContainerPtr options =
482 483 484 485 486 487
                            parser_context_->options_->getItems(space);
        // Should always be able to get options list even if it is empty.
        EXPECT_TRUE(options);
        if (options) {
            // Attempt to find desired option.
            const Subnet::OptionContainerTypeIndex& idx = options->get<1>();
488
            const Subnet::OptionContainerTypeRange& range =
489 490 491 492
                                                        idx.equal_range(code);
            int cnt = std::distance(range.first, range.second);
            EXPECT_EQ(1, cnt);
            if (cnt == 1) {
493 494
                Subnet::OptionDescriptor desc = *(idx.begin());
                option_ptr = desc.option;
495 496 497 498
                EXPECT_TRUE(option_ptr);
            }
        }

499
        return (option_ptr);
500 501
    }

502
    /// @brief Wipes the contents of the context to allowing another parsing
503 504 505
    /// during a given test if needed.
    void reset_context(){
        // Note set context universe to V6 as it has to be something.
506 507 508
        CfgMgr::instance().deleteSubnets4();
        CfgMgr::instance().deleteSubnets6();
        CfgMgr::instance().deleteOptionDefs();
509
        parser_context_.reset(new ParserContext(Option::V6));
510 511 512

        // Ensure no hooks libraries are loaded.
        HooksManager::unloadLibraries();
513 514 515 516

        // Set it to minimal, disabled config
        D2ClientConfigPtr tmp(new D2ClientConfig());
        CfgMgr::instance().setD2ClientConfig(tmp);
517 518
    }

519 520 521 522 523
    /// @brief Parsers used in the parsing of the configuration
    ///
    /// Allows the tests to interrogate the state of the parsers (if required).
    boost::shared_ptr<HooksLibrariesParser> hooks_libraries_parser_;

524 525
    /// @brief Parser context - provides storage for options and definitions
    ParserContextPtr parser_context_;
526 527 528

    /// @brief Error string if the parsing failed
    std::string error_text_;
529 530 531
};

/// @brief Check Basic parsing of option definitions.
532
///
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
/// Note that this tests basic operation of the OptionDefinitionListParser and
/// OptionDefinitionParser.  It uses a simple configuration consisting of one
/// one definition and verifies that it is parsed and committed to storage
/// correctly.
TEST_F(ParseConfigTest, basicOptionDefTest) {

    // Configuration string.
    std::string config =
        "{ \"option-def\": [ {"
        "      \"name\": \"foo\","
        "      \"code\": 100,"
        "      \"type\": \"ipv4-address\","
        "      \"array\": False,"
        "      \"record-types\": \"\","
        "      \"space\": \"isc\","
        "      \"encapsulate\": \"\""
        "  } ]"
        "}";

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config);
    ASSERT_TRUE(rcode == 0);

556

557
    // Verify that the option definition can be retrieved.
558
    OptionDefinitionPtr def = getOptionDef("isc", 100);
559 560 561 562 563 564 565 566 567 568 569
    ASSERT_TRUE(def);

    // Verify that the option definition is correct.
    EXPECT_EQ("foo", def->getName());
    EXPECT_EQ(100, def->getCode());
    EXPECT_FALSE(def->getArrayType());
    EXPECT_EQ(OPT_IPV4_ADDRESS_TYPE, def->getType());
    EXPECT_TRUE(def->getEncapsulatedSpace().empty());
}

/// @brief Check Basic parsing of options.
570
///
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
/// Note that this tests basic operation of the OptionDataListParser and
/// OptionDataParser.  It uses a simple configuration consisting of one
/// one definition and matching option data.  It verifies that the option
/// is parsed and committed to storage correctly.
TEST_F(ParseConfigTest, basicOptionDataTest) {

    // Configuration string.
    std::string config =
        "{ \"option-def\": [ {"
        "      \"name\": \"foo\","
        "      \"code\": 100,"
        "      \"type\": \"ipv4-address\","
        "      \"array\": False,"
        "      \"record-types\": \"\","
        "      \"space\": \"isc\","
        "      \"encapsulate\": \"\""
        " } ], "
        " \"option-data\": [ {"
        "    \"name\": \"foo\","
        "    \"space\": \"isc\","
        "    \"code\": 100,"
592
        "    \"data\": \"192.0.2.0\","
593 594 595 596 597 598 599 600 601 602 603 604 605 606
        "    \"csv-format\": True"
        " } ]"
        "}";

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config);
    ASSERT_TRUE(rcode == 0);

    // Verify that the option can be retrieved.
    OptionPtr opt_ptr = getOptionPtr("isc", 100);
    ASSERT_TRUE(opt_ptr);

    // Verify that the option definition is correct.
    std::string val = "type=100, len=4, data fields:\n "
607
                      " #0 192.0.2.0 ( ipv4-address ) \n";
608 609 610 611 612 613

    EXPECT_EQ(val, opt_ptr->toText());
}

};  // Anonymous namespace

Stephen Morris's avatar
Stephen Morris committed
614 615
/// These tests check basic operation of the HooksLibrariesParser.

616 617
// hooks-libraries that do not contain anything.
TEST_F(ParseConfigTest, noHooksLibrariesTest) {
Stephen Morris's avatar
Stephen Morris committed
618

619 620
    // Configuration with hooks-libraries not present.
    string config = "{ \"hooks-libraries\": [] }";
Stephen Morris's avatar
Stephen Morris committed
621 622 623

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config);
624 625 626 627 628 629 630 631 632 633 634 635
    ASSERT_TRUE(rcode == 0) << error_text_;

    // Check that the parser recorded no change to the current state
    // (as the test starts with no hooks libraries loaded).
    std::vector<std::string> libraries;
    bool changed;
    hooks_libraries_parser_->getLibraries(libraries, changed);
    EXPECT_TRUE(libraries.empty());
    EXPECT_FALSE(changed);

    // Load a single library and repeat the parse.
    vector<string> basic_library;
636
    basic_library.push_back(string(CALLOUT_LIBRARY_1));
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
    HooksManager::loadLibraries(basic_library);

    rcode = parseConfiguration(config);
    ASSERT_TRUE(rcode == 0) << error_text_;

    // This time the change should have been recorded.
    hooks_libraries_parser_->getLibraries(libraries, changed);
    EXPECT_TRUE(libraries.empty());
    EXPECT_TRUE(changed);

    // But repeating it again and we are back to no change.
    rcode = parseConfiguration(config);
    ASSERT_TRUE(rcode == 0) << error_text_;
    hooks_libraries_parser_->getLibraries(libraries, changed);
    EXPECT_TRUE(libraries.empty());
    EXPECT_FALSE(changed);
Stephen Morris's avatar
Stephen Morris committed
653 654 655 656

}


657
TEST_F(ParseConfigTest, validHooksLibrariesTest) {
Stephen Morris's avatar
Stephen Morris committed
658

659
    // Configuration string.  This contains a set of valid libraries.
Stephen Morris's avatar
Stephen Morris committed
660 661 662 663 664
    const std::string quote("\"");
    const std::string comma(", ");

    const std::string config =
        std::string("{ ") +
665
            std::string("\"hooks-libraries\": [") +
666 667
                quote + std::string(CALLOUT_LIBRARY_1) + quote + comma +
                quote + std::string(CALLOUT_LIBRARY_2)  + quote +
Stephen Morris's avatar
Stephen Morris committed
668 669 670 671 672
            std::string("]") +
        std::string("}");

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config);
673
    ASSERT_TRUE(rcode == 0) << error_text_;
Stephen Morris's avatar
Stephen Morris committed
674

675 676 677 678 679 680 681
    // Check that the parser holds two libraries and the configuration is
    // recorded as having changed.
    std::vector<std::string> libraries;
    bool changed;
    hooks_libraries_parser_->getLibraries(libraries, changed);
    EXPECT_EQ(2, libraries.size());
    EXPECT_TRUE(changed);
Stephen Morris's avatar
Stephen Morris committed
682 683 684 685

    // The expected libraries should be the list of libraries specified
    // in the given order.
    std::vector<std::string> expected;
686 687
    expected.push_back(CALLOUT_LIBRARY_1);
    expected.push_back(CALLOUT_LIBRARY_2);
688 689 690 691 692
    EXPECT_TRUE(expected == libraries);

    // Parse the string again.
    rcode = parseConfiguration(config);
    ASSERT_TRUE(rcode == 0) << error_text_;
Stephen Morris's avatar
Stephen Morris committed
693

694 695 696 697
    // The list has not changed, and this is what we should see.
    hooks_libraries_parser_->getLibraries(libraries, changed);
    EXPECT_EQ(2, libraries.size());
    EXPECT_FALSE(changed);
Stephen Morris's avatar
Stephen Morris committed
698 699
}

700
// Check with a set of libraries, some of which are invalid.
Stephen Morris's avatar
Stephen Morris committed
701 702
TEST_F(ParseConfigTest, invalidHooksLibrariesTest) {

703
    /// @todo Initialize global library context to null
Stephen Morris's avatar
Stephen Morris committed
704 705 706 707 708 709 710 711

    // Configuration string.  This contains an invalid library which should
    // trigger an error in the "build" stage.
    const std::string quote("\"");
    const std::string comma(", ");

    const std::string config =
        std::string("{ ") +
712
            std::string("\"hooks-libraries\": [") +
713
                quote + std::string(CALLOUT_LIBRARY_1) + quote + comma +
Stephen Morris's avatar
Stephen Morris committed
714
                quote + std::string(NOT_PRESENT_LIBRARY) + quote + comma +
715
                quote + std::string(CALLOUT_LIBRARY_2)  + quote +
Stephen Morris's avatar
Stephen Morris committed
716 717 718
            std::string("]") +
        std::string("}");

719 720
    // Verify that the configuration fails to parse. (Syntactically it's OK,
    // but the library is invalid).
Stephen Morris's avatar
Stephen Morris committed
721
    int rcode = parseConfiguration(config);
722
    ASSERT_FALSE(rcode == 0) << error_text_;
Stephen Morris's avatar
Stephen Morris committed
723

724 725 726
    // Check that the message contains the library in error.
    EXPECT_FALSE(error_text_.find(NOT_PRESENT_LIBRARY) == string::npos) <<
        "Error text returned from parse failure is " << error_text_;
Stephen Morris's avatar
Stephen Morris committed
727
}
728

729 730 731
/// @brief Checks that a valid, enabled D2 client configuration works correctly.
TEST_F(ParseConfigTest, validD2Config) {

732
    // Configuration string containing valid values.
733 734 735 736
    std::string config_str =
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
737
        "     \"server-ip\" : \"192.0.2.0\", "
738
        "     \"server-port\" : 3432, "
739 740 741
        "     \"sender-ip\" : \"192.0.2.1\", "
        "     \"sender-port\" : 3433, "
        "     \"max-queue-size\" : 2048, "
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}";

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config_str);
    ASSERT_TRUE(rcode == 0) << error_text_;

    // Verify that DHCP-DDNS is enabled and we can fetch the configuration.
758
    EXPECT_TRUE(CfgMgr::instance().ddnsEnabled());
759 760 761 762 763 764
    D2ClientConfigPtr d2_client_config;
    ASSERT_NO_THROW(d2_client_config = CfgMgr::instance().getD2ClientConfig());
    ASSERT_TRUE(d2_client_config);

    // Verify that the configuration values are as expected.
    EXPECT_TRUE(d2_client_config->getEnableUpdates());
765
    EXPECT_EQ("192.0.2.0", d2_client_config->getServerIp().toText());
766
    EXPECT_EQ(3432, d2_client_config->getServerPort());
767 768 769 770 771 772 773 774
    EXPECT_EQ(dhcp_ddns::NCR_UDP, d2_client_config->getNcrProtocol());
    EXPECT_EQ(dhcp_ddns::FMT_JSON, d2_client_config->getNcrFormat());
    EXPECT_TRUE(d2_client_config->getAlwaysIncludeFqdn());
    EXPECT_TRUE(d2_client_config->getOverrideNoUpdate());
    EXPECT_TRUE(d2_client_config->getOverrideClientUpdate());
    EXPECT_TRUE(d2_client_config->getReplaceClientName());
    EXPECT_EQ("test.prefix", d2_client_config->getGeneratedPrefix());
    EXPECT_EQ("test.suffix.", d2_client_config->getQualifyingSuffix());
775 776

    // Another valid Configuration string.
777
    // This one is disabled, has IPV6 server ip, control flags false,
778 779 780 781
    // empty prefix/suffix
    std::string config_str2 =
        "{ \"dhcp-ddns\" :"
        "    {"
782
        "     \"enable-updates\" : false, "
783
        "     \"server-ip\" : \"2001:db8::\", "
784
        "     \"server-port\" : 43567, "
785 786 787
        "     \"sender-ip\" : \"2001:db8::1\", "
        "     \"sender-port\" : 3433, "
        "     \"max-queue-size\" : 2048, "
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : false, "
        "     \"override-no-update\" : false, "
        "     \"override-client-update\" : false, "
        "     \"replace-client-name\" : false, "
        "     \"generated-prefix\" : \"\", "
        "     \"qualifying-suffix\" : \"\" "
        "    }"
        "}";

    // Verify that the configuration string parses.
    rcode = parseConfiguration(config_str2);
    ASSERT_TRUE(rcode == 0) << error_text_;

803 804
    // Verify that DHCP-DDNS is disabled and we can fetch the configuration.
    EXPECT_FALSE(CfgMgr::instance().ddnsEnabled());
805 806 807 808
    ASSERT_NO_THROW(d2_client_config = CfgMgr::instance().getD2ClientConfig());
    ASSERT_TRUE(d2_client_config);

    // Verify that the configuration values are as expected.
809
    EXPECT_FALSE(d2_client_config->getEnableUpdates());
810
    EXPECT_EQ("2001:db8::", d2_client_config->getServerIp().toText());
811 812 813 814 815 816 817 818 819
    EXPECT_EQ(43567, d2_client_config->getServerPort());
    EXPECT_EQ(dhcp_ddns::NCR_UDP, d2_client_config->getNcrProtocol());
    EXPECT_EQ(dhcp_ddns::FMT_JSON, d2_client_config->getNcrFormat());
    EXPECT_FALSE(d2_client_config->getAlwaysIncludeFqdn());
    EXPECT_FALSE(d2_client_config->getOverrideNoUpdate());
    EXPECT_FALSE(d2_client_config->getOverrideClientUpdate());
    EXPECT_FALSE(d2_client_config->getReplaceClientName());
    EXPECT_EQ("", d2_client_config->getGeneratedPrefix());
    EXPECT_EQ("", d2_client_config->getQualifyingSuffix());
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
}

/// @brief Checks that D2 client can be configured with enable flag of
/// false only.
TEST_F(ParseConfigTest, validDisabledD2Config) {

    // Configuration string.  This contains a set of valid libraries.
    std::string config_str =
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : false"
        "    }"
        "}";

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config_str);
    ASSERT_TRUE(rcode == 0) << error_text_;

    // Verify that DHCP-DDNS is disabled.
839
    EXPECT_FALSE(CfgMgr::instance().ddnsEnabled());
840 841 842 843 844 845 846 847

    // Make sure fetched config agrees.
    D2ClientConfigPtr d2_client_config;
    ASSERT_NO_THROW(d2_client_config = CfgMgr::instance().getD2ClientConfig());
    EXPECT_TRUE(d2_client_config);
    EXPECT_FALSE(d2_client_config->getEnableUpdates());
}

848 849 850 851 852 853
/// @brief Checks that given a partial configuration, parser supplies
/// default values
TEST_F(ParseConfigTest, parserDefaultsD2Config) {

    // Configuration string.  This contains a set of valid libraries.
    std::string config_str =
854 855 856 857
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true"
        "    }"
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
        "}";

    // Verify that the configuration string parses.
    int rcode = parseConfiguration(config_str);
    ASSERT_TRUE(rcode == 0) << error_text_;

    // Verify that DHCP-DDNS is enabled.
    EXPECT_TRUE(CfgMgr::instance().ddnsEnabled());

    // Make sure fetched config is correct.
    D2ClientConfigPtr d2_client_config;
    ASSERT_NO_THROW(d2_client_config = CfgMgr::instance().getD2ClientConfig());
    EXPECT_TRUE(d2_client_config);
    EXPECT_TRUE(d2_client_config->getEnableUpdates());
    EXPECT_EQ(D2ClientConfig::DFT_SERVER_IP,
              d2_client_config->getServerIp().toText());
    EXPECT_EQ(D2ClientConfig::DFT_SERVER_PORT,
              d2_client_config->getServerPort());
    EXPECT_EQ(dhcp_ddns::stringToNcrProtocol(D2ClientConfig::DFT_NCR_PROTOCOL),
              d2_client_config->getNcrProtocol());
    EXPECT_EQ(dhcp_ddns::stringToNcrFormat(D2ClientConfig::DFT_NCR_FORMAT),
              d2_client_config->getNcrFormat());
880 881
    EXPECT_EQ(D2ClientConfig::DFT_ALWAYS_INCLUDE_FQDN,
              d2_client_config->getAlwaysIncludeFqdn());
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
    EXPECT_EQ(D2ClientConfig::DFT_OVERRIDE_NO_UPDATE,
              d2_client_config->getOverrideNoUpdate());
    EXPECT_EQ(D2ClientConfig::DFT_OVERRIDE_CLIENT_UPDATE,
              d2_client_config->getOverrideClientUpdate());
    EXPECT_EQ(D2ClientConfig::DFT_REPLACE_CLIENT_NAME,
              d2_client_config->getReplaceClientName());
    EXPECT_EQ(D2ClientConfig::DFT_GENERATED_PREFIX,
              d2_client_config->getGeneratedPrefix());
    EXPECT_EQ(D2ClientConfig::DFT_QUALIFYING_SUFFIX,
              d2_client_config->getQualifyingSuffix());
}


/// @brief Check various invalid D2 client configurations.
TEST_F(ParseConfigTest, invalidD2Config) {
    std::string invalid_configs[] = {
        // Must supply at lease enable-updates
899 900 901 902 903 904 905 906
        "{ \"dhcp-ddns\" :"
        "    {"
        "    }"
        "}",
        // Invalid server ip value
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
907
        "     \"server-ip\" : \"x192.0.2.0\", "
908
        "     \"server-port\" : 53001, "
909 910 911 912 913 914 915 916 917 918 919 920 921 922
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
        // Unknown protocol
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
923
        "     \"server-ip\" : \"192.0.2.0\", "
924
        "     \"server-port\" : 53001, "
925 926 927 928 929 930 931 932 933 934 935 936 937 938
        "     \"ncr-protocol\" : \"Bogus\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
        // Unsupported protocol
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
939
        "     \"server-ip\" : \"192.0.2.0\", "
940
        "     \"server-port\" : 53001, "
941 942 943 944 945 946 947 948 949 950 951 952 953 954
        "     \"ncr-protocol\" : \"TCP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
        // Unknown format
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
955
        "     \"server-ip\" : \"192.0.2.0\", "
956
        "     \"server-port\" : 53001, "
957 958 959 960 961 962 963 964 965 966
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"Bogus\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
967
        // Invalid Port
968 969 970
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
971
        "     \"server-ip\" : \"192.0.2.0\", "
972
        "     \"server-port\" : \"bogus\", "
973 974 975 976 977 978 979 980 981 982
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
        // Mismatched server and sender IPs
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
        "     \"server-ip\" : \"192.0.2.0\", "
        "     \"server-port\" : 3432, "
        "     \"sender-ip\" : \"3001::5\", "
        "     \"sender-port\" : 3433, "
        "     \"max-queue-size\" : 2048, "
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
        // Identical server and sender IP/port
        "{ \"dhcp-ddns\" :"
        "    {"
        "     \"enable-updates\" : true, "
        "     \"server-ip\" : \"3001::5\", "
        "     \"server-port\" : 3433, "
        "     \"sender-ip\" : \"3001::5\", "
        "     \"sender-port\" : 3433, "
        "     \"max-queue-size\" : 2048, "
        "     \"ncr-protocol\" : \"UDP\", "
        "     \"ncr-format\" : \"JSON\", "
        "     \"always-include-fqdn\" : true, "
        "     \"override-no-update\" : true, "
        "     \"override-client-update\" : true, "
        "     \"replace-client-name\" : true, "
        "     \"generated-prefix\" : \"test.prefix\", "
        "     \"qualifying-suffix\" : \"test.suffix.\" "
        "    }"
        "}",
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
        // stop
        ""
    };

    // Fetch the original config.
    D2ClientConfigPtr original_config;
    ASSERT_NO_THROW(original_config = CfgMgr::instance().getD2ClientConfig());

    // Iterate through the invalid configuration strings, attempting to
    // parse each one.  They should fail to parse, but fail gracefully.
    D2ClientConfigPtr current_config;
    int i = 0;
    while (!invalid_configs[i].empty()) {
        // Verify that the configuration string parses without throwing.
        int rcode = parseConfiguration(invalid_configs[i]);

        // Verify that parse result indicates a parsing error.
        ASSERT_TRUE(rcode != 0) << "Invalid config #: " << i
                                << " should not have passed!";

        // Verify that the "official" config still matches the original config.
        ASSERT_NO_THROW(current_config =
                        CfgMgr::instance().getD2ClientConfig());
        EXPECT_EQ(*original_config, *current_config);
        ++i;
    }
}

1049 1050 1051 1052 1053 1054 1055 1056 1057
/// @brief DHCP Configuration Parser Context test fixture.
class ParserContextTest : public ::testing::Test {
public:
    /// @brief Constructor
    ParserContextTest() { }

    /// @brief Check that the storages of the specific type hold the
    /// same value.
    ///
1058 1059
    /// This function assumes that the ref_values storage holds parameter
    /// called 'foo'.
1060 1061 1062 1063 1064 1065
    ///
    /// @param ref_values A storage holding reference value. In the typical
    /// case it is a storage held in the original context, which is assigned
    /// to another context.
    /// @param values A storage holding value to be checked.
    /// @tparam ContainerType A type of the storage.
1066
    template<typename ContainerType>
1067 1068
    void checkValueEq(const boost::shared_ptr<ContainerType>& ref_values,
                      const boost::shared_ptr<ContainerType>& values) {
1069 1070
        ASSERT_NO_THROW(values->getParam("foo"));
        EXPECT_EQ(ref_values->getParam("foo"), values->getParam("foo"));
1071 1072
    }

1073
    /// @brief Check that the storages of the specific type hold the same
1074
    /// position of the parameter.
1075
    ///
1076
    /// @param name A name of the parameter to check.
1077 1078 1079 1080 1081
    /// @param ref_values A storage holding reference position. In the typical
    /// case it is a storage held in the original context, which is assigned
    /// to another context.
    /// @param values A storage holding position to be checked.
    /// @tparam ContainerType A type of the storage.
1082
    template<typename ContainerType>
1083 1084
    void checkPositionEq(const std::string& name,
                         const boost::shared_ptr<ContainerType>& ref_values,
1085 1086
                         const boost::shared_ptr<ContainerType>& values) {
        // Verify that the position is correct.
1087 1088
        EXPECT_EQ(ref_values->getPosition(name).line_,
                  values->getPosition(name).line_);
1089

1090 1091
        EXPECT_EQ(ref_values->getPosition(name).pos_,
                  values->getPosition(name).pos_);
1092

1093 1094
        EXPECT_EQ(ref_values->getPosition(name).file_,
                  values->getPosition(name).file_);
1095 1096
    }

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
    /// @brief Check that the storages of the specific type hold different
    /// value.
    ///
    /// This function assumes that the ref_values storage holds exactly
    /// one parameter called 'foo'.
    ///
    /// @param ref_values A storage holding reference value. In the typical
    /// case it is a storage held in the original context, which is assigned
    /// to another context.
    /// @param values A storage holding value to be checked.
    /// @tparam ContainerType A type of the storage.
    /// @tparam ValueType A type of the value in the container.
1109
    template<typename ContainerType>
1110 1111
    void checkValueNeq(const boost::shared_ptr<ContainerType>& ref_values,
                       const boost::shared_ptr<ContainerType>& values) {
1112 1113
        ASSERT_NO_THROW(values->getParam("foo"));
        EXPECT_NE(ref_values->getParam("foo"), values->getParam("foo"));
1114 1115
    }

1116
    /// @brief Check that the storages of the specific type hold different
1117 1118
    /// position.
    ///
1119
    /// @param name A name of the parameter to be checked.
1120 1121 1122 1123 1124
    /// @param ref_values A storage holding reference position. In the typical
    /// case it is a storage held in the original context, which is assigned
    /// to another context.
    /// @param values A storage holding position to be checked.
    /// @tparam ContainerType A type of the storage.
1125
    template<typename ContainerType>
1126 1127
    void checkPositionNeq(const std::string& name,
                          const boost::shared_ptr<ContainerType>& ref_values,
1128 1129
                          const boost::shared_ptr<ContainerType>& values) {
        // At least one of the position fields must be different.
1130 1131 1132 1133 1134 1135
        EXPECT_TRUE((ref_values->getPosition(name).line_ !=
                     values->getPosition(name).line_) ||
                    (ref_values->getPosition(name).pos_ !=
                     values->getPosition(name).pos_) ||
                    (ref_values->getPosition(name).file_ !=
                     values->getPosition(name).file_));
1136 1137
    }

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
    /// @brief Check that option definition storage in the context holds
    /// one option definition of the specified type.
    ///
    /// @param ctx A pointer to a context.
    /// @param opt_type Expected option type.
    void checkOptionDefinitionType(const ParserContext& ctx,
                                   const uint16_t opt_type) {
        OptionDefContainerPtr opt_defs =
            ctx.option_defs_->getItems("option-space");
        ASSERT_TRUE(opt_defs);
        OptionDefContainerTypeIndex& idx = opt_defs->get<1>();
        OptionDefContainerTypeRange range = idx.equal_range(opt_type);
        EXPECT_EQ(1, std::distance(range.first, range.