8a6052e8fcb5b5d06c4446f8b5745a87407df283
1 /*
2 * SysDB - t/utils/llist_test.c
3 * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #include "utils/llist.h"
29 #include "libsysdb_test.h"
31 #include <check.h>
33 /*
34 * private data types
35 */
37 static sdb_object_t golden_data[] = {
38 SSTRING_OBJ("abc"),
39 SSTRING_OBJ("bcd"),
40 SSTRING_OBJ("cde"),
41 SSTRING_OBJ("def"),
42 SSTRING_OBJ("efg"),
43 SSTRING_OBJ("fgh"),
44 SSTRING_OBJ("ghi")
45 };
47 static char *unused_names[] = {
48 "xyz",
49 "yza",
50 "zab"
51 };
53 static sdb_llist_t *list;
55 static void
56 setup(void)
57 {
58 list = sdb_llist_create();
59 fail_unless(list != NULL,
60 "sdb_llist_create() = NULL; expected list object");
61 } /* setup */
63 static void
64 teardown(void)
65 {
66 sdb_llist_destroy(list);
67 list = NULL;
68 } /* teardown */
70 /* populate the list with the golden data in the specified order */
71 static void
72 populate(void)
73 {
74 size_t i;
75 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
76 int check = sdb_llist_append(list, &golden_data[i]);
77 fail_unless(check == 0,
78 "sdb_llist_append(%s) = %i; expected: 0",
79 golden_data[i].name, check);
80 }
81 } /* populate */
83 START_TEST(test_llist_clone)
84 {
85 sdb_llist_t *clone;
86 size_t i;
88 populate();
90 clone = sdb_llist_clone(list);
91 fail_unless(clone != NULL,
92 "sdb_llist_clone() = NULL; expected: cloned list object");
94 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
95 fail_unless(golden_data[i].ref_cnt == 3,
96 "sdb_llist_clone() did not take ownership");
97 }
99 sdb_llist_destroy(clone);
100 }
101 END_TEST
103 START_TEST(test_llist_destroy)
104 {
105 size_t i;
106 populate();
107 sdb_llist_destroy(list);
108 list = NULL;
110 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
111 fail_unless(golden_data[i].ref_cnt == 1,
112 "sdb_llist_destroy() did not deref element %s",
113 golden_data[i].name);
114 }
115 }
116 END_TEST
118 START_TEST(test_llist_append)
119 {
120 size_t i;
122 fail_unless(sdb_llist_len(list) == 0,
123 "sdb_llist_len(<empty list>) = %zu; expected: 0",
124 sdb_llist_len(list));
126 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
127 int check = sdb_llist_append(list, &golden_data[i]);
128 fail_unless(check == 0,
129 "sdb_llist_append(%s) = %i; expected: 0",
130 golden_data[i].name, check);
131 fail_unless(golden_data[i].ref_cnt == 2,
132 "sdb_llist_append(%s) did not take ownership",
133 golden_data[i].name);
134 fail_unless(sdb_llist_len(list) == i + 1,
135 "sdb_llist_len(<empty list>) = %zu; expected: zu",
136 sdb_llist_len(list), i + 1);
137 }
138 }
139 END_TEST
141 START_TEST(test_llist_insert)
142 {
143 size_t i;
144 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
145 int check = sdb_llist_insert(list, &golden_data[i], 0);
146 fail_unless(check == 0,
147 "sdb_llist_insert(%s, 0) = %i; expected: 0",
148 golden_data[i].name, check);
149 fail_unless(golden_data[i].ref_cnt == 2,
150 "sdb_llist_insert(%s, 0) did not take ownership",
151 golden_data[i].name);
152 }
153 }
154 END_TEST
156 START_TEST(test_validate_insert)
157 {
158 size_t i;
159 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
160 /* none of these operations will succeed
161 * => 1 is invalid for each case */
162 int check = sdb_llist_insert(list, &golden_data[i], 1);
163 fail_unless(check == -1,
164 "sdb_llist_insert(%s, 1) = %i; expected: -1",
165 golden_data[i].name, check);
166 fail_unless(golden_data[i].ref_cnt == 1,
167 "sdb_llist_insert(%s, 1) took ownership",
168 golden_data[i].name);
169 }
170 }
171 END_TEST
173 START_TEST(test_llist_get)
174 {
175 size_t i;
176 populate();
177 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
178 sdb_object_t *check = sdb_llist_get(list, i);
179 fail_unless(check == &golden_data[i],
180 "sdb_llist_get() = %p; expected: %p",
181 check, &golden_data[i]);
182 fail_unless(check->ref_cnt == 3,
183 "sdb_llist_get() didn't increment reference count; got: %i; "
184 "expected: 3", check->ref_cnt);
185 sdb_object_deref(check);
186 }
187 }
188 END_TEST
190 START_TEST(test_remove_by_name)
191 {
192 /* "random" indexes */
193 int indexes[] = { 4, 5, 3, 6, 2, 0, 1 };
194 size_t i;
196 populate();
198 for (i = 0; i < SDB_STATIC_ARRAY_LEN(indexes); ++i) {
199 sdb_object_t *check;
201 fail_unless((size_t)indexes[i] < SDB_STATIC_ARRAY_LEN(golden_data),
202 "INTERNAL ERROR: invalid index %i", indexes[i]);
204 check = sdb_llist_remove_by_name(list, golden_data[indexes[i]].name);
205 fail_unless(check == &golden_data[indexes[i]],
206 "sdb_llist_remove_by_name() = %p; expected: %p",
207 check, &golden_data[indexes[i]]);
208 fail_unless(check->ref_cnt == 2,
209 "sdb_llist_remove_by_name() returned unexpected reference "
210 "count; got: %i; expected: 2", check->ref_cnt);
212 check = sdb_llist_remove_by_name(list, golden_data[indexes[i]].name);
213 fail_unless(check == NULL,
214 "sdb_llist_remove_by_name() did not remove the element");
215 }
216 }
217 END_TEST
219 static int
220 dummy_lookup(const sdb_object_t __attribute__((unused)) *obj,
221 const void __attribute__((unused)) *user_data)
222 {
223 return 0;
224 } /* dummy_lookup */
226 START_TEST(test_llist_search)
227 {
228 size_t i;
229 populate();
230 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
231 sdb_object_t *check = sdb_llist_search_by_name(list,
232 golden_data[i].name);
233 fail_unless(check == &golden_data[i],
234 "sdb_llist_search_by_name(%s) = NULL; expected: %p",
235 golden_data[i].name, &golden_data[i]);
236 }
238 for (i = 0; i < SDB_STATIC_ARRAY_LEN(unused_names); ++i) {
239 sdb_object_t *check = sdb_llist_search_by_name(list,
240 unused_names[i]);
241 fail_unless(check == NULL,
242 "sdb_llist_search_by_name(%s) = %p; expected: NULL",
243 unused_names[i], check);
244 }
246 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
247 /* dummy_lookup always return 0, thus, this will always return the
248 * first element */
249 sdb_object_t *check = sdb_llist_search(list, dummy_lookup, NULL);
250 fail_unless(check == &golden_data[i],
251 "sdb_llist_search() = %p (%s); expected: %p (%s)",
252 check, check->name, &golden_data[i], golden_data[i].name);
254 /* => remove the first element */
255 check = sdb_llist_remove(list, dummy_lookup, NULL);
256 fail_unless(check == &golden_data[i],
257 "sdb_llist_remove() = %p (%s); expected: %p (%s)",
258 check, check->name, &golden_data[i], golden_data[i].name);
259 fail_unless(check->ref_cnt == 2,
260 "sdb_llist_remove() changed reference count; got: %i; "
261 "expected: 2", check->ref_cnt);
262 }
263 /* should now be empty */
264 fail_unless(sdb_llist_len(list) == 0,
265 "Still have %i elements in the list; expected: 0",
266 sdb_llist_len(list));
267 }
268 END_TEST
270 START_TEST(test_llist_shift)
271 {
272 size_t i;
273 populate();
274 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
275 sdb_object_t *check = sdb_llist_shift(list);
276 fail_unless(check == &golden_data[i],
277 "sdb_llist_shift() = NULL; expected: %p",
278 &golden_data[i]);
279 fail_unless(check->ref_cnt == 2,
280 "sdb_llist_shift() changed reference count; got: %i; "
281 "expected: 2", check->ref_cnt);
282 }
284 /* must be empty now */
285 fail_unless(sdb_llist_shift(list) == NULL,
286 "sdb_llist_shift() returned value; expected: NULL");
287 }
288 END_TEST
290 START_TEST(test_llist_iter)
291 {
292 sdb_llist_iter_t *iter;
293 size_t i;
295 populate();
297 iter = sdb_llist_get_iter(list);
298 fail_unless(iter != NULL,
299 "sdb_llist_get_iter() did not return an iterator");
301 for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
302 sdb_object_t *check;
303 fail_unless(sdb_llist_iter_has_next(iter),
304 "sdb_llist_iter_has_next() = FALSE; expected: TRUE");
305 check = sdb_llist_iter_get_next(iter);
306 fail_unless(check == &golden_data[i],
307 "sdb_llist_iter_get_next() = %p; expected: %p",
308 check, &golden_data[i]);
309 }
311 fail_unless(!sdb_llist_iter_has_next(iter),
312 "sdb_llist_iter_has_next() = TRUE; expected: FALSE");
313 fail_unless(sdb_llist_iter_get_next(iter) == NULL,
314 "sdb_llist_iter_get_next() returned value; expected: NULL");
315 sdb_llist_iter_destroy(iter);
316 }
317 END_TEST
319 START_TEST(test_llist_iter_remove)
320 {
321 sdb_llist_iter_t *iter;
322 sdb_object_t *check;
323 size_t i;
325 populate();
327 iter = sdb_llist_get_iter(list);
328 fail_unless(iter != NULL,
329 "sdb_llist_get_iter() did not return an iterator");
331 i = 0;
332 while (sdb_llist_iter_has_next(iter)) {
333 check = sdb_llist_iter_get_next(iter);
334 fail_unless(check == &golden_data[i],
335 "sdb_llist_iter_get_next() = %p; expected: %p",
336 check, &golden_data[i]);
338 sdb_llist_iter_remove_current(iter);
339 ++i;
340 }
341 sdb_llist_iter_destroy(iter);
343 fail_unless(i == (size_t)SDB_STATIC_ARRAY_LEN(golden_data),
344 "iterated for %zu steps; expected: %i",
345 i, SDB_STATIC_ARRAY_LEN(golden_data));
347 /* all elements should be removed */
348 check = sdb_llist_shift(list);
349 fail_unless(check == NULL,
350 "sdb_llist_shift() = %p; expected: NULL", check);
351 }
352 END_TEST
354 Suite *
355 util_llist_suite(void)
356 {
357 Suite *s = suite_create("utils::llist");
358 TCase *tc;
360 tc = tcase_create("core");
361 tcase_add_checked_fixture(tc, setup, teardown);
362 tcase_add_test(tc, test_llist_clone);
363 tcase_add_test(tc, test_llist_destroy);
364 tcase_add_test(tc, test_llist_append);
365 tcase_add_test(tc, test_llist_insert);
366 tcase_add_test(tc, test_validate_insert);
367 tcase_add_test(tc, test_llist_get);
368 tcase_add_test(tc, test_remove_by_name);
369 tcase_add_test(tc, test_llist_search);
370 tcase_add_test(tc, test_llist_shift);
371 tcase_add_test(tc, test_llist_iter);
372 tcase_add_test(tc, test_llist_iter_remove);
373 suite_add_tcase(s, tc);
375 return s;
376 } /* util_llist_suite */
378 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */