]> git.ipfire.org Git - thirdparty/git.git/commitdiff
t/unit-tests: convert oid-array test to use clar test framework
authorSeyi Kuforiji <kuforiji98@gmail.com>
Tue, 25 Feb 2025 10:10:42 +0000 (11:10 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 25 Feb 2025 18:31:22 +0000 (10:31 -0800)
Adapt oid-array test script to clar framework by using clar assertions
where necessary. Remove descriptions from macros to reduce
redundancy, and move test input arrays to global scope for reuse across
multiple test functions. Introduce `test_oid_array__initialize()` to
explicitly initialize the hash algorithm.

These changes streamline the test suite, making individual tests
self-contained and reducing redundant code.

Mentored-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Seyi Kuforiji <kuforiji98@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Makefile
t/meson.build
t/unit-tests/t-oid-array.c [deleted file]
t/unit-tests/u-oid-array.c [new file with mode: 0644]

index 81799488f0a338ca228b4581b69d6c58ddb90500..c9b0320fcb203d69addaf2e713761d6dc3010b35 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1356,6 +1356,7 @@ CLAR_TEST_SUITES += u-example-decorate
 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-prio-queue
 CLAR_TEST_SUITES += u-reftable-tree
 CLAR_TEST_SUITES += u-strbuf
@@ -1367,7 +1368,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-oid-array
 UNIT_TEST_PROGRAMS += t-oidmap
 UNIT_TEST_PROGRAMS += t-oidtree
 UNIT_TEST_PROGRAMS += t-reftable-basics
index 862cf1cfd4060d98895a5c4515d299808655e12b..1b17a53acccd607e1c031d910b7cd24a7ef96dbc 100644 (file)
@@ -4,6 +4,7 @@ clar_test_suites = [
   'unit-tests/u-hash.c',
   'unit-tests/u-hashmap.c',
   'unit-tests/u-mem-pool.c',
+  'unit-tests/u-oid-array.c',
   'unit-tests/u-prio-queue.c',
   'unit-tests/u-reftable-tree.c',
   'unit-tests/u-strbuf.c',
@@ -49,7 +50,6 @@ clar_unit_tests = executable('unit-tests',
 test('unit-tests', clar_unit_tests)
 
 unit_test_programs = [
-  'unit-tests/t-oid-array.c',
   'unit-tests/t-oidmap.c',
   'unit-tests/t-oidtree.c',
   'unit-tests/t-reftable-basics.c',
diff --git a/t/unit-tests/t-oid-array.c b/t/unit-tests/t-oid-array.c
deleted file mode 100644 (file)
index 45b59a2..0000000
+++ /dev/null
@@ -1,126 +0,0 @@
-#define USE_THE_REPOSITORY_VARIABLE
-
-#include "test-lib.h"
-#include "lib-oid.h"
-#include "oid-array.h"
-#include "hex.h"
-
-static int fill_array(struct oid_array *array, const char *hexes[], size_t n)
-{
-       for (size_t i = 0; i < n; i++) {
-               struct object_id oid;
-
-               if (!check_int(get_oid_arbitrary_hex(hexes[i], &oid), ==, 0))
-                       return -1;
-               oid_array_append(array, &oid);
-       }
-       if (!check_uint(array->nr, ==, n))
-               return -1;
-       return 0;
-}
-
-static int add_to_oid_array(const struct object_id *oid, void *data)
-{
-       struct oid_array *array = data;
-
-       oid_array_append(array, oid);
-       return 0;
-}
-
-static void t_enumeration(const char **input_args, size_t input_sz,
-                         const char **expect_args, size_t expect_sz)
-{
-       struct oid_array input = OID_ARRAY_INIT, expect = OID_ARRAY_INIT,
-                        actual = OID_ARRAY_INIT;
-       size_t i;
-
-       if (fill_array(&input, input_args, input_sz))
-               return;
-       if (fill_array(&expect, expect_args, expect_sz))
-               return;
-
-       oid_array_for_each_unique(&input, add_to_oid_array, &actual);
-       if (!check_uint(actual.nr, ==, expect.nr))
-               return;
-
-       for (i = 0; i < actual.nr; i++) {
-               if (!check(oideq(&actual.oid[i], &expect.oid[i])))
-                       test_msg("expected: %s\n       got: %s\n     index: %" PRIuMAX,
-                                oid_to_hex(&expect.oid[i]), oid_to_hex(&actual.oid[i]),
-                                (uintmax_t)i);
-       }
-
-       oid_array_clear(&actual);
-       oid_array_clear(&input);
-       oid_array_clear(&expect);
-}
-
-#define TEST_ENUMERATION(input, expect, desc)                                     \
-       TEST(t_enumeration(input, ARRAY_SIZE(input), expect, ARRAY_SIZE(expect)), \
-                          desc " works")
-
-static void t_lookup(const char **input_hexes, size_t n, const char *query_hex,
-                    int lower_bound, int upper_bound)
-{
-       struct oid_array array = OID_ARRAY_INIT;
-       struct object_id oid_query;
-       int ret;
-
-       if (!check_int(get_oid_arbitrary_hex(query_hex, &oid_query), ==, 0))
-               return;
-       if (fill_array(&array, input_hexes, n))
-               return;
-       ret = oid_array_lookup(&array, &oid_query);
-
-       if (!check_int(ret, <=, upper_bound) ||
-           !check_int(ret, >=, lower_bound))
-               test_msg("oid query for lookup: %s", oid_to_hex(&oid_query));
-
-       oid_array_clear(&array);
-}
-
-#define TEST_LOOKUP(input_hexes, query, lower_bound, upper_bound, desc) \
-       TEST(t_lookup(input_hexes, ARRAY_SIZE(input_hexes), query,      \
-                     lower_bound, upper_bound),                        \
-            desc " works")
-
-static void setup(void)
-{
-       /* The hash algo is used by oid_array_lookup() internally */
-       int algo = init_hash_algo();
-       if (check_int(algo, !=, GIT_HASH_UNKNOWN))
-               repo_set_hash_algo(the_repository, algo);
-}
-
-int cmd_main(int argc UNUSED, const char **argv UNUSED)
-{
-       const char *arr_input[] = { "88", "44", "aa", "55" };
-       const char *arr_input_dup[] = { "88", "44", "aa", "55",
-                                       "88", "44", "aa", "55",
-                                       "88", "44", "aa", "55" };
-       const char *res_sorted[] = { "44", "55", "88", "aa" };
-       const char *nearly_55;
-
-       if (!TEST(setup(), "setup"))
-               test_skip_all("hash algo initialization failed");
-
-       TEST_ENUMERATION(arr_input, res_sorted, "ordered enumeration");
-       TEST_ENUMERATION(arr_input_dup, res_sorted,
-                        "ordered enumeration with duplicate suppression");
-
-       TEST_LOOKUP(arr_input, "55", 1, 1, "lookup");
-       TEST_LOOKUP(arr_input, "33", INT_MIN, -1, "lookup non-existent entry");
-       TEST_LOOKUP(arr_input_dup, "55", 3, 5, "lookup with duplicates");
-       TEST_LOOKUP(arr_input_dup, "66", INT_MIN, -1,
-                   "lookup non-existent entry with duplicates");
-
-       nearly_55 = init_hash_algo() == GIT_HASH_SHA1 ?
-                       "5500000000000000000000000000000000000001" :
-                       "5500000000000000000000000000000000000000000000000000000000000001";
-       TEST_LOOKUP(((const char *[]){ "55", nearly_55 }), "55", 0, 0,
-                   "lookup with almost duplicate values");
-       TEST_LOOKUP(((const char *[]){ "55", "55" }), "55", 0, 1,
-                   "lookup with single duplicate value");
-
-       return test_done();
-}
diff --git a/t/unit-tests/u-oid-array.c b/t/unit-tests/u-oid-array.c
new file mode 100644 (file)
index 0000000..e48a433
--- /dev/null
@@ -0,0 +1,129 @@
+#define USE_THE_REPOSITORY_VARIABLE
+
+#include "unit-test.h"
+#include "lib-oid.h"
+#include "oid-array.h"
+#include "hex.h"
+
+static void fill_array(struct oid_array *array, const char *hexes[], size_t n)
+{
+       for (size_t i = 0; i < n; i++) {
+               struct object_id oid;
+
+               cl_parse_any_oid(hexes[i], &oid);
+               oid_array_append(array, &oid);
+       }
+       cl_assert_equal_i(array->nr, n);
+}
+
+static int add_to_oid_array(const struct object_id *oid, void *data)
+{
+       struct oid_array *array = data;
+
+       oid_array_append(array, oid);
+       return 0;
+}
+
+static void t_enumeration(const char **input_args, size_t input_sz,
+                         const char **expect_args, size_t expect_sz)
+{
+       struct oid_array input = OID_ARRAY_INIT, expect = OID_ARRAY_INIT,
+                        actual = OID_ARRAY_INIT;
+       size_t i;
+
+       fill_array(&input, input_args, input_sz);
+       fill_array(&expect, expect_args, expect_sz);
+
+       oid_array_for_each_unique(&input, add_to_oid_array, &actual);
+       cl_assert_equal_i(actual.nr, expect.nr);
+
+       for (i = 0; i < actual.nr; i++)
+               cl_assert(oideq(&actual.oid[i], &expect.oid[i]));
+
+       oid_array_clear(&actual);
+       oid_array_clear(&input);
+       oid_array_clear(&expect);
+}
+
+#define TEST_ENUMERATION(input, expect)                                     \
+       t_enumeration(input, ARRAY_SIZE(input), expect, ARRAY_SIZE(expect));
+
+static void t_lookup(const char **input_hexes, size_t n, const char *query_hex,
+                    int lower_bound, int upper_bound)
+{
+       struct oid_array array = OID_ARRAY_INIT;
+       struct object_id oid_query;
+       int ret;
+
+       cl_parse_any_oid(query_hex, &oid_query);
+       fill_array(&array, input_hexes, n);
+       ret = oid_array_lookup(&array, &oid_query);
+
+       cl_assert(ret <= upper_bound);
+       cl_assert(ret >= lower_bound);
+
+       oid_array_clear(&array);
+}
+
+#define TEST_LOOKUP(input_hexes, query, lower_bound, upper_bound) \
+       t_lookup(input_hexes, ARRAY_SIZE(input_hexes), query,      \
+                     lower_bound, upper_bound);
+
+void test_oid_array__initialize(void)
+{
+       /* The hash algo is used by oid_array_lookup() internally */
+       int algo = cl_setup_hash_algo();
+       repo_set_hash_algo(the_repository, algo);
+}
+
+static const char *arr_input[] = { "88", "44", "aa", "55" };
+static const char *arr_input_dup[] = { "88", "44", "aa", "55",
+                                      "88", "44", "aa", "55",
+                                      "88", "44", "aa", "55" };
+static const char *res_sorted[] = { "44", "55", "88", "aa" };
+
+void test_oid_array__enumerate_unique(void)
+{
+       TEST_ENUMERATION(arr_input, res_sorted);
+}
+
+void test_oid_array__enumerate_duplicate(void)
+{
+       TEST_ENUMERATION(arr_input_dup, res_sorted);
+}
+
+void test_oid_array__lookup(void)
+{
+       TEST_LOOKUP(arr_input, "55", 1, 1);
+}
+
+void test_oid_array__lookup_non_existent(void)
+{
+       TEST_LOOKUP(arr_input, "33", INT_MIN, -1);
+}
+
+void test_oid_array__lookup_duplicates(void)
+{
+       TEST_LOOKUP(arr_input_dup, "55", 3, 5);
+}
+
+void test_oid_array__lookup_non_existent_dup(void)
+{
+       TEST_LOOKUP(arr_input_dup, "66", INT_MIN, -1);
+}
+
+void test_oid_array__lookup_almost_dup(void)
+{
+       const char *nearly_55;
+
+       nearly_55 = cl_setup_hash_algo() == GIT_HASH_SHA1 ?
+                       "5500000000000000000000000000000000000001" :
+                       "5500000000000000000000000000000000000000000000000000000000000001";
+
+       TEST_LOOKUP(((const char *[]){ "55", nearly_55 }), "55", 0, 0);
+}
+
+void test_oid_array__lookup_single_dup(void)
+{
+       TEST_LOOKUP(((const char *[]){ "55", "55" }), "55", 0, 1);
+}