bind9/tests/dns/dbversion_test.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 <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#define UNIT_TESTING
#include <cmocka.h>

#include <isc/file.h>
#include <isc/result.h>
#include <isc/serial.h>
#include <isc/stdtime.h>
#include <isc/string.h>
#include <isc/util.h>

#include <dns/db.h>
#include <dns/nsec3.h>
#include <dns/rdatalist.h>
#include <dns/rdataset.h>
#include <dns/rdatasetiter.h>

#include <tests/dns.h>

static char tempname[11] = "dtXXXXXXXX";
static dns_db_t *db1 = NULL, *db2 = NULL;
static dns_dbversion_t *v1 = NULL, *v2 = NULL;

/*
 * The code below enables us to trap assertion failures for testing
 * purposes. local_callback() is set as the callback function for
 * isc_assertion_failed(). It calls mock_assert() so that CMOCKA
 * will be able to see it, then returns to the calling function via
 * longjmp() so that the abort() call in isc_assertion_failed() will
 * never be reached. Use check_assertion() to check for assertions
 * instead of expect_assert_failure().
 */
jmp_buf assertion;

#define check_assertion(function_call)                        \
	do {                                                  \
		const int r = setjmp(assertion);              \
		if (r == 0) {                                 \
			expect_assert_failure(function_call); \
		}                                             \
	} while (false);

static void
local_callback(const char *file, int line, isc_assertiontype_t type,
	       const char *cond) {
	UNUSED(type);

	mock_assert(1, cond, file, line);
	longjmp(assertion, 1);
}

static int
setup_test(void **state) {
	isc_result_t res;

	UNUSED(state);

	isc_assertion_setcallback(local_callback);

	res = dns_db_create(mctx, ZONEDB_DEFAULT, dns_rootname, dns_dbtype_zone,
			    dns_rdataclass_in, 0, NULL, &db1);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_newversion(db1, &v1);
	assert_non_null(v1);

	res = dns_db_create(mctx, ZONEDB_DEFAULT, dns_rootname, dns_dbtype_zone,
			    dns_rdataclass_in, 0, NULL, &db2);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_newversion(db2, &v2);
	assert_non_null(v1);

	return 0;
}

static int
teardown_test(void **state) {
	UNUSED(state);

	if (strcmp(tempname, "dtXXXXXXXX") != 0) {
		unlink(tempname);
	}

	if (v1 != NULL) {
		dns_db_closeversion(db1, &v1, false);
		assert_null(v1);
	}
	if (db1 != NULL) {
		dns_db_detach(&db1);
		assert_null(db1);
	}

	if (v2 != NULL) {
		dns_db_closeversion(db2, &v2, false);
		assert_null(v2);
	}
	if (db2 != NULL) {
		dns_db_detach(&db2);
		assert_null(db2);
	}

	return 0;
}

/*
 * Check dns_db_attachversion() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(attachversion) {
	dns_dbversion_t *v = NULL;

	UNUSED(state);

	dns_db_attachversion(db1, v1, &v);
	assert_ptr_equal(v, v1);
	dns_db_closeversion(db1, &v, false);
	assert_null(v);

	check_assertion(dns_db_attachversion(db1, v2, &v));
}

/*
 * Check dns_db_closeversion() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(closeversion) {
	UNUSED(state);

	assert_non_null(v1);
	dns_db_closeversion(db1, &v1, false);
	assert_null(v1);

	check_assertion(dns_db_closeversion(db1, &v2, false));
}

/*
 * Check dns_db_find() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(find) {
	isc_result_t res;
	dns_rdataset_t rdataset;
	dns_fixedname_t fixed;
	dns_name_t *name = NULL;

	UNUSED(state);

	name = dns_fixedname_initname(&fixed);

	dns_rdataset_init(&rdataset);
	res = dns_db_find(db1, dns_rootname, v1, dns_rdatatype_soa, 0, 0, NULL,
			  name, &rdataset, NULL);
	/*
	 * Note: in the QPzone database, the root node always exists,
	 * even if it's empty, so we would get DNS_R_NXRRSET from this
	 * query. In other databases (including the old RBTDB) the root
	 * node can be nonexistent, and the query would then return
	 * DNS_R_NXDOMAIN. Allow for both possibilities.
	 */
	assert_true(res == DNS_R_NXRRSET || res == DNS_R_NXDOMAIN);

	if (dns_rdataset_isassociated(&rdataset)) {
		dns_rdataset_disassociate(&rdataset);
	}

	dns_rdataset_init(&rdataset);
	check_assertion((void)dns_db_find(db1, dns_rootname, v2,
					  dns_rdatatype_soa, 0, 0, NULL, name,
					  &rdataset, NULL));
}

