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

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

Adapt oidmap test script to clar framework by using clar assertions
where necessary. `cl_parse_any_oid()` ensures the hash algorithm is set
before parsing. This prevents issues from an uninitialized or invalid
hash algorithm.

Introduce 'test_oidmap__initialize` handles the to set up of the global
oidmap map with predefined key-value pairs, and `test_oidmap__cleanup`
frees the oidmap and its entries when all tests are completed.

The test loops through all entries to detect multiple errors. With this
change, it stops at the first error encountered, making it easier to
address it.

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-02-25 11:10:43 +01:00 committed by Junio C Hamano
parent 869a1edf44
commit 69bc044def
4 changed files with 138 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -1357,6 +1357,7 @@ CLAR_TEST_SUITES += u-hash
CLAR_TEST_SUITES += u-hashmap
CLAR_TEST_SUITES += u-mem-pool
CLAR_TEST_SUITES += u-oid-array
CLAR_TEST_SUITES += u-oidmap
CLAR_TEST_SUITES += u-prio-queue
CLAR_TEST_SUITES += u-reftable-tree
CLAR_TEST_SUITES += u-strbuf
@ -1368,7 +1369,6 @@ CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/clar/clar.o
CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/unit-test.o
CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/lib-oid.o

UNIT_TEST_PROGRAMS += t-oidmap
UNIT_TEST_PROGRAMS += t-oidtree
UNIT_TEST_PROGRAMS += t-reftable-basics
UNIT_TEST_PROGRAMS += t-reftable-block

2
t/meson.build
View File

