Merged revisions 332177 via svnmerge from
[asterisk/asterisk.git] / tests / test_gosub.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, 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 /*!
20  * \file
21  * \brief Gosub tests
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         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/utils.h"
38 #include "asterisk/module.h"
39 #include "asterisk/test.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/channel.h"
42
43 AST_TEST_DEFINE(test_gosub)
44 {
45         int res = AST_TEST_PASS, i;
46         struct ast_channel *chan;
47         struct ast_str *str;
48         struct ast_context *con;
49         struct testplan {
50                 const char *app;
51                 const char *args;
52                 const char *expected_value;
53         } testplan[] = {
54                 { "Gosub", "tests_test_gosub_virtual_context,s,1" },
55                 { NULL, "${EXTEN}", "s" },
56                 { "Gosub", "test,dne,1", (const char *) -1 }, /* This is the only invocation that should fail. */
57                 { NULL, "${EXTEN}", "s" },
58                 { "Gosub", "tests_test_gosub_virtual_context,s,1(5,5,5,5,5)" },
59                 { NULL, "$[0${ARG1} + 0${ARG5}]", "10" },
60                 { "Gosub", "tests_test_gosub_virtual_context,s,1(4,4,4,4)" },
61                 { NULL, "$[0${ARG1} + 0${ARG5}]", "4" },
62                 { NULL, "$[0${ARG1} + 0${ARG4}]", "8" },
63                 { "Gosub", "tests_test_gosub_virtual_context,s,1(3,3,3)" },
64                 { NULL, "$[0${ARG1} + 0${ARG4}]", "3" },
65                 { NULL, "$[0${ARG1} + 0${ARG3}]", "6" },
66                 { "Gosub", "tests_test_gosub_virtual_context,s,1(2,2)" },
67                 { NULL, "$[0${ARG1} + 0${ARG3}]", "2" },
68                 { NULL, "$[0${ARG1} + 0${ARG2}]", "4" },
69                 { "Gosub", "tests_test_gosub_virtual_context,s,1(1)" },
70                 { NULL, "$[0${ARG1} + 0${ARG2}]", "1" },
71                 { NULL, "$[0${ARG1} + 0${ARG1}]", "2" },
72                 { "Gosub", "tests_test_gosub_virtual_context,s,1" },
73                 { NULL, "$[0${ARG1} + 0${ARG1}]", "0" }, /* All arguments are correctly masked */
74                 { "Set", "LOCAL(foo)=5" },
75                 { NULL, "${foo}", "5" },                 /* LOCAL() set a variable correctly */
76                 { NULL, "${LOCAL_PEEK(0,ARG1)}", "" },   /* LOCAL_PEEK() arguments work correctly */
77                 { NULL, "${LOCAL_PEEK(4,ARG1)}", "4" },  /* LOCAL_PEEK() arguments work correctly */
78                 { NULL, "$[0${LOCAL_PEEK(3,ARG1)} + 0${LOCAL_PEEK(5,ARG1)}]", "8" },
79                 { "StackPop", "" },
80                 { NULL, "${foo}", "" },                  /* StackPop removed the variable set with LOCAL() */
81                 { "Return", "7" },
82                 { NULL, "${GOSUB_RETVAL}", "7" },              /* Return sets a return value correctly */
83                 { NULL, "$[0${GOSUB_RETVAL} + 0${ARG1}]", "9" }, /* Two frames less means ARG1 should have 2 */
84         };
85
86         switch (cmd) {
87         case TEST_INIT:
88                 info->name = "gosub application";
89                 info->category = "/apps/app_gosub/";
90                 info->summary = "Verify functionality of gosub application";
91                 info->description =
92                         "Verify functionality of gosub application";
93                 return AST_TEST_NOT_RUN;
94         case TEST_EXECUTE:
95                 break;
96         }
97
98         if (!(chan = ast_dummy_channel_alloc())) {
99                 ast_test_status_update(test, "Unable to allocate dummy channel\n");
100                 return AST_TEST_FAIL;
101         }
102
103         if (!(str = ast_str_create(16))) {
104                 ast_test_status_update(test, "Unable to allocate dynamic string buffer\n");
105                 ast_channel_release(chan);
106                 return AST_TEST_FAIL;
107         }
108
109         /* Create our test dialplan */
110         if (!(con = ast_context_find_or_create(NULL, NULL, "tests_test_gosub_virtual_context", "test_gosub"))) {
111                 ast_test_status_update(test, "Unable to create test dialplan context");
112                 ast_free(str);
113                 ast_channel_release(chan);
114                 return AST_TEST_FAIL;
115         }
116
117         ast_add_extension2(con, 1, "s", 1, NULL, NULL, "NoOp", ast_strdup(""), ast_free_ptr, "test_gosub");
118
119         for (i = 0; i < ARRAY_LEN(testplan); i++) {
120                 if (testplan[i].app == NULL) {
121                         /* Evaluation */
122                         ast_str_substitute_variables(&str, 0, chan, testplan[i].args);
123                         if (strcmp(ast_str_buffer(str), testplan[i].expected_value)) {
124                                 ast_test_status_update(test, "Evaluation of '%s' returned '%s' instead of the expected value '%s'\n",
125                                         testplan[i].args, ast_str_buffer(str), testplan[i].expected_value);
126                                 res = AST_TEST_FAIL;
127                         }
128                 } else {
129                         /* Run application */
130                         intptr_t exec_res;
131                         struct ast_app *app = pbx_findapp(testplan[i].app);
132                         if (!app) {
133                                 ast_test_status_update(test, "Could not find '%s' in application listing!\n", testplan[i].app);
134                                 res = AST_TEST_FAIL;
135                                 break;
136                         }
137
138                         if ((exec_res = pbx_exec(chan, app, testplan[i].args)) && ((const char *) exec_res != testplan[i].expected_value)) {
139                                 ast_test_status_update(test, "Application '%s' exited abnormally (with code %d)\n", testplan[i].app, (int) exec_res);
140                                 res = AST_TEST_FAIL;
141                                 break;
142                         }
143                 }
144         }
145
146         ast_free(str);
147         ast_channel_release(chan);
148         ast_context_remove_extension2(con, "s", 1, NULL, 0);
149         ast_context_destroy(con, "test_gosub");
150
151         return res;
152 }
153
154 static int unload_module(void)
155 {
156         AST_TEST_UNREGISTER(test_gosub);
157         return 0;
158 }
159
160 static int load_module(void)
161 {
162         AST_TEST_REGISTER(test_gosub);
163         return AST_MODULE_LOAD_SUCCESS;
164 }
165
166 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Gosub Tests");