/*
 * Check dns_db_allrdatasets() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(allrdatasets) {
	isc_result_t res;
	dns_dbnode_t *node = NULL;
	dns_rdatasetiter_t *iterator = NULL;

	UNUSED(state);

	res = dns_db_findnode(db1, dns_rootname, false, &node);
	assert_int_equal(res, ISC_R_SUCCESS);

	res = dns_db_allrdatasets(db1, node, v1, 0, 0, &iterator);
	assert_int_equal(res, ISC_R_SUCCESS);

	check_assertion(dns_db_allrdatasets(db1, node, v2, 0, 0, &iterator));

	dns_rdatasetiter_destroy(&iterator);
	assert_null(iterator);

	dns_db_detachnode(db1, &node);
	assert_null(node);
}

/*
 * Check dns_db_findrdataset() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(findrdataset) {
	isc_result_t res;
	dns_rdataset_t rdataset;
	dns_dbnode_t *node = NULL;

	UNUSED(state);

	res = dns_db_findnode(db1, dns_rootname, false, &node);
	assert_int_equal(res, ISC_R_SUCCESS);

	dns_rdataset_init(&rdataset);
	res = dns_db_findrdataset(db1, node, v1, dns_rdatatype_soa, 0, 0,
				  &rdataset, NULL);
	assert_int_equal(res, ISC_R_NOTFOUND);

	if (dns_rdataset_isassociated(&rdataset)) {
		dns_rdataset_disassociate(&rdataset);
	}

	dns_rdataset_init(&rdataset);
	check_assertion(dns_db_findrdataset(db1, node, v2, dns_rdatatype_soa, 0,
					    0, &rdataset, NULL));

	dns_db_detachnode(db1, &node);
	assert_null(node);
}

/*
 * Check dns_db_deleterdataset() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(deleterdataset) {
	isc_result_t res;
	dns_dbnode_t *node = NULL;

	UNUSED(state);

	res = dns_db_findnode(db1, dns_rootname, false, &node);
	assert_int_equal(res, ISC_R_SUCCESS);

	res = dns_db_deleterdataset(db1, node, v1, dns_rdatatype_soa, 0);
	assert_int_equal(res, DNS_R_UNCHANGED);

	check_assertion(
		dns_db_deleterdataset(db1, node, v2, dns_rdatatype_soa, 0));
	dns_db_detachnode(db1, &node);
	assert_null(node);
}

/*
 * Check dns_db_subtractrdataset() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(subtract) {
	isc_result_t res;
	dns_rdataset_t rdataset;
	dns_rdatalist_t rdatalist;
	dns_dbnode_t *node = NULL;

	UNUSED(state);

	dns_rdataset_init(&rdataset);
	dns_rdatalist_init(&rdatalist);

	rdatalist.rdclass = dns_rdataclass_in;

	dns_rdatalist_tordataset(&rdatalist, &rdataset);

	res = dns_db_findnode(db1, dns_rootname, false, &node);
	assert_int_equal(res, ISC_R_SUCCESS);

	res = dns_db_subtractrdataset(db1, node, v1, &rdataset, 0, NULL);
	assert_int_equal(res, DNS_R_UNCHANGED);

	if (dns_rdataset_isassociated(&rdataset)) {
		dns_rdataset_disassociate(&rdataset);
	}

	dns_rdataset_init(&rdataset);
	dns_rdatalist_tordataset(&rdatalist, &rdataset);

	check_assertion(
		dns_db_subtractrdataset(db1, node, v2, &rdataset, 0, NULL));

	dns_db_detachnode(db1, &node);
	assert_null(node);
}

/*
 * Check dns_db_addrdataset() passes with matching db and version, and
 * asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(addrdataset) {
	isc_result_t res;
	dns_rdataset_t rdataset;
	dns_dbnode_t *node = NULL;
	dns_rdatalist_t rdatalist;

	UNUSED(state);

	dns_rdataset_init(&rdataset);
	dns_rdatalist_init(&rdatalist);

	rdatalist.rdclass = dns_rdataclass_in;

	dns_rdatalist_tordataset(&rdatalist, &rdataset);

	res = dns_db_findnode(db1, dns_rootname, false, &node);
	assert_int_equal(res, ISC_R_SUCCESS);

	res = dns_db_addrdataset(db1, node, v1, 0, &rdataset, 0, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);

	check_assertion(
		dns_db_addrdataset(db1, node, v2, 0, &rdataset, 0, NULL));

	dns_db_detachnode(db1, &node);
	assert_null(node);
}

/*
 * Check dns_db_getnsec3parameters() passes with matching db and version,
 * and asserts with mis-matching db and version.
 */
