Function FILE tests. More...

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

Include dependency graph for test_func_file.c:

Go to the source code of this file.

Macros
#define	C1024 "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

struct ast_module *	AST_MODULE_SELF_SYM (void)

	AST_TEST_DEFINE (test_func_file)

static char *	file2display (struct ast_str *buf, ssize_t len, const char input)

static int	load_module (void)

static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "FILE() Tests" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static const struct ast_module_info *	ast_module_info = &__mod_info

struct {
const char * args

const char * contents

const char * value

}	read_tests []

struct {
const char * args

const char * contents

const char * contents2

const char * value

}	write_tests []

Detailed Description

Function FILE tests.

Author

Tilghman Lesher <tlesher AT digium DOT com>

Definition in file test_func_file.c.

Macro Definition Documentation

◆ C1024

#define C1024 "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"

Definition at line 41 of file test_func_file.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 399 of file test_func_file.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 399 of file test_func_file.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 399 of file test_func_file.c.

◆ AST_TEST_DEFINE()

AST_TEST_DEFINE ( test_func_file )

Definition at line 248 of file test_func_file.c.

{
    int res = AST_TEST_PASS;
    int i;
    char dir[] = "/tmp/test_func_file.XXXXXX";
    char file[80], expression[256];
    struct ast_str *buf, *disp[2] = { NULL, NULL };
    char fbuf[8192];
    FILE *fh;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "func_file";
        info->category = "/funcs/func_env/";
        info->summary = "Verify behavior of the FILE() dialplan function";
        info->description =
            "Verifies that the examples of the FILE() dialplan function documentation work as described.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    if (!mkdtemp(dir)) {
        ast_test_status_update(test, "Cannot create temporary directory: %s\n", strerror(errno));
        return AST_TEST_FAIL;
    }
 
    disp[0] = ast_str_create(16);
    disp[1] = ast_str_create(16);
    if (!(buf = ast_str_create(16)) || !disp[0] || !disp[1]) {
        ast_free(buf);
        ast_free(disp[0]);
        ast_free(disp[1]);
        rmdir(dir);
        return AST_TEST_FAIL;
    }
 
    snprintf(file, sizeof(file), "%s/test.txt", dir);
 
    for (i = 0; i < ARRAY_LEN(read_tests); i++) {
        if (!(fh = fopen(file, "w"))) {
            ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
            ast_free(buf);
            ast_free(disp[0]);
            ast_free(disp[1]);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        if (fwrite(read_tests[i].contents, 1, strlen(read_tests[i].contents), fh) < strlen(read_tests[i].contents)) {
            ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
            ast_free(buf);
            ast_free(disp[0]);
            ast_free(disp[1]);
            fclose(fh);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        fclose(fh);
 
        snprintf(expression, sizeof(expression), "${FILE(%s,%s)}", file, read_tests[i].args);
        ast_str_substitute_variables(&buf, 0, NULL, expression);
 
        if (strcmp(ast_str_buffer(buf), read_tests[i].value)) {
            ast_test_status_update(test, "Expression '${FILE(...,%s)}' did not produce ('%s') the expected value ('%s')\n",
                read_tests[i].args, file2display(&disp[0], 0, ast_str_buffer(buf)), file2display(&disp[1], 0, read_tests[i].value));
            res = AST_TEST_FAIL;
        }
    }
 
    ast_free(buf);
 
    for (i = 0; i < ARRAY_LEN(write_tests); i++) {
        if (!(fh = fopen(file, "w"))) {
            ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
            ast_free(disp[0]);
            ast_free(disp[1]);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        if (fwrite(write_tests[i].contents, 1, strlen(write_tests[i].contents), fh) < strlen(write_tests[i].contents)) {
            ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
            ast_free(disp[0]);
            ast_free(disp[1]);
            fclose(fh);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        fclose(fh);
 
        snprintf(expression, sizeof(expression), "FILE(%s,%s)", file, write_tests[i].args);
        ast_func_write(NULL, expression, write_tests[i].value);
 
        if (!(fh = fopen(file, "r"))) {
            ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
            ast_free(disp[0]);
            ast_free(disp[1]);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        memset(fbuf, 0, sizeof(fbuf));
        if (!fread(fbuf, 1, sizeof(fbuf), fh)) {
            ast_test_status_update(test, "Cannot read write results from test file: %s\n", strerror(errno));
            ast_free(disp[0]);
            ast_free(disp[1]);
            fclose(fh);
            unlink(file);
            rmdir(dir);
            return AST_TEST_FAIL;
        }
 
        fclose(fh);
 
        if (strcmp(fbuf, write_tests[i].contents2)) {
            ast_test_status_update(test, "Expression 'FILE(...,%s)=%s' did not produce ('%s') the expected result ('%s')\n",
                write_tests[i].args, write_tests[i].value, file2display(&disp[0], 0, fbuf), file2display(&disp[1], 0, write_tests[i].contents2));
            res = AST_TEST_FAIL;
        } else {
            ast_test_status_update(test, "Expression 'FILE(...,%s)=%s'... OK!\n", write_tests[i].args, write_tests[i].value);
        }
    }
 
    ast_free(disp[0]);
    ast_free(disp[1]);
    unlink(file);
    rmdir(dir);
 
    return res;
}

References args, ARRAY_LEN, ast_free, ast_func_write(), ast_str_buffer(), ast_str_create, ast_str_substitute_variables(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, buf, contents, contents2, errno, make_ari_stubs::file, file2display(), sip_to_pjsip::info(), mkdtemp(), NULL, read_tests, TEST_EXECUTE, TEST_INIT, value, and write_tests.

◆ file2display()

static char * file2display	(	struct ast_str **	buf,
		ssize_t	len,
		const char *	input
	)

static

Definition at line 228 of file test_func_file.c.

{
    const char *ptr;
    ast_str_reset(*buf);
    for (ptr = input; *ptr; ptr++) {
        if (*ptr == '\n') {
            ast_str_append(buf, len, "\\n");
        } else if (*ptr == '\r') {
            ast_str_append(buf, len, "\\r");
        } else if (*ptr == '\t') {
            ast_str_append(buf, len, "\\t");
        } else if (*ptr < ' ' || *ptr > 125) {
            ast_str_append(buf, len, "\\x%hhX", *ptr);
        } else {
            ast_str_append(buf, len, "%c", *ptr);
        }
    }
    return ast_str_buffer(*buf);
}

References ast_str_append(), ast_str_buffer(), ast_str_reset(), buf, input(), and len().

Referenced by AST_TEST_DEFINE().

◆ load_module()

static int load_module ( void )

static

Definition at line 393 of file test_func_file.c.

{
    AST_TEST_REGISTER(test_func_file);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, and AST_TEST_REGISTER.

◆ unload_module()

static int unload_module ( void )

static

Definition at line 387 of file test_func_file.c.

{
    AST_TEST_UNREGISTER(test_func_file);
    return 0;
}

References AST_TEST_UNREGISTER.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "FILE() Tests" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 399 of file test_func_file.c.