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