ISC_RUN_TEST_IMPL(getnsec3parameters) {
	isc_result_t res;
	dns_hash_t hash;
	uint8_t flags;
	uint16_t iterations;
	unsigned char salt[DNS_NSEC3_SALTSIZE];
	size_t salt_length = sizeof(salt);

	UNUSED(state);

	res = dns_db_getnsec3parameters(db1, v1, &hash, &flags, &iterations,
					salt, &salt_length);
	assert_int_equal(res, ISC_R_NOTFOUND);

	check_assertion(dns_db_getnsec3parameters(
		db1, v2, &hash, &flags, &iterations, salt, &salt_length));
}

/*
 * Check that the correct node contents are found after a rollback.
 */
ISC_RUN_TEST_IMPL(rollback) {
	isc_result_t res;
	dns_rdata_t rdata1 = DNS_RDATA_INIT, rdata2 = DNS_RDATA_INIT;
	dns_rdataset_t input1 = DNS_RDATASET_INIT;
	dns_rdataset_t input2 = DNS_RDATASET_INIT;
	dns_rdataset_t rdataset1 = DNS_RDATASET_INIT;
	dns_rdataset_t rdataset2 = DNS_RDATASET_INIT;
	dns_rdatalist_t rdatalist1, rdatalist2;
	dns_rdata_t out1 = DNS_RDATA_INIT, out2 = DNS_RDATA_INIT;
	dns_dbnode_t *node = NULL;
	char *txt1 = (char *)"\006text 1";
	char *txt2 = (char *)"\006text 2";
	size_t len1 = strlen(txt1), len2 = strlen(txt2);
	char buf[1024];
	isc_buffer_t b;

	UNUSED(state);

	isc_buffer_init(&b, buf, sizeof(buf));

	/* Set up two rdatasets to insert */
	rdata1.rdclass = dns_rdataclass_in;
	rdata1.type = dns_rdatatype_txt;
	rdata2 = rdata1;

	rdata1.length = len1;
	rdata1.data = (unsigned char *)txt1;
	rdata2.length = len2;
	rdata2.data = (unsigned char *)txt2;

	dns_rdatalist_init(&rdatalist1);
	rdatalist1.rdclass = dns_rdataclass_in;
	rdatalist1.type = dns_rdatatype_txt;
	rdatalist1.ttl = 3600;
	rdatalist2 = rdatalist1;

	ISC_LIST_APPEND(rdatalist1.rdata, &rdata1, link);
	ISC_LIST_APPEND(rdatalist2.rdata, &rdata2, link);

	dns_rdatalist_tordataset(&rdatalist1, &input1);
	dns_rdatalist_tordataset(&rdatalist2, &input2);

	/* db1: Insert the first version ("text 1"), and commit */
	res = dns_db_findnode(db1, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_addrdataset(db1, node, v1, 0, &input1, 0, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_closeversion(db1, &v1, true); /* commit */
	assert_null(v1);
	dns_db_detachnode(db1, &node);
	assert_null(node);

	/* db2: Insert the first version ("text 1"), and commit */
	res = dns_db_findnode(db2, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_addrdataset(db2, node, v2, 0, &input1, 0, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_closeversion(db2, &v2, true); /* commit */
	assert_null(v2);
	dns_db_detachnode(db2, &node);
	assert_null(node);

	/* Reopen the versions */
	dns_db_newversion(db1, &v1);
	assert_non_null(v1);
	dns_db_newversion(db2, &v2);
	assert_non_null(v2);

	/* db1: Insert the second version ("text 2"), and roll back */
	res = dns_db_findnode(db1, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_addrdataset(db1, node, v1, 0, &input2, 0, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_closeversion(db1, &v1, false); /* rollback */
	assert_null(v1);
	dns_db_detachnode(db1, &node);
	assert_null(node);

	/* db2: Insert the second version ("text 2"), and commit */
	res = dns_db_findnode(db2, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_addrdataset(db2, node, v2, 0, &input2, 0, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_db_closeversion(db2, &v2, true); /* commit */
	assert_null(v2);
	dns_db_detachnode(db2, &node);
	assert_null(node);

	/* db1: Look it up and check that the first version is found */
	dns_db_currentversion(db1, &v1);
	assert_non_null(v1);
	res = dns_db_findnode(db1, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_findrdataset(db1, node, v1, dns_rdatatype_txt, 0, 0,
				  &rdataset1, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);

	/* db1: Convert result to text */
	res = dns_rdataset_first(&rdataset1);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_rdataset_current(&rdataset1, &out1);

	res = dns_rdata_totext(&out1, NULL, &b);
	assert_int_equal(res, ISC_R_SUCCESS);
	isc_buffer_putuint8(&b, 0);

	/* db1: We should have "text 1" */
	assert_string_equal(buf, "\"text 1\"");

	dns_rdataset_disassociate(&rdataset1);

	dns_db_closeversion(db1, &v1, true);
	assert_null(v1);
	dns_db_detachnode(db1, &node);
	assert_null(node);

	/* db2: Look it up and check that the second version is found */
	dns_db_currentversion(db2, &v2);
	assert_non_null(v2);
	res = dns_db_findnode(db2, dns_rootname, true, &node);
	assert_int_equal(res, ISC_R_SUCCESS);
	res = dns_db_findrdataset(db2, node, v2, dns_rdatatype_txt, 0, 0,
				  &rdataset2, NULL);
	assert_int_equal(res, ISC_R_SUCCESS);

	/* db2: Convert result to text */
	res = dns_rdataset_first(&rdataset2);
	assert_int_equal(res, ISC_R_SUCCESS);
	dns_rdataset_current(&rdataset2, &out2);
	isc_buffer_init(&b, buf, sizeof(buf));
	res = dns_rdata_totext(&out2, NULL, &b);
	assert_int_equal(res, ISC_R_SUCCESS);
	isc_buffer_putuint8(&b, 0);

	/* db2: We should have "text 2" */
	assert_string_equal(buf, "\"text 2\"");

	dns_rdataset_disassociate(&rdataset2);

	dns_db_closeversion(db2, &v2, true);
	assert_null(v2);
	dns_db_detachnode(db2, &node);
	assert_null(node);
}

ISC_TEST_LIST_START
ISC_TEST_ENTRY_CUSTOM(find, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(allrdatasets, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(findrdataset, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(deleterdataset, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(subtract, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(addrdataset, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(getnsec3parameters, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(attachversion, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(closeversion, setup_test, teardown_test)
ISC_TEST_ENTRY_CUSTOM(rollback, setup_test, teardown_test)
ISC_TEST_LIST_END

ISC_TEST_MAIN