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