Merged revisions 328717 via svnmerge from
[asterisk/asterisk.git] / tests / test_linkedlists.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2011, Terry Wilson
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Linked List Tests
20  *
21  * \author Terry Wilson <twilson@digium.com>
22  *
23  * \ingroup tests
24  */
25
26 /*** MODULEINFO
27         <defaultenabled>no</defaultenabled>
28         <support_level>extended</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/module.h"
36 #include "asterisk/test.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/linkedlists.h"
40
41 struct test_val {
42         const char *name;
43         AST_LIST_ENTRY(test_val) list;
44 };
45
46 static struct test_val a = { "A" };
47 static struct test_val b = { "B" };
48 static struct test_val c = { "C" };
49 static struct test_val d = { "D" };
50
51 AST_LIST_HEAD_NOLOCK(test_list, test_val);
52
53 static int list_expect(struct test_list *test_list, char *expect, struct ast_str **buf)
54 {
55         struct test_val *i;
56
57         ast_str_reset(*buf);
58         AST_LIST_TRAVERSE(test_list, i, list) {
59                 ast_str_append(buf, 0, "%s", i->name);
60         }
61
62         return strcmp(expect, ast_str_buffer(*buf));
63 }
64
65 #define MATCH_OR_FAIL(list, val, retbuf) \
66         if (list_expect(list, val, &retbuf)) { \
67                 ast_test_status_update(test, "Expected: %s, Got: %s\n", val, ast_str_buffer(retbuf)); \
68                 ast_free(retbuf); \
69                 return AST_TEST_FAIL; \
70         }
71
72 #define ELEM_OR_FAIL(x,y) \
73         if ((x) != (y)) { \
74                 ast_test_status_update(test, "Expected: %s, Got: %s\n", (x)->name, (y)->name); \
75                 return AST_TEST_FAIL; \
76         }
77
78 AST_TEST_DEFINE(ll_tests)
79 {
80         struct ast_str *buf;
81         struct test_list test_list = { 0, };
82         struct test_val *bogus;
83
84         switch (cmd) {
85         case TEST_INIT:
86                 info->name = "ll_tests";
87                 info->category = "/main/linkedlists";
88                 info->summary = "linked list unit test";
89                 info->description =
90                         "Test the linked list API";
91                 return AST_TEST_NOT_RUN;
92         case TEST_EXECUTE:
93                 break;
94         }
95
96         if (!(buf = ast_str_create(16))) {
97                 return AST_TEST_FAIL;
98         }
99
100         if (!(bogus = alloca(sizeof(*bogus)))) {
101                 return AST_TEST_FAIL;
102         }
103
104         if (AST_LIST_REMOVE(&test_list, bogus, list)) {
105                 ast_test_status_update(test, "AST_LIST_REMOVE should safely return NULL for missing element from empty list\n");
106                 return AST_TEST_FAIL;
107         }
108
109         /* INSERT_HEAD and REMOVE_HEAD tests */
110         AST_LIST_INSERT_HEAD(&test_list, &a, list);
111         MATCH_OR_FAIL(&test_list, "A", buf);
112         AST_LIST_INSERT_HEAD(&test_list, &b, list);
113         MATCH_OR_FAIL(&test_list, "BA", buf);
114         AST_LIST_INSERT_HEAD(&test_list, &c, list);
115         MATCH_OR_FAIL(&test_list, "CBA", buf);
116         AST_LIST_INSERT_HEAD(&test_list, &d, list);
117         MATCH_OR_FAIL(&test_list, "DCBA", buf);
118         AST_LIST_REMOVE_HEAD(&test_list, list);
119         MATCH_OR_FAIL(&test_list, "CBA", buf);
120         AST_LIST_REMOVE_HEAD(&test_list, list);
121         MATCH_OR_FAIL(&test_list, "BA", buf);
122         AST_LIST_REMOVE_HEAD(&test_list, list);
123         MATCH_OR_FAIL(&test_list, "A", buf);
124         AST_LIST_REMOVE_HEAD(&test_list, list);
125         MATCH_OR_FAIL(&test_list, "", buf);
126
127         if (AST_LIST_REMOVE_HEAD(&test_list, list)) {
128                 ast_test_status_update(test, "Somehow removed an item from the head of a list that didn't exist\n");
129                 return AST_TEST_FAIL;
130         }
131
132         if (!AST_LIST_EMPTY(&test_list)) {
133                 ast_test_status_update(test, "List should be empty\n");
134                 return AST_TEST_FAIL;
135         }
136
137         AST_LIST_INSERT_TAIL(&test_list, &a, list);
138         MATCH_OR_FAIL(&test_list, "A", buf);
139         AST_LIST_INSERT_TAIL(&test_list, &b, list);
140         MATCH_OR_FAIL(&test_list, "AB", buf);
141         AST_LIST_INSERT_TAIL(&test_list, &c, list);
142         MATCH_OR_FAIL(&test_list, "ABC", buf);
143         AST_LIST_INSERT_TAIL(&test_list, &d, list);
144         MATCH_OR_FAIL(&test_list, "ABCD", buf);
145
146         if (AST_LIST_REMOVE(&test_list, bogus, list)) {
147                 ast_test_status_update(test, "AST_LIST_REMOVE should safely return NULL for missing element\n");
148                 return AST_TEST_FAIL;
149         }
150
151         bogus = NULL;
152
153         if (AST_LIST_REMOVE(&test_list, bogus, list)) {
154                 ast_test_status_update(test, "AST_LIST_REMOVE should safely return NULL for element set to NULL\n");
155                 return AST_TEST_FAIL;
156         }
157
158         AST_LIST_REMOVE(&test_list, &b, list);
159         MATCH_OR_FAIL(&test_list, "ACD", buf);
160         AST_LIST_REMOVE(&test_list, &d, list);
161         MATCH_OR_FAIL(&test_list, "AC", buf);
162         AST_LIST_REMOVE(&test_list, &a, list);
163         MATCH_OR_FAIL(&test_list, "C", buf);
164         AST_LIST_REMOVE(&test_list, &c, list);
165         MATCH_OR_FAIL(&test_list, "", buf);
166
167         if (!AST_LIST_EMPTY(&test_list)) {
168                 ast_test_status_update(test, "List should be empty\n");
169                 return AST_TEST_FAIL;
170         }
171
172         if (AST_LIST_REMOVE(&test_list, bogus, list)) {
173                 ast_test_status_update(test, "AST_LIST_REMOVE should safely return NULL asked to remove a NULL pointer from an empty list\n");
174                 return AST_TEST_FAIL;
175         }
176
177         AST_LIST_INSERT_HEAD(&test_list, &a, list);
178         MATCH_OR_FAIL(&test_list, "A", buf);
179         AST_LIST_INSERT_TAIL(&test_list, &b, list);
180         MATCH_OR_FAIL(&test_list, "AB", buf);
181         AST_LIST_INSERT_AFTER(&test_list, &a, &c, list);
182         MATCH_OR_FAIL(&test_list, "ACB", buf);
183         AST_LIST_INSERT_AFTER(&test_list, &b, &d, list);
184         MATCH_OR_FAIL(&test_list, "ACBD", buf);
185
186         ELEM_OR_FAIL(AST_LIST_FIRST(&test_list), &a);
187         ELEM_OR_FAIL(AST_LIST_LAST(&test_list), &d);
188         ELEM_OR_FAIL(AST_LIST_NEXT(&a, list), &c);
189
190         AST_LIST_TRAVERSE_SAFE_BEGIN(&test_list, bogus, list) {
191                 AST_LIST_REMOVE_CURRENT(list);
192         }
193         AST_LIST_TRAVERSE_SAFE_END;
194
195         if (!AST_LIST_EMPTY(&test_list)) {
196                 ast_test_status_update(test, "List should be empty after traversing and removal. It wasn't.\n");
197                 return AST_TEST_FAIL;
198         }
199
200         return AST_TEST_PASS;
201 }
202
203 static int unload_module(void)
204 {
205         AST_TEST_UNREGISTER(ll_tests);
206         return 0;
207 }
208
209 static int load_module(void)
210 {
211         AST_TEST_REGISTER(ll_tests);
212         return AST_MODULE_LOAD_SUCCESS;
213 }
214
215 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Test Linked Lists");