test_capture.c File Reference

Make basic use of capture capability in test framework. More...

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

Include dependency graph for test_capture.c:

Go to the source code of this file.

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (test_capture_false)
	AST_TEST_DEFINE (test_capture_stdout_stderr)
	AST_TEST_DEFINE (test_capture_true)
	AST_TEST_DEFINE (test_capture_with_dynamic)
	AST_TEST_DEFINE (test_capture_with_stdin)
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 = "Capture support test" , .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

Detailed Description

Make basic use of capture capability in test framework.

Author

Philip Prindeville <philipp@redfish-solutions.com> 

Exercise the capture capabilities built into the test framework so that external commands might be used to generate validating results used on corroborating tests.

Definition in file test_capture.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 378 of file test_capture.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 378 of file test_capture.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 378 of file test_capture.c.

AST_TEST_DEFINE() [1/5]

AST_TEST_DEFINE

(

test_capture_false

)

Definition at line 101 of file test_capture.c.

{
    int status = AST_TEST_FAIL;
    struct ast_test_capture cap;
    const char *command = "false";
    char *const args[] = { "false", NULL };
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "test_capture_false";
        info->category = "/main/test_capture/";
        info->summary = "capture false exit unit test";
        info->description =
            "Capture exit code from false command.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_status_update(test, "Executing false exit test...\n");
 
    if (!ast_check_command_in_path(command)) {
        ast_test_status_update(test, "couldn't find %s\n", command);
        return status;
    }
 
    if (ast_test_capture_command(&cap, command, args, NULL, 0) != 1) {
        ast_test_status_update(test, "ast_test_capture_command() failed\n");
        return status;
    }
 
    if (cap.outlen != 0) {
        ast_test_status_update(test, "unexpected value for stdout\n");
        goto cleanup;
    }
 
    if (cap.errlen != 0) {
        ast_test_status_update(test, "unexpected value for stderr\n");
        goto cleanup;
    }
 
    if (cap.pid == -1) {
        ast_test_status_update(test, "invalid process id\n");
        goto cleanup;
    }
 
    if (cap.exitcode != 1) {
        ast_test_status_update(test, "child exited %d\n", cap.exitcode);
        goto cleanup;
    }
 
    status = AST_TEST_PASS;
 
cleanup:
    ast_test_capture_free(&cap);
 
    return status;
}

