make func_file unit test's category consistent with other tests
[asterisk/asterisk.git] / tests / test_func_file.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 Function FILE 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  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/utils.h"
37 #include "asterisk/app.h"
38 #include "asterisk/module.h"
39 #include "asterisk/test.h"
40 #include "asterisk/pbx.h"
41
42 #define C1024 \
43                 "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"
44
45 static struct {
46         const char *contents;
47         const char *args;
48         const char *value;
49 } read_tests[] = {
50         /* 4 different ways of specifying the first character */
51         { "123456789", "0,1", "1" },
52         { "123456789", "0,-8", "1" },
53         { "123456789", "-9,1", "1" },
54         { "123456789", "-9,-8", "1" },
55         /* Does 0-length work? */
56         { "123456789", "0,0", "" },
57         { "123456789", "-9,0", "" },
58         { "123456789", "-9,-9", "" },
59         /* Does negative length work? */
60         { "123456789", "5,-6", "" },
61         { "123456789", "-5,-6", "" },
62         /* No length */
63         { "123456789", "-5", "56789" },
64         { "123456789", "4", "56789" },
65         /* Line mode, 4 ways of specifying the first character */
66         { "123\n456\n789\n", "0,1,l", "123\n" },
67         { "123\n456\n789\n", "-3,1,l", "123\n" },
68         { "123\n456\n789\n", "0,-2,l", "123\n" },
69         { "123\n456\n789\n", "-3,-2,l", "123\n" },
70         /* Line mode, 0-length */
71         { "123\n456\n789\n", "0,0,l", "" },
72         { "123\n456\n789\n", "-3,0,l", "" },
73         { "123\n456\n789\n", "-3,-3,l", "" },
74         /* Line mode, negative length */
75         { "123\n456\n789\n", "2,-2,l", "" },
76         { "123\n456\n789\n", "-2,-3,l", "" },
77         /* No length */
78         { "123\n456\n789\n", "1,,l", "456\n789\n" },
79         { "123\n456\n789\n", "-2,,l", "456\n789\n" },
80 };
81
82 static struct {
83         const char *contents;
84         const char *args;
85         const char *value;
86         const char *contents2;
87 } write_tests[] = {
88         /* Single character replace */
89         { "123456789", "0,1", "a", "a23456789" },
90         { "123456789", "-9,1", "a", "a23456789" },
91         { "123456789", "0,-8", "a", "a23456789" },
92         { "123456789", "-9,-8", "a", "a23456789" },
93         { "123456789", "5,1", "b", "12345b789" },
94         { "123456789", "-4,1", "b", "12345b789" },
95         { "123456789", "5,-3", "b", "12345b789" },
96         { "123456789", "-4,-3", "b", "12345b789" },
97         /* Replace 2 characters with 1 */
98         { "123456789", "0,2", "c", "c3456789" },
99         { "123456789", "-9,2", "c", "c3456789" },
100         { "123456789", "0,-7", "c", "c3456789" },
101         { "123456789", "-9,-7", "c", "c3456789" },
102         { "123456789", "4,2", "d", "1234d789" },
103         { "123456789", "-5,2", "d", "1234d789" },
104         { "123456789", "4,-3", "d", "1234d789" },
105         { "123456789", "-5,-3", "d", "1234d789" },
106         /* Truncate file */
107         { "123456789", "5", "e", "12345e" },
108         { "123456789", "5", "", "12345" },
109         { "123456789", "-4", "e", "12345e" },
110         { "123456789", "-4", "", "12345" },
111         /* Replace 1 character with 2 */
112         { "123456789", "0,1", "fg", "fg23456789" },
113         { "123456789", "0,-8", "fg", "fg23456789" },
114         { "123456789", "-9,1", "fg", "fg23456789" },
115         { "123456789", "-9,-8", "fg", "fg23456789" },
116         /* Overwrite file */
117         { "123456789", "", "h", "h" },
118         { "123456789", ",,,", "h", "h" },
119         { "123\n456\n789\n", ",,l", "h", "h\n" },
120         { "123\n456\n789\n", ",,ld", "h", "h" },
121         /* Single line replace, same length */
122         { "123\n456\n789\n", "0,1,l", "abc", "abc\n456\n789\n" },
123         { "123\n456\n789\n", "-3,1,l", "abc", "abc\n456\n789\n" },
124         { "123\n456\n789\n", "0,-2,l", "abc", "abc\n456\n789\n" },
125         { "123\n456\n789\n", "-3,-2,l", "abc", "abc\n456\n789\n" },
126         { "123\n456\n789\n", "1,1,l", "abc", "123\nabc\n789\n" },
127         { "123\n456\n789\n", "1,-1,l", "abc", "123\nabc\n789\n" },
128         { "123\n456\n789\n", "-2,1,l", "abc", "123\nabc\n789\n" },
129         { "123\n456\n789\n", "-2,-1,l", "abc", "123\nabc\n789\n" },
130         /* Single line replace, one character short */
131         { "123\n456\n789\n", "0,1,l", "ab", "ab\n456\n789\n" },
132         { "123\n456\n789\n", "-3,1,l", "ab", "ab\n456\n789\n" },
133         { "123\n456\n789\n", "0,-2,l", "ab", "ab\n456\n789\n" },
134         { "123\n456\n789\n", "-3,-2,l", "ab", "ab\n456\n789\n" },
135         { "123\n456\n789\n", "1,1,l", "ab", "123\nab\n789\n" },
136         { "123\n456\n789\n", "1,-1,l", "ab", "123\nab\n789\n" },
137         { "123\n456\n789\n", "-2,1,l", "ab", "123\nab\n789\n" },
138         { "123\n456\n789\n", "-2,-1,l", "ab", "123\nab\n789\n" },
139         /* Single line replace, one character long */
140         { "123\n456\n789\n", "0,1,l", "abcd", "abcd\n456\n789\n" },
141         { "123\n456\n789\n", "-3,1,l", "abcd", "abcd\n456\n789\n" },
142         { "123\n456\n789\n", "0,-2,l", "abcd", "abcd\n456\n789\n" },
143         { "123\n456\n789\n", "-3,-2,l", "abcd", "abcd\n456\n789\n" },
144         { "123\n456\n789\n", "1,1,l", "abcd", "123\nabcd\n789\n" },
145         { "123\n456\n789\n", "1,-1,l", "abcd", "123\nabcd\n789\n" },
146         { "123\n456\n789\n", "-2,1,l", "abcd", "123\nabcd\n789\n" },
147         { "123\n456\n789\n", "-2,-1,l", "abcd", "123\nabcd\n789\n" },
148         /* Multi-line replace, same number of characters, 2 lines for 1 */
149         { "123\n456\n789\n", "0,2,l", "abcdefg", "abcdefg\n789\n" },
150         { "123\n456\n789\n", "-3,2,l", "abcdefg", "abcdefg\n789\n" },
151         { "123\n456\n789\n", "0,-1,l", "abcdefg", "abcdefg\n789\n" },
152         { "123\n456\n789\n", "-3,-1,l", "abcdefg", "abcdefg\n789\n" },
153         { "123\n456\n789\n", "1,2,l", "abcdefg", "123\nabcdefg\n" },
154         { "123\n456\n789\n", "1,,l", "abcdefg", "123\nabcdefg\n" },
155         { "123\n456\n789\n", "-2,2,l", "abcdefg", "123\nabcdefg\n" },
156         { "123\n456\n789\n", "-2,,l", "abcdefg", "123\nabcdefg\n" },
157         /* Multi-line replace, shorter number of characters, 2 lines for 1 */
158         { "123\n456\n789\n", "0,2,l", "abcd", "abcd\n789\n" },
159         { "123\n456\n789\n", "-3,2,l", "abcd", "abcd\n789\n" },
160         { "123\n456\n789\n", "0,-1,l", "abcd", "abcd\n789\n" },
161         { "123\n456\n789\n", "-3,-1,l", "abcd", "abcd\n789\n" },
162         { "123\n456\n789\n", "1,2,l", "abcd", "123\nabcd\n" },
163         { "123\n456\n789\n", "1,,l", "abcd", "123\nabcd\n" },
164         { "123\n456\n789\n", "-2,2,l", "abcd", "123\nabcd\n" },
165         { "123\n456\n789\n", "-2,,l", "abcd", "123\nabcd\n" },
166         /* Multi-line replace, longer number of characters, 2 lines for 1 */
167         { "123\n456\n789\n", "0,2,l", "abcdefghijklmnop", "abcdefghijklmnop\n789\n" },
168         { "123\n456\n789\n", "-3,2,l", "abcdefghijklmnop", "abcdefghijklmnop\n789\n" },
169         { "123\n456\n789\n", "0,-1,l", "abcdefghijklmnop", "abcdefghijklmnop\n789\n" },
170         { "123\n456\n789\n", "-3,-1,l", "abcdefghijklmnop", "abcdefghijklmnop\n789\n" },
171         { "123\n456\n789\n", "1,2,l", "abcdefghijklmnop", "123\nabcdefghijklmnop\n" },
172         { "123\n456\n789\n", "1,,l", "abcdefghijklmnop", "123\nabcdefghijklmnop\n" },
173         { "123\n456\n789\n", "-2,2,l", "abcdefghijklmnop", "123\nabcdefghijklmnop\n" },
174         { "123\n456\n789\n", "-2,,l", "abcdefghijklmnop", "123\nabcdefghijklmnop\n" },
175         /* Insert line */
176         { "123\n456\n789\n", "0,0,l", "abcd", "abcd\n123\n456\n789\n" },
177         { "123\n456\n789\n", "-3,0,l", "abcd", "abcd\n123\n456\n789\n" },
178         { "123\n456\n789\n", "1,0,l", "abcd", "123\nabcd\n456\n789\n" },
179         { "123\n456\n789\n", "-2,0,l", "abcd", "123\nabcd\n456\n789\n" },
180         { "123\n456\n789\n", "2,0,l", "abcd", "123\n456\nabcd\n789\n" },
181         { "123\n456\n789\n", "-1,0,l", "abcd", "123\n456\nabcd\n789\n" },
182         { "123\n456\n789\n", "3,0,l", "abcd", "123\n456\n789\nabcd\n" },
183         { "123\n456\n789\n", ",,la", "abcd", "123\n456\n789\nabcd\n" },
184         /* Single line, replace with blank line */
185         { "123\n456\n789\n", "0,1,l", "", "\n456\n789\n" },
186         { "123\n456\n789\n", "-3,1,l", "", "\n456\n789\n" },
187         { "123\n456\n789\n", "0,-2,l", "", "\n456\n789\n" },
188         { "123\n456\n789\n", "-3,-2,l", "", "\n456\n789\n" },
189         { "123\n456\n789\n", "1,1,l", "", "123\n\n789\n" },
190         { "123\n456\n789\n", "1,-1,l", "", "123\n\n789\n" },
191         { "123\n456\n789\n", "-2,1,l", "", "123\n\n789\n" },
192         { "123\n456\n789\n", "-2,-1,l", "", "123\n\n789\n" },
193         /* Single line, delete */
194         { "123\n456\n789\n", "0,1,ld", "", "456\n789\n" },
195         { "123\n456\n789\n", "-3,1,ld", "", "456\n789\n" },
196         { "123\n456\n789\n", "0,-2,ld", "", "456\n789\n" },
197         { "123\n456\n789\n", "-3,-2,ld", "", "456\n789\n" },
198         { "123\n456\n789\n", "1,1,ld", "", "123\n789\n" },
199         { "123\n456\n789\n", "1,-1,ld", "", "123\n789\n" },
200         { "123\n456\n789\n", "-2,1,ld", "", "123\n789\n" },
201         { "123\n456\n789\n", "-2,-1,ld", "", "123\n789\n" },
202         /* Really long tests */
203         { "1234567890ABCDEF" C1024 C1024 C1024 C1024 C1024,
204                 "0,1", "a",
205                 "a234567890ABCDEF" C1024 C1024 C1024 C1024 C1024 },
206         { "1234567890ABCDEF" C1024 C1024 C1024 C1024 C1024,
207                 "0,1", "abcd",
208                 "abcd234567890ABCDEF" C1024 C1024 C1024 C1024 C1024 },
209         { "1234567890ABCDEF" C1024 C1024 C1024 C1024 C1024,
210                 "0,10", "abcd",
211                 "abcdABCDEF" C1024 C1024 C1024 C1024 C1024 },
212         { "1" C1024 "\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n",
213                 "0,1,l", "abcd",
214                 "abcd\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n" },
215         { "1234\n1" C1024 "\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n",
216                 "0,1,l", "abcd",
217                 "abcd\n1" C1024 "\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n" },
218         { "1234\n1" C1024 "\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n",
219                 "0,1,l", "a",
220                 "a\n1" C1024 "\n2" C1024 "\n3" C1024 "\n4" C1024 "\n5" C1024 "\n6" C1024 "\n" },
221 };
222
223 static char *file2display(struct ast_str **buf, ssize_t len, const char *input)
224 {
225         const char *ptr;
226         ast_str_reset(*buf);
227         for (ptr = input; *ptr; ptr++) {
228                 if (*ptr == '\n') {
229                         ast_str_append(buf, len, "\\n");
230                 } else if (*ptr == '\r') {
231                         ast_str_append(buf, len, "\\r");
232                 } else if (*ptr == '\t') {
233                         ast_str_append(buf, len, "\\t");
234                 } else if (*ptr < ' ' || *ptr > 125) {
235                         ast_str_append(buf, len, "\\x%hhX", *ptr);
236                 } else {
237                         ast_str_append(buf, len, "%c", *ptr);
238                 }
239         }
240         return ast_str_buffer(*buf);
241 }
242
243 AST_TEST_DEFINE(test_func_file)
244 {
245         int res = AST_TEST_PASS;
246         int i;
247         char dir[] = "/tmp/test_func_file.XXXXXX";
248         char file[80], expression[256];
249         struct ast_str *buf, *disp[2] = { NULL, NULL };
250         char fbuf[8192];
251         FILE *fh;
252
253         switch (cmd) {
254         case TEST_INIT:
255                 info->name = "func_file";
256                 info->category = "/funcs/func_env";
257                 info->summary = "Verify behavior of the FILE() dialplan function";
258                 info->description =
259                         "Verifies that the examples of the FILE() dialplan function documentation work as described.";
260                 return AST_TEST_NOT_RUN;
261         case TEST_EXECUTE:
262                 break;
263         }
264
265         if (!mkdtemp(dir)) {
266                 ast_test_status_update(test, "Cannot create temporary directory: %s\n", strerror(errno));
267                 return AST_TEST_FAIL;
268         }
269
270         disp[0] = ast_str_create(16);
271         disp[1] = ast_str_create(16);
272         if (!(buf = ast_str_create(16)) || !disp[0] || !disp[1]) {
273                 ast_free(buf);
274                 ast_free(disp[0]);
275                 ast_free(disp[1]);
276                 rmdir(dir);
277                 return AST_TEST_FAIL;
278         }
279
280         snprintf(file, sizeof(file), "%s/test.txt", dir);
281
282         for (i = 0; i < ARRAY_LEN(read_tests); i++) {
283                 if (!(fh = fopen(file, "w"))) {
284                         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
285                         ast_free(buf);
286                         ast_free(disp[0]);
287                         ast_free(disp[1]);
288                         unlink(file);
289                         rmdir(dir);
290                         return AST_TEST_FAIL;
291                 }
292
293                 if (fwrite(read_tests[i].contents, 1, strlen(read_tests[i].contents), fh) < strlen(read_tests[i].contents)) {
294                         ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
295                         ast_free(buf);
296                         ast_free(disp[0]);
297                         ast_free(disp[1]);
298                         fclose(fh);
299                         unlink(file);
300                         rmdir(dir);
301                         return AST_TEST_FAIL;
302                 }
303
304                 fclose(fh);
305
306                 snprintf(expression, sizeof(expression), "${FILE(%s,%s)}", file, read_tests[i].args);
307                 ast_str_substitute_variables(&buf, 0, NULL, expression);
308
309                 if (strcmp(ast_str_buffer(buf), read_tests[i].value)) {
310                         ast_test_status_update(test, "Expression '${FILE(...,%s)}' did not produce ('%s') the expected value ('%s')\n",
311                                 read_tests[i].args, file2display(&disp[0], 0, ast_str_buffer(buf)), file2display(&disp[1], 0, read_tests[i].value));
312                         res = AST_TEST_FAIL;
313                 }
314         }
315
316         ast_free(buf);
317
318         for (i = 0; i < ARRAY_LEN(write_tests); i++) {
319                 if (!(fh = fopen(file, "w"))) {
320                         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
321                         ast_free(disp[0]);
322                         ast_free(disp[1]);
323                         unlink(file);
324                         rmdir(dir);
325                         return AST_TEST_FAIL;
326                 }
327
328                 if (fwrite(write_tests[i].contents, 1, strlen(write_tests[i].contents), fh) < strlen(write_tests[i].contents)) {
329                         ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
330                         ast_free(disp[0]);
331                         ast_free(disp[1]);
332                         fclose(fh);
333                         unlink(file);
334                         rmdir(dir);
335                         return AST_TEST_FAIL;
336                 }
337
338                 fclose(fh);
339
340                 snprintf(expression, sizeof(expression), "FILE(%s,%s)", file, write_tests[i].args);
341                 ast_func_write(NULL, expression, write_tests[i].value);
342
343                 if (!(fh = fopen(file, "r"))) {
344                         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
345                         ast_free(disp[0]);
346                         ast_free(disp[1]);
347                         unlink(file);
348                         rmdir(dir);
349                         return AST_TEST_FAIL;
350                 }
351
352                 memset(fbuf, 0, sizeof(fbuf));
353                 if (!fread(fbuf, 1, sizeof(fbuf), fh)) {
354                         ast_test_status_update(test, "Cannot read write results from test file: %s\n", strerror(errno));
355                         ast_free(disp[0]);
356                         ast_free(disp[1]);
357                         fclose(fh);
358                         unlink(file);
359                         rmdir(dir);
360                         return AST_TEST_FAIL;
361                 }
362
363                 fclose(fh);
364
365                 if (strcmp(fbuf, write_tests[i].contents2)) {
366                         ast_test_status_update(test, "Expression 'FILE(...,%s)=%s' did not produce ('%s') the expected result ('%s')\n",
367                                 write_tests[i].args, write_tests[i].value, file2display(&disp[0], 0, fbuf), file2display(&disp[1], 0, write_tests[i].contents2));
368                         res = AST_TEST_FAIL;
369                 } else {
370                         ast_test_status_update(test, "Expression 'FILE(...,%s)=%s'... OK!\n", write_tests[i].args, write_tests[i].value);
371                 }
372         }
373
374         ast_free(disp[0]);
375         ast_free(disp[1]);
376         unlink(file);
377         rmdir(dir);
378
379         return res;
380 }
381
382 static int unload_module(void)
383 {
384         AST_TEST_UNREGISTER(test_func_file);
385         return 0;
386 }
387
388 static int load_module(void)
389 {
390         AST_TEST_REGISTER(test_func_file);
391         return AST_MODULE_LOAD_SUCCESS;
392 }
393
394 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "FILE() Tests");