d2_cfg_mgr_unittests.cc 64.4 KB
Newer Older
1
// Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

7 8
#include <config.h>

9 10 11 12
#include <config/module_spec.h>
#include <d2/d2_config.h>
#include <d2/d2_cfg_mgr.h>
#include <d_test_stubs.h>
13
#include <test_data_files_config.h>
14
#include <util/encode/base64.h>
15
#include <dhcpsrv/testutils/config_result_check.h>
16 17 18 19 20 21 22 23 24 25

#include <boost/foreach.hpp>
#include <gtest/gtest.h>

using namespace std;
using namespace isc;
using namespace isc::d2;

namespace {

26 27 28 29 30 31
/// @brief Function to create full path to the spec file
///
/// The full path is dependent upon the value of D2_SRC_DIR which
/// whose value is generated from test_data_files_config.h.in
///
/// @param name file name to which the path should be prepended
32 33 34 35
std::string specfile(const std::string& name) {
    return (std::string(D2_SRC_DIR) + "/" + name);
}

36 37 38 39 40 41
/// @brief Function to create full path to test data file
///
/// The full path is dependent upon the value of D2_TEST_DATA_DIR which
/// whose value is generated from test_data_files_config.h.in
///
/// @param name file name to which the path should be prepended
42 43 44 45
std::string testDataFile(const std::string& name) {
    return (std::string(D2_TEST_DATA_DIR) + "/" + name);
}

46 47 48 49 50 51 52 53
/// @brief Test fixture class for testing D2CfgMgr class.
/// It maintains an member instance of D2CfgMgr and provides methods for
/// converting JSON strings to configuration element sets, checking parse
/// results, and accessing the configuration context.
class D2CfgMgrTest : public ConfigParseTest {
public:

    /// @brief Constructor
54
    D2CfgMgrTest():cfg_mgr_(new D2CfgMgr()), d2_params_() {
55 56 57 58 59 60 61 62
    }

    /// @brief Destructor
    ~D2CfgMgrTest() {
    }

    /// @brief Configuration manager instance.
    D2CfgMgrPtr cfg_mgr_;
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