@ -5,6 +5,7 @@ clar_test_suites = [
'unit-tests/u-hashmap.c',
'unit-tests/u-mem-pool.c',
'unit-tests/u-oid-array.c',
'unit-tests/u-oidmap.c',
'unit-tests/u-prio-queue.c',
'unit-tests/u-reftable-tree.c',
'unit-tests/u-strbuf.c',
@ -50,7 +51,6 @@ clar_unit_tests = executable('unit-tests',
test('unit-tests', clar_unit_tests)

unit_test_programs = [
'unit-tests/t-oidmap.c',
'unit-tests/t-oidtree.c',
'unit-tests/t-reftable-basics.c',
'unit-tests/t-reftable-block.c',

181
t/unit-tests/t-oidmap.c
View File

@ -1,181 +0,0 @@
#include "test-lib.h"
#include "lib-oid.h"
#include "oidmap.h"
#include "hash.h"
#include "hex.h"

/*
* Elements we will put in oidmap structs are made of a key: the entry.oid
* field, which is of type struct object_id, and a value: the name field (could
* be a refname for example).
*/
struct test_entry {
struct oidmap_entry entry;
char name[FLEX_ARRAY];
};

static const char *const key_val[][2] = { { "11", "one" },
{ "22", "two" },
{ "33", "three" } };

static void setup(void (*f)(struct oidmap *map))
{
struct oidmap map = OIDMAP_INIT;
int ret = 0;

for (size_t i = 0; i < ARRAY_SIZE(key_val); i++){
struct test_entry *entry;

FLEX_ALLOC_STR(entry, name, key_val[i][1]);
if ((ret = get_oid_arbitrary_hex(key_val[i][0], &entry->entry.oid))) {
free(entry);
break;
}
entry = oidmap_put(&map, entry);
if (!check(entry == NULL))
free(entry);
}

if (!ret)
f(&map);
oidmap_free(&map, 1);
}

static void t_replace(struct oidmap *map)
{
struct test_entry *entry, *prev;

FLEX_ALLOC_STR(entry, name, "un");
if (get_oid_arbitrary_hex("11", &entry->entry.oid))
return;
prev = oidmap_put(map, entry);
if (!check(prev != NULL))
return;
check_str(prev->name, "one");
free(prev);

FLEX_ALLOC_STR(entry, name, "deux");
if (get_oid_arbitrary_hex("22", &entry->entry.oid))
return;
prev = oidmap_put(map, entry);
if (!check(prev != NULL))
return;
check_str(prev->name, "two");
free(prev);
}

static void t_get(struct oidmap *map)
{
struct test_entry *entry;
struct object_id oid;

if (get_oid_arbitrary_hex("22", &oid))
return;
entry = oidmap_get(map, &oid);
if (!check(entry != NULL))
return;
check_str(entry->name, "two");

if (get_oid_arbitrary_hex("44", &oid))
return;
check(oidmap_get(map, &oid) == NULL);

if (get_oid_arbitrary_hex("11", &oid))
return;
entry = oidmap_get(map, &oid);
if (!check(entry != NULL))
return;
check_str(entry->name, "one");
}

static void t_remove(struct oidmap *map)
{
struct test_entry *entry;
struct object_id oid;

if (get_oid_arbitrary_hex("11", &oid))
return;
entry = oidmap_remove(map, &oid);
if (!check(entry != NULL))
return;
check_str(entry->name, "one");
check(oidmap_get(map, &oid) == NULL);
free(entry);

if (get_oid_arbitrary_hex("22", &oid))
return;
entry = oidmap_remove(map, &oid);
if (!check(entry != NULL))
return;
check_str(entry->name, "two");
check(oidmap_get(map, &oid) == NULL);
free(entry);

if (get_oid_arbitrary_hex("44", &oid))
return;
check(oidmap_remove(map, &oid) == NULL);
}

static int key_val_contains(struct test_entry *entry, char seen[])
{
for (size_t i = 0; i < ARRAY_SIZE(key_val); i++) {
struct object_id oid;

if (get_oid_arbitrary_hex(key_val[i][0], &oid))
return -1;

if (oideq(&entry->entry.oid, &oid)) {
if (seen[i])
return 2;
seen[i] = 1;
return 0;
}
}
return 1;
}

static void t_iterate(struct oidmap *map)
{
struct oidmap_iter iter;
struct test_entry *entry;
char seen[ARRAY_SIZE(key_val)] = { 0 };
int count = 0;

oidmap_iter_init(map, &iter);
while ((entry = oidmap_iter_next(&iter))) {
int ret;
if (!check_int((ret = key_val_contains(entry, seen)), ==, 0)) {
switch (ret) {
case -1:
break; /* error message handled by get_oid_arbitrary_hex() */
case 1:
test_msg("obtained entry was not given in the input\n"
" name: %s\n oid: %s\n",
entry->name, oid_to_hex(&entry->entry.oid));
break;
case 2:
test_msg("duplicate entry detected\n"
" name: %s\n oid: %s\n",
entry->name, oid_to_hex(&entry->entry.oid));
break;
default:
test_msg("BUG: invalid return value (%d) from key_val_contains()",
ret);
break;
}
} else {
count++;
}
}
check_int(count, ==, ARRAY_SIZE(key_val));
check_int(hashmap_get_size(&map->map), ==, ARRAY_SIZE(key_val));
}

int cmd_main(int argc UNUSED, const char **argv UNUSED)
{
TEST(setup(t_replace), "replace works");
TEST(setup(t_get), "get works");
TEST(setup(t_remove), "remove works");
TEST(setup(t_iterate), "iterate works");
return test_done();
}

136
t/unit-tests/u-oidmap.c Normal file
View File

@ -0,0 +1,136 @@
#include "unit-test.h"
#include "lib-oid.h"
#include "oidmap.h"
#include "hash.h"
#include "hex.h"

/*
* Elements we will put in oidmap structs are made of a key: the entry.oid
* field, which is of type struct object_id, and a value: the name field (could
* be a refname for example).
*/
struct test_entry {
struct oidmap_entry entry;
char name[FLEX_ARRAY];
};

static const char *const key_val[][2] = { { "11", "one" },
{ "22", "two" },
{ "33", "three" } };

static struct oidmap map;

void test_oidmap__initialize(void)
{
oidmap_init(&map, 0);

for (size_t i = 0; i < ARRAY_SIZE(key_val); i++){
struct test_entry *entry;

FLEX_ALLOC_STR(entry, name, key_val[i][1]);
cl_parse_any_oid(key_val[i][0], &entry->entry.oid);
cl_assert(oidmap_put(&map, entry) == NULL);
}
}

void test_oidmap__cleanup(void)
{
oidmap_free(&map, 1);
}

void test_oidmap__replace(void)
{
struct test_entry *entry, *prev;

FLEX_ALLOC_STR(entry, name, "un");
cl_parse_any_oid("11", &entry->entry.oid);
prev = oidmap_put(&map, entry);
cl_assert(prev != NULL);
cl_assert_equal_s(prev->name, "one");
free(prev);

FLEX_ALLOC_STR(entry, name, "deux");
cl_parse_any_oid("22", &entry->entry.oid);
prev = oidmap_put(&map, entry);
cl_assert(prev != NULL);
cl_assert_equal_s(prev->name, "two");
free(prev);
}

void test_oidmap__get(void)
{
struct test_entry *entry;
struct object_id oid;

cl_parse_any_oid("22", &oid);
entry = oidmap_get(&map, &oid);
cl_assert(entry != NULL);
cl_assert_equal_s(entry->name, "two");

cl_parse_any_oid("44", &oid);
cl_assert(oidmap_get(&map, &oid) == NULL);

cl_parse_any_oid("11", &oid);
entry = oidmap_get(&map, &oid);
cl_assert(entry != NULL);
cl_assert_equal_s(entry->name, "one");
}

void test_oidmap__remove(void)
{
struct test_entry *entry;
struct object_id oid;

cl_parse_any_oid("11", &oid);
entry = oidmap_remove(&map, &oid);
cl_assert(entry != NULL);
cl_assert_equal_s(entry->name, "one");
cl_assert(oidmap_get(&map, &oid) == NULL);
free(entry);

cl_parse_any_oid("22", &oid);
entry = oidmap_remove(&map, &oid);
cl_assert(entry != NULL);
cl_assert_equal_s(entry->name, "two");
cl_assert(oidmap_get(&map, &oid) == NULL);
free(entry);

cl_parse_any_oid("44", &oid);
cl_assert(oidmap_remove(&map, &oid) == NULL);
}

static int key_val_contains(struct test_entry *entry, char seen[])
{
for (size_t i = 0; i < ARRAY_SIZE(key_val); i++) {
struct object_id oid;

cl_parse_any_oid(key_val[i][0], &oid);

if (oideq(&entry->entry.oid, &oid)) {
if (seen[i])
return 2;
seen[i] = 1;
return 0;
}
}
return 1;
}

void test_oidmap__iterate(void)
{
struct oidmap_iter iter;
struct test_entry *entry;
char seen[ARRAY_SIZE(key_val)] = { 0 };
int count = 0;

oidmap_iter_init(&map, &iter);
while ((entry = oidmap_iter_next(&iter))) {
if (key_val_contains(entry, seen) != 0) {
cl_failf("Unexpected entry: name = %s, oid = %s",
entry->name, oid_to_hex(&entry->entry.oid));
}
count++;
}
cl_assert_equal_i(count, ARRAY_SIZE(key_val));
cl_assert_equal_i(hashmap_get_size(&map.map), ARRAY_SIZE(key_val));
}