d2_cfg_mgr_unittests.cc 64.8 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
#include <dhcpsrv/testutils/config_result_check.h>
22 23 24 25 26 27 28 29 30 31

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

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

namespace {

32 33 34 35 36 37
/// @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
38 39 40 41
std::string specfile(const std::string& name) {
    return (std::string(D2_SRC_DIR) + "/" + name);
}

42 43 44 45 46 47
/// @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
48 49 50 51
std::string testDataFile(const std::string& name) {
    return (std::string(D2_TEST_DATA_DIR) + "/" + name);
}

52 53 54 55 56 57 58 59
/// @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
60
    D2CfgMgrTest():cfg_mgr_(new D2CfgMgr()), d2_params_() {
61 62 63 64 65 66 67 68
    }

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

    /// @brief Configuration manager instance.
    D2CfgMgrPtr cfg_mgr_;
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

    /// @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());
    }
102 103 104 105 106 107
    /// @brief Enumeration to select between expected configuration outcomes
    enum RunConfigMode {
       SHOULD_PASS,
       SHOULD_FAIL
    };

108 109 110 111 112 113 114 115 116 117
    /// @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
118 119 120 121
    /// @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) {
122 123 124 125 126
        // 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_);
127
        ASSERT_TRUE(checkAnswer(mode == SHOULD_FAIL));
128 129 130 131 132 133 134 135 136 137

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

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 176 177 178 179 180 181
    /// @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;
    }

182
    /// @brief Pointer the D2Params most recently parsed.
183
    D2ParamsPtr d2_params_;
184 185 186
};

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

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

214
    if (!server) {
215 216 217 218 219 220
        EXPECT_TRUE(server);
        return false;
    }

    // Check hostname.
    if (server->getHostname() != hostname) {
221
        EXPECT_EQ(hostname, server->getHostname());
222 223 224 225 226
        result = false;
    }

    // Check IP address.
    if (server->getIpAddress().toText() != ip_address) {
227
        EXPECT_EQ(ip_address, server->getIpAddress().toText());
228 229 230 231 232
        result = false;
    }

    // Check port.
    if (server->getPort() !=  port) {
233
        EXPECT_EQ (port, server->getPort());
234 235 236 237 238 239
        result = false;
    }

    return (result);
}

240
/// @brief Convenience function which compares the contents of the given
241 242
/// TSIGKeyInfo against the given set of values, and that the TSIGKey
/// member points to a key.
243
///
244
/// @param key is a pointer to the TSIGKeyInfo instance to verify
245 246 247 248 249 250
/// @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.
251
bool checkKey(TSIGKeyInfoPtr key, const std::string& name,
252 253
	      const std::string& algorithm, const std::string& secret,
              uint32_t digestbits = 0) {
254
    // Return value, assume its a match.
255 256 257
    return (((key) &&
        (key->getName() == name) &&
        (key->getAlgorithm() == algorithm)  &&
258
        (key->getDigestbits() == digestbits) &&
259 260
        (key->getSecret() ==  secret)  &&
        (key->getTSIGKey())));
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 289
}

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

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
/// @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_;
};

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

/// @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));
347
        (*keys_)[name]=key_info;
348 349 350 351 352 353 354 355 356 357 358 359
    }

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

    /// @brief Storage for TSIGKeys
    TSIGKeyInfoMapPtr keys_;

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

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
/// @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());
381 382

    // Verify the configuration summary.
383
    EXPECT_EQ("listening on 3001::5, port 777, using UDP",
384
              d2_params_->getConfigSummary());
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 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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
}

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

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
/// @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);
}


511 512 513 514 515 516 517 518 519 520 521 522
/// @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");
523
    runConfig(config, SHOULD_FAIL);
524 525 526

    // Cannot use IPv6 ANY address
    config = makeParamsConfigString ("::", 777, 333, "UDP", "JSON");
527
    runConfig(config, SHOULD_FAIL);
528 529 530

    // Cannot use port  0
    config = makeParamsConfigString ("127.0.0.1", 0, 333, "UDP", "JSON");
531
    runConfig(config, SHOULD_FAIL);
532 533 534

    // Cannot use dns server timeout of 0
    config = makeParamsConfigString ("127.0.0.1", 777, 0, "UDP", "JSON");
535
    runConfig(config, SHOULD_FAIL);
536 537 538

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

541 542 543 544
    // Unsupported protocol
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "TCP", "JSON");
    runConfig(config, SHOULD_FAIL);

545 546
    // Invalid format
    config = makeParamsConfigString ("127.0.0.1", 777, 333, "UDP", "BOGUS");
547
    runConfig(config, SHOULD_FAIL);
548 549
}

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

564 565
    // Verify that build fails on blank name.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
566 567 568 569 570

    // Config with a blank algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"\" , "
571
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
572 573
                         "}";