    /// @brief Build JSON configuration string for a D2Params element
    ///
    /// Constructs a JSON string for "params" element using replacable
    /// parameters.
    ///
    /// @param ip_address string to insert as ip_address value
    /// @param port integer to insert as port value
    /// @param dns_server_timeout integer to insert as dns_server_timeout value
    /// @param ncr_protocol string to insert as ncr_protocol value
    /// @param ncr_format string to insert as ncr_format value
    ///
    /// @return std::string containing the JSON configuration text
    std::string makeParamsConfigString(const std::string& ip_address,
                                       const int port,
                                       const int dns_server_timeout,
                                       const std::string& ncr_protocol,
                                       const std::string& ncr_format) {
        std::ostringstream config;
        config <<
            "{"
84
            " \"ip-address\": \"" << ip_address << "\" , "
85
            " \"port\": " << port << " , "
86 87 88 89 90 91
            " \"dns-server-timeout\": " << dns_server_timeout << " , "
            " \"ncr-protocol\": \"" << ncr_protocol << "\" , "
            " \"ncr-format\": \"" << ncr_format << "\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
92 93 94 95
            "}";

        return (config.str());
    }
96 97 98 99 100 101
    /// @brief Enumeration to select between expected configuration outcomes
    enum RunConfigMode {
       SHOULD_PASS,
       SHOULD_FAIL
    };

102 103 104 105 106 107 108 109 110 111
    /// @brief Parses a configuration string and tests against a given outcome
    ///
    /// Convenience method which accepts JSON text and an expected pass or fail
    /// outcome. It converts the text into an ElementPtr and passes that to
    /// configuration manager's parseConfig method.  It then tests the
    /// parse result against the expected outcome  If they do not match it
    /// the method asserts a failure.   If they do match, it refreshes the
    /// the D2Params pointer with the newly parsed instance.
    ///
    /// @param config_str the JSON configuration text to parse
112 113 114 115
    /// @param mode indicator if the parsing should fail or not.  It defaults
    /// defaults to SHOULD_PASS.
    ///
    void runConfig(std::string config_str, RunConfigMode mode=SHOULD_PASS) {
116 117 118 119 120
        // We assume the config string is valid JSON.
        ASSERT_TRUE(fromJSON(config_str));

        // Parse the configuration and verify we got the expected outcome.
        answer_ = cfg_mgr_->parseConfig(config_set_);
121
        ASSERT_TRUE(checkAnswer(mode == SHOULD_FAIL));
122 123 124 125 126 127 128 129 130 131

        // Verify that the D2 context can be retrieved and is not null.
        D2CfgContextPtr context;
        ASSERT_NO_THROW(context = cfg_mgr_->getD2CfgContext());

        // Verify that the global scalars have the proper values.
        d2_params_ = context->getD2Params();
        ASSERT_TRUE(d2_params_);
    }

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    /// @brief Check parse result against expected outcome and position info
    ///
    /// This method analyzes the given parsing result against an expected outcome
    /// of SHOULD_PASS or SHOULD_FAIL.  If it is expected to fail, the comment
    /// contained within the result is searched for Element::Position information
    /// which should contain the given file name.  It does not attempt to verify
    /// the numerical values for line number and col.
    ///
    /// @param answer Element set containing an integer result code and string
    /// comment.
    /// @param mode indicator if the parsing should fail or not.
    /// @param file_name name of the file containing the configuration text
    /// parsed. It defaults to "<string>" which is the value present if the
    /// configuration text did not originate from a file. (i.e. one did not use
    /// isc::data::Element::fromJSONFile() to read the JSON text).
    void
    checkAnswerWithError(isc::data::ConstElementPtr answer,
                         RunConfigMode mode, std::string file_name="<string>") {
        int rcode = 0;
        isc::data::ConstElementPtr comment;
        comment = isc::config::parseAnswer(rcode, answer);

        if (mode == SHOULD_PASS) {
            if (rcode == 0) {
                return;
            }

            FAIL() << "Parsing was expected to pass but failed : " << rcode
                   << " comment: " << *comment;
        }

        if (rcode == 0) {
            FAIL() << "Parsing was expected to fail but passed : "
                   << " comment: " << *comment;
        }

        // Parsing was expected to fail, test for position info.
        if (isc::dhcp::test::errorContainsPosition(answer, file_name)) {
            return;
        }

        FAIL() << "Parsing failed as expected but lacks position : " << *comment;
    }

176
    /// @brief Pointer the D2Params most recently parsed.
177
    D2ParamsPtr d2_params_;
178 179 180
};

/// @brief Tests that the spec file is valid.
181
/// Verifies that the DHCP-DDNS configuration specification file
182
//  is valid.
183
TEST(D2SpecTest, basicSpec) {
184 185
    ASSERT_NO_THROW(isc::config::
                    moduleSpecFromFile(specfile("dhcp-ddns.spec")));
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
}

/// @brief Convenience function which compares the contents of the given
/// DnsServerInfo against the given set of values.
///
/// It is structured in such a way that each value is checked, and output
/// is generate for all that do not match.
///
/// @param server is a pointer to the server to check against.
/// @param hostname is the value to compare against server's hostname_.
/// @param ip_address is the string value to compare against server's
/// ip_address_.
/// @param port is the value to compare against server's port.
///
/// @return returns true if there is a match across the board, otherwise it
/// returns false.
bool checkServer(DnsServerInfoPtr server, const char* hostname,
                 const char *ip_address, uint32_t port)
{
    // Return value, assume its a match.
    bool result = true;

208
    if (!server) {
209 210 211 212 213 214
        EXPECT_TRUE(server);
        return false;
    }

    // Check hostname.
    if (server->getHostname() != hostname) {
215
        EXPECT_EQ(hostname, server->getHostname());
216 217 218 219 220
        result = false;
    }

    // Check IP address.
    if (server->getIpAddress().toText() != ip_address) {
221
        EXPECT_EQ(ip_address, server->getIpAddress().toText());
222 223 224 225 226
        result = false;
    }

    // Check port.
    if (server->getPort() !=  port) {
227
        EXPECT_EQ (port, server->getPort());
228 229 230 231 232 233
        result = false;
    }

    return (result);
}

234
/// @brief Convenience function which compares the contents of the given
235 236
/// TSIGKeyInfo against the given set of values, and that the TSIGKey
/// member points to a key.
237
///
238
/// @param key is a pointer to the TSIGKeyInfo instance to verify
239 240 241 242 243 244
/// @param name is the value to compare against key's name_.
/// @param algorithm is the string value to compare against key's algorithm.
/// @param secret is the value to compare against key's secret.
///
/// @return returns true if there is a match across the board, otherwise it
/// returns false.
245
bool checkKey(TSIGKeyInfoPtr key, const std::string& name,
Francis Dupont's avatar
Francis Dupont committed
246
              const std::string& algorithm, const std::string& secret,
247
              uint32_t digestbits = 0) {
248
    // Return value, assume its a match.
249 250 251
    return (((key) &&
        (key->getName() == name) &&
        (key->getAlgorithm() == algorithm)  &&
252
        (key->getDigestbits() == digestbits) &&
253 254
        (key->getSecret() ==  secret)  &&
        (key->getTSIGKey())));
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
}

/// @brief Test fixture class for testing DnsServerInfo parsing.
class TSIGKeyInfoTest : public ConfigParseTest {
public:

    /// @brief Constructor
    TSIGKeyInfoTest() {
        reset();
    }

    /// @brief Destructor
    ~TSIGKeyInfoTest() {
    }

    /// @brief Wipe out the current storage and parser and replace
    /// them with new ones.
    void reset() {
        keys_.reset(new TSIGKeyInfoMap());
        parser_.reset(new TSIGKeyInfoParser("test", keys_));
    }

