t/unit-tests: adapt example decorate test to use clar test framework
Introduce `test_example_decorate__initialize()` to explicitly set up object IDs and retrieve corresponding objects before tests run. This ensures a consistent and predictable test state without relying on data from previous tests. Add `test_example_decorate__cleanup()` to clear decorations after each test, preventing interference between tests and ensuring each runs in isolation. Adapt example decorate test script to clar framework by using clar assertions where necessary. Previously, tests relied on data written by earlier tests, leading to unintended dependencies between them. This explicitly initializes the necessary state within `test_example_decorate__readd`, ensuring it does not depend on prior test executions. Mentored-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Seyi Kuforiji <kuforiji98@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Seyi Kuforiji committed
Jan 31, 2025 at 23:14 UTC
e0f807bdad096ef6a4d9f29de333d65d8282aeb1
4 files changed
+66
-76
Makefile
+1
-1
@@ -1340,6 +1340,7 @@ THIRD_PARTY_SOURCES += $(UNIT_TEST_DIR)/clar/%
1340
THIRD_PARTY_SOURCES += $(UNIT_TEST_DIR)/clar/clar/%
1341
1342
CLAR_TEST_SUITES += u-ctype
1343
+CLAR_TEST_SUITES += u-example-decorate
1344
CLAR_TEST_SUITES += u-hash
1345
CLAR_TEST_SUITES += u-hashmap
1346
CLAR_TEST_SUITES += u-mem-pool
@@ -1351,7 +1352,6 @@ CLAR_TEST_OBJS = $(patsubst %,$(UNIT_TEST_DIR)/%.o,$(CLAR_TEST_SUITES))
1352
CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/clar/clar.o
1353
CLAR_TEST_OBJS += $(UNIT_TEST_DIR)/unit-test.o
1354
1354
-UNIT_TEST_PROGRAMS += t-example-decorate
1355
UNIT_TEST_PROGRAMS += t-oid-array
1356
UNIT_TEST_PROGRAMS += t-oidmap
1357
UNIT_TEST_PROGRAMS += t-oidtree
t/meson.build
+1
-1
@@ -1,5 +1,6 @@
1
clar_test_suites = [
2
'unit-tests/u-ctype.c',
3
+ 'unit-tests/u-example-decorate.c',
4
'unit-tests/u-hash.c',
5
'unit-tests/u-hashmap.c',
6
'unit-tests/u-mem-pool.c',
@@ -45,7 +46,6 @@ clar_unit_tests = executable('unit-tests',
46
test('unit-tests', clar_unit_tests)
47
48
unit_test_programs = [
48
- 'unit-tests/t-example-decorate.c',
49
'unit-tests/t-oid-array.c',
50
'unit-tests/t-oidmap.c',
51
'unit-tests/t-oidtree.c',
t/unit-tests/t-example-decorate.c
deleted
-74
@@ -1,74 +0,0 @@
1
-#define USE_THE_REPOSITORY_VARIABLE
2
-
3
-#include "test-lib.h"
4
-#include "object.h"
5
-#include "decorate.h"
6
-#include "repository.h"
7
-
8
-struct test_vars {
9
- struct object *one, *two, *three;
10
- struct decoration n;
11
- int decoration_a, decoration_b;
12
-};
13
-
14
-static void t_add(struct test_vars *vars)
15
-{
16
- void *ret = add_decoration(&vars->n, vars->one, &vars->decoration_a);
17
-
18
- check(ret == NULL);
19
- ret = add_decoration(&vars->n, vars->two, NULL);
20
- check(ret == NULL);
21
-}
22
-
23
-static void t_readd(struct test_vars *vars)
24
-{
25
- void *ret = add_decoration(&vars->n, vars->one, NULL);
26
-
27
- check(ret == &vars->decoration_a);
28
- ret = add_decoration(&vars->n, vars->two, &vars->decoration_b);
29
- check(ret == NULL);
30
-}
31
-
32
-static void t_lookup(struct test_vars *vars)
33
-{
34
- void *ret = lookup_decoration(&vars->n, vars->one);
35
-
36
- check(ret == NULL);
37
- ret = lookup_decoration(&vars->n, vars->two);
38
- check(ret == &vars->decoration_b);
39
- ret = lookup_decoration(&vars->n, vars->three);
40
- check(ret == NULL);
41
-}
42
-
43
-static void t_loop(struct test_vars *vars)
44
-{
45
- int objects_noticed = 0;
46
-
47
- for (size_t i = 0; i < vars->n.size; i++) {
48
- if (vars->n.entries[i].base)
49
- objects_noticed++;
50
- }
51
- check_int(objects_noticed, ==, 2);
52
-}
53
-
54
-int cmd_main(int argc UNUSED, const char **argv UNUSED)
55
-{
56
- struct object_id one_oid = { { 1 } }, two_oid = { { 2 } }, three_oid = { { 3 } };
57
- struct test_vars vars = { 0 };
58
-
59
- vars.one = lookup_unknown_object(the_repository, &one_oid);
60
- vars.two = lookup_unknown_object(the_repository, &two_oid);
61
- vars.three = lookup_unknown_object(the_repository, &three_oid);
62
-
63
- TEST(t_add(&vars),
64
- "Add 2 objects, one with a non-NULL decoration and one with a NULL decoration.");
65
- TEST(t_readd(&vars),
66
- "When re-adding an already existing object, the old decoration is returned.");
67
- TEST(t_lookup(&vars),
68
- "Lookup returns the added declarations, or NULL if the object was never added.");
69
- TEST(t_loop(&vars), "The user can also loop through all entries.");
70
-
71
- clear_decoration(&vars.n, NULL);
72
-
73
- return test_done();
74
-}
t/unit-tests/u-example-decorate.c
new
+64
@@ -0,0 +1,64 @@
1
+#define USE_THE_REPOSITORY_VARIABLE
2
+
3
+#include "unit-test.h"
4
+#include "object.h"
5
+#include "decorate.h"
6
+#include "repository.h"
7
+
8
+struct test_vars {
9
+ struct object *one, *two, *three;
10
+ struct decoration n;
11
+ int decoration_a, decoration_b;
12
+};
13
+
14
+static struct test_vars vars;
15
+
16
+void test_example_decorate__initialize(void)
17
+{
18
+ struct object_id one_oid = { { 1 } }, two_oid = { { 2 } }, three_oid = { { 3 } };
19
+
20
+ vars.one = lookup_unknown_object(the_repository, &one_oid);
21
+ vars.two = lookup_unknown_object(the_repository, &two_oid);
22
+ vars.three = lookup_unknown_object(the_repository, &three_oid);
23
+}
24
+
25
+void test_example_decorate__cleanup(void)
26
+{
27
+ clear_decoration(&vars.n, NULL);
28
+}
29
+
30
+void test_example_decorate__add(void)
31
+{
32
+ cl_assert_equal_p(add_decoration(&vars.n, vars.one, &vars.decoration_a), NULL);
33
+ cl_assert_equal_p(add_decoration(&vars.n, vars.two, NULL), NULL);
34
+}
35
+
36
+void test_example_decorate__readd(void)
37
+{
38
+ cl_assert_equal_p(add_decoration(&vars.n, vars.one, &vars.decoration_a), NULL);
39
+ cl_assert_equal_p(add_decoration(&vars.n, vars.two, NULL), NULL);
40
+ cl_assert_equal_p(add_decoration(&vars.n, vars.one, NULL), &vars.decoration_a);
41
+ cl_assert_equal_p(add_decoration(&vars.n, vars.two, &vars.decoration_b), NULL);
42
+}
43
+
44
+void test_example_decorate__lookup(void)
45
+{
46
+ cl_assert_equal_p(add_decoration(&vars.n, vars.two, &vars.decoration_b), NULL);
47
+ cl_assert_equal_p(add_decoration(&vars.n, vars.one, NULL), NULL);
48
+ cl_assert_equal_p(lookup_decoration(&vars.n, vars.two), &vars.decoration_b);
49
+ cl_assert_equal_p(lookup_decoration(&vars.n, vars.one), NULL);
50
+}
51
+
52
+void test_example_decorate__loop(void)
53
+{
54
+ int objects_noticed = 0;
55
+
56
+ cl_assert_equal_p(add_decoration(&vars.n, vars.one, &vars.decoration_a), NULL);
57
+ cl_assert_equal_p(add_decoration(&vars.n, vars.two, &vars.decoration_b), NULL);
58
+
59
+ for (size_t i = 0; i < vars.n.size; i++)
60
+ if (vars.n.entries[i].base)
61
+ objects_noticed++;
62
+
63
+ cl_assert_equal_i(objects_noticed, 2);
64
+}