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