aboutsummaryrefslogtreecommitdiffstats
path: root/tests/test_gosub.c
blob: 75c09f8ce103ec45f448807b19cf4881aac679e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2010, Digium, Inc.
 *
 * Tilghman Lesher <tlesher AT digium DOT com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*!
 * \file
 * \brief Gosub tests
 *
 * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
 *
 * \ingroup tests
 */

/*** MODULEINFO
	<depend>TEST_FRAMEWORK</depend>
 ***/

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision$")

#include "asterisk/utils.h"
#include "asterisk/module.h"
#include "asterisk/test.h"
#include "asterisk/pbx.h"

AST_TEST_DEFINE(test_gosub)
{
	int res = AST_TEST_PASS, i;
	struct ast_channel *chan;
	struct ast_str *str;
	struct ast_context *con;
	struct testplan {
		const char *app;
		const char *args;
		const char *expected_value;
	} testplan[] = {
		{ "Gosub", "tests_test_gosub_virtual_context,s,1" },
		{ NULL, "${EXTEN}", "s" },
		{ "Gosub", "test,dne,1", (const char *) -1 }, /* This is the only invocation that should fail. */
		{ NULL, "${EXTEN}", "s" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1(5,5,5,5,5)" },
		{ NULL, "$[0${ARG1} + 0${ARG5}]", "10" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1(4,4,4,4)" },
		{ NULL, "$[0${ARG1} + 0${ARG5}]", "4" },
		{ NULL, "$[0${ARG1} + 0${ARG4}]", "8" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1(3,3,3)" },
		{ NULL, "$[0${ARG1} + 0${ARG4}]", "3" },
		{ NULL, "$[0${ARG1} + 0${ARG3}]", "6" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1(2,2)" },
		{ NULL, "$[0${ARG1} + 0${ARG3}]", "2" },
		{ NULL, "$[0${ARG1} + 0${ARG2}]", "4" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1(1)" },
		{ NULL, "$[0${ARG1} + 0${ARG2}]", "1" },
		{ NULL, "$[0${ARG1} + 0${ARG1}]", "2" },
		{ "Gosub", "tests_test_gosub_virtual_context,s,1" },
		{ NULL, "$[0${ARG1} + 0${ARG1}]", "0" }, /* All arguments are correctly masked */
		{ "Set", "LOCAL(foo)=5" },
		{ NULL, "${foo}", "5" },                 /* LOCAL() set a variable correctly */
		{ NULL, "${LOCAL_PEEK(0,ARG1)}", "" },   /* LOCAL_PEEK() arguments work correctly */
		{ NULL, "${LOCAL_PEEK(4,ARG1)}", "4" },  /* LOCAL_PEEK() arguments work correctly */
		{ NULL, "$[0${LOCAL_PEEK(3,ARG1)} + 0${LOCAL_PEEK(5,ARG1)}]", "8" },
		{ "StackPop", "" },
		{ NULL, "${foo}", "" },                  /* StackPop removed the variable set with LOCAL() */
		{ "Return", "7" },
		{ NULL, "${GOSUB_RETVAL}", "7" },              /* Return sets a return value correctly */
		{ NULL, "$[0${GOSUB_RETVAL} + 0${ARG1}]", "9" }, /* Two frames less means ARG1 should have 2 */
	};

	switch (cmd) {
	case TEST_INIT:
		info->name = "gosub application";
		info->category = "apps/app_gosub/";
		info->summary = "Verify functionality of gosub application";
		info->description =
			"Verify functionality of gosub application";
		return AST_TEST_NOT_RUN;
	case TEST_EXECUTE:
		break;
	}

	if (!(chan = ast_dummy_channel_alloc())) {
		ast_test_status_update(test, "Unable to allocate dummy channel\n");
		return AST_TEST_FAIL;
	}

	if (!(str = ast_str_create(16))) {
		ast_test_status_update(test, "Unable to allocate dynamic string buffer\n");
		ast_channel_release(chan);
		return AST_TEST_FAIL;
	}

	/* Create our test dialplan */
	if (!(con = ast_context_find_or_create(NULL, NULL, "tests_test_gosub_virtual_context", "test_gosub"))) {
		ast_test_status_update(test, "Unable to create test dialplan context");
		ast_free(str);
		ast_channel_release(chan);
		return AST_TEST_FAIL;
	}

	ast_add_extension2(con, 1, "s", 1, NULL, NULL, "NoOp", ast_strdup(""), ast_free_ptr, "test_gosub");

	for (i = 0; i < ARRAY_LEN(testplan); i++) {
		if (testplan[i].app == NULL) {
			/* Evaluation */
			ast_str_substitute_variables(&str, 0, chan, testplan[i].args);
			if (strcmp(ast_str_buffer(str), testplan[i].expected_value)) {
				ast_test_status_update(test, "Evaluation of '%s' returned '%s' instead of the expected value '%s'\n",
					testplan[i].args, ast_str_buffer(str), testplan[i].expected_value);
				res = AST_TEST_FAIL;
			}
		} else {
			/* Run application */
			intptr_t exec_res;
			struct ast_app *app = pbx_findapp(testplan[i].app);
			if (!app) {
				ast_test_status_update(test, "Could not find '%s' in application listing!\n", testplan[i].app);
				res = AST_TEST_FAIL;
				break;
			}

			if ((exec_res = pbx_exec(chan, app, testplan[i].args)) && ((const char *) exec_res != testplan[i].expected_value)) {
				ast_test_status_update(test, "Application '%s' exited abnormally (with code %d)\n", testplan[i].app, (int) exec_res);
				res = AST_TEST_FAIL;
				break;
			}
		}
	}

	ast_free(str);
	ast_channel_release(chan);
	ast_context_remove_extension2(con, "s", 1, NULL, 0);
	ast_context_destroy(con, "test_gosub");

	return res;
}

static int unload_module(void)
{
	AST_TEST_UNREGISTER(test_gosub);
	return 0;
}

static int load_module(void)
{
	AST_TEST_REGISTER(test_gosub);
	return AST_MODULE_LOAD_SUCCESS;
}

AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Gosub Tests");