mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-09-08 18:45:27 +00:00
Code Issues Releases Wiki Activity
Files
7101eae6f4df8ec9dcfafa04cb1588f43bb138bc
bind/lib/dns/tests/dbiterator_test.c
Michał Kępień 59528d0e9d Include <sched.h> where necessary for musl libc 
All unit tests define the UNIT_TESTING macro, which causes <cmocka.h> to
replace malloc(), calloc(), realloc(), and free() with its own functions
tracking memory allocations.  In order for this not to break
compilation, the system header declaring the prototypes for these
standard functions must be included before <cmocka.h>.

Normally, these prototypes are only present in <stdlib.h>, so we make
sure it is included before <cmocka.h>.  However, musl libc also defines
the prototypes for calloc() and free() in <sched.h>, which is included
by <pthread.h>, which is included e.g. by <isc/mutex.h>.  Thus, unit
tests including "dnstest.h" (which includes <isc/mem.h>, which includes
<isc/mutex.h>) after <cmocka.h> will not compile with musl libc as for
these programs, <sched.h> will be included after <cmocka.h>.

Always including <cmocka.h> after all other header files is not a
feasible solution as that causes the mock assertion macros defined in
<isc/util.h> to mangle the contents of <cmocka.h>, thus breaking
compilation.  We cannot really use the __noreturn__ or analyzer_noreturn
attributes with cmocka assertion functions because they do return if the
tested condition is true.  The problem is that what BIND unit tests do
is incompatible with Clang Static Analyzer's assumptions: since we use
cmocka, our custom assertion handlers are present in a shared library
(i.e. it is the cmocka library that checks the assertion condition, not
a macro in unit test code).  Redefining cmocka's assertion macros in
<isc/util.h> is an ugly hack to overcome that problem - unfortunately,
this is the only way we can think of to make Clang Static Analyzer
properly process unit test code.  Giving up on Clang Static Analyzer
being able to properly process unit test code is not a satisfactory
solution.

Undefining _GNU_SOURCE for unit test code could work around the problem
(musl libc's <sched.h> only defines the prototypes for calloc() and
free() when _GNU_SOURCE is defined), but doing that could introduce
discrepancies for unit tests including entire *.c files, so it is also
not a good solution.

All in all, including <sched.h> before <cmocka.h> for all affected unit
tests seems to be the most benign way of working around this musl libc
quirk.  While quite an ugly solution, it achieves our goals here, which
are to keep the benefit of proper static analysis of unit test code and
to fix compilation against musl libc.
2019-07-30 21:08:40 +02:00

391 lines
8.6 KiB
C
Raw Blame History

