d2_cfg_mgr_unittests.cc 61.5 KB
Newer Older
1
// Copyright (C) 2013-2014 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
//
// 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/module_spec.h>
#include <d2/d2_config.h>
#include <d2/d2_cfg_mgr.h>
#include <d_test_stubs.h>
19
#include <test_data_files_config.h>
20
#include <util/encode/base64.h>
21 22 23 24 25 26 27 28 29 30

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

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

namespace {

31 32 33 34
std::string specfile(const std::string& name) {
    return (std::string(D2_SRC_DIR) + "/" + name);
}

35 36 37 38
std::string testDataFile(const std::string& name) {
    return (std::string(D2_TEST_DATA_DIR) + "/" + name);
}

39 40 41 42 43 44 45 46
/// @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
47
    D2CfgMgrTest():cfg_mgr_(new D2CfgMgr()), d2_params_() {
48 49 50 51 52 53 54 55
    }

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

    /// @brief Configuration manager instance.
    D2CfgMgrPtr cfg_mgr_;
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

    /// @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 <<
            "{"
            " \"ip_address\": \"" << ip_address << "\" , "
            " \"port\": " << port << " , "
            " \"dns_server_timeout\": " << dns_server_timeout << " , "
            " \"ncr_protocol\": \"" << ncr_protocol << "\" , "
            " \"ncr_format\": \"" << ncr_format << "\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

        return (config.str());
    }

90 91 92 93 94 95
    /// @brief Enumeration to select between expected configuration outcomes
    enum RunConfigMode {
       SHOULD_PASS,
       SHOULD_FAIL
    };

96 97 98 99 100 101 102 103 104 105
    /// @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
106 107 108 109
    /// @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) {
110 111 112 113 114
        // 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_);
115
        ASSERT_TRUE(checkAnswer(mode == SHOULD_FAIL));
116 117 118 119 120 121 122 123 124 125

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

126
    /// @brief Pointer the D2Params most recently parsed.
127
    D2ParamsPtr d2_params_;
128 129 130 131 132
};

/// @brief Tests that the spec file is valid.
/// Verifies that the BIND10 DHCP-DDNS configuration specification file
//  is valid.
133
TEST(D2SpecTest, basicSpec) {
134 135
    ASSERT_NO_THROW(isc::config::
                    moduleSpecFromFile(specfile("dhcp-ddns.spec")));
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
}

/// @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;

158
    if (!server) {
159 160 161 162 163 164
        EXPECT_TRUE(server);
        return false;
    }

    // Check hostname.
    if (server->getHostname() != hostname) {
165
        EXPECT_EQ(hostname, server->getHostname());
166 167 168 169 170
        result = false;
    }

    // Check IP address.
    if (server->getIpAddress().toText() != ip_address) {
171
        EXPECT_EQ(ip_address, server->getIpAddress().toText());
172 173 174 175 176
        result = false;
    }

    // Check port.
    if (server->getPort() !=  port) {
177
        EXPECT_EQ (port, server->getPort());
178 179 180 181 182 183
        result = false;
    }

    return (result);
}

184
/// @brief Convenience function which compares the contents of the given
185 186
/// TSIGKeyInfo against the given set of values, and that the TSIGKey
/// member points to a key.
187
///
188
/// @param key is a pointer to the TSIGKeyInfo instance to verify
189 190 191 192 193 194
/// @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.
195
bool checkKey(TSIGKeyInfoPtr key, const std::string& name,
196
                 const std::string& algorithm, const std::string& secret) {
197
    // Return value, assume its a match.
198 199 200 201 202
    return (((key) &&
        (key->getName() == name) &&
        (key->getAlgorithm() == algorithm)  &&
        (key->getSecret() ==  secret)  &&
        (key->getTSIGKey())));
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
}

/// @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_;
};

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/// @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_;
};

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 286 287 288

/// @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));
289
        (*keys_)[name]=key_info;
