bind9/tests/include/tests/ns.h
Colin Vidal 1114b1eac0 add query unit test
A new query unit test covers the logic where zone hooks must be called
first, then view ones, and finally the default hooks. It also ensures
that if any hook returns NS_HOOK_RETURN the chain immediately stops.
2025-09-09 09:42:34 +02:00

131 lines
3.2 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.
*/
#pragma once
/*! \file */
#include <inttypes.h>
#include <stdbool.h>
#include <isc/buffer.h>
#include <isc/hash.h>
#include <isc/log.h>
#include <isc/loop.h>
#include <isc/mem.h>
#include <isc/result.h>
#include <isc/string.h>
#include <isc/timer.h>
#include <isc/util.h>
#include <dns/zone.h>
#include <ns/client.h>
#include <ns/hooks.h>
#include <ns/interfacemgr.h>
#include <tests/dns.h>
typedef struct ns_test_id {
const char *description;
int lineno;
} ns_test_id_t;
#define NS_TEST_ID(desc) { .description = desc, .lineno = __LINE__ }
extern dns_dispatchmgr_t *dispatchmgr;
extern ns_interfacemgr_t *interfacemgr;
extern ns_server_t *sctx;
extern atomic_uint_fast32_t client_refs[32];
extern atomic_uintptr_t client_addrs[32];
#if ISC_NETMGR_TRACE
#define FLARG \
, const char *file ISC_ATTR_UNUSED, unsigned int line ISC_ATTR_UNUSED, \
const char *func ISC_ATTR_UNUSED
#else
#define FLARG
#endif
int
setup_server(void **state);
int
teardown_server(void **state);
void
shutdown_interfacemgr(void *arg ISC_ATTR_UNUSED);
/*%
* Load data for zone "zonename" from file "filename" and start serving it to
* clients matching "view". Only one zone loaded using this function can be
* served at any given time.
*/
isc_result_t
ns_test_serve_zone(const char *zonename, const char *filename,
dns_view_t *view);
/*%
* Set a hooktable on the served zone
*/
void
ns_test_serve_zone_sethooktab(ns_hooktable_t *hooktab);
/*%
* Release the zone loaded by ns_test_serve_zone().
*/
void
ns_test_cleanup_zone(void);
isc_result_t
ns_test_loaddb(dns_db_t **db, dns_dbtype_t dbtype, const char *origin,
const char *testfile);
isc_result_t
ns_test_getdata(const char *file, unsigned char *buf, size_t bufsiz,
size_t *sizep);
void
ns_test_getclient(ns_interface_t *ifp0, bool tcp, ns_client_t **clientp);
/*%
* Structure containing parameters for ns_test_qctx_create().
*/
typedef struct ns_test_qctx_create_params {
const char *qname;
dns_rdatatype_t qtype;
unsigned int qflags;
bool with_cache;
} ns_test_qctx_create_params_t;
/*%
* Prepare a query context identical with one that would be prepared if a query
* with given QNAME, QTYPE and flags was received from a client. Recursion is
* assumed to be allowed for this client. If "with_cache" is set to true,
* a cache database will be created and associated with the view matching the
* incoming query.
*/
isc_result_t
ns_test_qctx_create(const ns_test_qctx_create_params_t *params,
query_ctx_t **qctxp);
/*%
* Destroy a query context created by ns_test_qctx_create().
*/
void
ns_test_qctx_destroy(query_ctx_t **qctxp);
/*%
* A hook callback interrupting execution at given hook's insertion point.
*/
ns_hookresult_t
ns_test_hook_catch_call(void *arg, void *data, isc_result_t *resultp);