Merged revisions 332177 via svnmerge from
[asterisk/asterisk.git] / tests / test_pbx.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, 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 /*! \file
20  *
21  * \brief PBX Tests
22  *
23  * \author Mark Michelson <mmichelson@digium.com>
24  *
25  * This module will run some PBX tests.
26  * \ingroup tests
27  */
28
29 /*** MODULEINFO
30         <depend>TEST_FRAMEWORK</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/module.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/test.h"
41
42 /*!
43  * If we determine that we really need
44  * to be able to register more than 10
45  * priorities for a single extension, then
46  * fine, we can do that later.
47  */
48 #define MAX_PRIORITIES 10
49
50 /*!
51  * \brief an extension to add to our context
52  */
53 struct exten_info {
54         /*!
55          * \brief Context
56          *
57          * \details
58          * The extension specified will be added to
59          * this context when it is created.
60          */
61         const char *context;
62         /*!
63          * \brief Extension pattern
64          *
65          * \details
66          * The extension pattern to use. This can be
67          * anything you would normally find in a dialplan,
68          * such as "1000" or "NXXNXXX" or whatever you
69          * wish it to be. If, however, you want a CID match
70          * to be part of the extension, do not include that
71          * here.
72          */
73         const char *exten;
74         /*!
75          * \brief CID match
76          *
77          * \details
78          * If your extension requires a specific caller ID in
79          * order to match, place that in this field. Note that
80          * a NULL and an empty CID match are two very different
81          * things. If you want no CID match, leave this NULL. If
82          * you want to explicitly match a blank CID, then put
83          * an empty string here.
84          */
85         const char *cid;
86         /*!
87          * \brief Number of priorities
88          *
89          * \details
90          * Tell the number of priorities to register for this
91          * extension. All priorities registered will just have a
92          * Noop application with the extension pattern as its
93          * data.
94          */
95         const int num_priorities;
96         /*!
97          * \brief The priorities to register
98          *
99          * \details
100          * In most cases, when registering multiple priorities for
101          * an extension, we'll be starting at priority 1 and going
102          * sequentially until we've read num_priorities. However,
103          * for some tests, it may be beneficial to start at a higher
104          * priority or skip certain priorities. This is why you have
105          * the freedom here to specify which priorities to register
106          * for the extension.
107          */
108         const int priorities[MAX_PRIORITIES];
109 };
110
111 struct pbx_test_pattern {
112         /*!
113          * \brief Test context
114          *
115          * \details
116          * This is the context to look in for a specific extension.
117          */
118         const char *context;
119         /*!
120          * \brief Test extension number
121          *
122          * \details
123          * This should be in the form of a specific number or string.
124          * For instance, if you were trying to match an extension defined
125          * with the pattern "_2." you might have as the test_exten one of
126          * "2000" , "2legit2quit" or some other specific match for the pattern.
127          */
128         const char *test_exten;
129         /*!
130          * \brief Test CID match
131          *
132          * \details
133          * If a specific CID match is required for pattern matching, then specify
134          * it in this parameter. Remember that a NULL CID and an empty CID are
135          * interpreted differently. For no CID match, leave this NULL. If you wish
136          * to explicitly match an empty CID, then use an empty string here.
137          */
138         const char *test_cid;
139         /*!
140          * \brief The priority to find
141          */
142         const int priority;
143         /*!
144          * \brief Expected extension match.
145          *
146          * \details
147          * This struct corresponds to an extension that was previously
148          * added to our test context. Once we have used all the above data
149          * to find an extension in the dialplan. We compare the data from that
150          * extension to the data that we have stored in this structure to be
151          * sure that what was matched was what we expected to match.
152          */
153         const struct exten_info *exten;
154 };
155
156 static int test_exten(const struct pbx_test_pattern *test_pattern, struct ast_test *test)
157 {
158         struct pbx_find_info pfi = { { 0 }, };
159         struct ast_exten *exten;
160         if (!(exten = pbx_find_extension(NULL, NULL, &pfi, test_pattern->context,
161                                         test_pattern->test_exten, test_pattern->priority, NULL,
162                                         test_pattern->test_cid, E_MATCH))) {
163                 ast_test_status_update(test, "Cannot find extension %s in context %s."
164                                 "Test failed.\n", test_pattern->test_exten, test_pattern->context);
165                 return -1;
166         }
167         if (strcmp(ast_get_extension_name(exten), test_pattern->exten->exten)) {
168                 ast_test_status_update(test, "Expected extension %s but got extension %s instead."
169                                 "Test failed.\n", test_pattern->exten->exten, ast_get_extension_name(exten));
170                 return -1;
171         }
172         if (test_pattern->test_cid && strcmp(ast_get_extension_cidmatch(exten), test_pattern->test_cid)) {
173                 ast_test_status_update(test, "Expected CID match %s but got CID match %s instead."
174                                 "Test failed.\n", test_pattern->exten->cid, ast_get_extension_cidmatch(exten));
175                 return -1;
176         }
177         ast_test_status_update(test, "Successfully matched %s to exten %s in context %s\n",
178                         test_pattern->test_exten, test_pattern->exten->exten, test_pattern->context);
179         return 0;
180 }
181
182 AST_TEST_DEFINE(pattern_match_test)
183 {
184         static const char registrar[] = "test_pbx";
185         enum ast_test_result_state res = AST_TEST_PASS;
186         static const char TEST_PATTERN[] = "test_pattern";
187         static const char TEST_PATTERN_INCLUDE[] = "test_pattern_include";
188         int i;
189
190         /* The array of contexts to register for our test.
191          * To add more contexts, just add more rows to this array.
192          */
193         struct {
194                 const char * context_string;
195                 struct ast_context *context;
196         } contexts[] = {
197                 { TEST_PATTERN, },
198                 { TEST_PATTERN_INCLUDE, },
199         };
200
201         /*
202          * Map to indicate which contexts should be included inside
203          * other contexts. The first context listed will include
204          * the second context listed.
205          *
206          * To add more inclusions, add new rows to this array.
207          */
208         const struct {
209                 const char *outer_context;
210                 const char *inner_context;
211         } context_includes[] = {
212                 { TEST_PATTERN, TEST_PATTERN_INCLUDE },
213         };
214
215         /* The array of extensions to add to our test context.
216          * For more information about the individual fields, see
217          * the doxygen for struct exten_info.
218          *
219          * To add new extensions to the test, simply add new rows
220          * to this array. All extensions will automatically be
221          * added when the test is run.
222          */
223         const struct exten_info extens[] = {
224                 [0] = { TEST_PATTERN, "_2.", NULL, 1, { 1 } },
225                 [1] = { TEST_PATTERN, "2000", NULL, 1, { 1 } },
226                 [2] = { TEST_PATTERN_INCLUDE, "2000", NULL, 1, { 2 } },
227         };
228
229         /* This array contains our test material. See the doxygen
230          * for struct pbx_test_pattern for more information on each
231          * component.
232          *
233          * To add more test cases, add more lines to this array. Each
234          * case will be tested automatically when the test is run.
235          */
236         const struct pbx_test_pattern tests[] = {
237                 { TEST_PATTERN, "200", NULL, 1, &extens[0] },
238                 { TEST_PATTERN, "2000", NULL, 1, &extens[1] },
239                 { TEST_PATTERN, "2000", NULL, 2, &extens[2] },
240                 { TEST_PATTERN_INCLUDE, "2000", NULL, 2, &extens[2] },
241         };
242
243         switch (cmd) {
244         case TEST_INIT:
245                 info->name = "pattern_match_test";
246                 info->category = "/main/pbx/";
247                 info->summary = "Test pattern matching";
248                 info->description = "Create a context with a bunch of extensions within. Then attempt\n"
249                         "to match some strings to the extensions.";
250                 return AST_TEST_NOT_RUN;
251         case TEST_EXECUTE:
252                 break;
253         }
254
255         /* Step one is to build the dialplan.
256          *
257          * We iterate first through the contexts array to build
258          * all the contexts we'll need. Then, we iterate over the
259          * extens array to add all the extensions to the appropriate
260          * contexts.
261          */
262
263         for (i = 0; i < ARRAY_LEN(contexts); ++i) {
264                 if (!(contexts[i].context = ast_context_find_or_create(NULL, NULL, contexts[i].context_string, registrar))) {
265                         ast_test_status_update(test, "Failed to create context %s\n", contexts[i].context_string);
266                         res = AST_TEST_FAIL;
267                         goto cleanup;
268                 }
269         }
270
271         for (i = 0; i < ARRAY_LEN(context_includes); ++i) {
272                 if (ast_context_add_include(context_includes[i].outer_context,
273                                         context_includes[i].inner_context, registrar)) {
274                         ast_test_status_update(test, "Failed to include context %s inside context %s\n",
275                                         context_includes[i].inner_context, context_includes[i].outer_context);
276                         res = AST_TEST_FAIL;
277                         goto cleanup;
278                 }
279         }
280
281         for (i = 0; i < ARRAY_LEN(extens); ++i) {
282                 int priority;
283                 if (extens[i].num_priorities > MAX_PRIORITIES) {
284                         ast_test_status_update(test, "Invalid number of priorities specified for extension %s."
285                                         "Max is %d, but we requested %d. Test failed\n",
286                                         extens[i].exten, MAX_PRIORITIES, extens[i].num_priorities);
287                         res = AST_TEST_FAIL;
288                         goto cleanup;
289                 }
290                 for (priority = 0; priority < extens[i].num_priorities; ++priority) {
291                         if (ast_add_extension(extens[i].context, 0, extens[i].exten, extens[i].priorities[priority],
292                                                 NULL, extens[i].cid, "Noop", (void *) extens[i].exten, NULL, registrar)) {
293                                 ast_test_status_update(test, "Failed to add extension %s, priority %d, to context %s."
294                                                 "Test failed\n", extens[i].exten, extens[i].priorities[priority], extens[i].context);
295                                 res = AST_TEST_FAIL;
296                                 goto cleanup;
297                         }
298                 }
299         }
300
301         /* At this stage, the dialplan is built. Now we iterate over
302          * the tests array to attempt to find each of the specified
303          * extensions.
304          */
305         for (i = 0; i < ARRAY_LEN(tests); ++i) {
306                 if (test_exten(&tests[i], test)) {
307                         res = AST_TEST_FAIL;
308                         break;
309                 }
310         }
311
312 cleanup:
313         for (i = 0; i < ARRAY_LEN(contexts); ++i) {
314                 if (contexts[i].context) {
315                         ast_context_destroy(contexts[i].context, registrar);
316                 }
317         }
318
319         return res;
320 }
321
322 static int unload_module(void)
323 {
324         AST_TEST_UNREGISTER(pattern_match_test);
325         return 0;
326 }
327
328 static int load_module(void)
329 {
330         AST_TEST_REGISTER(pattern_match_test);
331         return AST_MODULE_LOAD_SUCCESS;
332 }
333
334 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "PBX test module");