290 291 292 293 294 295 296 297 298 299 300 301
    }

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

    /// @brief Storage for TSIGKeys
    TSIGKeyInfoMapPtr keys_;

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

302 303 304 305 306 307 308 309 310 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 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/// @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());
}

/// @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 , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_protocol\": \"UDP\" , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

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

    // Check that omitting port gets you its default
    config =
            "{"
            " \"ip_address\": \"192.0.0.1\" , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_protocol\": \"UDP\" , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

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

    // Check that omitting timeout gets you its default
    config =
            "{"
            " \"ip_address\": \"192.0.0.1\" , "
            " \"port\": 777 , "
            " \"ncr_protocol\": \"UDP\" , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

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

    // Check that protocol timeout gets you its default
    config =
            "{"
            " \"ip_address\": \"192.0.0.1\" , "
            " \"port\": 777 , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

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

    // Check that format timeout gets you its default
    config =
            "{"
            " \"ip_address\": \"192.0.0.1\" , "
            " \"port\": 777 , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_protocol\": \"UDP\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {} "
            "}";

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

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
/// @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 =
            "{"
            " \"ip_address\": \"127.0.0.1\", "
            " \"port\": 777 , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_protocol\": \"UDP\" , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {}, "
            "\"bogus_param\" : true "
            "}";

    runConfig(config, SHOULD_FAIL);

    // Check that unsupported top level objects fails.  For
    // D2 these fail as they are not in the parse order.
    config =
            "{"
            " \"ip_address\": \"127.0.0.1\", "
            " \"port\": 777 , "
            " \"dns_server_timeout\": 333 , "
            " \"ncr_protocol\": \"UDP\" , "
            " \"ncr_format\": \"JSON\", "
            "\"tsig_keys\": [], "
            "\"bogus_object_one\" : {}, "
            "\"forward_ddns\" : {}, "
            "\"reverse_ddns\" : {}, "
            "\"bogus_object_two\" : {} "
            "}";

    runConfig(config, SHOULD_FAIL);
}


449 450 451 452 453 454 455 456 457 458 459 460
/// @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");
461
    runConfig(config, SHOULD_FAIL);
462 463 464

    // Cannot use IPv6 ANY address
    config = makeParamsConfigString ("::", 777, 333, "UDP", "JSON");
465
    runConfig(config, SHOULD_FAIL);
466 467 468

    // Cannot use port  0
    config = makeParamsConfigString ("127.0.0.1", 0, 333, "UDP", "JSON");
469
    runConfig(config, SHOULD_FAIL);
470 471 472

    // Cannot use dns server timeout of 0
    config = makeParamsConfigString ("127.0.0.1", 777, 0, "UDP", "JSON");
473
    runConfig(config, SHOULD_FAIL);
474 475 476

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

479 480 481 482
    // Unsupported protocol
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "TCP", "JSON");
    runConfig(config, SHOULD_FAIL);

483 484
    // Invalid format
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "UDP", "BOGUS");
485
    runConfig(config, SHOULD_FAIL);
486 487
}

488 489 490 491
/// @brief Tests the enforcement of data validation when parsing TSIGKeyInfos.
/// It verifies that:
/// 1. Name cannot be blank.
/// 2. Algorithm cannot be blank.
492
/// 3. Secret cannot be blank.
493
TEST_F(TSIGKeyInfoTest, invalidEntry) {
494 495 496
    // Config with a blank name entry.
    std::string config = "{"
                         " \"name\": \"\" , "
497
                         " \"algorithm\": \"HMAC-MD5\" , "
498
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
499
                         "}";
500
    ASSERT_TRUE(fromJSON(config));
501

502 503
    // Verify that build fails on blank name.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
504 505 506 507 508

    // Config with a blank algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"\" , "
509
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
510 511
                         "}";

512
    ASSERT_TRUE(fromJSON(config));
513

514 515
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
516

517 518 519 520
    // Config with an invalid algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"bogus\" , "
521
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
522 523
                         "}";

524
    ASSERT_TRUE(fromJSON(config));
525

526 527
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
528 529 530 531

    // Config with a blank secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
532
                         " \"algorithm\": \"HMAC-MD5\" , "
533 534 535
                         " \"secret\": \"\" "
                         "}";

536
    ASSERT_TRUE(fromJSON(config));
537

538 539
    // Verify that build fails blank secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
540 541 542 543

    // Config with an invalid secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
544
                         " \"algorithm\": \"HMAC-MD5\" , "
545 546 547 548 549 550 551
                         " \"secret\": \"bogus\" "
                         "}";

    ASSERT_TRUE(fromJSON(config));

    // Verify that build fails an invalid secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
552 553 554 555
}

