kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

t/unit-tests: convert strbuf test to use clar test framework 

Adapt strbuf test script to clar framework by using clar assertions
where necessary.

Mentored-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Seyi Kuforiji <kuforiji98@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Seyi Kuforiji 2025-01-31 23:14:19 +01:00 committed by Junio C Hamano
parent e0f807bdad
commit 4b995465b2
4 changed files with 121 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -1346,6 +1346,7 @@ CLAR_TEST_SUITES += u-hashmap
CLAR_TEST_SUITES += u-mem-pool
CLAR_TEST_SUITES += u-prio-queue
CLAR_TEST_SUITES += u-reftable-tree
CLAR_TEST_SUITES += u-strbuf
CLAR_TEST_SUITES += u-strvec
CLAR_TEST_PROG = $(UNIT_TEST_BIN)/unit-tests$(X)
CLAR_TEST_OBJS = $(patsubst %,$(UNIT_TEST_DIR)/%.o,$(CLAR_TEST_SUITES))
@ -1363,7 +1364,6 @@ UNIT_TEST_PROGRAMS += t-reftable-reader
UNIT_TEST_PROGRAMS += t-reftable-readwrite
UNIT_TEST_PROGRAMS += t-reftable-record
UNIT_TEST_PROGRAMS += t-reftable-stack
UNIT_TEST_PROGRAMS += t-strbuf
UNIT_TEST_PROGRAMS += t-strcmp-offset
UNIT_TEST_PROGRAMS += t-trailer
UNIT_TEST_PROGRAMS += t-urlmatch-normalization

2
t/meson.build
View File

@ -6,6 +6,7 @@ clar_test_suites = [
'unit-tests/u-mem-pool.c',
'unit-tests/u-prio-queue.c',
'unit-tests/u-reftable-tree.c',
'unit-tests/u-strbuf.c',
'unit-tests/u-strvec.c',
]