    /// @brief Storage for "committing" keys.
    TSIGKeyInfoMapPtr keys_;

    /// @brief Pointer to the current parser instance.
    isc::dhcp::ParserPtr parser_;
};

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
/// @brief Test fixture class for testing DnsServerInfo parsing.
class DnsServerInfoTest : public ConfigParseTest {
public:

    /// @brief Constructor
    DnsServerInfoTest() {
        reset();
    }

    /// @brief Destructor
    ~DnsServerInfoTest() {
    }

    /// @brief Wipe out the current storage and parser and replace
    /// them with new ones.
    void reset() {
        servers_.reset(new DnsServerInfoStorage());
        parser_.reset(new DnsServerInfoParser("test", servers_));
    }

    /// @brief Storage for "committing" servers.
    DnsServerInfoStoragePtr servers_;

    /// @brief Pointer to the current parser instance.
    isc::dhcp::ParserPtr parser_;
};

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

/// @brief Test fixture class for testing DDnsDomain parsing.
class DdnsDomainTest : public ConfigParseTest {
public:

    /// @brief Constructor
    DdnsDomainTest() {
        reset();
    }

    /// @brief Destructor
    ~DdnsDomainTest() {
    }

    /// @brief Wipe out the current storage and parser and replace
    /// them with new ones.
    void reset() {
        keys_.reset(new TSIGKeyInfoMap());
        domains_.reset(new DdnsDomainMap());
        parser_.reset(new DdnsDomainParser("test", domains_, keys_));
    }

    /// @brief Add TSIGKeyInfos to the key map
    ///
    /// @param name the name of the key
    /// @param algorithm the algorithm of the key
    /// @param secret the secret value of the key
    void addKey(const std::string& name, const std::string& algorithm,
                const std::string& secret) {
        TSIGKeyInfoPtr key_info(new TSIGKeyInfo(name, algorithm, secret));
341
        (*keys_)[name]=key_info;
342 343 344 345 346 347 348 349 350 351 352 353
    }

    /// @brief Storage for "committing" domains.
    DdnsDomainMapPtr domains_;

    /// @brief Storage for TSIGKeys
    TSIGKeyInfoMapPtr keys_;