/// @brief Verifies that TSIGKeyInfo parsing creates a proper TSIGKeyInfo
/// when given a valid combination of entries.
556
TEST_F(TSIGKeyInfoTest, validEntry) {
557 558 559
    // Valid entries for TSIG key, all items are required.
    std::string config = "{"
                         " \"name\": \"d2_key_one\" , "
560
                         " \"algorithm\": \"HMAC-MD5\" , "
561
                         " \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
562
                         "}";
563
    ASSERT_TRUE(fromJSON(config));
564 565

    // Verify that it builds and commits without throwing.
566 567
    //ASSERT_NO_THROW(parser_->build(config_set_));
    (parser_->build(config_set_));
568 569 570 571
    ASSERT_NO_THROW(parser_->commit());

    // Verify the correct number of keys are present
    int count =  keys_->size();
572
    EXPECT_EQ(1, count);
573 574 575 576 577 578 579

    // 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.
580
    EXPECT_TRUE(checkKey(key, "d2_key_one", "HMAC-MD5",
581
                         "dGhpcyBrZXkgd2lsbCBtYXRjaA=="));
582 583 584 585 586 587 588 589 590
}

/// @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\" , "
591
                         "   \"algorithm\": \"HMAC-MD5\" ,"
592
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
593
                         " },"
594
                         // this entry has an invalid algorithm
595 596
                         " { \"name\": \"key2\" , "
                         "   \"algorithm\": \"\" ,"
597
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
598 599
                         " },"
                         " { \"name\": \"key3\" , "
600
                         "   \"algorithm\": \"HMAC-MD5\" ,"
601
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
602 603 604
                         " }"
                         " ]";

605
    ASSERT_TRUE(fromJSON(config));
606 607 608 609 610 611

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

    // Verify that the list builds without errors.
612
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
613 614 615 616 617 618 619 620 621
}

/// @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\" , "
622
                         "   \"algorithm\": \"HMAC-MD5\" ,"
623
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
624 625
                         " },"
                         " { \"name\": \"key2\" , "
626
                         "   \"algorithm\": \"HMAC-MD5\" ,"
627
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
628 629
                         " },"
                         " { \"name\": \"key1\" , "
630
                         "   \"algorithm\": \"HMAC-MD5\" ,"
631
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
632 633 634
                         " }"
                         " ]";

635
    ASSERT_TRUE(fromJSON(config));
636 637 638 639 640 641

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

    // Verify that the list builds without errors.
642
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
643 644 645
}