@ -57,7 +58,6 @@ unit_test_programs = [
'unit-tests/t-reftable-readwrite.c',
'unit-tests/t-reftable-record.c',
'unit-tests/t-reftable-stack.c',
'unit-tests/t-strbuf.c',
'unit-tests/t-strcmp-offset.c',
'unit-tests/t-trailer.c',
'unit-tests/t-urlmatch-normalization.c',

122
t/unit-tests/t-strbuf.c
View File

@ -1,122 +0,0 @@
#include "test-lib.h"
#include "strbuf.h"

/* wrapper that supplies tests with an empty, initialized strbuf */
static void setup(void (*f)(struct strbuf*, const void*),
const void *data)
{
struct strbuf buf = STRBUF_INIT;

f(&buf, data);
strbuf_release(&buf);
check_uint(buf.len, ==, 0);
check_uint(buf.alloc, ==, 0);
}

/* wrapper that supplies tests with a populated, initialized strbuf */
static void setup_populated(void (*f)(struct strbuf*, const void*),
const char *init_str, const void *data)
{
struct strbuf buf = STRBUF_INIT;

strbuf_addstr(&buf, init_str);
check_uint(buf.len, ==, strlen(init_str));
f(&buf, data);
strbuf_release(&buf);
check_uint(buf.len, ==, 0);
check_uint(buf.alloc, ==, 0);
}

static int assert_sane_strbuf(struct strbuf *buf)
{
/* Initialized strbufs should always have a non-NULL buffer */
if (!check(!!buf->buf))
return 0;
/* Buffers should always be NUL-terminated */
if (!check_char(buf->buf[buf->len], ==, '\0'))
return 0;
/*
* Freshly-initialized strbufs may not have a dynamically allocated
* buffer
*/
if (buf->len == 0 && buf->alloc == 0)
return 1;
/* alloc must be at least one byte larger than len */
return check_uint(buf->len, <, buf->alloc);
}

static void t_static_init(void)
{
struct strbuf buf = STRBUF_INIT;

check_uint(buf.len, ==, 0);
check_uint(buf.alloc, ==, 0);
check_char(buf.buf[0], ==, '\0');
}

static void t_dynamic_init(void)
{
struct strbuf buf;

strbuf_init(&buf, 1024);
check(assert_sane_strbuf(&buf));
check_uint(buf.len, ==, 0);
check_uint(buf.alloc, >=, 1024);
check_char(buf.buf[0], ==, '\0');
strbuf_release(&buf);
}

static void t_addch(struct strbuf *buf, const void *data)
{
const char *p_ch = data;
const char ch = *p_ch;
size_t orig_alloc = buf->alloc;
size_t orig_len = buf->len;

if (!check(assert_sane_strbuf(buf)))
return;
strbuf_addch(buf, ch);
if (!check(assert_sane_strbuf(buf)))
return;
if (!(check_uint(buf->len, ==, orig_len + 1) &&
check_uint(buf->alloc, >=, orig_alloc)))
return; /* avoid de-referencing buf->buf */
check_char(buf->buf[buf->len - 1], ==, ch);
check_char(buf->buf[buf->len], ==, '\0');
}

static void t_addstr(struct strbuf *buf, const void *data)
{
const char *text = data;
size_t len = strlen(text);
size_t orig_alloc = buf->alloc;
size_t orig_len = buf->len;

if (!check(assert_sane_strbuf(buf)))
return;
strbuf_addstr(buf, text);
if (!check(assert_sane_strbuf(buf)))
return;
if (!(check_uint(buf->len, ==, orig_len + len) &&
check_uint(buf->alloc, >=, orig_alloc) &&
check_uint(buf->alloc, >, orig_len + len) &&
check_char(buf->buf[orig_len + len], ==, '\0')))
return;
check_str(buf->buf + orig_len, text);
}

int cmd_main(int argc UNUSED, const char **argv UNUSED)
{
if (!TEST(t_static_init(), "static initialization works"))
test_skip_all("STRBUF_INIT is broken");
TEST(t_dynamic_init(), "dynamic initialization works");
TEST(setup(t_addch, "a"), "strbuf_addch adds char");
TEST(setup(t_addch, ""), "strbuf_addch adds NUL char");
TEST(setup_populated(t_addch, "initial value", "a"),
"strbuf_addch appends to initial value");
TEST(setup(t_addstr, "hello there"), "strbuf_addstr adds string");
TEST(setup_populated(t_addstr, "initial value", "hello there"),
"strbuf_addstr appends string to initial value");

return test_done();
}

119
t/unit-tests/u-strbuf.c Normal file
View File

@ -0,0 +1,119 @@
#include "unit-test.h"
#include "strbuf.h"

/* wrapper that supplies tests with an empty, initialized strbuf */
static void setup(void (*f)(struct strbuf*, const void*),
const void *data)
{
struct strbuf buf = STRBUF_INIT;

f(&buf, data);
strbuf_release(&buf);
cl_assert_equal_i(buf.len, 0);
cl_assert_equal_i(buf.alloc, 0);
}

/* wrapper that supplies tests with a populated, initialized strbuf */
static void setup_populated(void (*f)(struct strbuf*, const void*),
const char *init_str, const void *data)
{
struct strbuf buf = STRBUF_INIT;

strbuf_addstr(&buf, init_str);
cl_assert_equal_i(buf.len, strlen(init_str));
f(&buf, data);
strbuf_release(&buf);
cl_assert_equal_i(buf.len, 0);
cl_assert_equal_i(buf.alloc, 0);
}

static void assert_sane_strbuf(struct strbuf *buf)
{
/* Initialized strbufs should always have a non-NULL buffer */
cl_assert(buf->buf != NULL);
/* Buffers should always be NUL-terminated */
cl_assert(buf->buf[buf->len] == '\0');
/*
* In case the buffer contains anything, `alloc` must alloc must
* be at least one byte larger than `len`.
*/
if (buf->len)
cl_assert(buf->len < buf->alloc);
}

void test_strbuf__static_init(void)
{
struct strbuf buf = STRBUF_INIT;

cl_assert_equal_i(buf.len, 0);
cl_assert_equal_i(buf.alloc, 0);
cl_assert(buf.buf[0] == '\0');
}

void test_strbuf__dynamic_init(void)
{
struct strbuf buf;

strbuf_init(&buf, 1024);
assert_sane_strbuf(&buf);
cl_assert_equal_i(buf.len, 0);
cl_assert(buf.alloc >= 1024);
cl_assert(buf.buf[0] == '\0');
strbuf_release(&buf);
}

static void t_addch(struct strbuf *buf, const void *data)
{
const char *p_ch = data;
const char ch = *p_ch;
size_t orig_alloc = buf->alloc;
size_t orig_len = buf->len;

assert_sane_strbuf(buf);
strbuf_addch(buf, ch);
assert_sane_strbuf(buf);
cl_assert_equal_i(buf->len, orig_len + 1);
cl_assert(buf->alloc >= orig_alloc);
cl_assert(buf->buf[buf->len] == '\0');
}

static void t_addstr(struct strbuf *buf, const void *data)
{
const char *text = data;
size_t len = strlen(text);
size_t orig_alloc = buf->alloc;
size_t orig_len = buf->len;

assert_sane_strbuf(buf);
strbuf_addstr(buf, text);
assert_sane_strbuf(buf);
cl_assert_equal_i(buf->len, orig_len + len);
cl_assert(buf->alloc >= orig_alloc);
cl_assert(buf->buf[buf->len] == '\0');
cl_assert_equal_s(buf->buf + orig_len, text);
}

void test_strbuf__add_single_char(void)
{
setup(t_addch, "a");
}

void test_strbuf__add_empty_char(void)
{
setup(t_addch, "");
}

void test_strbuf__add_append_char(void)
{
setup_populated(t_addch, "initial value", "a");
}

void test_strbuf__add_single_str(void)
{
setup(t_addstr, "hello there");
}

void test_strbuf__add_append_str(void)
{
setup_populated(t_addstr, "initial value", "hello there");
}