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"
|
|
|
|
|
|
|
|
// library initialization is only needed for windows builds
|
|
|
|
#ifdef USE_WINSOCK
|
|
|
|
#define EXPECTED_NONINIT ARES_ENOTINITIALIZED
|
|
|
|
#else
|
|
|
|
#define EXPECTED_NONINIT ARES_SUCCESS
|
|
|
|
#endif
|
|
|
|
|
|
|
|
namespace ares {
|
|
|
|
namespace test {
|
|
|
|
|
|
|
|
TEST(LibraryInit, Basic) {
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_init(ARES_LIB_INIT_ALL));
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_initialized());
|
|
|
|
ares_library_cleanup();
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(LibraryInit, UnexpectedCleanup) {
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
ares_library_cleanup();
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
}
|
|
|
|
|
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
|
|
|
TEST(LibraryInit, DISABLED_InvalidParam) {
|
|
|
|
// TODO: police flags argument to ares_library_init()
|
|
|
|
EXPECT_EQ(ARES_EBADQUERY, ares_library_init(ARES_LIB_INIT_ALL << 2));
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
ares_library_cleanup();
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST(LibraryInit, Nested) {
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_init(ARES_LIB_INIT_ALL));
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_initialized());
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_init(ARES_LIB_INIT_ALL));
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_initialized());
|
|
|
|
ares_library_cleanup();
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_initialized());
|
|
|
|
ares_library_cleanup();
|
|
|
|
EXPECT_EQ(EXPECTED_NONINIT, ares_library_initialized());
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, BasicChannelInit) {
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_library_init(ARES_LIB_INIT_ALL));
|
|
|
|
ares_channel channel = nullptr;
|
|
|
|
EXPECT_EQ(ARES_SUCCESS, ares_init(&channel));
|
|
|
|
EXPECT_NE(nullptr, channel);
|
|
|
|
ares_destroy(channel);
|
|
|
|
ares_library_cleanup();
|
|
|
|
}
|
|
|
|
|
|
|
|
TEST_F(LibraryTest, FailChannelInit) {
|
|
|
|
EXPECT_EQ(ARES_SUCCESS,
|
|
|
|
ares_library_init_mem(ARES_LIB_INIT_ALL,
|
|
|
|
&LibraryTest::amalloc,
|
|
|
|
&LibraryTest::afree,
|
|
|
|
&LibraryTest::arealloc));
|
|
|
|
SetAllocFail(1);
|
|
|
|
ares_channel channel = nullptr;
|
|
|
|
EXPECT_EQ(ARES_ENOMEM, ares_init(&channel));
|
|
|
|
EXPECT_EQ(nullptr, channel);
|
|
|
|
ares_library_cleanup();
|
|
|
|
}
|
|
|
|
|
|
|
|
#ifdef USE_WINSOCK
|
|
|
|
TEST(Init, NoLibraryInit) {
|
|
|
|
ares_channel channel = nullptr;
|
|
|
|
EXPECT_EQ(ARES_ENOTINITIALIZED, ares_init(&channel));
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
} // namespace test
|
|
|
|
} // namespace ares
|