574
    ASSERT_TRUE(fromJSON(config));
575

576 577
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
578

579 580 581 582
    // Config with an invalid algorithm entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
                         " \"algorithm\": \"bogus\" , "
583
                         "   \"secret\": \"LSWXnfkKZjdPJI5QxlpnfQ==\" "
584 585
                         "}";

586
    ASSERT_TRUE(fromJSON(config));
587

588 589
    // Verify that build fails on blank algorithm.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
590 591 592 593

    // Config with a blank secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
594
                         " \"algorithm\": \"HMAC-MD5\" , "
595 596 597
                         " \"secret\": \"\" "
                         "}";

598
    ASSERT_TRUE(fromJSON(config));
599

600 601
    // Verify that build fails blank secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
602 603 604 605

    // Config with an invalid secret entry.
    config = "{"
                         " \"name\": \"d2_key_one\" , "
606
                         " \"algorithm\": \"HMAC-MD5\" , "
607 608 609 610 611 612 613
                         " \"secret\": \"bogus\" "
                         "}";

    ASSERT_TRUE(fromJSON(config));

    // Verify that build fails an invalid secret
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
614 615 616 617
}

/// @brief Verifies that TSIGKeyInfo parsing creates a proper TSIGKeyInfo
/// when given a valid combination of entries.
618
TEST_F(TSIGKeyInfoTest, validEntry) {
619 620 621
    // Valid entries for TSIG key, all items are required.
    std::string config = "{"
                         " \"name\": \"d2_key_one\" , "
622
                         " \"algorithm\": \"HMAC-MD5\" , "
623
                         " \"digest_bits\": 120 , "
624
                         " \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
625
                         "}";
626
    ASSERT_TRUE(fromJSON(config));
627 628

    // Verify that it builds and commits without throwing.
629 630
    //ASSERT_NO_THROW(parser_->build(config_set_));
    (parser_->build(config_set_));
631 632 633 634
    ASSERT_NO_THROW(parser_->commit());

    // Verify the correct number of keys are present
    int count =  keys_->size();
635
    EXPECT_EQ(1, count);
636 637 638 639 640 641 642

    // 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.
643
    EXPECT_TRUE(checkKey(key, "d2_key_one", "HMAC-MD5",
644
                         "dGhpcyBrZXkgd2lsbCBtYXRjaA==", 120));
645 646 647 648 649 650 651 652 653
}

/// @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\" , "
654
                         "   \"algorithm\": \"HMAC-MD5\" ,"
655
                         " \"digest_bits\": 120 , "
656
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
657
                         " },"
658
                         // this entry has an invalid algorithm
659 660
                         " { \"name\": \"key2\" , "
                         "   \"algorithm\": \"\" ,"
661
                         " \"digest_bits\": 120 , "
662
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
663 664
                         " },"
                         " { \"name\": \"key3\" , "
665
                         "   \"algorithm\": \"HMAC-MD5\" ,"
666
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
667 668 669
                         " }"
                         " ]";

670
    ASSERT_TRUE(fromJSON(config));
671 672 673 674 675 676

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

    // Verify that the list builds without errors.
677
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
678 679 680 681 682 683 684 685 686
}

/// @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\" , "
687
                         "   \"algorithm\": \"HMAC-MD5\" ,"
688
                         " \"digest_bits\": 120 , "
689
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
690 691
                         " },"
                         " { \"name\": \"key2\" , "
692
                         "   \"algorithm\": \"HMAC-MD5\" ,"
693
                         " \"digest_bits\": 120 , "
694
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
695 696
                         " },"
                         " { \"name\": \"key1\" , "
697
                         "   \"algorithm\": \"HMAC-MD5\" ,"
698
                         "   \"secret\": \"GWG/Xfbju4O2iXGqkSu4PQ==\" "
699 700 701
                         " }"
                         " ]";

702
    ASSERT_TRUE(fromJSON(config));
703 704 705 706 707 708

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

    // Verify that the list builds without errors.
709
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
710 711 712
}

