mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-22 10:10:06 +00:00
Code Issues Releases Wiki Activity
bind/lib/isc/tests/lex_test.c
Ondřej Surý 63fe9312ff Give the unit tests a big overhaul 
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.
2022-05-28 14:52:56 -07:00

355 lines
10 KiB
C
Raw Blame History

/*
* 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 <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/buffer.h>
#include <isc/lex.h>
#include <isc/mem.h>
#include <isc/util.h>
#include <isc/test.h>
#define AS_STR(x) (x).value.as_textregion.base
/* check handling of 0xff */
ISC_RUN_TEST_IMPL(lex_0xff) {
isc_result_t result;
isc_lex_t *lex = NULL;
isc_buffer_t death_buf;
isc_token_t token;
unsigned char death[] = { EOF, 'A' };
UNUSED(state);
result = isc_lex_create(mctx, 1024, &lex);
assert_int_equal(result, ISC_R_SUCCESS);
isc_buffer_init(&death_buf, &death[0], sizeof(death));
isc_buffer_add(&death_buf, sizeof(death));
result = isc_lex_openbuffer(lex, &death_buf);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_lex_gettoken(lex, 0, &token);
assert_int_equal(result, ISC_R_SUCCESS);
isc_lex_destroy(&lex);
}
/* check setting of source line */
ISC_RUN_TEST_IMPL(lex_setline) {
isc_result_t result;
isc_lex_t *lex = NULL;
unsigned char text[] = "text\nto\nbe\nprocessed\nby\nlexer";
isc_buffer_t buf;
isc_token_t token;
unsigned long line;
int i;
UNUSED(state);
result = isc_lex_create(mctx, 1024, &lex);
assert_int_equal(result, ISC_R_SUCCESS);
isc_buffer_init(&buf, &text[0], sizeof(text));
isc_buffer_add(&buf, sizeof(text));
result = isc_lex_openbuffer(lex, &buf);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_lex_setsourceline(lex, 100);
assert_int_equal(result, ISC_R_SUCCESS);
for (i = 0; i < 6; i++) {
result = isc_lex_gettoken(lex, 0, &token);
assert_int_equal(result, ISC_R_SUCCESS);
line = isc_lex_getsourceline(lex);
assert_int_equal(line, 100U + i);
}
result = isc_lex_gettoken(lex, 0, &token);
assert_int_equal(result, ISC_R_EOF);
line = isc_lex_getsourceline(lex);
assert_int_equal(line, 105U);
isc_lex_destroy(&lex);
}
static struct {
const char *text;
const char *string_value;
isc_result_t string_result;
isc_tokentype_t string_type;
const char *qstring_value;
isc_result_t qstring_result;
isc_tokentype_t qstring_type;
const char *qvpair_value;
isc_result_t qvpair_result;
isc_tokentype_t qvpair_type;
} parse_tests[] = {
{ "", "", ISC_R_SUCCESS, isc_tokentype_eof, "", ISC_R_SUCCESS,
isc_tokentype_eof, "", ISC_R_SUCCESS, isc_tokentype_eof },
{ "1234", "1234", ISC_R_SUCCESS, isc_tokentype_string, "1234",
ISC_R_SUCCESS, isc_tokentype_string, "1234", ISC_R_SUCCESS,
isc_tokentype_string },
{ "1234=", "1234=", ISC_R_SUCCESS, isc_tokentype_string,
"1234=", ISC_R_SUCCESS, isc_tokentype_string, "1234=", ISC_R_SUCCESS,
isc_tokentype_vpair },
{ "1234=foo", "1234=foo", ISC_R_SUCCESS, isc_tokentype_string,
"1234=foo", ISC_R_SUCCESS, isc_tokentype_string, "1234=foo",
ISC_R_SUCCESS, isc_tokentype_vpair },
{ "1234=\"foo", "1234=\"foo", ISC_R_SUCCESS, isc_tokentype_string,
"1234=\"foo", ISC_R_SUCCESS, isc_tokentype_string, NULL,
ISC_R_UNEXPECTEDEND, 0 },
{ "1234=\"foo\"", "1234=\"foo\"", ISC_R_SUCCESS, isc_tokentype_string,
"1234=\"foo\"", ISC_R_SUCCESS, isc_tokentype_string, "1234=foo",
ISC_R_SUCCESS, isc_tokentype_qvpair },
{ "key", "key", ISC_R_SUCCESS, isc_tokentype_string, "key",
ISC_R_SUCCESS, isc_tokentype_string, "key", ISC_R_SUCCESS,
isc_tokentype_string },
{ "\"key=", "\"key=", ISC_R_SUCCESS, isc_tokentype_string, NULL,
ISC_R_UNEXPECTEDEND, 0, "\"key=", ISC_R_SUCCESS,
isc_tokentype_vpair },
{ "\"key=\"", "\"key=\"", ISC_R_SUCCESS, isc_tokentype_string, "key=",
ISC_R_SUCCESS, isc_tokentype_qstring, NULL, ISC_R_UNEXPECTEDEND, 0 },
{ "key=\"\"", "key=\"\"", ISC_R_SUCCESS, isc_tokentype_string,
"key=\"\"", ISC_R_SUCCESS, isc_tokentype_string,
"key=", ISC_R_SUCCESS, isc_tokentype_qvpair },
{ "key=\"a b\"", "key=\"a", ISC_R_SUCCESS, isc_tokentype_string,
"key=\"a", ISC_R_SUCCESS, isc_tokentype_string, "key=a b",
ISC_R_SUCCESS, isc_tokentype_qvpair },
{ "key=\"a\tb\"", "key=\"a", ISC_R_SUCCESS, isc_tokentype_string,
"key=\"a", ISC_R_SUCCESS, isc_tokentype_string, "key=a\tb",
ISC_R_SUCCESS, isc_tokentype_qvpair },
/* double quote not immediately after '=' is not special. */
{ "key=c\"a b\"", "key=c\"a", ISC_R_SUCCESS, isc_tokentype_string,
"key=c\"a", ISC_R_SUCCESS, isc_tokentype_string, "key=c\"a",
ISC_R_SUCCESS, isc_tokentype_vpair },
/* remove special meaning for '=' by escaping */
{ "key\\=", "key\\=", ISC_R_SUCCESS, isc_tokentype_string,
"key\\=", ISC_R_SUCCESS, isc_tokentype_string,
"key\\=", ISC_R_SUCCESS, isc_tokentype_string },
{ "key\\=\"a\"", "key\\=\"a\"", ISC_R_SUCCESS, isc_tokentype_string,
"key\\=\"a\"", ISC_R_SUCCESS, isc_tokentype_string, "key\\=\"a\"",
ISC_R_SUCCESS, isc_tokentype_string },
{ "key\\=\"a \"", "key\\=\"a", ISC_R_SUCCESS, isc_tokentype_string,
"key\\=\"a", ISC_R_SUCCESS, isc_tokentype_string, "key\\=\"a",
ISC_R_SUCCESS, isc_tokentype_string },
/* vpair with a key of 'key\=' (would need to be deescaped) */
{ "key\\==", "key\\==", ISC_R_SUCCESS, isc_tokentype_string,
"key\\==", ISC_R_SUCCESS, isc_tokentype_string,
"key\\==", ISC_R_SUCCESS, isc_tokentype_vpair },
{ "key\\==\"\"", "key\\==\"\"", ISC_R_SUCCESS, isc_tokentype_string,
"key\\==\"\"", ISC_R_SUCCESS, isc_tokentype_string,
"key\\==", ISC_R_SUCCESS, isc_tokentype_qvpair },
{ "key=\\\\\\\\", "key=\\\\\\\\", ISC_R_SUCCESS, isc_tokentype_string,
"key=\\\\\\\\", ISC_R_SUCCESS, isc_tokentype_string, "key=\\\\\\\\",
ISC_R_SUCCESS, isc_tokentype_vpair },
{ "key=\\\\\\\"", "key=\\\\\\\"", ISC_R_SUCCESS, isc_tokentype_string,
"key=\\\\\\\"", ISC_R_SUCCESS, isc_tokentype_string, "key=\\\\\\\"",
ISC_R_SUCCESS, isc_tokentype_vpair },
/* incomplete escape sequence */
{ "key=\\\"\\", NULL, ISC_R_UNEXPECTEDEND, isc_tokentype_string, NULL,
ISC_R_UNEXPECTEDEND, 0, NULL, ISC_R_UNEXPECTEDEND, 0 },
/* incomplete escape sequence */
{ "key=\\", NULL, ISC_R_UNEXPECTEDEND, isc_tokentype_string, NULL,
ISC_R_UNEXPECTEDEND, 0, NULL, ISC_R_UNEXPECTEDEND, 0 },
};
/*%
* string
*/
ISC_RUN_TEST_IMPL(lex_string) {
isc_buffer_t buf;
isc_lex_t *lex = NULL;
isc_result_t result;
isc_token_t token;
size_t i;
UNUSED(state);
for (i = 0; i < ARRAY_SIZE(parse_tests); i++) {
result = isc_lex_create(mctx, 1024, &lex);
assert_int_equal(result, ISC_R_SUCCESS);
isc_buffer_constinit(&buf, parse_tests[i].text,
strlen(parse_tests[i].text));
isc_buffer_add(&buf, strlen(parse_tests[i].text));
result = isc_lex_openbuffer(lex, &buf);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_lex_setsourceline(lex, 100);
assert_int_equal(result, ISC_R_SUCCESS);
memset(&token, 0, sizeof(token));
result = isc_lex_getmastertoken(lex, &token,
isc_tokentype_string, true);
assert_int_equal(result, parse_tests[i].string_result);
if (result == ISC_R_SUCCESS) {
switch (token.type) {
case isc_tokentype_string:
case isc_tokentype_qstring:
case isc_tokentype_vpair:
case isc_tokentype_qvpair:
assert_int_equal(token.type,
parse_tests[i].string_type);
assert_string_equal(
AS_STR(token),
parse_tests[i].string_value);
break;
default:
assert_int_equal(token.type,
parse_tests[i].string_type);
break;
}
}
isc_lex_destroy(&lex);
}
}
/*%
* qstring
*/
ISC_RUN_TEST_IMPL(lex_qstring) {
isc_buffer_t buf;
isc_lex_t *lex = NULL;
isc_result_t result;
isc_token_t token;
size_t i;
UNUSED(state);
for (i = 0; i < ARRAY_SIZE(parse_tests); i++) {
result = isc_lex_create(mctx, 1024, &lex);
assert_int_equal(result, ISC_R_SUCCESS);
isc_buffer_constinit(&buf, parse_tests[i].text,
strlen(parse_tests[i].text));
isc_buffer_add(&buf, strlen(parse_tests[i].text));
result = isc_lex_openbuffer(lex, &buf);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_lex_setsourceline(lex, 100);
assert_int_equal(result, ISC_R_SUCCESS);
memset(&token, 0, sizeof(token));
result = isc_lex_getmastertoken(lex, &token,
isc_tokentype_qstring, true);
assert_int_equal(result, parse_tests[i].qstring_result);
if (result == ISC_R_SUCCESS) {
switch (token.type) {
case isc_tokentype_string:
case isc_tokentype_qstring:
case isc_tokentype_vpair:
case isc_tokentype_qvpair:
assert_int_equal(token.type,
parse_tests[i].qstring_type);
assert_string_equal(
AS_STR(token),
parse_tests[i].qstring_value);
break;
default:
assert_int_equal(token.type,
parse_tests[i].qstring_type);
break;
}
}
isc_lex_destroy(&lex);
}
}
/*%
* keypair is <string>=<qstring>. This has implications double quotes
* in key names.
*/
ISC_RUN_TEST_IMPL(lex_keypair) {
isc_buffer_t buf;
isc_lex_t *lex = NULL;
isc_result_t result;
isc_token_t token;
size_t i;
UNUSED(state);
for (i = 0; i < ARRAY_SIZE(parse_tests); i++) {
result = isc_lex_create(mctx, 1024, &lex);
assert_int_equal(result, ISC_R_SUCCESS);
isc_buffer_constinit(&buf, parse_tests[i].text,
strlen(parse_tests[i].text));
isc_buffer_add(&buf, strlen(parse_tests[i].text));
result = isc_lex_openbuffer(lex, &buf);
assert_int_equal(result, ISC_R_SUCCESS);
result = isc_lex_setsourceline(lex, 100);
assert_int_equal(result, ISC_R_SUCCESS);
memset(&token, 0, sizeof(token));
result = isc_lex_getmastertoken(lex, &token,
isc_tokentype_qvpair, true);
assert_int_equal(result, parse_tests[i].qvpair_result);
if (result == ISC_R_SUCCESS) {
switch (token.type) {
case isc_tokentype_string:
case isc_tokentype_qstring:
case isc_tokentype_vpair:
case isc_tokentype_qvpair:
assert_int_equal(token.type,
parse_tests[i].qvpair_type);
assert_string_equal(
AS_STR(token),
parse_tests[i].qvpair_value);
break;
default:
assert_int_equal(token.type,
parse_tests[i].qvpair_type);
break;
}
}
isc_lex_destroy(&lex);
}
}
ISC_TEST_LIST_START
ISC_TEST_ENTRY(lex_0xff)
ISC_TEST_ENTRY(lex_keypair)
ISC_TEST_ENTRY(lex_setline)
ISC_TEST_ENTRY(lex_string)
ISC_TEST_ENTRY(lex_qstring)
ISC_TEST_LIST_END
ISC_TEST_MAIN
Reference in New Issue View Git Blame Copy Permalink