mirror of
https://github.com/isc-projects/bind9.git
synced 2026-04-12 20:46:14 -04:00
59528d0e9d
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.
363 lines
7.5 KiB
C
363 lines
7.5 KiB
C
/*
|
|
* 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 <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
|
|
#define UNIT_TESTING
|
|
#include <cmocka.h>
|
|
|
|
#include <isc/print.h>
|
|
#include <isc/string.h>
|
|
#include <isc/types.h>
|
|
#include <isc/util.h>
|
|
|
|
#include <dns/geoip.h>
|
|
|
|
#include "dnstest.h"
|
|
|
|
#if defined(HAVE_GEOIP2)
|
|
#include <maxminddb.h>
|
|
|
|
/* Use GeoIP2 databases from the 'geoip2' system test */
|
|
#define TEST_GEOIP_DATA "../../../bin/tests/system/geoip2/data"
|
|
|
|
static dns_geoip_databases_t geoip;
|
|
|
|
static MMDB_s geoip_country, geoip_city, geoip_as, geoip_isp, geoip_domain;
|
|
|
|
static void load_geoip(const char *dir);
|
|
static void close_geoip(void);
|
|
|
|
static int
|
|
_setup(void **state) {
|
|
isc_result_t result;
|
|
|
|
UNUSED(state);
|
|
|
|
result = dns_test_begin(NULL, false);
|
|
assert_int_equal(result, ISC_R_SUCCESS);
|
|
|
|
/* Use databases from the geoip system test */
|
|
load_geoip(TEST_GEOIP_DATA);
|
|
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
_teardown(void **state) {
|
|
UNUSED(state);
|
|
|
|
close_geoip();
|
|
|
|
dns_test_end();
|
|
|
|
return (0);
|
|
}
|
|
|
|
static MMDB_s *
|
|
open_geoip2(const char *dir, const char *dbfile, MMDB_s *mmdb) {
|
|
char pathbuf[PATH_MAX];
|
|
int ret;
|
|
|
|
snprintf(pathbuf, sizeof(pathbuf), "%s/%s", dir, dbfile);
|
|
ret = MMDB_open(pathbuf, MMDB_MODE_MMAP, mmdb);
|
|
if (ret == MMDB_SUCCESS) {
|
|
return (mmdb);
|
|
}
|
|
|
|
return (NULL);
|
|
}
|
|
|
|
static void
|
|
load_geoip(const char *dir) {
|
|
geoip.country = open_geoip2(dir, "GeoIP2-Country.mmdb",
|
|
&geoip_country);
|
|
geoip.city = open_geoip2(dir, "GeoIP2-City.mmdb", &geoip_city);
|
|
geoip.as = open_geoip2(dir, "GeoLite2-ASN.mmdb", &geoip_as);
|
|
geoip.isp = open_geoip2(dir, "GeoIP2-ISP.mmdb", &geoip_isp);
|
|
geoip.domain = open_geoip2(dir, "GeoIP2-Domain.mmdb", &geoip_domain);
|
|
}
|
|
|
|
static void
|
|
close_geoip(void) {
|
|
MMDB_close(&geoip_country);
|
|
MMDB_close(&geoip_city);
|
|
MMDB_close(&geoip_as);
|
|
MMDB_close(&geoip_isp);
|
|
MMDB_close(&geoip_domain);
|
|
}
|
|
|
|
static bool
|
|
do_lookup_string(const char *addr, dns_geoip_subtype_t subtype,
|
|
const char *string)
|
|
{
|
|
dns_geoip_elem_t elt;
|
|
struct in_addr in4;
|
|
isc_netaddr_t na;
|
|
|
|
inet_pton(AF_INET, addr, &in4);
|
|
isc_netaddr_fromin(&na, &in4);
|
|
|
|
elt.subtype = subtype;
|
|
strlcpy(elt.as_string, string, sizeof(elt.as_string));
|
|
|
|
return (dns_geoip_match(&na, &geoip, &elt));
|
|
}
|
|
|
|
static bool
|
|
do_lookup_string_v6(const char *addr, dns_geoip_subtype_t subtype,
|
|
const char *string)
|
|
{
|
|
dns_geoip_elem_t elt;
|
|
struct in6_addr in6;
|
|
isc_netaddr_t na;
|
|
|
|
inet_pton(AF_INET6, addr, &in6);
|
|
isc_netaddr_fromin6(&na, &in6);
|
|
|
|
elt.subtype = subtype;
|
|
strlcpy(elt.as_string, string, sizeof(elt.as_string));
|
|
|
|
return (dns_geoip_match(&na, &geoip, &elt));
|
|
}
|
|
|
|
/* GeoIP country matching */
|
|
static void
|
|
country(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.country == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.1", dns_geoip_country_code, "AU");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_country_name, "Australia");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("192.0.2.128", dns_geoip_country_code, "O1");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("192.0.2.128",
|
|
dns_geoip_country_name, "Other");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP country (ipv6) matching */
|
|
static void
|
|
country_v6(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.country == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_country_code, "AU");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_country_name, "Australia");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP city (ipv4) matching */
|
|
static void
|
|
city(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.city == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_continentcode, "NA");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_countrycode, "US");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_countryname, "United States");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_region, "CA");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_regionname, "California");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_name, "Redwood City");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string("10.53.0.1",
|
|
dns_geoip_city_postalcode, "94063");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP city (ipv6) matching */
|
|
static void
|
|
city_v6(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.city == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_continentcode, "NA");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_countrycode, "US");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_countryname,
|
|
"United States");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_region, "CA");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_regionname, "California");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_name, "Redwood City");
|
|
assert_true(match);
|
|
|
|
match = do_lookup_string_v6("fd92:7065:b8e:ffff::1",
|
|
dns_geoip_city_postalcode, "94063");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP asnum matching */
|
|
static void
|
|
asnum(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.as == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.3", dns_geoip_as_asnum, "AS100003");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP isp matching */
|
|
static void
|
|
isp(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.isp == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.1", dns_geoip_isp_name,
|
|
"One Systems, Inc.");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP org matching */
|
|
static void
|
|
org(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.as == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.2", dns_geoip_org_name,
|
|
"Two Technology Ltd.");
|
|
assert_true(match);
|
|
}
|
|
|
|
/* GeoIP domain matching */
|
|
static void
|
|
domain(void **state) {
|
|
bool match;
|
|
|
|
UNUSED(state);
|
|
|
|
if (geoip.domain == NULL) {
|
|
skip();
|
|
}
|
|
|
|
match = do_lookup_string("10.53.0.5",
|
|
dns_geoip_domain_name, "five.es");
|
|
assert_true(match);
|
|
}
|
|
#endif /* HAVE_GEOIP2 */
|
|
|
|
int
|
|
main(void) {
|
|
#if defined(HAVE_GEOIP2)
|
|
const struct CMUnitTest tests[] = {
|
|
cmocka_unit_test_setup_teardown(country, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(country_v6, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(city, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(city_v6, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(asnum, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(isp, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(org, _setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(domain, _setup, _teardown),
|
|
};
|
|
|
|
return (cmocka_run_group_tests(tests, NULL, NULL));
|
|
#else
|
|
print_message("1..0 # Skip GeoIP not enabled\n");
|
|
#endif
|
|
}
|
|
|
|
#else /* HAVE_CMOCKA */
|
|
|
|
#include <stdio.h>
|
|
|
|
int
|
|
main(void) {
|
|
printf("1..0 # Skipped: cmocka not available\n");
|
|
return (0);
|
|
}
|
|
|
|
#endif /* HAVE_CMOCKA */
|