/// @brief Verifies a valid list of TSIG Keys parses correctly.
713
/// Also verifies that all of the supported algorithm names work.
714
TEST_F(TSIGKeyInfoTest, validTSIGKeyList) {
715
    // Construct a valid list of keys.
716 717 718
    std::string config = "["

                         " { \"name\": \"key1\" , "
719
                         "   \"algorithm\": \"HMAC-MD5\" ,"
720
                         " \"digest_bits\": 80 , "
721
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
722 723
                         " },"
                         " { \"name\": \"key2\" , "
724
                         "   \"algorithm\": \"HMAC-SHA1\" ,"
725
                         " \"digest_bits\": 80 , "
726
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
727 728
                         " },"
                         " { \"name\": \"key3\" , "
729
                         "   \"algorithm\": \"HMAC-SHA256\" ,"
730
                         " \"digest_bits\": 128 , "
731
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
732 733
                         " },"
                         " { \"name\": \"key4\" , "
734
                         "   \"algorithm\": \"HMAC-SHA224\" ,"
735
                         " \"digest_bits\": 112 , "
736
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
737 738
                         " },"
                         " { \"name\": \"key5\" , "
739
                         "   \"algorithm\": \"HMAC-SHA384\" ,"
740
                         " \"digest_bits\": 192 , "
741
                         "  \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
742 743
                         " },"
                         " { \"name\": \"key6\" , "
744
                         "   \"algorithm\": \"HMAC-SHA512\" ,"
745
                         " \"digest_bits\": 256 , "
746
                         "   \"secret\": \"dGhpcyBrZXkgd2lsbCBtYXRjaA==\" "
747 748 749
                         " }"
                         " ]";

750
    ASSERT_TRUE(fromJSON(config));
751 752 753 754 755 756 757 758

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

759
    std::string ref_secret = "dGhpcyBrZXkgd2lsbCBtYXRjaA==";
760 761
    // Verify the correct number of keys are present
    int count =  keys_->size();
762
    ASSERT_EQ(6, count);
763 764 765 766 767 768 769

    // 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.
770 771
    EXPECT_TRUE(checkKey(key, "key1", TSIGKeyInfo::HMAC_MD5_STR,
                         ref_secret, 80));
772 773 774 775 776 777 778

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

    // Verify the key contents.
779 780
    EXPECT_TRUE(checkKey(key, "key2", TSIGKeyInfo::HMAC_SHA1_STR,
                         ref_secret, 80));
781 782 783 784 785 786 787

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

    // Verify the key contents.
788
    EXPECT_TRUE(checkKey(key, "key3", TSIGKeyInfo::HMAC_SHA256_STR,
789
                         ref_secret, 128));
790 791 792 793 794 795 796

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

    // Verify the key contents.
797
    EXPECT_TRUE(checkKey(key, "key4", TSIGKeyInfo::HMAC_SHA224_STR,
798
                         ref_secret, 112));
799 800 801 802 803 804 805

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

    // Verify the key contents.
806
    EXPECT_TRUE(checkKey(key, "key5", TSIGKeyInfo::HMAC_SHA384_STR,
807
                         ref_secret, 192));
808 809 810 811 812 813 814

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

    // Verify the key contents.
815
    EXPECT_TRUE(checkKey(key, "key6", TSIGKeyInfo::HMAC_SHA512_STR,
816
                         ref_secret, 256));
817 818
}

819 820 821 822 823
/// @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.
824
TEST_F(DnsServerInfoTest, invalidEntry) {
825
    // Create a config in which both host and ip address are supplied.
826
    // Verify that build fails.
827 828
    std::string config = "{ \"hostname\": \"pegasus.tmark\", "
                         "  \"ip_address\": \"127.0.0.1\" } ";
829
    ASSERT_TRUE(fromJSON(config));
830
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
831 832

    // Neither host nor ip address supplied
833
    // Verify that builds fails.
834 835
    config = "{ \"hostname\": \"\", "
             "  \"ip_address\": \"\" } ";
836
    ASSERT_TRUE(fromJSON(config));
837
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
838 839 840 841 842

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

847

848 849 850 851 852 853
/// @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.
854
TEST_F(DnsServerInfoTest, validEntry) {
855 856 857 858
    /// @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));
859

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

864 865 866
    /// //Verify the correct number of servers are present
    /// int count =  servers_->size();
    /// EXPECT_EQ(1, count);
867

868 869 870 871 872
    /// 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));
873

874 875
    /// // Start over for a new test.
    /// reset();
876 877

    // Valid entries for static ip
878 879
    std::string config = " { \"ip_address\": \"127.0.0.1\" , "
                         "  \"port\": 100 }";
880
    ASSERT_TRUE(fromJSON(config));
881 882 883 884 885 886

    // 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
887
    int count =  servers_->size();
888
    EXPECT_EQ(1, count);
889 890

    // Verify the server exists and has the correct values.
891
    DnsServerInfoPtr server = (*servers_)[0];
892 893 894 895 896 897 898
    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\" }";
899
    ASSERT_TRUE(fromJSON(config));
900 901 902 903 904 905 906

    // 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();
907
    EXPECT_EQ(1, count);
908 909 910 911

    // Verify the server exists and has the correct values.
    server = (*servers_)[0];
    EXPECT_TRUE(checkServer(server, "", "192.168.2.5",
912
                            DnsServerInfo::STANDARD_DNS_PORT));
913 914 915 916 917 918
}

/// @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.
919 920 921
    std::string config = "[ { \"ip_address\": \"127.0.0.1\" }, "
                        "{ \"ip_address\": \"\" }, "
                        "{ \"ip_address\": \"127.0.0.2\" } ]";
922
    ASSERT_TRUE(fromJSON(config));
923 924 925 926 927 928

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

929 930
    // Verify that build fails.
    EXPECT_THROW(parser->build(config_set_), D2CfgError);
931 932 933 934 935 936
}

