test: Add initial unit tests for c-ares library
The tests are written in C++11, using the GoogleTest and GoogleMock
frameworks. They have their own independent autoconf setup, so that
users of the library need not have a C++ compiler just to get c-ares
working (however, the test/configure.ac file does assume the use of
a shared top-level m4/ directory). However, this autoconf setup has
only been tested on Linux and OSX so far.
Run with "./arestest", or "./arestest -v" to see extra debug info.
The GoogleTest options for running specific tests are also
available (e.g. "./arestest --gtest_filter=*Live*").
The tests are nowhere near complete yet (currently hitting around
60% coverage as reported by gcov), but they do include examples
of a few different styles of testing:
- There are live tests (ares-test-live.cc), which assume that the
current machine has a valid DNS setup and connection to the
internet; these tests issue queries for real domains but don't
particularly check what gets returned. The tests will fail on
an offline machine.
- There a few mock tests (ares-test-mock.cc) that set up a fake DNS
server and inject its port into the c-ares library configuration.
These tests allow specific response messages to be crafted and
injected, and so are likely to be used for many more tests in
future.
- To make this generation/injection easier, the dns-proto.h file
includes C++ helper classes for building DNS packets.
- Other library entrypoints that don't require network activity
(e.g. ares_parse_*_reply) are tested directly.
- There are few tests of library-internal functions that are not
normally visible to API users (in ares-test-internal.cc).
- A couple of the tests use a helper method of the test fixture to
inject memory allocation failures, using the earlier change to the
library to allow override of malloc/realloc/free.
- There is also an entrypoint to allow Clang's libfuzzer to drive
the packet parsing code in ares_parse_*_reply, together with a
standalone wrapper for it (./aresfuzz) to allow use of afl-fuzz
for further fuzz testing.
9 years ago
|
|
|
#include "ares-test.h"
|
|
|
|
|
#include "dns-proto.h"
|
|
|
|
|
|
|
|
|
|
#include <sstream>
|
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
|
|
namespace ares {
|
|
|
|
|
namespace test {
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParseRootName) {
|
|
|
|
|
DNSPacket pkt;
|
|
|
|
|
pkt.set_qid(0x1234).set_response().set_aa()
|
|
|
|
|
.add_question(new DNSQuestion(".", ns_t_a))
|
|
|
|
|
.add_answer(new DNSARR(".", 100, {0x02, 0x03, 0x04, 0x05}));
|
test: Add initial unit tests for c-ares library
The tests are written in C++11, using the GoogleTest and GoogleMock
frameworks. They have their own independent autoconf setup, so that
users of the library need not have a C++ compiler just to get c-ares
working (however, the test/configure.ac file does assume the use of
a shared top-level m4/ directory). However, this autoconf setup has
only been tested on Linux and OSX so far.
Run with "./arestest", or "./arestest -v" to see extra debug info.
The GoogleTest options for running specific tests are also
available (e.g. "./arestest --gtest_filter=*Live*").
The tests are nowhere near complete yet (currently hitting around
60% coverage as reported by gcov), but they do include examples
of a few different styles of testing:
- There are live tests (ares-test-live.cc), which assume that the
current machine has a valid DNS setup and connection to the
internet; these tests issue queries for real domains but don't
particularly check what gets returned. The tests will fail on
an offline machine.
- There a few mock tests (ares-test-mock.cc) that set up a fake DNS
server and inject its port into the c-ares library configuration.
These tests allow specific response messages to be crafted and
injected, and so are likely to be used for many more tests in
future.
- To make this generation/injection easier, the dns-proto.h file
includes C++ helper classes for building DNS packets.
- Other library entrypoints that don't require network activity
(e.g. ares_parse_*_reply) are tested directly.
- There are few tests of library-internal functions that are not
normally visible to API users (in ares-test-internal.cc).
- A couple of the tests use a helper method of the test fixture to
inject memory allocation failures, using the earlier change to the
library to allow override of malloc/realloc/free.
- There is also an entrypoint to allow Clang's libfuzzer to drive
the packet parsing code in ares_parse_*_reply, together with a
standalone wrapper for it (./aresfuzz) to allow use of afl-fuzz
for further fuzz testing.
9 years ago
|
|
|
std::vector<byte> data = pkt.data();
|
|
|
|
|
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
EXPECT_EQ(1, count);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << HostEnt(host);
|
|
|
|
|
EXPECT_EQ("{'' aliases=[] addrs=[2.3.4.5]}", ss.str());
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParseIndirectRootName) {
|
|
|
|
|
std::vector<byte> data = {
|
|
|
|
|
0x12, 0x34, // qid
|
|
|
|
|
0x84, // response + query + AA + not-TC + not-RD
|
|
|
|
|
0x00, // not-RA + not-Z + not-AD + not-CD + rc=NoError
|
|
|
|
|
0x00, 0x01, // num questions
|
|
|
|
|
0x00, 0x01, // num answer RRs
|
|
|
|
|
0x00, 0x00, // num authority RRs
|
|
|
|
|
0x00, 0x00, // num additional RRs
|
|
|
|
|
// Question
|
|
|
|
|
0xC0, 0x04, // weird: pointer to a random zero earlier in the message
|
|
|
|
|
0x00, 0x01, // type A
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
// Answer 1
|
|
|
|
|
0xC0, 0x04,
|
|
|
|
|
0x00, 0x01, // RR type
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
0x01, 0x02, 0x03, 0x04, // TTL
|
|
|
|
|
0x00, 0x04, // rdata length
|
|
|
|
|
0x02, 0x03, 0x04, 0x05,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
EXPECT_EQ(1, count);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << HostEnt(host);
|
|
|
|
|
EXPECT_EQ("{'' aliases=[] addrs=[2.3.4.5]}", ss.str());
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParseEscapedName) {
|
|
|
|
|
std::vector<byte> data = {
|
|
|
|
|
0x12, 0x34, // qid
|
|
|
|
|
0x84, // response + query + AA + not-TC + not-RD
|
|
|
|
|
0x00, // not-RA + not-Z + not-AD + not-CD + rc=NoError
|
|
|
|
|
0x00, 0x01, // num questions
|
|
|
|
|
0x00, 0x01, // num answer RRs
|
|
|
|
|
0x00, 0x00, // num authority RRs
|
|
|
|
|
0x00, 0x00, // num additional RRs
|
|
|
|
|
// Question
|
|
|
|
|
0x05, 'a', '\\', 'b', '.', 'c',
|
|
|
|
|
0x03, 'c', 'o', 'm',
|
|
|
|
|
0x00,
|
|
|
|
|
0x00, 0x01, // type A
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
// Answer 1
|
|
|
|
|
0x05, 'a', '\\', 'b', '.', 'c',
|
|
|
|
|
0x03, 'c', 'o', 'm',
|
|
|
|
|
0x00,
|
|
|
|
|
0x00, 0x01, // RR type
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
0x01, 0x02, 0x03, 0x04, // TTL
|
|
|
|
|
0x00, 0x04, // rdata length
|
|
|
|
|
0x02, 0x03, 0x04, 0x05,
|
|
|
|
|
};
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
EXPECT_EQ(1, count);
|
|
|
|
|
HostEnt hent(host);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << hent;
|
|
|
|
|
// The printable name is expanded with escapes.
|
|
|
|
|
EXPECT_EQ(11, hent.name_.size());
|
|
|
|
|
EXPECT_EQ('a', hent.name_[0]);
|
|
|
|
|
EXPECT_EQ('\\', hent.name_[1]);
|
|
|
|
|
EXPECT_EQ('\\', hent.name_[2]);
|
|
|
|
|
EXPECT_EQ('b', hent.name_[3]);
|
|
|
|
|
EXPECT_EQ('\\', hent.name_[4]);
|
|
|
|
|
EXPECT_EQ('.', hent.name_[5]);
|
|
|
|
|
EXPECT_EQ('c', hent.name_[6]);
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParsePartialCompressedName) {
|
|
|
|
|
std::vector<byte> data = {
|
|
|
|
|
0x12, 0x34, // qid
|
|
|
|
|
0x84, // response + query + AA + not-TC + not-RD
|
|
|
|
|
0x00, // not-RA + not-Z + not-AD + not-CD + rc=NoError
|
|
|
|
|
0x00, 0x01, // num questions
|
|
|
|
|
0x00, 0x01, // num answer RRs
|
|
|
|
|
0x00, 0x00, // num authority RRs
|
|
|
|
|
0x00, 0x00, // num additional RRs
|
|
|
|
|
// Question
|
|
|
|
|
0x03, 'w', 'w', 'w',
|
|
|
|
|
0x07, 'e', 'x', 'a', 'm', 'p', 'l', 'e',
|
|
|
|
|
0x03, 'c', 'o', 'm',
|
|
|
|
|
0x00,
|
|
|
|
|
0x00, 0x01, // type A
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
// Answer 1
|
|
|
|
|
0x03, 'w', 'w', 'w',
|
|
|
|
|
0xc0, 0x10, // offset 16
|
|
|
|
|
0x00, 0x01, // RR type
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
0x01, 0x02, 0x03, 0x04, // TTL
|
|
|
|
|
0x00, 0x04, // rdata length
|
|
|
|
|
0x02, 0x03, 0x04, 0x05,
|
|
|
|
|
};
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
ASSERT_NE(nullptr, host);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << HostEnt(host);
|
|
|
|
|
EXPECT_EQ("{'www.example.com' aliases=[] addrs=[2.3.4.5]}", ss.str());
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParseFullyCompressedName) {
|
|
|
|
|
std::vector<byte> data = {
|
|
|
|
|
0x12, 0x34, // qid
|
|
|
|
|
0x84, // response + query + AA + not-TC + not-RD
|
|
|
|
|
0x00, // not-RA + not-Z + not-AD + not-CD + rc=NoError
|
|
|
|
|
0x00, 0x01, // num questions
|
|
|
|
|
0x00, 0x01, // num answer RRs
|
|
|
|
|
0x00, 0x00, // num authority RRs
|
|
|
|
|
0x00, 0x00, // num additional RRs
|
|
|
|
|
// Question
|
|
|
|
|
0x03, 'w', 'w', 'w',
|
|
|
|
|
0x07, 'e', 'x', 'a', 'm', 'p', 'l', 'e',
|
|
|
|
|
0x03, 'c', 'o', 'm',
|
|
|
|
|
0x00,
|
|
|
|
|
0x00, 0x01, // type A
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
// Answer 1
|
|
|
|
|
0xc0, 0x0c, // offset 12
|
|
|
|
|
0x00, 0x01, // RR type
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
0x01, 0x02, 0x03, 0x04, // TTL
|
|
|
|
|
0x00, 0x04, // rdata length
|
|
|
|
|
0x02, 0x03, 0x04, 0x05,
|
|
|
|
|
};
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
ASSERT_NE(nullptr, host);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << HostEnt(host);
|
|
|
|
|
EXPECT_EQ("{'www.example.com' aliases=[] addrs=[2.3.4.5]}", ss.str());
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, ParseFullyCompressedName2) {
|
|
|
|
|
std::vector<byte> data = {
|
|
|
|
|
0x12, 0x34, // qid
|
|
|
|
|
0x84, // response + query + AA + not-TC + not-RD
|
|
|
|
|
0x00, // not-RA + not-Z + not-AD + not-CD + rc=NoError
|
|
|
|
|
0x00, 0x01, // num questions
|
|
|
|
|
0x00, 0x01, // num answer RRs
|
|
|
|
|
0x00, 0x00, // num authority RRs
|
|
|
|
|
0x00, 0x00, // num additional RRs
|
|
|
|
|
// Question
|
|
|
|
|
0xC0, 0x12, // pointer to later in message
|
|
|
|
|
0x00, 0x01, // type A
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
// Answer 1
|
|
|
|
|
0x03, 'w', 'w', 'w',
|
|
|
|
|
0x07, 'e', 'x', 'a', 'm', 'p', 'l', 'e',
|
|
|
|
|
0x03, 'c', 'o', 'm',
|
|
|
|
|
0x00,
|
|
|
|
|
0x00, 0x01, // RR type
|
|
|
|
|
0x00, 0x01, // class IN
|
|
|
|
|
0x01, 0x02, 0x03, 0x04, // TTL
|
|
|
|
|
0x00, 0x04, // rdata length
|
|
|
|
|
0x02, 0x03, 0x04, 0x05,
|
|
|
|
|
};
|
|
|
|
|
struct hostent *host = nullptr;
|
|
|
|
|
struct ares_addrttl info[2];
|
|
|
|
|
int count = 2;
|
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_parse_a_reply(data.data(), data.size(),
|
|
|
|
|
&host, info, &count));
|
|
|
|
|
ASSERT_NE(nullptr, host);
|
|
|
|
|
std::stringstream ss;
|
|
|
|
|
ss << HostEnt(host);
|
|
|
|
|
EXPECT_EQ("{'www.example.com' aliases=[] addrs=[2.3.4.5]}", ss.str());
|
|
|
|
|
ares_free_hostent(host);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} // namespace test
|
|
|
|
|
} // namespace ares
|