    /// @brief Pointer to the current parser instance.
    isc::dhcp::ParserPtr parser_;
};

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
/// @brief Tests a basic valid configuration for D2Param.
TEST_F(D2CfgMgrTest, validParamsEntry) {
    // Verify that ip_address can be valid v4 address.
    std::string config = makeParamsConfigString ("192.0.0.1", 777, 333,
                                           "UDP", "JSON");
    runConfig(config);

    EXPECT_EQ(isc::asiolink::IOAddress("192.0.0.1"),
              d2_params_->getIpAddress());
    EXPECT_EQ(777, d2_params_->getPort());
    EXPECT_EQ(333, d2_params_->getDnsServerTimeout());
    EXPECT_EQ(dhcp_ddns::NCR_UDP, d2_params_->getNcrProtocol());
    EXPECT_EQ(dhcp_ddns::FMT_JSON, d2_params_->getNcrFormat());

    // Verify that ip_address can be valid v6 address.
    config = makeParamsConfigString ("3001::5", 777, 333, "UDP", "JSON");
    runConfig(config);

    // Verify that the global scalars have the proper values.
    EXPECT_EQ(isc::asiolink::IOAddress("3001::5"),
              d2_params_->getIpAddress());
375 376

    // Verify the configuration summary.
377
    EXPECT_EQ("listening on 3001::5, port 777, using UDP",
378
              d2_params_->getConfigSummary());
379 380 381 382 383 384 385 386 387 388 389 390
}

/// @brief Tests default values for D2Params.
/// It verifies that D2Params is populated with default value for optional
/// parameter if not supplied in the configuration.
/// Currently they are all optional.
TEST_F(D2CfgMgrTest, defaultValues) {

    // Check that omitting ip_address gets you its default
    std::string config =
            "{"
            " \"port\": 777 , "
391 392 393 394 395 396
            " \"dns-server-timeout\": 333 , "
            " \"ncr-protocol\": \"UDP\" , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
397 398 399 400 401 402 403 404 405
            "}";

    runConfig(config);
    EXPECT_EQ(isc::asiolink::IOAddress(D2Params::DFT_IP_ADDRESS),
              d2_params_->getIpAddress());

    // Check that omitting port gets you its default
    config =
            "{"
406 407 408 409 410 411 412
            " \"ip-address\": \"192.0.0.1\" , "
            " \"dns-server-timeout\": 333 , "
            " \"ncr-protocol\": \"UDP\" , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
413 414 415 416 417 418 419 420
            "}";

    runConfig(config);
    EXPECT_EQ(D2Params::DFT_PORT, d2_params_->getPort());

    // Check that omitting timeout gets you its default
    config =
            "{"
421
            " \"ip-address\": \"192.0.0.1\" , "
422
            " \"port\": 777 , "
423 424 425 426 427
            " \"ncr-protocol\": \"UDP\" , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
428 429 430 431 432 433 434 435 436
            "}";

    runConfig(config);
    EXPECT_EQ(D2Params::DFT_DNS_SERVER_TIMEOUT,
              d2_params_->getDnsServerTimeout());

    // Check that protocol timeout gets you its default
    config =
            "{"
437
            " \"ip-address\": \"192.0.0.1\" , "
438
            " \"port\": 777 , "
439 440 441 442 443
            " \"dns-server-timeout\": 333 , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
444 445 446 447 448 449 450 451 452
            "}";

    runConfig(config);
    EXPECT_EQ(dhcp_ddns::stringToNcrProtocol(D2Params::DFT_NCR_PROTOCOL),
              d2_params_->getNcrProtocol());

    // Check that format timeout gets you its default
    config =
            "{"
453
            " \"ip-address\": \"192.0.0.1\" , "
454
            " \"port\": 777 , "
455 456 457 458 459
            " \"dns-server-timeout\": 333 , "
            " \"ncr-protocol\": \"UDP\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {} "
460 461 462 463 464 465 466
            "}";

    runConfig(config);
    EXPECT_EQ(dhcp_ddns::stringToNcrFormat(D2Params::DFT_NCR_FORMAT),
              d2_params_->getNcrFormat());
}

467 468 469 470 471
/// @brief Tests the unsupported scalar parameters and objects are detected.
TEST_F(D2CfgMgrTest, unsupportedTopLevelItems) {
    // Check that an unsupported top level parameter fails.
    std::string config =
            "{"
472
            " \"ip-address\": \"127.0.0.1\", "
473
            " \"port\": 777 , "
474 475 476 477 478 479 480
            " \"dns-server-timeout\": 333 , "
            " \"ncr-protocol\": \"UDP\" , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {}, "
            "\"bogus-param\" : true "
481 482 483 484 485 486 487 488
            "}";

    runConfig(config, SHOULD_FAIL);

    // Check that unsupported top level objects fails.  For
    // D2 these fail as they are not in the parse order.
    config =
            "{"
489
            " \"ip-address\": \"127.0.0.1\", "
490
            " \"port\": 777 , "
491 492 493 494 495 496 497 498
            " \"dns-server-timeout\": 333 , "
            " \"ncr-protocol\": \"UDP\" , "
            " \"ncr-format\": \"JSON\", "
            "\"tsig-keys\": [], "
            "\"bogus-object-one\" : {}, "
            "\"forward-ddns\" : {}, "
            "\"reverse-ddns\" : {}, "
            "\"bogus-object-two\" : {} "
499 500 501 502 503 504
            "}";

    runConfig(config, SHOULD_FAIL);
}


505 506 507 508 509 510 511 512 513 514 515 516
/// @brief Tests the enforcement of data validation when parsing D2Params.
/// It verifies that:
/// -# ip_address cannot be "0.0.0.0"
/// -# ip_address cannot be "::"
/// -# port cannot be 0
/// -# dns_server_timeout cannat be 0
/// -# ncr_protocol must be valid
/// -# ncr_format must be valid
TEST_F(D2CfgMgrTest, invalidEntry) {
    // Cannot use IPv4 ANY address
    std::string config = makeParamsConfigString ("0.0.0.0", 777, 333,
                                           "UDP", "JSON");
517
    runConfig(config, SHOULD_FAIL);
518 519 520

    // Cannot use IPv6 ANY address
    config = makeParamsConfigString ("::", 777, 333, "UDP", "JSON");
521
    runConfig(config, SHOULD_FAIL);
522 523 524

    // Cannot use port  0
    config = makeParamsConfigString ("127.0.0.1", 0, 333, "UDP", "JSON");
525
    runConfig(config, SHOULD_FAIL);
526 527 528

    // Cannot use dns server timeout of 0
    config = makeParamsConfigString ("127.0.0.1", 777, 0, "UDP", "JSON");
529
    runConfig(config, SHOULD_FAIL);
530 531 532

    // Invalid protocol
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "BOGUS", "JSON");
533
    runConfig(config, SHOULD_FAIL);
534

535 536 537 538
    // Unsupported protocol
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "TCP", "JSON");
    runConfig(config, SHOULD_FAIL);

539 540
    // Invalid format
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "UDP", "BOGUS");
541
    runConfig(config, SHOULD_FAIL);
542 543
}

