Add unit test for testing ACL functionality.
[asterisk/asterisk.git] / tests / test_astobj2.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * David Vossel <dvossel@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief astobj2 test module
22  *
23  * \author David Vossel <dvossel@digium.com>
24  */
25
26 /*** MODULEINFO
27         <depend>TEST_FRAMEWORK</depend>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/utils.h"
35 #include "asterisk/module.h"
36 #include "asterisk/test.h"
37 #include "asterisk/astobj2.h"
38
39 struct test_obj {
40         char c[20];
41         int i;
42         int *destructor_count;
43 };
44
45 static void test_obj_destructor(void *obj)
46 {
47         struct test_obj *test_obj = (struct test_obj *) obj;
48         *test_obj->destructor_count = *test_obj->destructor_count - 1;
49 }
50
51 static int increment_cb(void *obj, void *arg, int flag)
52 {
53         int *i = (int *) arg;
54
55         *i = *i + 1;
56         return 0;
57 }
58
59 static int all_but_one_cb(void *obj, void *arg, int flag)
60 {
61         struct test_obj *test_obj = (struct test_obj *) obj;
62
63         return (test_obj->i > 1) ? CMP_MATCH : 0;
64 }
65
66 static int multiple_cb(void *obj, void *arg, int flag)
67 {
68         int *i = (int *) arg;
69         struct test_obj *test_obj = (struct test_obj *) obj;
70
71         return (test_obj->i <= *i) ? CMP_MATCH : 0;
72 }
73
74 static int test_cmp_cb(void *obj, void *arg, int flags)
75 {
76         struct test_obj *cmp_obj = (struct test_obj *) obj;
77         struct test_obj *test_obj = (struct test_obj *) arg;
78         if (!arg) {
79                 return 0;
80         }
81         return (cmp_obj->i == test_obj->i) ? CMP_MATCH | CMP_STOP : 0;
82 }
83
84 static int test_hash_cb(const void *obj, const int flags)
85 {
86         struct test_obj *test_obj = (struct test_obj *) obj;
87         if (!test_obj || ast_strlen_zero(test_obj->c)) {
88                 return 0;
89         }
90         return ast_str_hash(test_obj->c);
91 }
92
93 static int astobj2_test_helper(int use_hash, int use_cmp, unsigned int lim, struct ast_test *test)
94 {
95         struct ao2_container *c1;
96         struct ao2_container *c2;
97         struct ao2_iterator it;
98         struct ao2_iterator *mult_it;
99         struct test_obj *obj;
100         struct test_obj tmp_obj;
101         int bucket_size;
102         int increment = 0;
103         int destructor_count = 0;
104         int num;
105         int  res = AST_TEST_PASS;
106
107         /* This test needs at least 5 objects */
108         if (lim < 5) {
109                 lim = 5;
110         }
111
112         bucket_size = (ast_random() % ((lim / 4) + 1)) + 1;
113         c1 = ao2_t_container_alloc(bucket_size, use_hash ? test_hash_cb : NULL, use_cmp ? test_cmp_cb : NULL, "test");
114         c2 = ao2_t_container_alloc(bucket_size, test_hash_cb, test_cmp_cb, "test");
115
116         if (!c1 || !c2) {
117                 ast_test_status_update(test, "ao2_container_alloc failed.\n");
118                 res = AST_TEST_FAIL;
119                 goto cleanup;
120         }
121
122         /* Create objects and link into container */
123         destructor_count = lim;
124         for (num = 1; num <= lim; num++) {
125                 if (!(obj = ao2_t_alloc(sizeof(struct test_obj), test_obj_destructor, "making zombies"))) {
126                         ast_test_status_update(test, "ao2_alloc failed.\n");
127                         res = AST_TEST_FAIL;
128                         goto cleanup;
129                 }
130                 snprintf(obj->c, sizeof(obj->c), "zombie #%d", num);
131                 obj->destructor_count = &destructor_count;
132                 obj->i = num;
133                 ao2_link(c1, obj);
134                 ao2_t_ref(obj, -1, "test");
135                 if (ao2_container_count(c1) != num) {
136                         ast_test_status_update(test, "container did not link correctly\n");
137                         res = AST_TEST_FAIL;
138                 }
139         }
140
141         ast_test_status_update(test, "Container created: random bucket size %d: number of items: %d\n", bucket_size, lim);
142
143         /* Testing ao2_find with no flags */
144         num = 100;
145         for (; num; num--) {
146                 int i = (ast_random() % ((lim / 2)) + 1); /* find a random object */
147                 tmp_obj.i = i;
148                 if (!(obj = ao2_find(c1, &tmp_obj, 0))) {
149                         res = AST_TEST_FAIL;
150                         ast_test_status_update(test, "COULD NOT FIND:%d, ao2_find() with no flags failed.\n", i);
151                 } else {
152                         /* a correct match will only take place when the custom cmp function is used */
153                         if (use_cmp && obj->i != i) {
154                                 ast_test_status_update(test, "object %d does not match object %d\n", obj->i, tmp_obj.i);
155                                 res = AST_TEST_FAIL;
156                         }
157                         ao2_t_ref(obj, -1, "test");
158                 }
159         }
160
161         /* Testing ao2_find with OBJ_POINTER */
162         num = 75;
163         for (; num; num--) {
164                 int i = (ast_random() % ((lim / 2)) + 1); /* find a random object */
165                 snprintf(tmp_obj.c, sizeof(tmp_obj.c), "zombie #%d", i);
166                 tmp_obj.i = i;
167                 if (!(obj = ao2_find(c1, &tmp_obj, OBJ_POINTER))) {
168                         res = AST_TEST_FAIL;
169                         ast_test_status_update(test, "COULD NOT FIND:%d, ao2_find() with OBJ_POINTER flag failed.\n", i);
170                 } else {
171                         /* a correct match will only take place when the custom cmp function is used */
172                         if (use_cmp && obj->i != i) {
173                                 ast_test_status_update(test, "object %d does not match object %d\n", obj->i, tmp_obj.i);
174                                 res = AST_TEST_FAIL;
175                         }
176                         ao2_t_ref(obj, -1, "test");
177                 }
178         }
179
180         /* Testing ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE.
181          * In this test items are unlinked from c1 and placed in c2.  Then
182          * unlinked from c2 and placed back into c1.
183          *
184          * For this module and set of custom hash/cmp functions, an object
185          * should only be found if the astobj2 default cmp function is used.
186          * This test is designed to mimic the chan_iax.c call number use case. */
187         num = lim < 25 ? lim : 25;
188         for (; num; num--) {
189                 if (!(obj = ao2_find(c1, NULL, OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE))) {
190                         if (!use_cmp) {
191                                 ast_test_status_update(test, "ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE failed with default hash function.\n");
192                                 res = AST_TEST_FAIL;
193                         }
194                 } else {
195                         if (use_cmp) {
196                                 ast_test_status_update(test, "ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE failed with custom hash function.\n");
197                                 res = AST_TEST_FAIL;
198                         }
199                         ao2_link(c2, obj);
200                         ao2_t_ref(obj, -1, "test");
201                 }
202         }
203         it = ao2_iterator_init(c2, 0);
204         while ((obj = ao2_t_iterator_next(&it, "test"))) {
205                 ao2_t_unlink(c2, obj, "test");
206                 ao2_t_link(c1, obj, "test");
207                 ao2_t_ref(obj, -1, "test");
208         }
209         ao2_iterator_destroy(&it);
210
211         /* Test Callback with no flags. */
212         increment = 0;
213         ao2_t_callback(c1, 0, increment_cb, &increment, "test callback");
214         if (increment != lim) {
215                 ast_test_status_update(test, "callback with no flags failed. Increment is %d\n", increment);
216                 res = AST_TEST_FAIL;
217         }
218
219         /* Test Callback with OBJ_NODATA. This should do nothing different than with no flags here. */
220         increment = 0;
221         ao2_t_callback(c1, OBJ_NODATA, increment_cb, &increment, "test callback");
222         if (increment != lim) {
223                 ast_test_status_update(test, "callback with OBJ_NODATA failed. Increment is %d\n", increment);
224                 res = AST_TEST_FAIL;
225         }
226
227         /* Test OBJ_MULTIPLE with OBJ_UNLINK*/
228         num = lim < 25 ? lim : 25;
229         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE | OBJ_UNLINK, multiple_cb, &num, "test multiple"))) {
230                 ast_test_status_update(test, "OBJ_MULTIPLE iwth OBJ_UNLINK test failed.\n");
231                 res = AST_TEST_FAIL;
232         } else {
233                 /* make sure num items unlinked is as expected */
234                 if ((lim - ao2_container_count(c1)) != num) {
235                         ast_test_status_update(test, "OBJ_MULTIPLE | OBJ_UNLINK test failed, did not unlink correct number of objects.\n");
236                         res = AST_TEST_FAIL;
237                 }
238
239                 /* link what was unlinked back into c1 */
240                 while ((obj = ao2_t_iterator_next(mult_it, "test"))) {
241                         ao2_t_link(c1, obj, "test");
242                         ao2_t_ref(obj, -1, "test"); /* remove ref from iterator */
243                 }
244                 ao2_iterator_destroy(mult_it);
245         }
246
247         /* Test OBJ_MULTIPLE without unlink, add items back afterwards */
248         num = lim < 25 ? lim : 25;
249         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE, multiple_cb, &num, "test multiple"))) {
250                 ast_test_status_update(test, "OBJ_MULTIPLE without OBJ_UNLINK test failed.\n");
251                 res = AST_TEST_FAIL;
252         } else {
253                 while ((obj = ao2_t_iterator_next(mult_it, "test"))) {
254                         ao2_t_ref(obj, -1, "test"); /* remove ref from iterator */
255                 }
256                 ao2_iterator_destroy(mult_it);
257         }
258
259         /* Test OBJ_MULTIPLE without unlink and no iterating */
260         num = lim < 5 ? lim : 5;
261         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE, multiple_cb, &num, "test multiple"))) {
262                 ast_test_status_update(test, "OBJ_MULTIPLE with no OBJ_UNLINK and no iterating failed.\n");
263                 res = AST_TEST_FAIL;
264         } else {
265                 ao2_iterator_destroy(mult_it);
266         }
267
268         /* Is the container count what we expect after all the finds and unlinks?*/
269         if (ao2_container_count(c1) != lim) {
270                 ast_test_status_update(test, "container count does not match what is expected after ao2_find tests.\n");
271                 res = AST_TEST_FAIL;
272         }
273
274         /* Testing iterator.  Unlink a single object and break. do not add item back */
275         it = ao2_iterator_init(c1, 0);
276         num = (lim / 4) + 1;
277         while ((obj = ao2_t_iterator_next(&it, "test"))) {
278                 if (obj->i == num) {
279                         ao2_t_ref(obj, -1, "test");
280                         ao2_t_unlink(c1, obj, "test");
281                         break;
282                 }
283                 ao2_t_ref(obj, -1, "test");
284         }
285         ao2_iterator_destroy(&it);
286
287         /* Is the container count what we expect after removing a single item? */
288         if (ao2_container_count(c1) != (lim - 1)) {
289                 ast_test_status_update(test, "unlink during iterator failed. Number %d was not removed.\n", num);
290                 res = AST_TEST_FAIL;
291         }
292
293         /* Test unlink all with OBJ_MULTIPLE, leave a single object for the container to destroy */
294         ao2_t_callback(c1, OBJ_MULTIPLE | OBJ_UNLINK | OBJ_NODATA, all_but_one_cb, NULL, "test multiple");
295         /* check to make sure all test_obj destructors were called except for 1 */
296         if (destructor_count != 1) {
297                 ast_test_status_update(test, "OBJ_MULTIPLE | OBJ_UNLINK | OBJ_NODATA failed. destructor count %d\n", destructor_count);
298                 res = AST_TEST_FAIL;
299         }
300
301 cleanup:
302         /* destroy containers */
303         if (c1) {
304                 ao2_t_ref(c1, -1, "bye c1");
305         }
306         if (c2) {
307                 ao2_t_ref(c2, -1, "bye c2");
308         }
309
310         if (destructor_count > 0) {
311                 ast_test_status_update(test, "all destructors were not called, destructor count is %d\n", destructor_count);
312                 res = AST_TEST_FAIL;
313         } else if (destructor_count < 0) {
314                 ast_test_status_update(test, "Destructor was called too many times, destructor count is %d\n", destructor_count);
315                 res = AST_TEST_FAIL;
316         }
317
318         return res;
319 }
320
321 AST_TEST_DEFINE(astobj2_test_1)
322 {
323         int res = AST_TEST_PASS;
324
325         switch (cmd) {
326         case TEST_INIT:
327                 info->name = "astobj2_test1";
328                 info->category = "main/astobj2/";
329                 info->summary = "astobj2 test using ao2 objects, containers, callbacks, and iterators";
330                 info->description =
331                         "Builds ao2_containers with various item numbers, bucket sizes, cmp and hash "
332                         "functions. Runs a series of tests to manipulate the container using callbacks "
333                         "and iterators.  Verifies expected behavior.";
334                 return AST_TEST_NOT_RUN;
335         case TEST_EXECUTE:
336                 break;
337         }
338
339
340         /* Test 1, 500 items with custom hash and cmp functions */
341         ast_test_status_update(test, "Test 1, astobj2 test with 500 items.\n");
342         if ((res = astobj2_test_helper(1, 1, 500, test)) == AST_TEST_FAIL) {
343                 return res;
344         }
345
346         /* Test 2, 1000 items with custom hash and default cmp functions */
347         ast_test_status_update(test, "Test 2, astobj2 test with 1000 items.\n");
348         if ((res = astobj2_test_helper(1, 0, 1000, test)) == AST_TEST_FAIL) {
349                 return res;
350         }
351
352         /* Test 3, 10000 items with default hash and custom cmp functions */
353         ast_test_status_update(test, "Test 3, astobj2 test with 10000 items.\n");
354         if ((res = astobj2_test_helper(0, 1, 10000, test)) == AST_TEST_FAIL) {
355                 return res;
356         }
357
358         /* Test 4, 100000 items with default hash and cmp functions */
359         ast_test_status_update(test, "Test 4, astobj2 test with 100000 items.\n");
360         if ((res = astobj2_test_helper(0, 0, 100000, test)) == AST_TEST_FAIL) {
361                 return res;
362         }
363
364         return res;
365 }
366
367 static int unload_module(void)
368 {
369         AST_TEST_UNREGISTER(astobj2_test_1);
370         return 0;
371 }
372
373 static int load_module(void)
374 {
375         AST_TEST_REGISTER(astobj2_test_1);
376         return AST_MODULE_LOAD_SUCCESS;
377 }
378
379 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "ASTOBJ2 Unit Test");