t/unit-tests: adapt priority queue test to use clar test framework

Convert the prio-queue test script to clar framework by using clar
assertions where necessary. Test functions are created as a standalone
to test different cases.

update the type of the variable `j` from int to `size_t`, this ensures
compatibility with the type used for result_size, which is also size_t,
preventing a potential warning or error caused by comparisons between
signed and unsigned integers.

Mentored-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Seyi Kuforiji <kuforiji98@gmail.com>
Acked-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Makefile b/Makefile
index 49ada4169db1ca0680b669b198ca74f577511e53..049f857512842c1848ae64a9a19cfbde11629989 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1339,6 +1339,7 @@ THIRD_PARTY_SOURCES += $(UNIT_TEST_DIR)/clar/clar/%
 
 CLAR_TEST_SUITES += u-ctype
 CLAR_TEST_SUITES += u-mem-pool
+CLAR_TEST_SUITES += u-prio-queue
 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))
@@ -1351,7 +1352,6 @@ UNIT_TEST_PROGRAMS += t-hashmap
 UNIT_TEST_PROGRAMS += t-oid-array
 UNIT_TEST_PROGRAMS += t-oidmap
 UNIT_TEST_PROGRAMS += t-oidtree
-UNIT_TEST_PROGRAMS += t-prio-queue
 UNIT_TEST_PROGRAMS += t-reftable-basics
 UNIT_TEST_PROGRAMS += t-reftable-block
 UNIT_TEST_PROGRAMS += t-reftable-merged

diff --git a/t/meson.build b/t/meson.build
index ffe951f9be4a1d1764623e6a8fee0156e3b2d249..09232967cdaa208a5f064e576c8180347c3cfed7 100644 (file)
--- a/t/meson.build
+++ b/t/meson.build
@@ -1,6 +1,7 @@
 clar_test_suites = [
   'unit-tests/u-ctype.c',
   'unit-tests/u-mem-pool.c',
+  'unit-tests/u-prio-queue.c',
   'unit-tests/u-strvec.c',
 ]
 