/// @brief Verifies a valid list of TSIG Keys parses correctly.
646
/// Also verifies that all of the supported algorithm names work.
647
TEST_F(TSIGKeyInfoTest, validTSIGKeyList) {
648
    // Construct a valid list of keys.
649 650 651
    std::string config = "["

                         " { \"name\": \"key1\" , "
652
                         "   \"algorithm\": \"HMAC-MD5\" ,"
653
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
654 655
                         " },"
                         " { \"name\": \"key2\" , "
656
                         "   \"algorithm\": \"HMAC-SHA1\" ,"
657
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
658 659
                         " },"
                         " { \"name\": \"key3\" , "
660
                         "   \"algorithm\": \"HMAC-SHA256\" ,"
661
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
662 663
                         " },"
                         " { \"name\": \"key4\" , "
664
                         "   \"algorithm\": \"HMAC-SHA224\" ,"
665
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
666 667
                         " },"
                         " { \"name\": \"key5\" , "
668
                         "   \"algorithm\": \"HMAC-SHA384\" ,"
669
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
670 671
                         " },"
                         " { \"name\": \"key6\" , "
672
                         "   \"algorithm\": \"HMAC-SHA512\" ,"
673
                         "   \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
674 675 676
                         " }"
                         " ]";

677
    ASSERT_TRUE(fromJSON(config));
678 679 680 681 682 683 684 685

    // 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());

686
    std::string ref_secret = "dGhpcyBrZXkgd2lsbCBtYXRjaA==";
687 688
    // Verify the correct number of keys are present
    int count =  keys_->size();
689
    ASSERT_EQ(6, count);
690 691 692 693 694 695 696

    // 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.
697
    EXPECT_TRUE(checkKey(key, "key1", TSIGKeyInfo::HMAC_MD5_STR, ref_secret));
698 699 700 701 702 703 704

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

    // Verify the key contents.
705
    EXPECT_TRUE(checkKey(key, "key2", TSIGKeyInfo::HMAC_SHA1_STR, ref_secret));
706 707 708 709 710 711 712

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

    // Verify the key contents.
713 714
    EXPECT_TRUE(checkKey(key, "key3", TSIGKeyInfo::HMAC_SHA256_STR,
                         ref_secret));
715 716 717 718 719 720 721

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

    // Verify the key contents.
722 723
    EXPECT_TRUE(checkKey(key, "key4", TSIGKeyInfo::HMAC_SHA224_STR,
                         ref_secret));
724 725 726 727 728 729 730

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

    // Verify the key contents.
731 732
    EXPECT_TRUE(checkKey(key, "key5", TSIGKeyInfo::HMAC_SHA384_STR,
                         ref_secret));
733 734 735 736 737 738 739

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

    // Verify the key contents.
740 741
    EXPECT_TRUE(checkKey(key, "key6", TSIGKeyInfo::HMAC_SHA512_STR,
                         ref_secret));
742 743
}

744 745 746 747 748
/// @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.
749
TEST_F(DnsServerInfoTest, invalidEntry) {
750
    // Create a config in which both host and ip address are supplied.
751
    // Verify that build fails.
752 753
    std::string config = "{ \"hostname\": \"pegasus.tmark\", "
                         "  \"ip_address\": \"127.0.0.1\" } ";
754
    ASSERT_TRUE(fromJSON(config));
755
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
756 757

    // Neither host nor ip address supplied
758
    // Verify that builds fails.
759 760
    config = "{ \"hostname\": \"\", "
             "  \"ip_address\": \"\" } ";
761
    ASSERT_TRUE(fromJSON(config));
762
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
763 764 765 766 767

    // Create a config with a negative port number.
    // Verify that build fails.
    config = "{ \"ip_address\": \"192.168.5.6\" ,"
             "  \"port\": -100 }";
768
    ASSERT_TRUE(fromJSON(config));
769 770 771
    EXPECT_THROW (parser_->build(config_set_), isc::BadValue);
}

772

773 774 775 776 777 778
/// @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.
779
TEST_F(DnsServerInfoTest, validEntry) {
780 781 782 783
    /// @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));
784

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

789 790 791
    /// //Verify the correct number of servers are present
    /// int count =  servers_->size();
    /// EXPECT_EQ(1, count);
792

793 794 795 796 797
    /// 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));
798

799 800
    /// // Start over for a new test.
    /// reset();
801 802

    // Valid entries for static ip
803 804
    std::string config = " { \"ip_address\": \"127.0.0.1\" , "
                         "  \"port\": 100 }";
805
    ASSERT_TRUE(fromJSON(config));
806 807 808 809 810 811

    // 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
812
    int count =  servers_->size();
813
    EXPECT_EQ(1, count);
814 815

    // Verify the server exists and has the correct values.
816
    DnsServerInfoPtr server = (*servers_)[0];
817 818 819 820 821 822 823
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1", 100));

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

    // Valid entries for static ip, no port
    config = " { \"ip_address\": \"192.168.2.5\" }";
824
    ASSERT_TRUE(fromJSON(config));
825 826 827 828 829 830 831

    // 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();
832
    EXPECT_EQ(1, count);
833 834 835 836

    // Verify the server exists and has the correct values.
    server = (*servers_)[0];
    EXPECT_TRUE(checkServer(server, "", "192.168.2.5",
837
                            DnsServerInfo::STANDARD_DNS_PORT));
838 839 840 841 842 843
}

