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