t/utils/llist_test.c

   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  */
  27
  28 #include "utils/llist.h"
  29 #include "libsysdb_test.h"
  30
  31 #include <check.h>
  32
  33 /*
  34  * private data types
  35  */
  36
  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 };
  46
  47 static char *unused_names[] = {
  48         "xyz",
  49         "yza",
  50         "zab"
  51 };
  52
  53 static sdb_llist_t *list;
  54
  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 */
  62
  63 static void
  64 teardown(void)
  65 {
  66         sdb_llist_destroy(list);
  67         list = NULL;
  68 } /* teardown */
  69
  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 */
  82
  83 START_TEST(test_llist_clone)
  84 {
  85         sdb_llist_t *clone;
  86         size_t i;
  87
  88         populate();
  89
  90         clone = sdb_llist_clone(list);
  91         fail_unless(clone != NULL,
  92                         "sdb_llist_clone() = NULL; expected: cloned list object");
  93
  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         }
  98
  99         sdb_llist_destroy(clone);
 100 }
 101 END_TEST
 102
 103 START_TEST(test_llist_destroy)
 104 {
 105         size_t i;
 106         populate();
 107         sdb_llist_destroy(list);
 108         list = NULL;
 109
 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
 117
 118 START_TEST(test_llist_append)
 119 {
 120         size_t i;
 121
 122         fail_unless(sdb_llist_len(list) == 0,
 123                         "sdb_llist_len(<empty list>) = %zu; expected: 0",
 124                         sdb_llist_len(list));
 125
 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
 140
 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
 155
 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
 172
 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() = NULL; expected: %p",
 181                                 &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
 189
 190 static int
 191 dummy_lookup(const sdb_object_t __attribute__((unused)) *obj,
 192                 const void __attribute__((unused)) *user_data)
 193 {
 194         return 0;
 195 } /* dummy_lookup */
 196
 197 START_TEST(test_llist_search)
 198 {
 199         size_t i;
 200         populate();
 201         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 202                 sdb_object_t *check = sdb_llist_search_by_name(list,
 203                                 golden_data[i].name);
 204                 fail_unless(check == &golden_data[i],
 205                                 "sdb_llist_search_by_name(%s) = NULL; expected: %p",
 206                                 golden_data[i].name, &golden_data[i]);
 207         }
 208
 209         for (i = 0; i < SDB_STATIC_ARRAY_LEN(unused_names); ++i) {
 210                 sdb_object_t *check = sdb_llist_search_by_name(list,
 211                                 unused_names[i]);
 212                 fail_unless(check == NULL,
 213                                 "sdb_llist_search_by_name(%s) = %p; expected: NULL",
 214                                 unused_names[i], check);
 215         }
 216
 217         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 218                 /* dummy_lookup always return 0, thus, this will always return the
 219                  * first element */
 220                 sdb_object_t *check = sdb_llist_search(list, dummy_lookup, NULL);
 221                 fail_unless(check == &golden_data[i],
 222                                 "sdb_llist_search() = %p (%s); expected: %p (%s)",
 223                                 check, check->name, &golden_data[i], golden_data[i].name);
 224
 225                 /* => remove the first element */
 226                 check = sdb_llist_remove(list, dummy_lookup, NULL);
 227                 fail_unless(check == &golden_data[i],
 228                                 "sdb_llist_remove() = %p (%s); expected: %p (%s)",
 229                                 check, check->name, &golden_data[i], golden_data[i].name);
 230                 fail_unless(check->ref_cnt == 2,
 231                                 "sdb_llist_remove() changed reference count; got: %i; "
 232                                 "expected: 2", check->ref_cnt);
 233         }
 234         /* should now be empty */
 235         fail_unless(sdb_llist_len(list) == 0,
 236                         "Still have %i elements in the list; expected: 0",
 237                         sdb_llist_len(list));
 238 }
 239 END_TEST
 240
 241 START_TEST(test_llist_shift)
 242 {
 243         size_t i;
 244         populate();
 245         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 246                 sdb_object_t *check = sdb_llist_shift(list);
 247                 fail_unless(check == &golden_data[i],
 248                                 "sdb_llist_shift() = NULL; expected: %p",
 249                                 &golden_data[i]);
 250                 fail_unless(check->ref_cnt == 2,
 251                                 "sdb_llist_shift() changed reference count; got: %i; "
 252                                 "expected: 2", check->ref_cnt);
 253         }
 254
 255         /* must be empty now */
 256         fail_unless(sdb_llist_shift(list) == NULL,
 257                         "sdb_llist_shift() returned value; expected: NULL");
 258 }
 259 END_TEST
 260
 261 START_TEST(test_llist_iter)
 262 {
 263         sdb_llist_iter_t *iter;
 264         size_t i;
 265
 266         populate();
 267
 268         iter = sdb_llist_get_iter(list);
 269         fail_unless(iter != NULL,
 270                         "sdb_llist_get_iter() did not return an iterator");
 271
 272         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 273                 sdb_object_t *check;
 274                 fail_unless(sdb_llist_iter_has_next(iter),
 275                                 "sdb_llist_iter_has_next() = FALSE; expected: TRUE");
 276                 check = sdb_llist_iter_get_next(iter);
 277                 fail_unless(check == &golden_data[i],
 278                                 "sdb_llist_iter_get_next() = %p; expected: %p",
 279                                 check, &golden_data[i]);
 280         }
 281
 282         fail_unless(!sdb_llist_iter_has_next(iter),
 283                         "sdb_llist_iter_has_next() = TRUE; expected: FALSE");
 284         fail_unless(sdb_llist_iter_get_next(iter) == NULL,
 285                         "sdb_llist_iter_get_next() returned value; expected: NULL");
 286         sdb_llist_iter_destroy(iter);
 287 }
 288 END_TEST
 289
 290 START_TEST(test_llist_iter_remove)
 291 {
 292         sdb_llist_iter_t *iter;
 293         sdb_object_t *check;
 294         size_t i;
 295
 296         populate();
 297
 298         iter = sdb_llist_get_iter(list);
 299         fail_unless(iter != NULL,
 300                         "sdb_llist_get_iter() did not return an iterator");
 301
 302         i = 0;
 303         while (sdb_llist_iter_has_next(iter)) {
 304                 check = sdb_llist_iter_get_next(iter);
 305                 fail_unless(check == &golden_data[i],
 306                                 "sdb_llist_iter_get_next() = %p; expected: %p",
 307                                 check, &golden_data[i]);
 308
 309                 sdb_llist_iter_remove_current(iter);
 310                 ++i;
 311         }
 312         sdb_llist_iter_destroy(iter);
 313
 314         fail_unless(i == (size_t)SDB_STATIC_ARRAY_LEN(golden_data),
 315                         "iterated for %zu steps; expected: %i",
 316                         i, SDB_STATIC_ARRAY_LEN(golden_data));
 317
 318         /* all elements should be removed */
 319         check = sdb_llist_shift(list);
 320         fail_unless(check == NULL,
 321                         "sdb_llist_shift() = %p; expected: NULL", check);
 322 }
 323 END_TEST
 324
 325 Suite *
 326 util_llist_suite(void)
 327 {
 328         Suite *s = suite_create("utils::llist");
 329         TCase *tc;
 330
 331         tc = tcase_create("core");
 332         tcase_add_checked_fixture(tc, setup, teardown);
 333         tcase_add_test(tc, test_llist_clone);
 334         tcase_add_test(tc, test_llist_destroy);
 335         tcase_add_test(tc, test_llist_append);
 336         tcase_add_test(tc, test_llist_insert);
 337         tcase_add_test(tc, test_validate_insert);
 338         tcase_add_test(tc, test_llist_get);
 339         tcase_add_test(tc, test_llist_search);
 340         tcase_add_test(tc, test_llist_shift);
 341         tcase_add_test(tc, test_llist_iter);
 342         tcase_add_test(tc, test_llist_iter_remove);
 343         suite_add_tcase(s, tc);
 344
 345         return s;
 346 } /* util_llist_suite */
 347
 348 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 349