/// @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.
844 845 846
    std::string config = "[ { \"ip_address\": \"127.0.0.1\" }, "
                        "{ \"ip_address\": \"\" }, "
                        "{ \"ip_address\": \"127.0.0.2\" } ]";
847
    ASSERT_TRUE(fromJSON(config));
848 849 850 851 852 853

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

854 855
    // Verify that build fails.
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
856 857 858 859 860 861
}

/// @brief Verifies that a list of DnsServerInfo entries parses correctly given
/// a valid configuration.
TEST_F(ConfigParseTest, validServerList) {
    // Create a valid list of servers.
862 863 864
    std::string config = "[ { \"ip_address\": \"127.0.0.1\" }, "
                        "{ \"ip_address\": \"127.0.0.2\" }, "
                        "{ \"ip_address\": \"127.0.0.3\" } ]";
865
    ASSERT_TRUE(fromJSON(config));
866 867 868 869 870 871 872 873 874 875 876 877

    // 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();
878
    EXPECT_EQ(3, count);
879 880 881

    // Verify the first server exists and has the correct values.
    DnsServerInfoPtr server = (*servers)[0];
882
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1",
883
                            DnsServerInfo::STANDARD_DNS_PORT));
884 885 886

    // Verify the second server exists and has the correct values.
    server = (*servers)[1];
887
    EXPECT_TRUE(checkServer(server, "", "127.0.0.2",
888
                            DnsServerInfo::STANDARD_DNS_PORT));
889 890 891

    // Verify the third server exists and has the correct values.
    server = (*servers)[2];
892
    EXPECT_TRUE(checkServer(server, "", "127.0.0.3",
893
                            DnsServerInfo::STANDARD_DNS_PORT));
894 895 896 897 898 899 900 901
}

/// @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.
902 903
/// 5. That an undefined key name is detected.
TEST_F(DdnsDomainTest, invalidDdnsDomainEntry) {
904
    // Verify that attempting to construct the parser with null storage fails.
905 906 907
    DdnsDomainMapPtr domains;
    ASSERT_THROW(isc::dhcp::ParserPtr(
                 new DdnsDomainParser("test", domains, keys_)), D2CfgError);
908 909 910 911 912 913 914 915 916 917

    // Create a domain configuration without a name
    std::string config = "{  \"key_name\": \"d2_key.tmark.org\" , "
                         "  \"dns_servers\" : [ "
                         "  {  \"ip_address\": \"127.0.0.1\" , "
                         "    \"port\": 100 },"
                         "  { \"ip_address\": \"127.0.0.2\" , "
                         "    \"port\": 200 },"
                         "  {  \"ip_address\": \"127.0.0.3\" , "
                         "    \"port\": 300 } ] } ";
918
    ASSERT_TRUE(fromJSON(config));
919

920
    // Verify that the domain configuration builds fails.
921
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
922 923 924 925 926 927

    // Create a domain configuration with an empty server list.
    config = "{ \"name\": \"tmark.org\" , "
             "  \"key_name\": \"d2_key.tmark.org\" , "
             "  \"dns_servers\" : [ "
             "   ] } ";
928
    ASSERT_TRUE(fromJSON(config));
929 930

    // Verify that the domain configuration build fails.
931
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
932 933 934 935 936 937 938

    // Create a domain configuration with a mal-formed server entry.
    config = "{ \"name\": \"tmark.org\" , "
             "  \"key_name\": \"d2_key.tmark.org\" , "
             "  \"dns_servers\" : [ "
             "  {  \"ip_address\": \"127.0.0.3\" , "
             "    \"port\": -1 } ] } ";
939
    ASSERT_TRUE(fromJSON(config));
940 941

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

944 945 946 947 948 949
    // Create a domain configuration without an defined key name
    config = "{ \"name\": \"tmark.org\" , "
             "  \"key_name\": \"d2_key.tmark.org\" , "
             "  \"dns_servers\" : [ "
             "  {  \"ip_address\": \"127.0.0.3\" , "
             "    \"port\": 300 } ] } ";
950
    ASSERT_TRUE(fromJSON(config));
951

952 953
    // Verify that the domain configuration build fails.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
954
}
955 956 957 958 959 960

/// @brief Verifies the basics of parsing DdnsDomains.
/// It verifies that:
/// 1. Valid construction of DdnsDomainParser functions.
/// 2. Given a valid, configuration entry, DdnsDomainParser parses
/// correctly.
961 962
/// (It indirectly verifies the operation of DdnsDomainMap).
TEST_F(DdnsDomainTest, ddnsDomainParsing) {
963 964 965 966 967 968 969 970 971 972 973 974
    // Create a valid domain configuration entry containing three valid
    // servers.
    std::string config =
                        "{ \"name\": \"tmark.org\" , "
                        "  \"key_name\": \"d2_key.tmark.org\" , "
                        "  \"dns_servers\" : [ "
                        "  {  \"ip_address\": \"127.0.0.1\" , "
                        "    \"port\": 100 },"
                        "  { \"ip_address\": \"127.0.0.2\" , "
                        "    \"port\": 200 },"
                        "  {  \"ip_address\": \"127.0.0.3\" , "
                        "    \"port\": 300 } ] } ";
975
    ASSERT_TRUE(fromJSON(config));
976

977
    // Add a TSIG key to the test key map, so key validation will pass.
978
    addKey("d2_key.tmark.org", "HMAC-MD5", "GWG/Xfbju4O2iXGqkSu4PQ==");
979 980

    // Verify that the domain configuration builds and commits without error.
981 982
    ASSERT_NO_THROW(parser_->build(config_set_));
    ASSERT_NO_THROW(parser_->commit());
983 984

    // Verify that the domain storage contains the correct number of domains.
985
    int count =  domains_->size();
986
    EXPECT_EQ(1, count);
987 988 989

    // Verify that the expected domain exists and can be retrieved from
    // the storage.
990 991
    DdnsDomainMap::iterator gotit = domains_->find("tmark.org");
    ASSERT_TRUE(gotit != domains_->end());
992 993 994
    DdnsDomainPtr& domain = gotit->second;

    // Verify the name and key_name values.
995 996
    EXPECT_EQ("tmark.org", domain->getName());
    EXPECT_EQ("d2_key.tmark.org", domain->getKeyName());
997 998
    ASSERT_TRUE(domain->getTSIGKeyInfo());
    ASSERT_TRUE(domain->getTSIGKeyInfo()->getTSIGKey());
999 1000 1001 1002 1003 1004

    // Verify that the server list exists and contains the correct number of
    // servers.
    const DnsServerInfoStoragePtr& servers = domain->getServers();
    EXPECT_TRUE(servers);
    count =  servers->size();
1005
    EXPECT_EQ(3, count);
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

    // Fetch each server and verify its contents.
    DnsServerInfoPtr server = (*servers)[0];
    EXPECT_TRUE(server);

    EXPECT_TRUE(checkServer(server, "", "127.0.0.1", 100));

    server = (*servers)[1];
    EXPECT_TRUE(server);

    EXPECT_TRUE(checkServer(server, "", "127.0.0.2", 200));

    server = (*servers)[2];
    EXPECT_TRUE(server);

    EXPECT_TRUE(checkServer(server, "", "127.0.0.3", 300));
}

