Test that shutdown callback is called when expected.
[asterisk/asterisk.git] / tests / test_taskprocessor.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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 taskprocessor unit tests
22  *
23  * \author Mark Michelson <mmichelson@digium.com>
24  *
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 #include "asterisk/test.h"
35 #include "asterisk/taskprocessor.h"
36 #include "asterisk/module.h"
37 #include "asterisk/astobj2.h"
38
39 struct task_data {
40         ast_cond_t cond;
41         ast_mutex_t lock;
42         int task_complete;
43 };
44
45 static int task(void *data)
46 {
47         struct task_data *task_data = data;
48         SCOPED_MUTEX(lock, &task_data->lock);
49         task_data->task_complete = 1;
50         ast_cond_signal(&task_data->cond);
51         return 0;
52 }
53
54 AST_TEST_DEFINE(default_taskprocessor)
55 {
56         struct ast_taskprocessor *tps;
57         struct task_data task_data;
58         enum ast_test_result_state res = AST_TEST_PASS;
59
60         switch (cmd) {
61         case TEST_INIT:
62                 info->name = "default_taskprocessor";
63                 info->category = "/main/taskprocessor/";
64                 info->summary = "Test of default taskproccesor";
65                 info->description =
66                         "Ensures that queued tasks are executed.";
67                 return AST_TEST_NOT_RUN;
68         case TEST_EXECUTE:
69                 break;
70         }
71
72         tps = ast_taskprocessor_get("test", TPS_REF_DEFAULT);
73
74         if (!tps) {
75                 ast_test_status_update(test, "Unable to create test taskprocessor\n");
76                 return AST_TEST_FAIL;
77         }
78
79         ast_cond_init(&task_data.cond, NULL);
80         ast_mutex_init(&task_data.lock);
81         task_data.task_complete = 0;
82
83         ast_taskprocessor_push(tps, task, &task_data);
84         ast_mutex_lock(&task_data.lock);
85         while (!task_data.task_complete) {
86                 ast_cond_wait(&task_data.cond, &task_data.lock);
87         }
88
89         if (!task_data.task_complete) {
90                 ast_test_status_update(test, "Queued task did not execute!\n");
91                 res = AST_TEST_FAIL;
92                 goto test_end;
93         }
94
95 test_end:
96         tps = ast_taskprocessor_unreference(tps);
97         ast_mutex_destroy(&task_data.lock);
98         ast_cond_destroy(&task_data.cond);
99         return res;
100 }
101
102 struct test_listener_pvt {
103         int num_pushed;
104         int num_emptied;
105         int num_was_empty;
106         int shutdown;
107 };
108
109 static void *test_alloc(struct ast_taskprocessor_listener *listener)
110 {
111         struct test_listener_pvt *pvt;
112
113         pvt = ast_calloc(1, sizeof(*pvt));
114         return pvt;
115 }
116
117 static void test_task_pushed(struct ast_taskprocessor_listener *listener, int was_empty)
118 {
119         struct test_listener_pvt *pvt = listener->private_data;
120         ++pvt->num_pushed;
121         if (was_empty) {
122                 ++pvt->num_was_empty;
123         }
124 }
125
126 static void test_emptied(struct ast_taskprocessor_listener *listener)
127 {
128         struct test_listener_pvt *pvt = listener->private_data;
129         ++pvt->num_emptied;
130 }
131
132 static void test_shutdown(struct ast_taskprocessor_listener *listener)
133 {
134         struct test_listener_pvt *pvt = listener->private_data;
135         pvt->shutdown = 1;
136 }
137
138 static void test_destroy(void *private_data)
139 {
140         struct test_listener_pvt *pvt = private_data;
141         ast_free(pvt);
142 }
143
144 static const struct ast_taskprocessor_listener_callbacks test_callbacks = {
145         .alloc = test_alloc,
146         .task_pushed = test_task_pushed,
147         .emptied = test_emptied,
148         .shutdown = test_shutdown,
149         .destroy = test_destroy,
150 };
151
152 static int listener_test_task(void *ignore)
153 {
154         return 0;
155 }
156
157 static int check_stats(struct ast_test *test, const struct test_listener_pvt *pvt, int num_pushed, int num_emptied, int num_was_empty)
158 {
159         if (pvt->num_pushed != num_pushed) {
160                 ast_test_status_update(test, "Unexpected number of tasks pushed. Expected %d but got %d\n",
161                                 num_pushed, pvt->num_pushed);
162                 return -1;
163         }
164
165         if (pvt->num_emptied != num_emptied) {
166                 ast_test_status_update(test, "Unexpected number of empties. Expected %d but got %d\n",
167                                 num_emptied, pvt->num_emptied);
168                 return -1;
169         }
170
171         if (pvt->num_was_empty != num_was_empty) {
172                 ast_test_status_update(test, "Unexpected number of empties. Expected %d but got %d\n",
173                                 num_was_empty, pvt->num_emptied);
174                 return -1;
175         }
176
177         return 0;
178 }
179
180 AST_TEST_DEFINE(taskprocessor_listener)
181 {
182         struct ast_taskprocessor *tps;
183         struct ast_taskprocessor_listener *listener;
184         struct test_listener_pvt *pvt;
185         enum ast_test_result_state res = AST_TEST_PASS;
186
187         switch (cmd) {
188         case TEST_INIT:
189                 info->name = "taskprocessor_listener";
190                 info->category = "/main/taskprocessor/";
191                 info->summary = "Test of taskproccesor listeners";
192                 info->description =
193                         "Ensures that listener callbacks are called when expected.";
194                 return AST_TEST_NOT_RUN;
195         case TEST_EXECUTE:
196                 break;
197         }
198
199         listener = ast_taskprocessor_listener_alloc(&test_callbacks);
200         if (!listener) {
201                 ast_test_status_update(test, "Unable to allocate test taskprocessor listener\n");
202                 return AST_TEST_FAIL;
203         }
204
205         tps = ast_taskprocessor_create_with_listener("test_listener", listener);
206         if (!tps) {
207                 ast_test_status_update(test, "Unable to allocate test taskprocessor\n");
208                 res = AST_TEST_FAIL;
209                 goto test_exit;
210         }
211
212         pvt = listener->private_data;
213
214         ast_taskprocessor_push(tps, listener_test_task, NULL);
215
216         if (check_stats(test, pvt, 1, 0, 1) < 0) {
217                 res = AST_TEST_FAIL;
218                 goto test_exit;
219         }
220
221         ast_taskprocessor_push(tps, listener_test_task, NULL);
222
223         if (check_stats(test, pvt, 2, 0, 1) < 0) {
224                 res = AST_TEST_FAIL;
225                 goto test_exit;
226         }
227
228         ast_taskprocessor_execute(tps);
229
230         if (check_stats(test, pvt, 2, 0, 1) < 0) {
231                 res = AST_TEST_FAIL;
232                 goto test_exit;
233         }
234
235         ast_taskprocessor_execute(tps);
236
237         if (check_stats(test, pvt, 2, 1, 1) < 0) {
238                 res = AST_TEST_FAIL;
239                 goto test_exit;
240         }
241
242         tps = ast_taskprocessor_unreference(tps);
243
244         if (!pvt->shutdown) {
245                 res = AST_TEST_FAIL;
246                 goto test_exit;
247         }
248
249 test_exit:
250         ao2_ref(listener, -1);
251         /* This is safe even if tps is NULL */
252         ast_taskprocessor_unreference(tps);
253         return res;
254 }
255
256 static int unload_module(void)
257 {
258         ast_test_unregister(default_taskprocessor);
259         ast_test_unregister(taskprocessor_listener);
260         return 0;
261 }
262
263 static int load_module(void)
264 {
265         ast_test_register(default_taskprocessor);
266         ast_test_register(taskprocessor_listener);
267         return AST_MODULE_LOAD_SUCCESS;
268 }
269
270 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "taskprocessor test module");