/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
#if HAVE_CMOCKA
#include <stdarg.h>
#include <stddef.h>
#include <setjmp.h>
#include <sched.h> /* IWYU pragma: keep */
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#define UNIT_TESTING
#include <cmocka.h>
#include <isc/util.h>
#include <dns/db.h>
#include <dns/dbiterator.h>
#include <dns/name.h>
#include "dnstest.h"
#define BUFLEN 255
#define BIGBUFLEN (64 * 1024)
#define TEST_ORIGIN "test"
static int
_setup(void **state) {
isc_result_t result;
UNUSED(state);
result = dns_test_begin(NULL, false);
assert_int_equal(result, ISC_R_SUCCESS);
return (0);
}
static int
_teardown(void **state) {
UNUSED(state);
dns_test_end();
return (0);
}
static isc_result_t
make_name(const char *src, dns_name_t *name) {
isc_buffer_t b;
isc_buffer_constinit(&b, src, strlen(src));
isc_buffer_add(&b, strlen(src));
return (dns_name_fromtext(name, &b, dns_rootname, 0, NULL));
}
/* create: make sure we can create a dbiterator */
static void
test_create(const char *filename) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
create(void **state) {
UNUSED(state);
test_create("testdata/dbiterator/zone1.data");
}
static void
create_nsec3(void **state) {
UNUSED(state);
test_create("testdata/dbiterator/zone2.data");
}
/* walk: walk a database */
static void
test_walk(const char *filename, int nodes) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
dns_dbnode_t *node = NULL;
dns_name_t *name;
dns_fixedname_t f;
int i = 0;
name = dns_fixedname_initname(&f);
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
for (result = dns_dbiterator_first(iter);
result == ISC_R_SUCCESS;
result = dns_dbiterator_next(iter)) {
result = dns_dbiterator_current(iter, &node, name);
if (result == DNS_R_NEWORIGIN)
result = ISC_R_SUCCESS;
assert_int_equal(result, ISC_R_SUCCESS);
dns_db_detachnode(db, &node);
i++;
}
assert_int_equal(i, nodes);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
walk(void **state) {
UNUSED(state);
test_walk("testdata/dbiterator/zone1.data", 12);
}
static void
walk_nsec3(void **state) {
UNUSED(state);
test_walk("testdata/dbiterator/zone2.data", 33);
}
/* reverse: walk database backwards */
static void
test_reverse(const char *filename) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
dns_dbnode_t *node = NULL;
dns_name_t *name;
dns_fixedname_t f;
int i = 0;
name = dns_fixedname_initname(&f);
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
for (result = dns_dbiterator_last(iter);
result == ISC_R_SUCCESS;
result = dns_dbiterator_prev(iter)) {
result = dns_dbiterator_current(iter, &node, name);
if (result == DNS_R_NEWORIGIN)
result = ISC_R_SUCCESS;
assert_int_equal(result, ISC_R_SUCCESS);
dns_db_detachnode(db, &node);
i++;
}
assert_int_equal(i, 12);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
reverse(void **state) {
UNUSED(state);
test_reverse("testdata/dbiterator/zone1.data");
}
static void
reverse_nsec3(void **state) {
UNUSED(state);
test_reverse("testdata/dbiterator/zone2.data");
}
/* seek: walk database starting at a particular node */
static void
test_seek_node(const char *filename, int nodes) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
dns_dbnode_t *node = NULL;
dns_name_t *name, *seekname;
dns_fixedname_t f1, f2;
int i = 0;
name = dns_fixedname_initname(&f1);
seekname = dns_fixedname_initname(&f2);
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
result = make_name("c." TEST_ORIGIN, seekname);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_dbiterator_seek(iter, seekname);
assert_int_equal(result, ISC_R_SUCCESS);
while (result == ISC_R_SUCCESS) {
result = dns_dbiterator_current(iter, &node, name);
if (result == DNS_R_NEWORIGIN)
result = ISC_R_SUCCESS;
assert_int_equal(result, ISC_R_SUCCESS);
dns_db_detachnode(db, &node);
result = dns_dbiterator_next(iter);
i++;
}
assert_int_equal(i, nodes);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
seek_node(void **state) {
UNUSED(state);
test_seek_node("testdata/dbiterator/zone1.data", 9);
}
static void
seek_node_nsec3(void **state) {
UNUSED(state);
test_seek_node("testdata/dbiterator/zone2.data", 30);
}
/*
* seek_emty: walk database starting at an empty nonterminal node
* (should fail)
*/
static void
test_seek_empty(const char *filename) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
dns_name_t *seekname;
dns_fixedname_t f1;
seekname = dns_fixedname_initname(&f1);
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
result = make_name("d." TEST_ORIGIN, seekname);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_dbiterator_seek(iter, seekname);
assert_int_equal(result, DNS_R_PARTIALMATCH);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
seek_empty(void **state) {
UNUSED(state);
test_seek_empty("testdata/dbiterator/zone1.data");
}
static void
seek_empty_nsec3(void **state) {
UNUSED(state);
test_seek_empty("testdata/dbiterator/zone2.data");
}
/*
* seek_nx: walk database starting at a nonexistent node
*/
static void
test_seek_nx(const char *filename) {
isc_result_t result;
dns_db_t *db = NULL;
dns_dbiterator_t *iter = NULL;
dns_name_t *seekname;
dns_fixedname_t f1;
seekname = dns_fixedname_initname(&f1);
result = dns_test_loaddb(&db, dns_dbtype_cache, TEST_ORIGIN, filename);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_db_createiterator(db, 0, &iter);
assert_int_equal(result, ISC_R_SUCCESS);
result = make_name("nonexistent." TEST_ORIGIN, seekname);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_dbiterator_seek(iter, seekname);
assert_int_equal(result, DNS_R_PARTIALMATCH);
result = make_name("nonexistent.", seekname);
assert_int_equal(result, ISC_R_SUCCESS);
result = dns_dbiterator_seek(iter, seekname);
assert_int_equal(result, ISC_R_NOTFOUND);
dns_dbiterator_destroy(&iter);
dns_db_detach(&db);
}
static void
seek_nx(void **state) {
UNUSED(state);
test_seek_nx("testdata/dbiterator/zone1.data");
}
static void
seek_nx_nsec3(void **state) {
UNUSED(state);
test_seek_nx("testdata/dbiterator/zone2.data");
}
/*
* XXX:
* dns_dbiterator API calls that are not yet part of this unit test:
*
* dns_dbiterator_pause
* dns_dbiterator_origin
* dns_dbiterator_setcleanmode
*/
int
main(void) {
const struct CMUnitTest tests[] = {
cmocka_unit_test_setup_teardown(create, _setup, _teardown),
cmocka_unit_test_setup_teardown(create_nsec3,
_setup, _teardown),
cmocka_unit_test_setup_teardown(walk, _setup, _teardown),
cmocka_unit_test_setup_teardown(walk_nsec3, _setup, _teardown),
cmocka_unit_test_setup_teardown(reverse, _setup, _teardown),
cmocka_unit_test_setup_teardown(reverse_nsec3,
_setup, _teardown),
cmocka_unit_test_setup_teardown(seek_node, _setup, _teardown),
cmocka_unit_test_setup_teardown(seek_node_nsec3,
_setup, _teardown),
cmocka_unit_test_setup_teardown(seek_empty, _setup, _teardown),
cmocka_unit_test_setup_teardown(seek_empty_nsec3,
_setup, _teardown),
cmocka_unit_test_setup_teardown(seek_nx, _setup, _teardown),
cmocka_unit_test_setup_teardown(seek_nx_nsec3,
_setup, _teardown),
};
return (cmocka_run_group_tests(tests, NULL, NULL));
}
#else /* HAVE_CMOCKA */
#include <stdio.h>
int
main(void) {
printf("1..0 # Skipped: cmocka not available\n");
return (0);
}
#endif
Reference in New Issue View Git Blame Copy Permalink