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         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
  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         ast_test_status_update(test, "Tested '%s' . . . . . %s\n", expression, okay ? "passed" : "FAILED");
  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_integer_accessor(struct ast_test *test,
  74                 struct ast_channel *c, void (*setter)(struct ast_channel *, int),const char *expression)
  75 {
  76         int i, okay = 1, value1 = -1, value2 = -1;
  77         char workspace[4096];
  78         struct ast_str *str = ast_str_create(16);
  79
  80         for (i = 0; i < 256; i++) {
  81                 setter(c, i);
  82                 ast_str_substitute_variables(&str, 0, c, expression);
  83                 pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
  84
  85                 if (sscanf(workspace, "%d", &value1) != 1 || value1 != i || sscanf(ast_str_buffer(str), "%d", &value2) != 1 || value2 != i) {
  86                         ast_test_status_update(test, "%s != %s and/or %d != %d != %d\n", ast_str_buffer(str), workspace, value1, value2, i);
  87                         okay = 0;
  88                 }
  89         }
  90         ast_test_status_update(test, "Tested '%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_string(struct ast_test *test,
  98                 struct ast_channel *c, void (*setter)(struct ast_channel *, const char *),
  99                 const char *(*getter)(const struct ast_channel *), const char *expression)
 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
 106         for (i = 0; i < ARRAY_LEN(values); i++) {
 107                 setter(c, values[i]);
 108                 ast_str_substitute_variables(&str, 0, c, expression);
 109                 pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
 110
 111                 if (strcmp(getter(c), ast_str_buffer(str)) != 0 || strcmp(getter(c), workspace) != 0) {
 112                         ast_test_status_update(test, "%s != %s != %s\n", getter(c), ast_str_buffer(str), workspace);
 113                         okay = 0;
 114                 }
 115         }
 116         ast_test_status_update(test, "Tested '%s' . . . . . %s\n",
 117                 expression, okay ? "passed" : "FAILED");
 118
 119         ast_free(str);
 120
 121         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
 122 }
 123
 124 static enum ast_test_result_state test_chan_variable(struct ast_test *test,
 125                 struct ast_channel *c, const char *varname)
 126 {
 127         const char *values[] = { "one", "three", "reallylongdinosaursoundingthingwithwordsinit" };
 128         int i, okay = 1;
 129         char workspace[4096];
 130         struct ast_str *str = ast_str_create(16);
 131         struct ast_str *var = ast_str_create(16);
 132
 133         ast_str_set(&var, 0, "${%s}", varname);
 134         for (i = 0; i < ARRAY_LEN(values); i++) {
 135                 pbx_builtin_setvar_helper(c, varname, values[i]);
 136                 ast_str_substitute_variables(&str, 0, c, ast_str_buffer(var));
 137                 pbx_substitute_variables_helper(c, ast_str_buffer(var), workspace, sizeof(workspace));
 138
 139                 if (strcmp(values[i], ast_str_buffer(str)) != 0 || strcmp(values[i], workspace) != 0) {
 140                         ast_test_status_update(test, "%s != %s != %s\n",
 141                                         values[i], ast_str_buffer(str), workspace);
 142                         okay = 0;
 143                 }
 144         }
 145         ast_test_status_update(test, "Tested '%s' . . . . . %s\n",
 146                 ast_str_buffer(var), okay ? "passed" : "FAILED");
 147
 148         ast_free(str);
 149         ast_free(var);
 150
 151         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
 152 }
 153
 154 static enum ast_test_result_state test_chan_function(struct ast_test *test,
 155                 struct ast_channel *c, const char *expression)
 156 {
 157         int okay = 1;
 158         char workspace[4096];
 159         struct ast_str *str = ast_str_create(16);
 160
 161         ast_str_substitute_variables(&str, 0, c, expression);
 162         pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
 163
 164         if (strcmp(workspace, ast_str_buffer(str)) != 0) {
 165                 ast_test_status_update(test, "expr: '%s' ... %s != %s\n",
 166                                 expression, ast_str_buffer(str), workspace);
 167                 okay = 0;
 168         }
 169         ast_test_status_update(test, "Tested '%s' . . . . . %s\n",
 170                 expression, okay ? "passed" : "FAILED");
 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_2way_function(struct ast_test *test,
 178                 struct ast_channel *c, const char *encode1, const char *encode2,
 179                 const char *decode1, const char *decode2)
 180 {
 181         struct ast_str *str = ast_str_create(16), *expression = ast_str_alloca(120);
 182         int okay;
 183
 184         ast_str_set(&expression, 0, "%s%s%s", encode1, "foobarbaz", encode2);
 185         ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
 186         ast_str_set(&expression, 0, "%s%s%s", decode1, ast_str_buffer(str), decode2);
 187         ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
 188
 189         okay = !strcmp(ast_str_buffer(str), "foobarbaz");
 190         if (!okay) {
 191                 ast_test_status_update(test, "'%s' != 'foobarbaz'\n",
 192                                 ast_str_buffer(str));
 193         }
 194         ast_test_status_update(test, "Tested '%s%s' and '%s%s' . . . . . %s\n",
 195                 encode1, encode2, decode1, decode2,
 196                 okay ? "passed" : "FAILED");
 197
 198         ast_free(str);
 199
 200         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
 201 }
 202
 203 static enum ast_test_result_state test_expected_result(struct ast_test *test,
 204                 struct ast_channel *c, const char *expression, const char *result)
 205 {
 206         struct ast_str *str = ast_str_create(16);
 207         int okay;
 208
 209         ast_str_substitute_variables(&str, 0, c, expression);
 210
 211         okay = !strcmp(ast_str_buffer(str), result);
 212         if (!okay) {
 213                 ast_test_status_update(test, "'%s' != '%s'\n",
 214                                 ast_str_buffer(str), result);
 215         }
 216         ast_test_status_update(test, "Tested '%s' ('%s') == '%s' . . . . . %s\n",
 217                 ast_str_buffer(str), expression, result,
 218                 okay ? "passed" : "FAILED");
 219
 220         ast_free(str);
 221
 222         return okay ? AST_TEST_PASS : AST_TEST_FAIL;
 223 }
 224
 225 AST_TEST_DEFINE(test_substitution)
 226 {
 227         struct ast_channel *c;
 228         int i;
 229         enum ast_test_result_state res = AST_TEST_PASS;
 230
 231         switch (cmd) {
 232         case TEST_INIT:
 233                 info->name = "test_substitution";
 234                 info->category = "/main/pbx/";
 235                 info->summary = "Test variable and function substitution";
 236                 info->description =
 237                         "This test executes a variety of variable and function substitutions "
 238                         "and ensures that the expected results are received.";
 239                 return AST_TEST_NOT_RUN;
 240         case TEST_EXECUTE:
 241                 break;
 242         }
 243
 244         ast_test_status_update(test, "Testing variable substitution ...\n");
 245
 246         c = ast_channel_alloc(0, 0, "", "", "", "", "", "", 0, "Test/substitution");
 247
 248 #define TEST(t) if (t == AST_TEST_FAIL) { res = AST_TEST_FAIL; }
 249 #if 0
 250         /*
 251          * We can no longer test the CALLINGPRES value this way because it is now
 252          * a calculated value from the name and number presentation information to
 253          * get a combined presentation value.
 254          */
 255         TEST(test_chan_integer(test, c, &c->caller.id.number.presentation, "${CALLINGPRES}"));
 256 #endif
 257         TEST(test_chan_integer(test, c, &ast_channel_caller(c)->ani2, "${CALLINGANI2}"));
 258         TEST(test_chan_integer(test, c, &ast_channel_caller(c)->id.number.plan, "${CALLINGTON}"));
 259         TEST(test_chan_integer(test, c, &ast_channel_dialed(c)->transit_network_select, "${CALLINGTNS}"));
 260         TEST(test_chan_integer_accessor(test, c, ast_channel_hangupcause_set, "${HANGUPCAUSE}"));
 261         TEST(test_chan_integer_accessor(test, c, ast_channel_priority_set, "${PRIORITY}"));
 262         TEST(test_chan_string(test, c, ast_channel_context_set, ast_channel_context, "${CONTEXT}"));
 263         TEST(test_chan_string(test, c, ast_channel_exten_set, ast_channel_exten, "${EXTEN}"));
 264         TEST(test_chan_variable(test, c, "CHANNEL(language)"));
 265         TEST(test_chan_variable(test, c, "CHANNEL(musicclass)"));
 266         TEST(test_chan_variable(test, c, "CHANNEL(parkinglot)"));
 267         TEST(test_chan_variable(test, c, "CALLERID(name)"));
 268         TEST(test_chan_variable(test, c, "CURLOPT(proxyuserpwd)"));
 269         TEST(test_chan_variable(test, c, "CDR(foo)"));
 270         TEST(test_chan_variable(test, c, "ENV(foo)"));
 271         TEST(test_chan_variable(test, c, "GLOBAL(foo)"));
 272         TEST(test_chan_variable(test, c, "GROUP()"));
 273         TEST(test_2way_function(test, c, "${AES_ENCRYPT(abcdefghijklmnop,", ")}", "${AES_DECRYPT(abcdefghijklmnop,", ")}"));
 274         TEST(test_2way_function(test, c, "${BASE64_ENCODE(", ")}", "${BASE64_DECODE(", ")}"));
 275         pbx_builtin_setvar_helper(c, "foo", "123");
 276         pbx_builtin_setvar_helper(c, "bar", "foo");
 277         pbx_builtin_setvar_helper(c, "baz", "fo");
 278         TEST(test_expected_result(test, c, "${foo}${foo}", "123123"));
 279         TEST(test_expected_result(test, c, "A${foo}A${foo}A", "A123A123A"));
 280         TEST(test_expected_result(test, c, "A${${bar}}A", "A123A"));
 281         TEST(test_expected_result(test, c, "A${${baz}o}A", "A123A"));
 282         TEST(test_expected_result(test, c, "A${${baz}o:1}A", "A23A"));
 283         TEST(test_expected_result(test, c, "A${${baz}o:1:1}A", "A2A"));
 284         TEST(test_expected_result(test, c, "A${${baz}o:1:-1}A", "A2A"));
 285         TEST(test_expected_result(test, c, "A${${baz}o:-1:1}A", "A3A"));
 286         TEST(test_expected_result(test, c, "A${${baz}o:-2:1}A", "A2A"));
 287         TEST(test_expected_result(test, c, "A${${baz}o:-2:-1}A", "A2A"));
 288         pbx_builtin_setvar_helper(c, "list1", "ab&cd&ef");
 289         TEST(test_expected_result(test, c, "${LISTFILTER(list1,&,cd)}", "ab&ef"));
 290         TEST(test_expected_result(test, c, "${SHELL(printf '%d' 123)},${SHELL(printf '%d' 456)}", "123,456"));
 291         TEST(test_expected_result(test, c, "${foo},${CDR(answer)},${SHELL(printf '%d' 456)}", "123,0.000000,456"));
 292         TEST(test_expected_result(test, c, "${foo},${CDR(answer,u)},${SHELL(printf '%d' 456)}", "123,0.000000,456"));
 293         TEST(test_expected_result(test, c, "${foo},${this_does_not_exist},${THIS_DOES_NOT_EXIST(either)}", "123,,"));
 294 #undef TEST
 295
 296         /* For testing dialplan functions */
 297         for (i = 0; ; i++) {
 298                 char *cmd = ast_cli_generator("core show function", "", i);
 299                 if (cmd == NULL) {
 300                         break;
 301                 }
 302                 if (strcmp(cmd, "CHANNEL") && strcmp(cmd, "CALLERID") && strncmp(cmd, "CURL", 4) &&
 303                                 strncmp(cmd, "AES", 3) && strncmp(cmd, "BASE64", 6) &&
 304                                 strcmp(cmd, "CDR") && strcmp(cmd, "ENV") && strcmp(cmd, "GLOBAL") &&
 305                                 strcmp(cmd, "GROUP") && strcmp(cmd, "CUT") && strcmp(cmd, "LISTFILTER") &&
 306                                 strcmp(cmd, "PP_EACH_EXTENSION") && strcmp(cmd, "SET")) {
 307                         struct ast_custom_function *acf = ast_custom_function_find(cmd);
 308                         if (acf->read && acf->read2) {
 309                                 char expression[80];
 310                                 snprintf(expression, sizeof(expression), "${%s(foo)}", cmd);
 311                                 if (AST_TEST_FAIL == test_chan_function(test, c, expression)) {
 312                                         res = AST_TEST_FAIL;
 313                                 }
 314                         }
 315                 }
 316                 ast_free(cmd);
 317         }
 318
 319         ast_hangup(c);
 320         return res;
 321 }
 322
 323 static int unload_module(void)
 324 {
 325         AST_TEST_UNREGISTER(test_substitution);
 326         return 0;
 327 }
 328
 329 static int load_module(void)
 330 {
 331         AST_TEST_REGISTER(test_substitution);
 332         return AST_MODULE_LOAD_SUCCESS;
 333 }
 334
 335 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Substitution tests");