544 545 546 547
/// @brief Tests the enforcement of data validation when parsing TSIGKeyInfos.
/// It verifies that:
/// 1. Name cannot be blank.
/// 2. Algorithm cannot be blank.
548
/// 3. Secret cannot be blank.
549
TEST_F(TSIGKeyInfoTest, invalidEntry) {
550 551 552
    // Config with a blank name entry.
    std::string config = "{"
                         " \"name\": \"\" , "
553
                         " \"algorithm\": \"HMAC-MD5\" , "
554
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
555
                         "}";
556
    ASSERT_TRUE(fromJSON(config));
557

558 559
    // Verify that build fails on blank name.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
560 561 562 563 564

    // Config with a blank algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"\" , "
565
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
566 567
                         "}";

568
    ASSERT_TRUE(fromJSON(config));
569

570 571
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
572

573 574 575 576
    // Config with an invalid algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"bogus\" , "
577
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
578 579
                         "}";

580
    ASSERT_TRUE(fromJSON(config));
581

582 583
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
584 585 586 587

    // Config with a blank secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
588
                         " \"algorithm\": \"HMAC-MD5\" , "
589 590 591
                         " \"secret\": \"\" "
                         "}";

592
    ASSERT_TRUE(fromJSON(config));
593

594 595
    // Verify that build fails blank secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
596 597 598 599

    // Config with an invalid secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
600
                         " \"algorithm\": \"HMAC-MD5\" , "
601 602 603 604 605 606 607
                         " \"secret\": \"bogus\" "
                         "}";

    ASSERT_TRUE(fromJSON(config));

    // Verify that build fails an invalid secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
608 609 610 611
}

/// @brief Verifies that TSIGKeyInfo parsing creates a proper TSIGKeyInfo
/// when given a valid combination of entries.
612
TEST_F(TSIGKeyInfoTest, validEntry) {
613 614 615
    // Valid entries for TSIG key, all items are required.
    std::string config = "{"
                         " \"name\": \"d2_key_one\" , "
616
                         " \"algorithm\": \"HMAC-MD5\" , "
617
                         " \"digest-bits\": 120 , "
618
                         " \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
619
                         "}";
620
    ASSERT_TRUE(fromJSON(config));
621 622

    // Verify that it builds and commits without throwing.
623 624
    //ASSERT_NO_THROW(parser_->build(config_set_));
    (parser_->build(config_set_));
625 626 627 628
    ASSERT_NO_THROW(parser_->commit());

    // Verify the correct number of keys are present
    int count =  keys_->size();
629
    EXPECT_EQ(1, count);
630 631 632 633 634 635 636

    // Find the key and retrieve it.
    TSIGKeyInfoMap::iterator gotit = keys_->find("d2_key_one");
    ASSERT_TRUE(gotit != keys_->end());
    TSIGKeyInfoPtr& key = gotit->second;

    // Verify the key contents.
637
    EXPECT_TRUE(checkKey(key, "d2_key_one", "HMAC-MD5",
638
                         "dGhpcyBrZXkgd2lsbCBtYXRjaA==", 120));
639 640 641 642 643 644 645 646 647
}

/// @brief Verifies that attempting to parse an invalid list of TSIGKeyInfo
/// entries is detected.
TEST_F(TSIGKeyInfoTest, invalidTSIGKeyList) {
    // Construct a list of keys with an invalid key entry.
    std::string config = "["

                         " { \"name\": \"key1\" , "
648
                         "   \"algorithm\": \"HMAC-MD5\" ,"
649
                         " \"digest-bits\": 120 , "
650
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
651
                         " },"
652
                         // this entry has an invalid algorithm
653 654
                         " { \"name\": \"key2\" , "
                         "   \"algorithm\": \"\" ,"
655
                         " \"digest-bits\": 120 , "
656
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
657 658
                         " },"
                         " { \"name\": \"key3\" , "
659
                         "   \"algorithm\": \"HMAC-MD5\" ,"
660
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
661 662 663
                         " }"
                         " ]";

664
    ASSERT_TRUE(fromJSON(config));
665 666 667 668 669 670

    // Create the list parser.
    isc::dhcp::ParserPtr parser;
    ASSERT_NO_THROW(parser.reset(new TSIGKeyInfoListParser("test", keys_)));

    // Verify that the list builds without errors.
671
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
672 673 674 675 676 677 678 679 680
}

/// @brief Verifies that attempting to parse an invalid list of TSIGKeyInfo
/// entries is detected.
TEST_F(TSIGKeyInfoTest, duplicateTSIGKey) {
    // Construct a list of keys with an invalid key entry.
    std::string config = "["

                         " { \"name\": \"key1\" , "
681
                         "   \"algorithm\": \"HMAC-MD5\" ,"
682
                         " \"digest-bits\": 120 , "
683
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
684 685
                         " },"
                         " { \"name\": \"key2\" , "
686
                         "   \"algorithm\": \"HMAC-MD5\" ,"
687
                         " \"digest-bits\": 120 , "
688
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
689 690
                         " },"
                         " { \"name\": \"key1\" , "
691
                         "   \"algorithm\": \"HMAC-MD5\" ,"
692
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
693 694 695
                         " }"
                         " ]";

696
    ASSERT_TRUE(fromJSON(config));
697 698 699 700 701 702

    // Create the list parser.
    isc::dhcp::ParserPtr parser;
    ASSERT_NO_THROW(parser.reset(new TSIGKeyInfoListParser("test", keys_)));

    // Verify that the list builds without errors.
703
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
704 705 706
}