/// @brief Tests the fundamentals of parsing DdnsDomain lists.
/// This test verifies that given a valid domain list configuration
/// it will accurately parse and populate each domain in the list.
1027
TEST_F(DdnsDomainTest, DdnsDomainListParsing) {
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
    // Create a valid domain list configuration, with two domains
    // that have three servers each.
    std::string config =
                        "[ "
                        "{ \"name\": \"tmark.org\" , "
                        "  \"key_name\": \"d2_key.tmark.org\" , "
                        "  \"dns_servers\" : [ "
                        "  { \"ip_address\": \"127.0.0.1\" , "
                        "    \"port\": 100 },"
                        "  { \"ip_address\": \"127.0.0.2\" , "
                        "    \"port\": 200 },"
                        "  { \"ip_address\": \"127.0.0.3\" , "
                        "    \"port\": 300 } ] } "
                        ", "
                        "{ \"name\": \"billcat.net\" , "
                        "  \"key_name\": \"d2_key.billcat.net\" , "
                        "  \"dns_servers\" : [ "
                        "  { \"ip_address\": \"127.0.0.4\" , "
                        "    \"port\": 400 },"
                        "  { \"ip_address\": \"127.0.0.5\" , "
                        "    \"port\": 500 },"
                        "  { \"ip_address\": \"127.0.0.6\" , "
                        "    \"port\": 600 } ] } "
                        "] ";

1053
    ASSERT_TRUE(fromJSON(config));
1054

1055
    // Add keys to key map so key validation passes.
1056 1057
    addKey("d2_key.tmark.org", "HMAC-MD5", "GWG/Xfbju4O2iXGqkSu4PQ==");
    addKey("d2_key.billcat.net", "HMAC-MD5", "GWG/Xfbju4O2iXGqkSu4PQ==");
1058 1059

    // Create the list parser
1060
    isc::dhcp::ParserPtr list_parser;
1061 1062
    ASSERT_NO_THROW(list_parser.reset(
                    new DdnsDomainListParser("test", domains_, keys_)));
1063 1064

    // Verify that the domain configuration builds and commits without error.
1065 1066
    ASSERT_NO_THROW(list_parser->build(config_set_));
    ASSERT_NO_THROW(list_parser->commit());
1067 1068

    // Verify that the domain storage contains the correct number of domains.
1069
    int count =  domains_->size();
1070
    EXPECT_EQ(2, count);
1071 1072

    // Verify that the first domain exists and can be retrieved.
1073 1074
    DdnsDomainMap::iterator gotit = domains_->find("tmark.org");
    ASSERT_TRUE(gotit != domains_->end());
1075 1076 1077
    DdnsDomainPtr& domain = gotit->second;

    // Verify the name and key_name values of the first domain.
1078 1079
    EXPECT_EQ("tmark.org", domain->getName());
    EXPECT_EQ("d2_key.tmark.org", domain->getKeyName());
1080 1081
    ASSERT_TRUE(domain->getTSIGKeyInfo());
    ASSERT_TRUE(domain->getTSIGKeyInfo()->getTSIGKey());
1082 1083 1084 1085 1086

    // Verify the each of the first domain's servers
    DnsServerInfoStoragePtr servers = domain->getServers();
    EXPECT_TRUE(servers);
    count =  servers->size();
1087
    EXPECT_EQ(3, count);
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

    DnsServerInfoPtr server = (*servers)[0];
    EXPECT_TRUE(server);
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1", 100));

    server = (*servers)[1];
    EXPECT_TRUE(server);
    EXPECT_TRUE(checkServer(server, "", "127.0.0.2", 200));

    server = (*servers)[2];
    EXPECT_TRUE(server);
    EXPECT_TRUE(checkServer(server, "", "127.0.0.3", 300));

    // Verify second domain
1102 1103
    gotit = domains_->find("billcat.net");
    ASSERT_TRUE(gotit != domains_->end());
1104 1105 1106
    domain = gotit->second;

    // Verify the name and key_name values of the second domain.