AST_MODULE_INFO: Format corrections to the usages of AST_MODULE_INFO macro.
[asterisk/asterisk.git] / tests / test_stasis_endpoints.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 \brief Test endpoints.
21  *
22  * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim
23  *
24  * \ingroup tests
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <depend>res_stasis_test</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_REGISTER_FILE()
36
37 #include "asterisk/astobj2.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/endpoints.h"
40 #include "asterisk/module.h"
41 #include "asterisk/stasis_channels.h"
42 #include "asterisk/stasis_endpoints.h"
43 #include "asterisk/stasis_test.h"
44 #include "asterisk/test.h"
45
46 static const char *test_category = "/stasis/endpoints/";
47
48 /*! \brief Message matcher looking for cache update messages */
49 static int cache_update(struct stasis_message *msg, const void *data) {
50         struct stasis_cache_update *update;
51         struct ast_endpoint_snapshot *snapshot;
52         const char *name = data;
53
54         if (stasis_cache_update_type() != stasis_message_type(msg)) {
55                 return 0;
56         }
57
58         update = stasis_message_data(msg);
59         if (ast_endpoint_snapshot_type() != update->type) {
60                 return 0;
61         }
62
63         snapshot = stasis_message_data(update->old_snapshot);
64         if (!snapshot) {
65                 snapshot = stasis_message_data(update->new_snapshot);
66         }
67
68         return 0 == strcmp(name, snapshot->resource);
69 }
70
71 AST_TEST_DEFINE(state_changes)
72 {
73         RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
74         RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
75         RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
76         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
77         struct stasis_message *msg;
78         struct stasis_message_type *type;
79         struct ast_endpoint_snapshot *actual_snapshot;
80         int actual_count;
81
82         switch (cmd) {
83         case TEST_INIT:
84                 info->name = __func__;
85                 info->category = test_category;
86                 info->summary = "Test endpoint updates as its state changes";
87                 info->description =
88                         "Test endpoint updates as its state changes";
89                 return AST_TEST_NOT_RUN;
90         case TEST_EXECUTE:
91                 break;
92         }
93
94         uut = ast_endpoint_create("TEST", __func__);
95         ast_test_validate(test, NULL != uut);
96
97         sink = stasis_message_sink_create();
98         ast_test_validate(test, NULL != sink);
99
100         sub = stasis_subscribe(ast_endpoint_topic(uut),
101                 stasis_message_sink_cb(), sink);
102         ast_test_validate(test, NULL != sub);
103
104         ast_endpoint_set_state(uut, AST_ENDPOINT_OFFLINE);
105         actual_count = stasis_message_sink_wait_for_count(sink, 1,
106                 STASIS_SINK_DEFAULT_WAIT);
107         ast_test_validate(test, 1 == actual_count);
108         msg = sink->messages[0];
109         type = stasis_message_type(msg);
110         ast_test_validate(test, ast_endpoint_snapshot_type() == type);
111         actual_snapshot = stasis_message_data(msg);
112         ast_test_validate(test, AST_ENDPOINT_OFFLINE == actual_snapshot->state);
113
114         ast_endpoint_set_max_channels(uut, 8675309);
115         actual_count = stasis_message_sink_wait_for_count(sink, 2,
116                 STASIS_SINK_DEFAULT_WAIT);
117         ast_test_validate(test, 2 == actual_count);
118         msg = sink->messages[1];
119         type = stasis_message_type(msg);
120         ast_test_validate(test, ast_endpoint_snapshot_type() == type);
121         actual_snapshot = stasis_message_data(msg);
122         ast_test_validate(test, 8675309 == actual_snapshot->max_channels);
123
124         return AST_TEST_PASS;
125 }
126
127 AST_TEST_DEFINE(cache_clear)
128 {
129         RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
130         RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
131         RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
132         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
133         struct stasis_message *msg;
134         struct stasis_message_type *type;
135         struct ast_endpoint_snapshot *actual_snapshot;
136         struct stasis_cache_update *update;
137         int message_index;
138
139         switch (cmd) {
140         case TEST_INIT:
141                 info->name = __func__;
142                 info->category = test_category;
143                 info->summary = "Test endpoint state change messages";
144                 info->description = "Test endpoint state change messages";
145                 return AST_TEST_NOT_RUN;
146         case TEST_EXECUTE:
147                 break;
148         }
149
150         /* Subscribe to the cache topic */
151         sink = stasis_message_sink_create();
152         ast_test_validate(test, NULL != sink);
153
154         sub = stasis_subscribe(
155                 ast_endpoint_topic_all_cached(),
156                 stasis_message_sink_cb(), sink);
157         ast_test_validate(test, NULL != sub);
158
159         uut = ast_endpoint_create("TEST", __func__);
160         ast_test_validate(test, NULL != uut);
161
162         /* Since the cache topic is a singleton (ew), it may have messages from
163          * elsewheres that it's processing, or maybe even some final messages
164          * from the prior test. We've got to wait_for our specific message,
165          * instead of wait_for_count.
166          */
167         message_index = stasis_message_sink_wait_for(sink, 0,
168                 cache_update, __func__, STASIS_SINK_DEFAULT_WAIT);
169         ast_test_validate(test, 0 <= message_index);
170
171         /* First message should be a cache creation entry for our endpoint */
172         msg = sink->messages[message_index];
173         type = stasis_message_type(msg);
174         ast_test_validate(test, stasis_cache_update_type() == type);
175         update = stasis_message_data(msg);
176         ast_test_validate(test, ast_endpoint_snapshot_type() == update->type);
177         ast_test_validate(test, NULL == update->old_snapshot);
178         actual_snapshot = stasis_message_data(update->new_snapshot);
179         ast_test_validate(test, 0 == strcmp("TEST", actual_snapshot->tech));
180         ast_test_validate(test,
181                 0 == strcmp(__func__, actual_snapshot->resource));
182
183         ast_endpoint_shutdown(uut);
184         uut = NULL;
185
186         /* Note: there's a few messages between the creation and the clear.
187          * Wait for all of them... */
188         message_index = stasis_message_sink_wait_for(sink, message_index + 4,
189                 cache_update, __func__, STASIS_SINK_DEFAULT_WAIT);
190         ast_test_validate(test, 0 <= message_index);
191         /* Now we should have a cache removal entry */
192         msg = sink->messages[message_index];
193         type = stasis_message_type(msg);
194         ast_test_validate(test, stasis_cache_update_type() == type);
195         update = stasis_message_data(msg);
196         ast_test_validate(test, ast_endpoint_snapshot_type() == update->type);
197         actual_snapshot = stasis_message_data(update->old_snapshot);
198         ast_test_validate(test, 0 == strcmp("TEST", actual_snapshot->tech));
199         ast_test_validate(test,
200                 0 == strcmp(__func__, actual_snapshot->resource));
201         ast_test_validate(test, NULL == update->new_snapshot);
202
203         return AST_TEST_PASS;
204 }
205
206 AST_TEST_DEFINE(channel_messages)
207 {
208         RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
209         RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
210         RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
211         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
212         struct stasis_message *msg;
213         struct stasis_message_type *type;
214         struct ast_endpoint_snapshot *actual_snapshot;
215         int actual_count;
216
217         switch (cmd) {
218         case TEST_INIT:
219                 info->name = __func__;
220                 info->category = test_category;
221                 info->summary = "Test channel messages on an endpoint topic";
222                 info->description =
223                         "Test channel messages on an endpoint topic";
224                 return AST_TEST_NOT_RUN;
225         case TEST_EXECUTE:
226                 break;
227         }
228
229         uut = ast_endpoint_create("TEST", __func__);
230         ast_test_validate(test, NULL != uut);
231
232         sink = stasis_message_sink_create();
233         ast_test_validate(test, NULL != sink);
234
235         sub = stasis_subscribe(ast_endpoint_topic(uut),
236                 stasis_message_sink_cb(), sink);
237         ast_test_validate(test, NULL != sub);
238
239         chan = ast_channel_alloc(0, AST_STATE_DOWN, "100", __func__, "100",
240                 "100", "default", NULL, NULL, 0, "TEST/test_res");
241         ast_test_validate(test, NULL != chan);
242
243         ast_endpoint_add_channel(uut, chan);
244
245         actual_count = stasis_message_sink_wait_for_count(sink, 1,
246                 STASIS_SINK_DEFAULT_WAIT);
247         ast_test_validate(test, 1 == actual_count);
248
249         msg = sink->messages[0];
250         type = stasis_message_type(msg);
251         ast_test_validate(test, ast_endpoint_snapshot_type() == type);
252         actual_snapshot = stasis_message_data(msg);
253         ast_test_validate(test, 1 == actual_snapshot->num_channels);
254
255         ast_hangup(chan);
256         chan = NULL;
257
258         actual_count = stasis_message_sink_wait_for_count(sink, 6,
259                 STASIS_SINK_DEFAULT_WAIT);
260         ast_test_validate(test, 6 == actual_count);
261
262         msg = sink->messages[1];
263         type = stasis_message_type(msg);
264         ast_test_validate(test, stasis_cache_update_type() == type);
265
266         msg = sink->messages[2];
267         type = stasis_message_type(msg);
268         ast_test_validate(test, ast_channel_snapshot_type() == type);
269
270         msg = sink->messages[3];
271         type = stasis_message_type(msg);
272         ast_test_validate(test, stasis_cache_update_type() == type);
273
274         /* The ordering of the cache clear and endpoint snapshot are
275          * unspecified */
276         msg = sink->messages[4];
277         if (stasis_message_type(msg) == stasis_cache_clear_type()) {
278                 /* Okay; the next message should be the endpoint snapshot */
279                 msg = sink->messages[5];
280         }
281
282         type = stasis_message_type(msg);
283         ast_test_validate(test, ast_endpoint_snapshot_type() == type);
284         actual_snapshot = stasis_message_data(msg);
285         ast_test_validate(test, 0 == actual_snapshot->num_channels);
286
287         return AST_TEST_PASS;
288 }
289
290 static int unload_module(void)
291 {
292         AST_TEST_UNREGISTER(state_changes);
293         AST_TEST_UNREGISTER(cache_clear);
294         AST_TEST_UNREGISTER(channel_messages);
295         return 0;
296 }
297
298 static int load_module(void)
299 {
300         AST_TEST_REGISTER(state_changes);
301         AST_TEST_REGISTER(cache_clear);
302         AST_TEST_REGISTER(channel_messages);
303         return AST_MODULE_LOAD_SUCCESS;
304 }
305
306 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Endpoint stasis-related testing",
307         .load = load_module,
308         .unload = unload_module,
309         .nonoptreq = "res_stasis_test",
310 );