/// @brief Verifies a valid list of TSIG Keys parses correctly.
707
/// Also verifies that all of the supported algorithm names work.
708
TEST_F(TSIGKeyInfoTest, validTSIGKeyList) {
709
    // Construct a valid list of keys.
710 711 712
    std::string config = "["

                         " { \"name\": \"key1\" , "
713
                         "   \"algorithm\": \"HMAC-MD5\" ,"
714
                         " \"digest-bits\": 80 , "
715
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
716 717
                         " },"
                         " { \"name\": \"key2\" , "
718
                         "   \"algorithm\": \"HMAC-SHA1\" ,"
719
                         " \"digest-bits\": 80 , "
720
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
721 722
                         " },"
                         " { \"name\": \"key3\" , "
723
                         "   \"algorithm\": \"HMAC-SHA256\" ,"
724
                         " \"digest-bits\": 128 , "
725
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
726 727
                         " },"
                         " { \"name\": \"key4\" , "
728
                         "   \"algorithm\": \"HMAC-SHA224\" ,"
729
                         " \"digest-bits\": 112 , "
730
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
731 732
                         " },"
                         " { \"name\": \"key5\" , "
733
                         "   \"algorithm\": \"HMAC-SHA384\" ,"
734
                         " \"digest-bits\": 192 , "
735
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
736 737
                         " },"
                         " { \"name\": \"key6\" , "
738
                         "   \"algorithm\": \"HMAC-SHA512\" ,"
739
                         " \"digest-bits\": 256 , "
740
                         "   \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
741 742 743
                         " }"
                         " ]";

744
    ASSERT_TRUE(fromJSON(config));
745 746 747 748 749 750 751 752

    // Verify that the list builds and commits without errors.
    // Create the list parser.
    isc::dhcp::ParserPtr parser;
    ASSERT_NO_THROW(parser.reset(new TSIGKeyInfoListParser("test", keys_)));
    ASSERT_NO_THROW(parser->build(config_set_));
    ASSERT_NO_THROW(parser->commit());

753
    std::string ref_secret = "dGhpcyBrZXkgd2lsbCBtYXRjaA==";
754 755
    // Verify the correct number of keys are present
    int count =  keys_->size();
756
    ASSERT_EQ(6, count);
757 758 759 760 761 762 763

    // Find the 1st key and retrieve it.
    TSIGKeyInfoMap::iterator gotit = keys_->find("key1");
    ASSERT_TRUE(gotit != keys_->end());
    TSIGKeyInfoPtr& key = gotit->second;

    // Verify the key contents.
764 765
    EXPECT_TRUE(checkKey(key, "key1", TSIGKeyInfo::HMAC_MD5_STR,
                         ref_secret, 80));
766 767 768 769 770 771 772

    // Find the 2nd key and retrieve it.
    gotit = keys_->find("key2");
    ASSERT_TRUE(gotit != keys_->end());
    key = gotit->second;

    // Verify the key contents.
773 774
    EXPECT_TRUE(checkKey(key, "key2", TSIGKeyInfo::HMAC_SHA1_STR,
                         ref_secret, 80));
775 776 777 778 779 780 781

    // Find the 3rd key and retrieve it.
    gotit = keys_->find("key3");
    ASSERT_TRUE(gotit != keys_->end());
    key = gotit->second;

    // Verify the key contents.
782
    EXPECT_TRUE(checkKey(key, "key3", TSIGKeyInfo::HMAC_SHA256_STR,
783
                         ref_secret, 128));
784 785 786 787 788 789 790

    // Find the 4th key and retrieve it.
    gotit = keys_->find("key4");
    ASSERT_TRUE(gotit != keys_->end());
    key = gotit->second;

    // Verify the key contents.
791
    EXPECT_TRUE(checkKey(key, "key4", TSIGKeyInfo::HMAC_SHA224_STR,
792
                         ref_secret, 112));
793 794 795 796 797 798 799

    // Find the 5th key and retrieve it.
    gotit = keys_->find("key5");
    ASSERT_TRUE(gotit != keys_->end());
    key = gotit->second;

    // Verify the key contents.
800
    EXPECT_TRUE(checkKey(key, "key5", TSIGKeyInfo::HMAC_SHA384_STR,
801
                         ref_secret, 192));
802 803 804 805 806 807 808

    // Find the 6th key and retrieve it.
    gotit = keys_->find("key6");
    ASSERT_TRUE(gotit != keys_->end());
    key = gotit->second;

    // Verify the key contents.
809
    EXPECT_TRUE(checkKey(key, "key6", TSIGKeyInfo::HMAC_SHA512_STR,
810
                         ref_secret, 256));
811 812
}

