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