mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-08-22 10:10:06 +00:00
63fe9312ff
The unit tests contain a lot of duplicated code and here's an attempt
to reduce code duplication.
This commit does several things:
1. Remove #ifdef HAVE_CMOCKA - we already solve this with automake
conditionals.
2. Create a set of ISC_TEST_* and ISC_*_TEST_ macros to wrap the test
implementations, test lists, and the main test routine, so we don't
have to repeat this all over again. The macros were modeled after
libuv test suite but adapted to cmocka as the test driver.
A simple example of a unit test would be:
ISC_RUN_TEST_IMPL(test1) { assert_true(true); }
ISC_TEST_LIST_START
ISC_TEST_ENTRY(test1)
ISC_TEST_LIST_END
ISC_TEST_MAIN (Discussion: Should this be ISC_TEST_RUN ?)
For more complicated examples including group setup and teardown
functions, and per-test setup and teardown functions.
3. The macros prefix the test functions and cmocka entries, so the name
of the test can now match the tested function name, and we don't have
to append `_test` because `run_test_` is automatically prepended to
the main test function, and `setup_test_` and `teardown_test_` is
prepended to setup and teardown function.
4. Update all the unit tests to use the new syntax and fix a few bits
here and there.
5. In the future, we can separate the test declarations and test
implementations which are going to greatly help with uncluttering the
bigger unit tests like doh_test and netmgr_test, because the test
implementations are not declared static (see `ISC_RUN_TEST_DECLARE`
and `ISC_RUN_TEST_IMPL` for more details.
NOTE: This heavily relies on preprocessor macros, but the result greatly
outweighs all the negatives of using the macros. There's less
duplicated code, the tests are more uniform and the implementation can
be more flexible.
266 lines
7.0 KiB
C
266 lines
7.0 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* SPDX-License-Identifier: MPL-2.0
|
|
*
|
|
* 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 https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#include <inttypes.h>
|
|
#include <sched.h> /* IWYU pragma: keep */
|
|
#include <setjmp.h>
|
|
#include <stdarg.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
|
|
#define UNIT_TESTING
|
|
#include <cmocka.h>
|
|
|
|
#include <isc/print.h>
|
|
#include <isc/util.h>
|
|
|
|
#include <dns/stats.h>
|
|
|
|
#include <dns/test.h>
|
|
|
|
static void
|
|
set_typestats(dns_stats_t *stats, dns_rdatatype_t type) {
|
|
dns_rdatastatstype_t which;
|
|
unsigned int attributes;
|
|
|
|
attributes = 0;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR_NXRRSET;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
}
|
|
|
|
static void
|
|
set_nxdomainstats(dns_stats_t *stats) {
|
|
dns_rdatastatstype_t which;
|
|
unsigned int attributes;
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR_NXDOMAIN;
|
|
which = DNS_RDATASTATSTYPE_VALUE(0, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
}
|
|
|
|
static void
|
|
mark_stale(dns_stats_t *stats, dns_rdatatype_t type, int from, int to) {
|
|
dns_rdatastatstype_t which;
|
|
unsigned int attributes;
|
|
|
|
attributes = from;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_decrement(stats, which);
|
|
|
|
attributes |= to;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR_NXRRSET | from;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_decrement(stats, which);
|
|
|
|
attributes |= to;
|
|
which = DNS_RDATASTATSTYPE_VALUE(type, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
}
|
|
|
|
static void
|
|
mark_nxdomain_stale(dns_stats_t *stats, int from, int to) {
|
|
dns_rdatastatstype_t which;
|
|
unsigned int attributes;
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR_NXDOMAIN | from;
|
|
which = DNS_RDATASTATSTYPE_VALUE(0, attributes);
|
|
dns_rdatasetstats_decrement(stats, which);
|
|
|
|
attributes |= to;
|
|
which = DNS_RDATASTATSTYPE_VALUE(0, attributes);
|
|
dns_rdatasetstats_increment(stats, which);
|
|
}
|
|
|
|
#define ATTRIBUTE_SET(y) ((attributes & (y)) != 0)
|
|
static void
|
|
verify_active_counters(dns_rdatastatstype_t which, uint64_t value, void *arg) {
|
|
unsigned int attributes;
|
|
#if debug
|
|
unsigned int type;
|
|
#endif /* if debug */
|
|
|
|
UNUSED(which);
|
|
UNUSED(arg);
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR(which);
|
|
#if debug
|
|
type = DNS_RDATASTATSTYPE_BASE(which);
|
|
|
|
fprintf(stderr, "%s%s%s%s%s/%u, %u\n",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_OTHERTYPE) ? "O" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXRRSET) ? "!" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_ANCIENT) ? "~" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_STALE) ? "#" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXDOMAIN) ? "X" : " ",
|
|
type, (unsigned)value);
|
|
#endif /* if debug */
|
|
if ((attributes & DNS_RDATASTATSTYPE_ATTR_ANCIENT) == 0 &&
|
|
(attributes & DNS_RDATASTATSTYPE_ATTR_STALE) == 0)
|
|
{
|
|
assert_int_equal(value, 1);
|
|
} else {
|
|
assert_int_equal(value, 0);
|
|
}
|
|
}
|
|
|
|
static void
|
|
verify_stale_counters(dns_rdatastatstype_t which, uint64_t value, void *arg) {
|
|
unsigned int attributes;
|
|
#if debug
|
|
unsigned int type;
|
|
#endif /* if debug */
|
|
|
|
UNUSED(which);
|
|
UNUSED(arg);
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR(which);
|
|
#if debug
|
|
type = DNS_RDATASTATSTYPE_BASE(which);
|
|
|
|
fprintf(stderr, "%s%s%s%s%s/%u, %u\n",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_OTHERTYPE) ? "O" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXRRSET) ? "!" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_ANCIENT) ? "~" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_STALE) ? "#" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXDOMAIN) ? "X" : " ",
|
|
type, (unsigned)value);
|
|
#endif /* if debug */
|
|
if ((attributes & DNS_RDATASTATSTYPE_ATTR_STALE) != 0) {
|
|
assert_int_equal(value, 1);
|
|
} else {
|
|
assert_int_equal(value, 0);
|
|
}
|
|
}
|
|
|
|
static void
|
|
verify_ancient_counters(dns_rdatastatstype_t which, uint64_t value, void *arg) {
|
|
unsigned int attributes;
|
|
#if debug
|
|
unsigned int type;
|
|
#endif /* if debug */
|
|
|
|
UNUSED(which);
|
|
UNUSED(arg);
|
|
|
|
attributes = DNS_RDATASTATSTYPE_ATTR(which);
|
|
#if debug
|
|
type = DNS_RDATASTATSTYPE_BASE(which);
|
|
|
|
fprintf(stderr, "%s%s%s%s%s/%u, %u\n",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_OTHERTYPE) ? "O" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXRRSET) ? "!" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_ANCIENT) ? "~" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_STALE) ? "#" : " ",
|
|
ATTRIBUTE_SET(DNS_RDATASTATSTYPE_ATTR_NXDOMAIN) ? "X" : " ",
|
|
type, (unsigned)value);
|
|
#endif /* if debug */
|
|
if ((attributes & DNS_RDATASTATSTYPE_ATTR_ANCIENT) != 0) {
|
|
assert_int_equal(value, 1);
|
|
} else {
|
|
assert_int_equal(value, 0);
|
|
}
|
|
}
|
|
/*
|
|
* Individual unit tests
|
|
*/
|
|
|
|
/*
|
|
* Test that rdatasetstats counters are properly set when moving from
|
|
* active -> stale -> ancient.
|
|
*/
|
|
static void
|
|
rdatasetstats(void **state, bool servestale) {
|
|
unsigned int i;
|
|
unsigned int from = 0;
|
|
dns_stats_t *stats = NULL;
|
|
isc_result_t result;
|
|
|
|
UNUSED(state);
|
|
|
|
result = dns_rdatasetstats_create(mctx, &stats);
|
|
assert_int_equal(result, ISC_R_SUCCESS);
|
|
|
|
/* First 255 types. */
|
|
for (i = 1; i <= 255; i++) {
|
|
set_typestats(stats, (dns_rdatatype_t)i);
|
|
}
|
|
/* Specials */
|
|
set_typestats(stats, (dns_rdatatype_t)1000);
|
|
set_nxdomainstats(stats);
|
|
|
|
/* Check that all active counters are set to appropriately. */
|
|
dns_rdatasetstats_dump(stats, verify_active_counters, NULL, 1);
|
|
|
|
if (servestale) {
|
|
/* Mark stale */
|
|
for (i = 1; i <= 255; i++) {
|
|
mark_stale(stats, (dns_rdatatype_t)i, 0,
|
|
DNS_RDATASTATSTYPE_ATTR_STALE);
|
|
}
|
|
mark_stale(stats, (dns_rdatatype_t)1000, 0,
|
|
DNS_RDATASTATSTYPE_ATTR_STALE);
|
|
mark_nxdomain_stale(stats, 0, DNS_RDATASTATSTYPE_ATTR_STALE);
|
|
|
|
/* Check that all counters are set to appropriately. */
|
|
dns_rdatasetstats_dump(stats, verify_stale_counters, NULL, 1);
|
|
|
|
/* Set correct staleness state */
|
|
from = DNS_RDATASTATSTYPE_ATTR_STALE;
|
|
}
|
|
|
|
/* Mark ancient */
|
|
for (i = 1; i <= 255; i++) {
|
|
mark_stale(stats, (dns_rdatatype_t)i, from,
|
|
DNS_RDATASTATSTYPE_ATTR_ANCIENT);
|
|
}
|
|
mark_stale(stats, (dns_rdatatype_t)1000, from,
|
|
DNS_RDATASTATSTYPE_ATTR_ANCIENT);
|
|
mark_nxdomain_stale(stats, from, DNS_RDATASTATSTYPE_ATTR_ANCIENT);
|
|
|
|
/*
|
|
* Check that all counters are set to appropriately.
|
|
*/
|
|
dns_rdatasetstats_dump(stats, verify_ancient_counters, NULL, 1);
|
|
|
|
dns_stats_detach(&stats);
|
|
}
|
|
|
|
/*
|
|
* Test that rdatasetstats counters are properly set when moving from
|
|
* active -> stale -> ancient.
|
|
*/
|
|
ISC_RUN_TEST_IMPL(active_stale_ancient) { rdatasetstats(state, true); }
|
|
|
|
/*
|
|
* Test that rdatasetstats counters are properly set when moving from
|
|
* active -> ancient.
|
|
*/
|
|
ISC_RUN_TEST_IMPL(active_ancient) { rdatasetstats(state, false); }
|
|
|
|
ISC_TEST_LIST_START
|
|
ISC_TEST_ENTRY(active_stale_ancient)
|
|
ISC_TEST_ENTRY(active_ancient)
|
|
ISC_TEST_LIST_END
|
|
|
|
ISC_TEST_MAIN
|