813 814 815 816 817
/// @brief Tests the enforcement of data validation when parsing DnsServerInfos.
/// It verifies that:
/// 1. Specifying both a hostname and an ip address is not allowed.
/// 2. Specifying both blank a hostname and blank ip address is not allowed.
/// 3. Specifying a negative port number is not allowed.
818
TEST_F(DnsServerInfoTest, invalidEntry) {
819
    // Create a config in which both host and ip address are supplied.
820
    // Verify that build fails.
821
    std::string config = "{ \"hostname\": \"pegasus.tmark\", "
822
                         "  \"ip-address\": \"127.0.0.1\" } ";
823
    ASSERT_TRUE(fromJSON(config));
824
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
825 826

    // Neither host nor ip address supplied
827
    // Verify that builds fails.
828
    config = "{ \"hostname\": \"\", "
829
             "  \"ip-address\": \"\" } ";
830
    ASSERT_TRUE(fromJSON(config));
831
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
832 833 834

    // Create a config with a negative port number.
    // Verify that build fails.
835
    config = "{ \"ip-address\": \"192.168.5.6\" ,"
836
             "  \"port\": -100 }";
837
    ASSERT_TRUE(fromJSON(config));
838 839 840
    EXPECT_THROW (parser_->build(config_set_), isc::BadValue);
}

841

842 843 844 845 846 847
/// @brief Verifies that DnsServerInfo parsing creates a proper DnsServerInfo
/// when given a valid combination of entries.
/// It verifies that:
/// 1. A DnsServerInfo entry is correctly made, when given only a hostname.
/// 2. A DnsServerInfo entry is correctly made, when given ip address and port.
/// 3. A DnsServerInfo entry is correctly made, when given only an ip address.
848
TEST_F(DnsServerInfoTest, validEntry) {
849 850 851 852
    /// @todo When resolvable hostname is supported you'll need this test.
    /// // Valid entries for dynamic host
    /// std::string config = "{ \"hostname\": \"pegasus.tmark\" }";
    /// ASSERT_TRUE(fromJSON(config));
853

854 855 856
    /// // Verify that it builds and commits without throwing.
    /// ASSERT_NO_THROW(parser_->build(config_set_));
    /// ASSERT_NO_THROW(parser_->commit());
857

858 859 860
    /// //Verify the correct number of servers are present
    /// int count =  servers_->size();
    /// EXPECT_EQ(1, count);
861

862 863 864 865 866
    /// Verify the server exists and has the correct values.
    /// DnsServerInfoPtr server = (*servers_)[0];
    /// EXPECT_TRUE(checkServer(server, "pegasus.tmark",
    ///                         DnsServerInfo::EMPTY_IP_STR,
    ///                         DnsServerInfo::STANDARD_DNS_PORT));
867

868 869
    /// // Start over for a new test.
    /// reset();
870 871

    // Valid entries for static ip
872
    std::string config = " { \"ip-address\": \"127.0.0.1\" , "
873
                         "  \"port\": 100 }";
874
    ASSERT_TRUE(fromJSON(config));
875 876 877 878 879 880

    // Verify that it builds and commits without throwing.
    ASSERT_NO_THROW(parser_->build(config_set_));
    ASSERT_NO_THROW(parser_->commit());

    // Verify the correct number of servers are present
881
    int count =  servers_->size();
882
    EXPECT_EQ(1, count);
883 884

    // Verify the server exists and has the correct values.
885
    DnsServerInfoPtr server = (*servers_)[0];
886 887 888 889 890 891
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1", 100));

    // Start over for a new test.
    reset();

    // Valid entries for static ip, no port
892
    config = " { \"ip-address\": \"192.168.2.5\" }";
893
    ASSERT_TRUE(fromJSON(config));
894 895 896 897 898 899 900

    // Verify that it builds and commits without throwing.
    ASSERT_NO_THROW(parser_->build(config_set_));
    ASSERT_NO_THROW(parser_->commit());

    // Verify the correct number of servers are present
    count =  servers_->size();
901
    EXPECT_EQ(1, count);
902 903 904 905

    // Verify the server exists and has the correct values.
    server = (*servers_)[0];
    EXPECT_TRUE(checkServer(server, "", "192.168.2.5",
906
                            DnsServerInfo::STANDARD_DNS_PORT));
907 908 909 910 911 912
}

/// @brief Verifies that attempting to parse an invalid list of DnsServerInfo
/// entries is detected.
TEST_F(ConfigParseTest, invalidServerList) {
    // Construct a list of servers with an invalid server entry.
913 914 915
    std::string config = "[ { \"ip-address\": \"127.0.0.1\" }, "
                        "{ \"ip-address\": \"\" }, "
                        "{ \"ip-address\": \"127.0.0.2\" } ]";
916
    ASSERT_TRUE(fromJSON(config));
917 918 919 920 921 922

    // Create the server storage and list parser.
    DnsServerInfoStoragePtr servers(new DnsServerInfoStorage());
    isc::dhcp::ParserPtr parser;
    ASSERT_NO_THROW(parser.reset(new DnsServerInfoListParser("test", servers)));

923 924
    // Verify that build fails.
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
925 926 927 928 929 930
}