References args, ast_check_command_in_path(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, cleanup(), ast_test_capture::errlen, ast_test_capture::exitcode, sip_to_pjsip::info(), NULL, ast_test_capture::outlen, ast_test_capture::pid, status, TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [2/5]

AST_TEST_DEFINE

(

test_capture_stdout_stderr

)

Definition at line 299 of file test_capture.c.

{
    int status = AST_TEST_FAIL;
    struct ast_test_capture cap;
    const char *command = "sh";
    char *const args[] = { "sh", "-c", "echo -n 'foo' >&2 ; echo -n 'zzz' >&1 ; echo -n 'bar' >&2", NULL };
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "test_capture_stdout_stderr";
        info->category = "/main/test_capture/";
        info->summary = "capture stdout & stderr unit test";
        info->description =
            "Capture both stdout and stderr from shell.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_status_update(test, "Executing stdout/stderr test...\n");
 
    if (!ast_check_command_in_path(command)) {
        ast_test_status_update(test, "couldn't find %s\n", command);
        return status;
    }
 
    if (ast_test_capture_command(&cap, command, args, NULL, 0) != 1) {
        ast_test_status_update(test, "ast_test_capture_command() failed\n");
        return status;
    }
 
    if (cap.outlen != 3 || memcmp(cap.outbuf, "zzz", 3)) {
        ast_test_status_update(test, "unexpected value for stdout\n");
        goto cleanup;
    }
 
    if (cap.errlen != 6 || memcmp(cap.errbuf, "foobar", 6)) {
        ast_test_status_update(test, "unexpected value for stderr\n");
        goto cleanup;
    }
 
    if (cap.pid == -1) {
        ast_test_status_update(test, "invalid process id\n");
        goto cleanup;
    }
 
    if (cap.exitcode != 0) {
        ast_test_status_update(test, "child exited %d\n", cap.exitcode);
        goto cleanup;
    }
 
    status = AST_TEST_PASS;
 
cleanup:
    ast_test_capture_free(&cap);
 
    return status;
}

References args, ast_check_command_in_path(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, cleanup(), ast_test_capture::errbuf, ast_test_capture::errlen, ast_test_capture::exitcode, sip_to_pjsip::info(), NULL, ast_test_capture::outbuf, ast_test_capture::outlen, ast_test_capture::pid, status, TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [3/5]

AST_TEST_DEFINE

(

test_capture_true

)

Definition at line 42 of file test_capture.c.

{
    int status = AST_TEST_FAIL;
    struct ast_test_capture cap;
    const char *command = "true";
    char *const args[] = { "true", NULL };
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "test_capture_true";
        info->category = "/main/test_capture/";
        info->summary = "capture true exit unit test";
        info->description =
            "Capture exit code from true command.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_status_update(test, "Executing true exit test...\n");
 
    if (!ast_check_command_in_path(command)) {
        ast_test_status_update(test, "couldn't find %s\n", command);
        return status;
    }
 
    if (ast_test_capture_command(&cap, command, args, NULL, 0) != 1) {
        ast_test_status_update(test, "ast_test_capture_command() failed\n");
        return status;
    }
 
    if (cap.outlen != 0) {
        ast_test_status_update(test, "unexpected value for stdout\n");
        goto cleanup;
    }
 
    if (cap.errlen != 0) {
        ast_test_status_update(test, "unexpected value for stderr\n");
        goto cleanup;
    }
 
    if (cap.pid == -1) {
        ast_test_status_update(test, "invalid process id\n");
        goto cleanup;
    }
 
    if (cap.exitcode != 0) {
        ast_test_status_update(test, "child exited %d\n", cap.exitcode);
        goto cleanup;
    }
 
    status = AST_TEST_PASS;
 
cleanup:
    ast_test_capture_free(&cap);
 
    return status;
}

References args, ast_check_command_in_path(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, cleanup(), ast_test_capture::errlen, ast_test_capture::exitcode, sip_to_pjsip::info(), NULL, ast_test_capture::outlen, ast_test_capture::pid, status, TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [4/5]

AST_TEST_DEFINE

(

test_capture_with_dynamic

)

Definition at line 223 of file test_capture.c.

{
    int status = AST_TEST_FAIL;
    struct ast_test_capture cap;
    const char *command = "date";
    char *args[] = { "date", "DATE", "FORMAT", NULL };
    char date[40];
    const char format[] = "+%a, %d %b %y %T %z";
    const char format2[] = "%a, %d %b %y %T %z\n";
    char myresult[64];
    unsigned myresultlen;
    time_t now;
    struct tm *tm;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "test_capture_with_dynamic";
        info->category = "/main/test_capture/";
        info->summary = "capture with dynamic argument unit test";
        info->description =
            "Capture output from dynamic transformation command.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_status_update(test, "Executing dynamic argument test...\n");
 
    if (!ast_check_command_in_path(command)) {
        ast_test_status_update(test, "couldn't find %s\n", command);
        return status;
    }
 
    time(&now);
    snprintf(date, sizeof(date), "--date=@%lu", now);
 
    tm = localtime(&now);
    strftime(myresult, sizeof(myresult), format2, tm);
    myresultlen = strlen(myresult);
 
    args[1] = date;
    args[2] = (char *)format;
 
    if (ast_test_capture_command(&cap, command, args, NULL, 0) != 1) {
        ast_test_status_update(test, "ast_test_capture_command() failed\n");
        return status;
    }
 
    if (cap.outlen != myresultlen || memcmp(cap.outbuf, myresult, cap.outlen)) {
        ast_test_status_update(test, "unexpected value for stdout\n");
        goto cleanup;
    }
 
    if (cap.errlen != 0) {
        ast_test_status_update(test, "unexpected value for stderr\n");
        goto cleanup;
    }
 
    if (cap.pid == -1) {
        ast_test_status_update(test, "invalid process id\n");
        goto cleanup;
    }
 
    if (cap.exitcode != 0) {
        ast_test_status_update(test, "child exited %d\n", cap.exitcode);
        goto cleanup;
    }
 
    status = AST_TEST_PASS;
 
cleanup:
    ast_test_capture_free(&cap);
 
    return status;
}

References args, ast_check_command_in_path(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, cleanup(), ast_test_capture::errlen, ast_test_capture::exitcode, sip_to_pjsip::info(), NULL, ast_test_capture::outbuf, ast_test_capture::outlen, ast_test_capture::pid, status, TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [5/5]

AST_TEST_DEFINE

(

test_capture_with_stdin

)

Definition at line 160 of file test_capture.c.

{
    int status = AST_TEST_FAIL;
    struct ast_test_capture cap;
    const char *command = "base64";
    char *const args[] = { "base64", NULL };
    const char data[] = "Mary had a little lamb.";
    const unsigned datalen = sizeof(data) - 1;
    const char output[] = "TWFyeSBoYWQgYSBsaXR0bGUgbGFtYi4=\n";
    const unsigned outputlen = sizeof(output) - 1;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "test_capture_with_stdin";
        info->category = "/main/test_capture/";
        info->summary = "capture with stdin unit test";
        info->description =
            "Capture output from stdin transformation command.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_status_update(test, "Executing stdin test...\n");
 
    if (!ast_check_command_in_path(command)) {
        ast_test_status_update(test, "couldn't find %s\n", command);
        return status;
    }
 
    if (ast_test_capture_command(&cap, command, args, data, datalen) != 1) {
        ast_test_status_update(test, "ast_test_capture_command() failed\n");
        return status;
    }
 
    if (cap.outlen != outputlen || memcmp(cap.outbuf, output, cap.outlen)) {
        ast_test_status_update(test, "unexpected value for stdout\n");
        goto cleanup;
    }
 
    if (cap.errlen != 0) {
        ast_test_status_update(test, "unexpected value for stderr\n");
        goto cleanup;
    }
 
    if (cap.pid == -1) {
        ast_test_status_update(test, "invalid process id\n");
        goto cleanup;
    }
 
    if (cap.exitcode != 0) {
        ast_test_status_update(test, "child exited %d\n", cap.exitcode);
        goto cleanup;
    }
 
    status = AST_TEST_PASS;
 
cleanup:
    ast_test_capture_free(&cap);
 
    return status;
}

References args, ast_check_command_in_path(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, cleanup(), ast_test_capture::errlen, ast_test_capture::exitcode, sip_to_pjsip::info(), NULL, ast_test_capture::outbuf, ast_test_capture::outlen, ast_test_capture::pid, status, TEST_EXECUTE, and TEST_INIT.

load_module()

static int load_module ( void  )

static

Definition at line 368 of file test_capture.c.

{
    AST_TEST_REGISTER(test_capture_with_stdin);
    AST_TEST_REGISTER(test_capture_with_dynamic);
    AST_TEST_REGISTER(test_capture_stdout_stderr);
    AST_TEST_REGISTER(test_capture_true);
    AST_TEST_REGISTER(test_capture_false);
    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 358 of file test_capture.c.

{
    AST_TEST_UNREGISTER(test_capture_with_stdin);
    AST_TEST_UNREGISTER(test_capture_with_dynamic);
    AST_TEST_UNREGISTER(test_capture_stdout_stderr);
    AST_TEST_UNREGISTER(test_capture_true);
    AST_TEST_UNREGISTER(test_capture_false);
    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 = "Capture support test" , .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 378 of file test_capture.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 378 of file test_capture.c.