Merged revisions 332177 via svnmerge from
[asterisk/asterisk.git] / tests / test_substitution.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Tilghman Lesher <tlesher AT digium DOT 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 Substitution Test
22  *
23  * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
24  * 
25  * \ingroup tests
26  */
27
28 /*** MODULEINFO
29         <depend>TEST_FRAMEWORK</depend>
30         <depend>func_curl</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/file.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/app.h"
44 #include "asterisk/strings.h"
45 #include "asterisk/stringfields.h"
46 #include "asterisk/threadstorage.h"
47 #include "asterisk/test.h"
48
49 static enum ast_test_result_state test_chan_integer(struct ast_test *test,
50                 struct ast_channel *c, int *ifield, const char *expression)
51 {
52         int i, okay = 1, value1 = -1, value2 = -1;
53         char workspace[4096];
54         struct ast_str *str = ast_str_create(16);
55
56         ast_test_status_update(test, "Testing '%s' . . . . . %s\n", expression, okay ? "passed" : "FAILED");
57         for (i = 0; i < 256; i++) {
58                 *ifield = i;
59                 ast_str_substitute_variables(&str, 0, c, expression);
60                 pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
61                 if (sscanf(workspace, "%d", &value1) != 1 || value1 != i || sscanf(ast_str_buffer(str), "%d", &value2) != 1 || value2 != i) {
62                         ast_test_status_update(test, "%s != %s and/or %d != %d != %d\n", ast_str_buffer(str), workspace, value1, value2, i);
63                         okay = 0;
64                 }
65         }
66
67         ast_free(str);
68
69         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
70 }
71
72 static enum ast_test_result_state test_chan_string(struct ast_test *test,
73                 struct ast_channel *c, char *cfield, size_t cfieldsize,
74                 const char *expression)
75 {
76         const char *values[] = { "one", "three", "reallylongdinosaursoundingthingwithwordsinit" };
77         int i, okay = 1;
78         char workspace[4096];
79         struct ast_str *str = ast_str_create(16);
80
81         for (i = 0; i < ARRAY_LEN(values); i++) {
82                 ast_copy_string(cfield, values[i], cfieldsize);
83                 ast_str_substitute_variables(&str, 0, c, expression);
84                 pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
85                 ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
86                                 expression, okay ? "passed" : "FAILED");
87                 if (strcmp(cfield, ast_str_buffer(str)) != 0 || strcmp(cfield, workspace) != 0) {
88                         ast_test_status_update(test, "%s != %s != %s\n", cfield, ast_str_buffer(str), workspace);
89                         okay = 0;
90                 }
91         }
92
93         ast_free(str);
94
95         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
96 }
97
98 static enum ast_test_result_state test_chan_variable(struct ast_test *test,
99                 struct ast_channel *c, const char *varname)
100 {
101         const char *values[] = { "one", "three", "reallylongdinosaursoundingthingwithwordsinit" };
102         int i, okay = 1;
103         char workspace[4096];
104         struct ast_str *str = ast_str_create(16);
105         struct ast_str *var = ast_str_create(16);
106
107         ast_str_set(&var, 0, "${%s}", varname);
108         for (i = 0; i < ARRAY_LEN(values); i++) {
109                 pbx_builtin_setvar_helper(c, varname, values[i]);
110                 ast_str_substitute_variables(&str, 0, c, ast_str_buffer(var));
111                 pbx_substitute_variables_helper(c, ast_str_buffer(var), workspace, sizeof(workspace));
112                 ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
113                                 ast_str_buffer(var), okay ? "passed" : "FAILED");
114                 if (strcmp(values[i], ast_str_buffer(str)) != 0 || strcmp(values[i], workspace) != 0) {
115                         ast_test_status_update(test, "%s != %s != %s\n",
116                                         values[i], ast_str_buffer(str), workspace);
117                         okay = 0;
118                 }
119         }
120
121         ast_free(str);
122         ast_free(var);
123
124         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
125 }
126
127 static enum ast_test_result_state test_chan_function(struct ast_test *test,
128                 struct ast_channel *c, const char *expression)
129 {
130         int okay = 1;
131         char workspace[4096];
132         struct ast_str *str = ast_str_create(16);
133
134         ast_str_substitute_variables(&str, 0, c, expression);
135         pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
136         ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
137                         expression, okay ? "passed" : "FAILED");
138         if (strcmp(workspace, ast_str_buffer(str)) != 0) {
139                 ast_test_status_update(test, "test_chan_function, expr: '%s' ... %s != %s\n",
140                                 expression, ast_str_buffer(str), workspace);
141                 okay = 0;
142         }
143
144         ast_free(str);
145
146         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
147 }
148
149 static enum ast_test_result_state test_2way_function(struct ast_test *test,
150                 struct ast_channel *c, const char *encode1, const char *encode2,
151                 const char *decode1, const char *decode2)
152 {
153         struct ast_str *str = ast_str_create(16), *expression = ast_str_alloca(120);
154         int okay;
155
156         ast_str_set(&expression, 0, "%s%s%s", encode1, "foobarbaz", encode2);
157         ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
158         ast_str_set(&expression, 0, "%s%s%s", decode1, ast_str_buffer(str), decode2);
159         ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
160
161         okay = !strcmp(ast_str_buffer(str), "foobarbaz");
162
163         ast_test_status_update(test, "Testing '%s%s' and '%s%s' . . . . . %s\n",
164                         encode1, encode2, decode1, decode2,
165                         okay ? "passed" : "FAILED");
166
167         if (!okay) {
168                 ast_test_status_update(test, "  '%s' != 'foobarbaz'\n",
169                                 ast_str_buffer(str));
170         }
171
172         ast_free(str);
173
174         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
175 }
176
177 static enum ast_test_result_state test_expected_result(struct ast_test *test,
178                 struct ast_channel *c, const char *expression, const char *result)
179 {
180         struct ast_str *str = ast_str_create(16);
181         int okay;
182
183         ast_str_substitute_variables(&str, 0, c, expression);
184         okay = !strcmp(ast_str_buffer(str), result);
185
186         ast_test_status_update(test, "Testing '%s' ('%s') == '%s' . . . . . %s\n",
187                         ast_str_buffer(str), expression, result,
188                         okay ? "passed" : "FAILED");
189
190         if (!okay) {
191                 ast_test_status_update(test, "test_expected_result: '%s' != '%s'\n",
192                                 ast_str_buffer(str), result);
193         }
194
195         ast_free(str);
196
197         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
198 }
199
200 AST_TEST_DEFINE(test_substitution)
201 {
202         struct ast_channel *c;
203         int i;
204         enum ast_test_result_state res = AST_TEST_PASS;
205
206         switch (cmd) {
207         case TEST_INIT:
208                 info->name = "test_substitution";
209                 info->category = "/main/pbx/";
210                 info->summary = "Test variable and function substitution";
211                 info->description =
212                         "This test executes a variety of variable and function substitutions "
213                         "and ensures that the expected results are received.";
214                 return AST_TEST_NOT_RUN;
215         case TEST_EXECUTE:
216                 break;
217         }
218
219         ast_test_status_update(test, "Testing variable substitution ...\n");
220
221         c = ast_channel_alloc(0, 0, "", "", "", "", "", "", 0, "Test/substitution");
222
223 #define TEST(t) if (t == AST_TEST_FAIL) { res = AST_TEST_FAIL; }
224 #if 0
225         /*
226          * We can no longer test the CALLINGPRES value this way because it is now
227          * a calculated value from the name and number presentation information to
228          * get a combined presentation value.
229          */
230         TEST(test_chan_integer(test, c, &c->caller.id.number.presentation, "${CALLINGPRES}"));
231 #endif
232         TEST(test_chan_integer(test, c, &c->caller.ani2, "${CALLINGANI2}"));
233         TEST(test_chan_integer(test, c, &c->caller.id.number.plan, "${CALLINGTON}"));
234         TEST(test_chan_integer(test, c, &c->dialed.transit_network_select, "${CALLINGTNS}"));
235         TEST(test_chan_integer(test, c, &c->hangupcause, "${HANGUPCAUSE}"));
236         TEST(test_chan_integer(test, c, &c->priority, "${PRIORITY}"));
237         TEST(test_chan_string(test, c, c->context, sizeof(c->context), "${CONTEXT}"));
238         TEST(test_chan_string(test, c, c->exten, sizeof(c->exten), "${EXTEN}"));
239         TEST(test_chan_variable(test, c, "CHANNEL(language)"));
240         TEST(test_chan_variable(test, c, "CHANNEL(musicclass)"));
241         TEST(test_chan_variable(test, c, "CHANNEL(parkinglot)"));
242         TEST(test_chan_variable(test, c, "CALLERID(name)"));
243         TEST(test_chan_variable(test, c, "CURLOPT(proxyuserpwd)"));
244         TEST(test_chan_variable(test, c, "CDR(foo)"));
245         TEST(test_chan_variable(test, c, "ENV(foo)"));
246         TEST(test_chan_variable(test, c, "GLOBAL(foo)"));
247         TEST(test_chan_variable(test, c, "GROUP()"));
248         TEST(test_2way_function(test, c, "${AES_ENCRYPT(abcdefghijklmnop,", ")}", "${AES_DECRYPT(abcdefghijklmnop,", ")}"));
249         TEST(test_2way_function(test, c, "${BASE64_ENCODE(", ")}", "${BASE64_DECODE(", ")}"));
250         pbx_builtin_setvar_helper(c, "foo", "123");
251         pbx_builtin_setvar_helper(c, "bar", "foo");
252         pbx_builtin_setvar_helper(c, "baz", "fo");
253         TEST(test_expected_result(test, c, "${foo}${foo}", "123123"));
254         TEST(test_expected_result(test, c, "A${foo}A${foo}A", "A123A123A"));
255         TEST(test_expected_result(test, c, "A${${bar}}A", "A123A"));
256         TEST(test_expected_result(test, c, "A${${baz}o}A", "A123A"));
257         TEST(test_expected_result(test, c, "A${${baz}o:1}A", "A23A"));
258         TEST(test_expected_result(test, c, "A${${baz}o:1:1}A", "A2A"));
259         TEST(test_expected_result(test, c, "A${${baz}o:1:-1}A", "A2A"));
260         TEST(test_expected_result(test, c, "A${${baz}o:-1:1}A", "A3A"));
261         TEST(test_expected_result(test, c, "A${${baz}o:-2:1}A", "A2A"));
262         TEST(test_expected_result(test, c, "A${${baz}o:-2:-1}A", "A2A"));
263         pbx_builtin_setvar_helper(c, "list1", "ab&cd&ef");
264         TEST(test_expected_result(test, c, "${LISTFILTER(list1,&,cd)}", "ab&ef"));
265         TEST(test_expected_result(test, c, "${SHELL(printf '%d' 123)},${SHELL(printf '%d' 456)}", "123,456"));
266         TEST(test_expected_result(test, c, "${foo},${CDR(answer)},${SHELL(printf '%d' 456)}", "123,,456"));
267         TEST(test_expected_result(test, c, "${foo},${this_does_not_exist},${THIS_DOES_NOT_EXIST(either)}", "123,,"));
268 #undef TEST
269
270         /* For testing dialplan functions */
271         for (i = 0; ; i++) {
272                 char *cmd = ast_cli_generator("core show function", "", i);
273                 if (cmd == NULL) {
274                         break;
275                 }
276                 if (strcmp(cmd, "CHANNEL") && strcmp(cmd, "CALLERID") && strncmp(cmd, "CURL", 4) &&
277                                 strncmp(cmd, "AES", 3) && strncmp(cmd, "BASE64", 6) &&
278                                 strcmp(cmd, "CDR") && strcmp(cmd, "ENV") && strcmp(cmd, "GLOBAL") &&
279                                 strcmp(cmd, "GROUP") && strcmp(cmd, "CUT") && strcmp(cmd, "LISTFILTER") &&
280                                 strcmp(cmd, "PP_EACH_EXTENSION") && strcmp(cmd, "SET")) {
281                         struct ast_custom_function *acf = ast_custom_function_find(cmd);
282                         if (acf->read && acf->read2) {
283                                 char expression[80];
284                                 snprintf(expression, sizeof(expression), "${%s(foo)}", cmd);
285                                 if (AST_TEST_FAIL == test_chan_function(test, c, expression)) {
286                                         res = AST_TEST_FAIL;
287                                 }
288                         }
289                 }
290                 ast_free(cmd);
291         }
292
293         ast_hangup(c);
294         return res;
295 }
296
297 static int unload_module(void)
298 {
299         AST_TEST_UNREGISTER(test_substitution);
300         return 0;
301 }
302
303 static int load_module(void)
304 {
305         AST_TEST_REGISTER(test_substitution);
306         return AST_MODULE_LOAD_SUCCESS;
307 }
308
309 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Substitution tests");