test_skel.c File Reference

Skeleton Test. More...

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

Include dependency graph for test_skel.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 (sample_test)
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 = "Skeleton (sample) 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

Skeleton Test.

Author

<Your Name Here> <<Your Email Here>> 

This is a skeleton for development of an Asterisk test module

Definition in file test_skel.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 140 of file test_skel.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 140 of file test_skel.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 140 of file test_skel.c.

AST_TEST_DEFINE()

AST_TEST_DEFINE

(

sample_test

)

Definition at line 40 of file test_skel.c.

{
    /* Retrieve the command line arguments used to invoke the test */
    struct ast_cli_args *cli_args = ast_test_get_cli_args(test);
    /* Set default values for the options */
    int test_option = 999;
    char test_option2[128] = { 0 };
    void *ptr = NULL;
    void *ptr2 = NULL;
    int i;
    enum ast_test_result_state rc = AST_TEST_PASS;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = "sample_test";
        info->category = "/main/sample/";
        info->summary = "sample unit test";
        info->description =
            "This demonstrates what is required to implement "
            "a unit test.  You can pass in test-option and "
            "test-option2 as command line arguments to this "
            "test.  test-option is an integer and test-option2 "
            "is a string.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    /*
     * This is an example of how to get command line arguments
     * from the test framework.  The arguments are "test-option"
     * (expected to be an integer) and "test-option2" (expected
     * to be a string).
     *
     * NOTES:
     *
     * cli_args will contain all of the command line arguments
     * including "test execute", etc. so the location of the options
     * will vary depending on how the test was invoked.
     * For instance, this test could be run by either of the following:
     *
     * test execute category /main/sample/ options test-option=444
     * test execute category /main/sample/ name sample_test options test-option=444
     *
     * You therefore need to test each of the items in the argv array
     * to find the ones you are looking for.
     *
     * No special processing is done on string arguments so if your
     * option value is a string, you must deal with the possibility
     * of embedded spaces yourself.
     */
 
    for (i = 0; i < cli_args->argc; i++) {
        ast_test_status_update(test, "Test argument: %d: %s\n", i, cli_args->argv[i]);
        if (ast_begins_with(cli_args->argv[i], "test-option=")) {
            sscanf(cli_args->argv[i], "test-option=%d", &test_option);
        }
        if (ast_begins_with(cli_args->argv[i], "test-option2=")) {
            sscanf(cli_args->argv[i], "test-option2=%s", test_option2);
        }
    }
 
    ast_test_status_update(test, "Executing sample test with test-option=%d and test-option2=%s\n",
        test_option, test_option2);
 
    if (!(ptr = ast_malloc(8))) {
        ast_test_status_update(test, "ast_malloc() failed\n");
        return AST_TEST_FAIL;
    }
 
    ptr2 = ast_malloc(8);
    /*
     * This is an example of how to use the ast_test_validate_cleanup_custom
     * macro to check a condition and cleanup if it fails.
     * If ptr2 is NULL, rc will be set to AST_TEST_FAIL, the specified
     * message will be printed, and the test will jump to the "done"
     * label to perform cleanup.
     */
    ast_test_validate_cleanup_custom(test, ptr2, rc, done, "ptr2 is NULL\n");
 
done:
 
    ast_free(ptr);
    ast_free(ptr2);
 
    return rc;
}

References ast_cli_args::argc, ast_cli_args::argv, ast_begins_with(), ast_free, ast_malloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, done, sip_to_pjsip::info(), NULL, TEST_EXECUTE, and TEST_INIT.

load_module()

static int load_module ( void  )

static

Definition at line 134 of file test_skel.c.

{
    AST_TEST_REGISTER(sample_test);
    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 128 of file test_skel.c.

{
    AST_TEST_UNREGISTER(sample_test);
    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 = "Skeleton (sample) 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 140 of file test_skel.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 140 of file test_skel.c.