/// @brief Verifies that a list of DnsServerInfo entries parses correctly given
/// a valid configuration.
TEST_F(ConfigParseTest, validServerList) {
    // Create a valid list of servers.
931 932 933
    std::string config = "[ { \"ip-address\": \"127.0.0.1\" }, "
                        "{ \"ip-address\": \"127.0.0.2\" }, "
                        "{ \"ip-address\": \"127.0.0.3\" } ]";
934
    ASSERT_TRUE(fromJSON(config));
935 936 937 938 939 940 941 942 943 944 945 946

    // Create the server storage and list parser.
    DnsServerInfoStoragePtr servers(new DnsServerInfoStorage());
    isc::dhcp::ParserPtr parser;
    ASSERT_NO_THROW(parser.reset(new DnsServerInfoListParser("test", servers)));

    // Verfiy that the list builds and commits without error.
    ASSERT_NO_THROW(parser->build(config_set_));
    ASSERT_NO_THROW(parser->commit());

    // Verify that the server storage contains the correct number of servers.
    int count =  servers->size();
947
    EXPECT_EQ(3, count);
948 949 950

    // Verify the first server exists and has the correct values.
    DnsServerInfoPtr server = (*servers)[0];
951
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1",
952
                            DnsServerInfo::STANDARD_DNS_PORT));
953 954 955

    // Verify the second server exists and has the correct values.
    server = (*servers)[1];
956
    EXPECT_TRUE(checkServer(server, "", "127.0.0.2",
957
                            DnsServerInfo::STANDARD_DNS_PORT));
958 959 960

    // Verify the third server exists and has the correct values.
    server = (*servers)[2];
961
    EXPECT_TRUE(checkServer(server, "", "127.0.0.3",
962
                            DnsServerInfo::STANDARD_DNS_PORT));
963 964 965 966 967 968 969 970
}

/// @brief Tests the enforcement of data validation when parsing DdnsDomains.
/// It verifies that:
/// 1. Domain storage cannot be null when constructing a DdnsDomainParser.
/// 2. The name entry is not optional.
/// 3. The server list man not be empty.
/// 4. That a mal-formed server entry is detected.
971 972
/// 5. That an undefined key name is detected.
TEST_F(DdnsDomainTest, invalidDdnsDomainEntry) {
973
    // Verify that attempting to construct the parser with null storage fails.
974 975 976
    DdnsDomainMapPtr domains;
    ASSERT_THROW(isc::dhcp::ParserPtr(
                 new DdnsDomainParser("test", domains, keys_)), D2CfgError);
977 978

    // Create a domain configuration without a name
979 980 981
    std::string config = "{  \"key-name\": \"d2_key.tmark.org\" , "
                         "  \"dns-servers\" : [ "
                         "  {  \"ip-address\": \"127.0.0.1\" , "
982
                         "    \"port\": 100 },"
983
                         "  { \"ip-address\": \"127.0.0.2\" , "
984
                         "    \"port\": 200 },"
985
                         "  {  \"ip-address\": \"127.0.0.3\" , "
986
                         "    \"port\": 300 } ] } ";
987
    ASSERT_TRUE(fromJSON(config));
988

989
    // Verify that the domain configuration builds fails.
990
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
991 992 993

    // Create a domain configuration with an empty server list.
    config = "{ \"name\": \"tmark.org\" , "
994 995
             "  \"key-name\": \"d2_key.tmark.org\" , "
             "  \"dns-servers\" : [ "
996
             "   ] } ";
997
    ASSERT_TRUE(fromJSON(config));
998 999

    // Verify that the domain configuration build fails.
1000
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
1001 1002 1003

    // Create a domain configuration with a mal-formed server entry.
    config = "{ \"name\": \"tmark.org\" , "
1004 1005 1006
             "  \"key-name\": \"d2_key.tmark.org\" , "
             "  \"dns-servers\" : [ "
             "  {  \"ip-address\": \"127.0.0.3\" , "
1007
             "    \"port\": -1 } ] } ";
1008
    ASSERT_TRUE(fromJSON(config));
1009 1010

    // Verify that the domain configuration build fails.
1011
    EXPECT_THROW(parser_->build(config_set_), isc::BadValue);
1012

1013 1014
    // Create a domain configuration without an defined key name
    config = "{ \"name\": \"tmark.org\" , "
1015 1016 1017
             "  \"key-name\": \"d2_key.tmark.org\" , "
             "  \"dns-servers\" : [ "
             "  {  \"ip-address\": \"127.0.0.3\" , "
1018
             "    \"port\": 300 } ] } ";
1019
    ASSERT_TRUE(fromJSON(config));