/// @brief Verifies that a list of DnsServerInfo entries parses correctly given
/// a valid configuration.
TEST_F(ConfigParseTest, validServerList) {
    // Create a valid list of servers.
937 938 939
    std::string config = "[ { \"ip_address\": \"127.0.0.1\" }, "
                        "{ \"ip_address\": \"127.0.0.2\" }, "
                        "{ \"ip_address\": \"127.0.0.3\" } ]";
940
    ASSERT_TRUE(fromJSON(config));
941 942 943 944 945 946 947 948 949 950 951 952

    // 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();
953
    EXPECT_EQ(3, count);
954 955 956

    // Verify the first server exists and has the correct values.
    DnsServerInfoPtr server = (*servers)[0];
957
    EXPECT_TRUE(checkServer(server, "", "127.0.0.1",
958
                            DnsServerInfo::STANDARD_DNS_PORT));
959 960 961

    // Verify the second server exists and has the correct values.
    server = (*servers)[1];
962
    EXPECT_TRUE(checkServer(server, "", "127.0.0.2",
963
                            DnsServerInfo::STANDARD_DNS_PORT));
964 965 966

    // Verify the third server exists and has the correct values.
    server = (*servers)[2];
967
    EXPECT_TRUE(checkServer(server, "", "127.0.0.3",
968
                            DnsServerInfo::STANDARD_DNS_PORT));
969 970 971 972 973 974 975 976
}

/// @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.
977 978
/// 5. That an undefined key name is detected.
TEST_F(DdnsDomainTest, invalidDdnsDomainEntry) {
979
    // Verify that attempting to construct the parser with null storage fails.
980 981 982
    DdnsDomainMapPtr domains;
    ASSERT_THROW(isc::dhcp::ParserPtr(
                 new DdnsDomainParser("test", domains, keys_)), D2CfgError);
983 984 985 986 987 988 989 990 991 992

    // 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 } ] } ";
993
    ASSERT_TRUE(fromJSON(config));
994

995
    // Verify that the domain configuration builds fails.
996
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
997 998 999 1000 1001 1002

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

    // Verify that the domain configuration build fails.
1006
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
1007 1008 1009 1010 1011 1012 1013

    // 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 } ] } ";
1014
    ASSERT_TRUE(fromJSON(config));
1015 1016

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

1019 1020 1021 1022 1023 1024
    // 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 } ] } ";
1025
    ASSERT_TRUE(fromJSON(config));
1026

1027 1028
    // Verify that the domain configuration build fails.
    EXPECT_THROW(parser_->build(config_set_), D2CfgError);
1029
}
1030 1031 1032 1033 1034 1035

/// @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.
1036 1037
/// (It indirectly verifies the operation of DdnsDomainMap).
TEST_F(DdnsDomainTest, ddnsDomainParsing) {
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
    // 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 } ] } ";
1050
    ASSERT_TRUE(fromJSON(config));
1051

1052
    // Add a TSIG key to the test key map, so key validation will pass.
1053
    addKey("d2_key.tmark.org", "HMAC-MD5", "GWG/Xfbju4O2iXGqkSu4PQ==");
1054 1055

    // Verify that the domain configuration builds and commits without error.
1056 1057
    ASSERT_NO_THROW(parser_->build(config_set_));
    ASSERT_NO_THROW(parser_->commit());
1058 1059

    // Verify that the domain storage contains the correct number of domains.
1060
    int count =  domains_->size();
1061
    EXPECT_EQ(1, count);
1062 1063 1064

    // Verify that the expected domain exists and can be retrieved from
    // the storage.
1065 1066
    DdnsDomainMap::iterator gotit = domains_->find("tmark.org");
    ASSERT_TRUE(gotit != domains_->end());
1067 1068 1069
    DdnsDomainPtr& domain = gotit->second;

    // Verify the name and key_name values.
1070 1071
    EXPECT_EQ("tmark.org", domain->getName());
    EXPECT_EQ("d2_key.tmark.org", domain->getKeyName());
1072 1073
    ASSERT_TRUE(domain->getTSIGKeyInfo());
    ASSERT_TRUE(domain->getTSIGKeyInfo()->getTSIGKey());
1074 1075 1076 1077 1078 1079

    // Verify that the server list exists and contains the correct number of
    // servers.
    const DnsServerInfoStoragePtr& servers = domain->getServers();
    EXPECT_TRUE(servers);
    count =  servers->size();
1080
    EXPECT_EQ(3, count);
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

    // 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.
1102
TEST_F(DdnsDomainTest, DdnsDomainListParsing) {
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112