d2_cfg_mgr_unittests.cc 64.8 KB
Newer Older
1
// Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// 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.

15 16
#include <config.h>

17 18 19 20
#include <config/module_spec.h>
#include <d2/d2_config.h>
#include <d2/d2_cfg_mgr.h>
#include <d_test_stubs.h>
21
#include <test_data_files_config.h>
22
#include <util/encode/base64.h>
23
#include <dhcpsrv/testutils/config_result_check.h>
24 25 26 27 28 29 30 31 32 33

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

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

namespace {

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

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

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

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

    /// @brief Configuration manager instance.
    D2CfgMgrPtr cfg_mgr_;
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 102 103

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

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

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

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

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

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

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

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

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

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

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

    return (result);
}

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

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

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

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

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

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

    /// @brief Storage for TSIGKeys
    TSIGKeyInfoMapPtr keys_;

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

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

    // Verify the configuration summary.
385
    EXPECT_EQ("listening on 3001::5, port 777, using UDP",
386
              d2_params_->getConfigSummary());
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 473 474
}

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

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


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

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

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

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

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

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

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

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

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

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

576
    ASSERT_TRUE(fromJSON(config));
577

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

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

588
    ASSERT_TRUE(fromJSON(config));
589

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

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

600
    ASSERT_TRUE(fromJSON(config));
601

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

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

    ASSERT_TRUE(fromJSON(config));

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

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

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

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

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

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

672
    ASSERT_TRUE(fromJSON(config));
673 674 675 676 677 678

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

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

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

704
    ASSERT_TRUE(fromJSON(config));
705 706 707 708 709 710

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

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

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

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

752
    ASSERT_TRUE(fromJSON(config));
753 754 755 756 757 758 759 760

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

849

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

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

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

870 871 872 873 874
    /// 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));
875

876 877
    /// // Start over for a new test.
    /// reset();
878 879

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // 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.