@@ -47,7 +48,6 @@ unit_test_programs = [
   'unit-tests/t-oid-array.c',
   'unit-tests/t-oidmap.c',
   'unit-tests/t-oidtree.c',
-  'unit-tests/t-prio-queue.c',
   'unit-tests/t-reftable-basics.c',
   'unit-tests/t-reftable-block.c',
   'unit-tests/t-reftable-merged.c',

diff --git a/t/unit-tests/t-prio-queue.c b/t/unit-tests/t-prio-queue.c
deleted file mode 100644 (file)
index a053635..0000000
--- a/t/unit-tests/t-prio-queue.c
+++ /dev/null
@@ -1,91 +0,0 @@
-#include "test-lib.h"
-#include "prio-queue.h"
-
-static int intcmp(const void *va, const void *vb, void *data UNUSED)
-{
-       const int *a = va, *b = vb;
-       return *a - *b;
-}
-
-
-#define MISSING  -1
-#define DUMP    -2
-#define STACK   -3
-#define GET     -4
-#define REVERSE  -5
-
-static int show(int *v)
-{
-       return v ? *v : MISSING;
-}
-
-static void test_prio_queue(int *input, size_t input_size,
-                           int *result, size_t result_size)
-{
-       struct prio_queue pq = { intcmp };
-       int j = 0;
-
-       for (size_t i = 0; i < input_size; i++) {
-               void *peek, *get;
-               switch(input[i]) {
-               case GET:
-                       peek = prio_queue_peek(&pq);
-                       get = prio_queue_get(&pq);
-                       if (!check(peek == get))
-                               return;
-                       if (!check_uint(j, <, result_size))
-                               break;
-                       if (!check_int(result[j], ==, show(get)))
-                               test_msg("      j: %d", j);
-                       j++;
-                       break;
-               case DUMP:
-                       while ((peek = prio_queue_peek(&pq))) {
-                               get = prio_queue_get(&pq);
-                               if (!check(peek == get))
-                                       return;
-                               if (!check_uint(j, <, result_size))
-                                       break;
-                               if (!check_int(result[j], ==, show(get)))
-                                       test_msg("      j: %d", j);
-                               j++;
-                       }
-                       break;
-               case STACK:
-                       pq.compare = NULL;
-                       break;
-               case REVERSE:
-                       prio_queue_reverse(&pq);
-                       break;
-               default:
-                       prio_queue_put(&pq, &input[i]);
-                       break;
-               }
-       }
-       check_uint(j, ==, result_size);
-       clear_prio_queue(&pq);
-}
-
-#define TEST_INPUT(input, result) \
-       test_prio_queue(input, ARRAY_SIZE(input), result, ARRAY_SIZE(result))
-
-int cmd_main(int argc UNUSED, const char **argv UNUSED)
-{
-       TEST(TEST_INPUT(((int []){ 2, 6, 3, 10, 9, 5, 7, 4, 5, 8, 1, DUMP }),
-                       ((int []){ 1, 2, 3, 4, 5, 5, 6, 7, 8, 9, 10 })),
-            "prio-queue works for basic input");
-       TEST(TEST_INPUT(((int []){ 6, 2, 4, GET, 5, 3, GET, GET, 1, DUMP }),
-                       ((int []){ 2, 3, 4, 1, 5, 6 })),
-            "prio-queue works for mixed put & get commands");
-       TEST(TEST_INPUT(((int []){ 1, 2, GET, GET, GET, 1, 2, GET, GET, GET }),
-                       ((int []){ 1, 2, MISSING, 1, 2, MISSING })),
-            "prio-queue works when queue is empty");
-       TEST(TEST_INPUT(((int []){ STACK, 8, 1, 5, 4, 6, 2, 3, DUMP }),
-                       ((int []){ 3, 2, 6, 4, 5, 1, 8 })),
-            "prio-queue works when used as a LIFO stack");
-       TEST(TEST_INPUT(((int []){ STACK, 1, 2, 3, 4, 5, 6, REVERSE, DUMP }),
-                       ((int []){ 1, 2, 3, 4, 5, 6 })),
-            "prio-queue works when LIFO stack is reversed");
-
-       return test_done();
-}

diff --git a/t/unit-tests/u-prio-queue.c b/t/unit-tests/u-prio-queue.c
new file mode 100644 (file)
index 0000000..145e689
--- /dev/null
+++ b/t/unit-tests/u-prio-queue.c
@@ -0,0 +1,94 @@
+#include "unit-test.h"
+#include "prio-queue.h"
+
+static int intcmp(const void *va, const void *vb, void *data UNUSED)
+{
+       const int *a = va, *b = vb;
+       return *a - *b;
+}
+
+
+#define MISSING  -1
+#define DUMP    -2
+#define STACK   -3
+#define GET     -4
+#define REVERSE  -5
+
+static int show(int *v)
+{
+       return v ? *v : MISSING;
+}
+
+static void test_prio_queue(int *input, size_t input_size,
+                           int *result, size_t result_size)
+{
+       struct prio_queue pq = { intcmp };
+       size_t j = 0;
+
+       for (size_t i = 0; i < input_size; i++) {
+               void *peek, *get;
+               switch(input[i]) {
+               case GET:
+                       peek = prio_queue_peek(&pq);
+                       get = prio_queue_get(&pq);
+                       cl_assert(peek == get);
+                       cl_assert(j < result_size);
+                       cl_assert_equal_i(result[j], show(get));
+                       j++;
+                       break;
+               case DUMP:
+                       while ((peek = prio_queue_peek(&pq))) {
+                               get = prio_queue_get(&pq);
+                               cl_assert(peek == get);
+                               cl_assert(j < result_size);
+                               cl_assert_equal_i(result[j], show(get));
+                               j++;
+                       }
+                       break;
+               case STACK:
+                       pq.compare = NULL;
+                       break;
+               case REVERSE:
+                       prio_queue_reverse(&pq);
+                       break;
+               default:
+                       prio_queue_put(&pq, &input[i]);
+                       break;
+               }
+       }
+       cl_assert_equal_i(j, result_size);
+       clear_prio_queue(&pq);
+}
+
+#define TEST_INPUT(input, result) \
+       test_prio_queue(input, ARRAY_SIZE(input), result, ARRAY_SIZE(result))
+
+void test_prio_queue__basic(void)
+{
+       TEST_INPUT(((int []){ 2, 6, 3, 10, 9, 5, 7, 4, 5, 8, 1, DUMP }),
+                  ((int []){ 1, 2, 3, 4, 5, 5, 6, 7, 8, 9, 10 }));
+}
+
+void test_prio_queue__mixed(void)
+{
+       TEST_INPUT(((int []){ 6, 2, 4, GET, 5, 3, GET, GET, 1, DUMP }),
+                  ((int []){ 2, 3, 4, 1, 5, 6 }));
+}
+
+void test_prio_queue__empty(void)
+{
+       TEST_INPUT(((int []){ 1, 2, GET, GET, GET, 1, 2, GET, GET, GET }),
+                  ((int []){ 1, 2, MISSING, 1, 2, MISSING }));
+}
+
+void test_prio_queue__stack(void)
+{
+       TEST_INPUT(((int []){ STACK, 8, 1, 5, 4, 6, 2, 3, DUMP }),
+                  ((int []){ 3, 2, 6, 4, 5, 1, 8 }));
+}
+
+void test_prio_queue__reverse_stack(void)
+{
+       TEST_INPUT(((int []){ STACK, 1, 2, 3, 4, 5, 6, REVERSE, DUMP }),
+                  ((int []){ 1, 2, 3, 4, 5, 6 }));
+}