Merged revisions 332177 via svnmerge from
[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         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/utils.h"
36 #include "asterisk/module.h"
37 #include "asterisk/test.h"
38 #include "asterisk/astobj2.h"
39
40 struct test_obj {
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
78         if (!arg) {
79                 return 0;
80         }
81
82         if (flags & OBJ_KEY) {
83                 int *i = (int *) arg;
84                 return (cmp_obj->i == *i) ? CMP_MATCH | CMP_STOP : 0;
85         } else {
86                 struct test_obj *test_obj = (struct test_obj *) arg;
87                 return (cmp_obj->i == test_obj->i) ? CMP_MATCH | CMP_STOP : 0;
88         }
89 }
90
91 static int test_hash_cb(const void *obj, const int flags)
92 {
93         if (!obj) {
94                 return 0;
95         }
96
97         if (flags & OBJ_KEY) {
98                 const int *i = obj;
99
100                 return *i;
101         } else {
102                 const struct test_obj *test_obj = obj;
103
104                 return test_obj->i;
105         }
106 }
107
108 static int astobj2_test_helper(int use_hash, int use_cmp, unsigned int lim, struct ast_test *test)
109 {
110         struct ao2_container *c1;
111         struct ao2_container *c2;
112         struct ao2_iterator it;
113         struct ao2_iterator *mult_it;
114         struct test_obj *obj;
115         struct test_obj tmp_obj;
116         int bucket_size;
117         int increment = 0;
118         int destructor_count = 0;
119         int num;
120         int  res = AST_TEST_PASS;
121
122         /* This test needs at least 5 objects */
123         if (lim < 5) {
124                 lim = 5;
125         }
126
127         bucket_size = (ast_random() % ((lim / 4) + 1)) + 1;
128         c1 = ao2_t_container_alloc(bucket_size, use_hash ? test_hash_cb : NULL, use_cmp ? test_cmp_cb : NULL, "test");
129         c2 = ao2_t_container_alloc(bucket_size, test_hash_cb, test_cmp_cb, "test");
130
131         if (!c1 || !c2) {
132                 ast_test_status_update(test, "ao2_container_alloc failed.\n");
133                 res = AST_TEST_FAIL;
134                 goto cleanup;
135         }
136
137         /* Create objects and link into container */
138         destructor_count = lim;
139         for (num = 1; num <= lim; num++) {
140                 if (!(obj = ao2_t_alloc(sizeof(struct test_obj), test_obj_destructor, "making zombies"))) {
141                         ast_test_status_update(test, "ao2_alloc failed.\n");
142                         res = AST_TEST_FAIL;
143                         goto cleanup;
144                 }
145                 obj->destructor_count = &destructor_count;
146                 obj->i = num;
147                 ao2_link(c1, obj);
148                 ao2_t_ref(obj, -1, "test");
149                 if (ao2_container_count(c1) != num) {
150                         ast_test_status_update(test, "container did not link correctly\n");
151                         res = AST_TEST_FAIL;
152                 }
153         }
154
155         ast_test_status_update(test, "Container created: random bucket size %d: number of items: %d\n", bucket_size, lim);
156
157         /* Testing ao2_find with no flags */
158         num = 100;
159         for (; num; num--) {
160                 int i = (ast_random() % ((lim / 2)) + 1); /* find a random object */
161                 tmp_obj.i = i;
162                 if (!(obj = ao2_find(c1, &tmp_obj, 0))) {
163                         res = AST_TEST_FAIL;
164                         ast_test_status_update(test, "COULD NOT FIND:%d, ao2_find() with no flags failed.\n", i);
165                 } else {
166                         /* a correct match will only take place when the custom cmp function is used */
167                         if (use_cmp && obj->i != i) {
168                                 ast_test_status_update(test, "object %d does not match object %d\n", obj->i, tmp_obj.i);
169                                 res = AST_TEST_FAIL;
170                         }
171                         ao2_t_ref(obj, -1, "test");
172                 }
173         }
174
175         /* Testing ao2_find with OBJ_POINTER */
176         num = 75;
177         for (; num; num--) {
178                 int i = (ast_random() % ((lim / 2)) + 1); /* find a random object */
179                 tmp_obj.i = i;
180                 if (!(obj = ao2_find(c1, &tmp_obj, OBJ_POINTER))) {
181                         res = AST_TEST_FAIL;
182                         ast_test_status_update(test, "COULD NOT FIND:%d, ao2_find() with OBJ_POINTER flag failed.\n", i);
183                 } else {
184                         /* a correct match will only take place when the custom cmp function is used */
185                         if (use_cmp && obj->i != i) {
186                                 ast_test_status_update(test, "object %d does not match object %d\n", obj->i, tmp_obj.i);
187                                 res = AST_TEST_FAIL;
188                         }
189                         ao2_t_ref(obj, -1, "test");
190                 }
191         }
192
193         /* Testing ao2_find with OBJ_KEY */
194         num = 75;
195         for (; num; num--) {
196                 int i = (ast_random() % ((lim / 2)) + 1); /* find a random object */
197                 if (!(obj = ao2_find(c1, &i, OBJ_KEY))) {
198                         res = AST_TEST_FAIL;
199                         ast_test_status_update(test, "COULD NOT FIND:%d, ao2_find() with OBJ_KEY flag failed.\n", i);
200                 } else {
201                         /* a correct match will only take place when the custom cmp function is used */
202                         if (use_cmp && obj->i != i) {
203                                 ast_test_status_update(test, "object %d does not match object %d\n", obj->i, tmp_obj.i);
204                                 res = AST_TEST_FAIL;
205                         }
206                         ao2_t_ref(obj, -1, "test");
207                 }
208         }
209
210         /* Testing ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE.
211          * In this test items are unlinked from c1 and placed in c2.  Then
212          * unlinked from c2 and placed back into c1.
213          *
214          * For this module and set of custom hash/cmp functions, an object
215          * should only be found if the astobj2 default cmp function is used.
216          * This test is designed to mimic the chan_iax.c call number use case. */
217         num = lim < 25 ? lim : 25;
218         for (; num; num--) {
219                 if (!(obj = ao2_find(c1, NULL, OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE))) {
220                         if (!use_cmp) {
221                                 ast_test_status_update(test, "ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE failed with default hash function.\n");
222                                 res = AST_TEST_FAIL;
223                         }
224                 } else {
225                         if (use_cmp) {
226                                 ast_test_status_update(test, "ao2_find with OBJ_POINTER | OBJ_UNLINK | OBJ_CONTINUE failed with custom hash function.\n");
227                                 res = AST_TEST_FAIL;
228                         }
229                         ao2_link(c2, obj);
230                         ao2_t_ref(obj, -1, "test");
231                 }
232         }
233         it = ao2_iterator_init(c2, 0);
234         while ((obj = ao2_t_iterator_next(&it, "test"))) {
235                 ao2_t_unlink(c2, obj, "test");
236                 ao2_t_link(c1, obj, "test");
237                 ao2_t_ref(obj, -1, "test");
238         }
239         ao2_iterator_destroy(&it);
240
241         /* Test Callback with no flags. */
242         increment = 0;
243         ao2_t_callback(c1, 0, increment_cb, &increment, "test callback");
244         if (increment != lim) {
245                 ast_test_status_update(test, "callback with no flags failed. Increment is %d\n", increment);
246                 res = AST_TEST_FAIL;
247         }
248
249         /* Test Callback with OBJ_NODATA. This should do nothing different than with no flags here. */
250         increment = 0;
251         ao2_t_callback(c1, OBJ_NODATA, increment_cb, &increment, "test callback");
252         if (increment != lim) {
253                 ast_test_status_update(test, "callback with OBJ_NODATA failed. Increment is %d\n", increment);
254                 res = AST_TEST_FAIL;
255         }
256
257         /* Test OBJ_MULTIPLE with OBJ_UNLINK*/
258         num = lim < 25 ? lim : 25;
259         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE | OBJ_UNLINK, multiple_cb, &num, "test multiple"))) {
260                 ast_test_status_update(test, "OBJ_MULTIPLE iwth OBJ_UNLINK test failed.\n");
261                 res = AST_TEST_FAIL;
262         } else {
263                 /* make sure num items unlinked is as expected */
264                 if ((lim - ao2_container_count(c1)) != num) {
265                         ast_test_status_update(test, "OBJ_MULTIPLE | OBJ_UNLINK test failed, did not unlink correct number of objects.\n");
266                         res = AST_TEST_FAIL;
267                 }
268
269                 /* link what was unlinked back into c1 */
270                 while ((obj = ao2_t_iterator_next(mult_it, "test"))) {
271                         ao2_t_link(c1, obj, "test");
272                         ao2_t_ref(obj, -1, "test"); /* remove ref from iterator */
273                 }
274                 ao2_iterator_destroy(mult_it);
275         }
276
277         /* Test OBJ_MULTIPLE without unlink, add items back afterwards */
278         num = lim < 25 ? lim : 25;
279         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE, multiple_cb, &num, "test multiple"))) {
280                 ast_test_status_update(test, "OBJ_MULTIPLE without OBJ_UNLINK test failed.\n");
281                 res = AST_TEST_FAIL;
282         } else {
283                 while ((obj = ao2_t_iterator_next(mult_it, "test"))) {
284                         ao2_t_ref(obj, -1, "test"); /* remove ref from iterator */
285                 }
286                 ao2_iterator_destroy(mult_it);
287         }
288
289         /* Test OBJ_MULTIPLE without unlink and no iterating */
290         num = lim < 5 ? lim : 5;
291         if (!(mult_it = ao2_t_callback(c1, OBJ_MULTIPLE, multiple_cb, &num, "test multiple"))) {
292                 ast_test_status_update(test, "OBJ_MULTIPLE with no OBJ_UNLINK and no iterating failed.\n");
293                 res = AST_TEST_FAIL;
294         } else {
295                 ao2_iterator_destroy(mult_it);
296         }
297
298         /* Is the container count what we expect after all the finds and unlinks?*/
299         if (ao2_container_count(c1) != lim) {
300                 ast_test_status_update(test, "container count does not match what is expected after ao2_find tests.\n");
301                 res = AST_TEST_FAIL;
302         }
303
304         /* Testing iterator.  Unlink a single object and break. do not add item back */
305         it = ao2_iterator_init(c1, 0);
306         num = (lim / 4) + 1;
307         while ((obj = ao2_t_iterator_next(&it, "test"))) {
308                 if (obj->i == num) {
309                         ao2_t_ref(obj, -1, "test");
310                         ao2_t_unlink(c1, obj, "test");
311                         break;
312                 }
313                 ao2_t_ref(obj, -1, "test");
314         }
315         ao2_iterator_destroy(&it);
316
317         /* Is the container count what we expect after removing a single item? */
318         if (ao2_container_count(c1) != (lim - 1)) {
319                 ast_test_status_update(test, "unlink during iterator failed. Number %d was not removed.\n", num);
320                 res = AST_TEST_FAIL;
321         }
322
323         /* Test unlink all with OBJ_MULTIPLE, leave a single object for the container to destroy */
324         ao2_t_callback(c1, OBJ_MULTIPLE | OBJ_UNLINK | OBJ_NODATA, all_but_one_cb, NULL, "test multiple");
325         /* check to make sure all test_obj destructors were called except for 1 */
326         if (destructor_count != 1) {
327                 ast_test_status_update(test, "OBJ_MULTIPLE | OBJ_UNLINK | OBJ_NODATA failed. destructor count %d\n", destructor_count);
328                 res = AST_TEST_FAIL;
329         }
330
331 cleanup:
332         /* destroy containers */
333         if (c1) {
334                 ao2_t_ref(c1, -1, "bye c1");
335         }
336         if (c2) {
337                 ao2_t_ref(c2, -1, "bye c2");
338         }
339
340         if (destructor_count > 0) {
341                 ast_test_status_update(test, "all destructors were not called, destructor count is %d\n", destructor_count);
342                 res = AST_TEST_FAIL;
343         } else if (destructor_count < 0) {
344                 ast_test_status_update(test, "Destructor was called too many times, destructor count is %d\n", destructor_count);
345                 res = AST_TEST_FAIL;
346         }
347
348         return res;
349 }
350
351 AST_TEST_DEFINE(astobj2_test_1)
352 {
353         int res = AST_TEST_PASS;
354
355         switch (cmd) {
356         case TEST_INIT:
357                 info->name = "astobj2_test1";
358                 info->category = "/main/astobj2/";
359                 info->summary = "astobj2 test using ao2 objects, containers, callbacks, and iterators";
360                 info->description =
361                         "Builds ao2_containers with various item numbers, bucket sizes, cmp and hash "
362                         "functions. Runs a series of tests to manipulate the container using callbacks "
363                         "and iterators.  Verifies expected behavior.";
364                 return AST_TEST_NOT_RUN;
365         case TEST_EXECUTE:
366                 break;
367         }
368
369
370         /* Test 1, 500 items with custom hash and cmp functions */
371         ast_test_status_update(test, "Test 1, astobj2 test with 500 items.\n");
372         if ((res = astobj2_test_helper(1, 1, 500, test)) == AST_TEST_FAIL) {
373                 return res;
374         }
375
376         /* Test 2, 1000 items with custom hash and default cmp functions */
377         ast_test_status_update(test, "Test 2, astobj2 test with 1000 items.\n");
378         if ((res = astobj2_test_helper(1, 0, 1000, test)) == AST_TEST_FAIL) {
379                 return res;
380         }
381
382         /* Test 3, 10000 items with default hash and custom cmp functions */
383         ast_test_status_update(test, "Test 3, astobj2 test with 10000 items.\n");
384         if ((res = astobj2_test_helper(0, 1, 10000, test)) == AST_TEST_FAIL) {
385                 return res;
386         }
387
388         /* Test 4, 100000 items with default hash and cmp functions */
389         ast_test_status_update(test, "Test 4, astobj2 test with 100000 items.\n");
390         if ((res = astobj2_test_helper(0, 0, 100000, test)) == AST_TEST_FAIL) {
391                 return res;
392         }
393
394         return res;
395 }
396
397 AST_TEST_DEFINE(astobj2_test_2)
398 {
399         int res = AST_TEST_PASS;
400         struct ao2_container *c;
401         struct ao2_iterator i;
402         struct test_obj *obj;
403         int num;
404         static const int NUM_OBJS = 5;
405         int destructor_count = NUM_OBJS;
406         struct test_obj tmp_obj = { 0, };
407
408         switch (cmd) {
409         case TEST_INIT:
410                 info->name = "astobj2_test2";
411                 info->category = "/main/astobj2/";
412                 info->summary = "Test a certain scenario using ao2 iterators";
413                 info->description =
414                         "This test is aimed at testing for a specific regression that occurred. "
415                         "Add some objects into a container.  Mix finds and iteration and make "
416                         "sure that the iterator still sees all objects.";
417                 return AST_TEST_NOT_RUN;
418         case TEST_EXECUTE:
419                 break;
420         }
421
422         c = ao2_container_alloc(1, NULL, test_cmp_cb);
423         if (!c) {
424                 ast_test_status_update(test, "ao2_container_alloc failed.\n");
425                 res = AST_TEST_FAIL;
426                 goto cleanup;
427         }
428
429         for (num = 1; num <= NUM_OBJS; num++) {
430                 if (!(obj = ao2_alloc(sizeof(struct test_obj), test_obj_destructor))) {
431                         ast_test_status_update(test, "ao2_alloc failed.\n");
432                         res = AST_TEST_FAIL;
433                         goto cleanup;
434                 }
435                 obj->destructor_count = &destructor_count;
436                 obj->i = num;
437                 ao2_link(c, obj);
438                 ao2_ref(obj, -1);
439                 if (ao2_container_count(c) != num) {
440                         ast_test_status_update(test, "container did not link correctly\n");
441                         res = AST_TEST_FAIL;
442                 }
443         }
444
445         /*
446          * Iteration take 1.  Just make sure we see all NUM_OBJS objects.
447          */
448         num = 0;
449         i = ao2_iterator_init(c, 0);
450         while ((obj = ao2_iterator_next(&i))) {
451                 num++;
452                 ao2_ref(obj, -1);
453         }
454         ao2_iterator_destroy(&i);
455
456         if (num != NUM_OBJS) {
457                 ast_test_status_update(test, "iterate take 1, expected '%d', only saw '%d' objects\n",
458                                 NUM_OBJS, num);
459                 res = AST_TEST_FAIL;
460         }
461
462         /*
463          * Iteration take 2.  Do a find for the last object, then iterate and make
464          * sure we find all NUM_OBJS objects.
465          */
466         tmp_obj.i = NUM_OBJS;
467         obj = ao2_find(c, &tmp_obj, OBJ_POINTER);
468         if (!obj) {
469                 ast_test_status_update(test, "ao2_find() failed.\n");
470                 res = AST_TEST_FAIL;
471         } else {
472                 ao2_ref(obj, -1);
473         }
474
475         num = 0;
476         i = ao2_iterator_init(c, 0);
477         while ((obj = ao2_iterator_next(&i))) {
478                 num++;
479                 ao2_ref(obj, -1);
480         }
481         ao2_iterator_destroy(&i);
482
483         if (num != NUM_OBJS) {
484                 ast_test_status_update(test, "iterate take 2, expected '%d', only saw '%d' objects\n",
485                                 NUM_OBJS, num);
486                 res = AST_TEST_FAIL;
487         }
488
489         /*
490          * Iteration take 3.  Do a find for an object while in the middle
491          * of iterating;
492          */
493         num = 0;
494         i = ao2_iterator_init(c, 0);
495         while ((obj = ao2_iterator_next(&i))) {
496                 if (num == 1) {
497                         struct test_obj *obj2;
498                         tmp_obj.i = NUM_OBJS - 1;
499                         obj2 = ao2_find(c, &tmp_obj, OBJ_POINTER);
500                         if (!obj2) {
501                                 ast_test_status_update(test, "ao2_find() failed.\n");
502                                 res = AST_TEST_FAIL;
503                         } else {
504                                 ao2_ref(obj2, -1);
505                         }
506                 }
507                 num++;
508                 ao2_ref(obj, -1);
509         }
510         ao2_iterator_destroy(&i);
511
512         if (num != NUM_OBJS) {
513                 ast_test_status_update(test, "iterate take 3, expected '%d', only saw '%d' objects\n",
514                                 NUM_OBJS, num);
515                 res = AST_TEST_FAIL;
516         }
517
518
519 cleanup:
520         if (c) {
521                 ao2_ref(c, -1);
522         }
523
524         return res;
525 }
526
527 static int unload_module(void)
528 {
529         AST_TEST_UNREGISTER(astobj2_test_1);
530         AST_TEST_UNREGISTER(astobj2_test_2);
531         return 0;
532 }
533
534 static int load_module(void)
535 {
536         AST_TEST_REGISTER(astobj2_test_1);
537         AST_TEST_REGISTER(astobj2_test_2);
538         return AST_MODULE_LOAD_SUCCESS;
539 }
540
541 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "ASTOBJ2 Unit Tests");