test_amihooks.c File Reference

Test AMI hook. More...

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

Include dependency graph for test_amihooks.c:

Go to the source code of this file.

Macros
#define	CATEGORY   "/main/amihooks/"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	amihook_helper (int category, const char *event, char *content)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (amihook_cli_send)
static char *	handle_cli_amihook_register_hook (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_cli_amihook_send (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_cli_amihook_unregister_hook (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	hook_send (void)
static int	load_module (void)
static void	register_hook (void)
static int	unload_module (void)
static void	unregister_hook (void)
static int	wait_for_hook (struct ast_test *test)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "AMI Hook Test Module" , .key = ASTERISK_GPL_KEY , .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
static struct ast_cli_entry	cli_amihook_evt []
int	done
ast_cond_t	hook_cond
static ast_mutex_t	hook_lock = AST_MUTEX_INIT_VALUE
static struct manager_custom_hook	test_hook

Detailed Description

Test AMI hook.

Author

David Brooks dbroo.nosp@m.ks@d.nosp@m.igium.nosp@m..com based off of code written by Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

This started, and continues to serves, as an example illustrating the ability for a custom module to hook into AMI. Registration for AMI events and sending of AMI actions is shown. A test has also been created that utilizes the original example in order to make sure the ami event hook gets raised.

Definition in file test_amihooks.c.

Macro Definition Documentation

CATEGORY

#define CATEGORY   "/main/amihooks/"

Definition at line 44 of file test_amihooks.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 218 of file test_amihooks.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 218 of file test_amihooks.c.

amihook_helper()

static int amihook_helper ( int  category, const char *  event, char *  content  )

static

Definition at line 95 of file test_amihooks.c.

{
    ast_log(LOG_NOTICE, "AMI Event: \nCategory: %d Event: %s\n%s\n", category, event, content);
 
    ast_mutex_lock(&hook_lock);
    done = 1;
    ast_cond_signal(&hook_cond);
    ast_mutex_unlock(&hook_lock);
    return 0;
}

References ast_cond_signal, ast_log, ast_mutex_lock, ast_mutex_unlock, done, hook_cond, hook_lock, and LOG_NOTICE.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 218 of file test_amihooks.c.

AST_TEST_DEFINE()

AST_TEST_DEFINE

(

amihook_cli_send

)

Definition at line 72 of file test_amihooks.c.

{
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = CATEGORY;
        info->summary = "Execute an action using an AMI hook";
        info->description = info->summary;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    done = 0;
    if (ast_cli_command(-1, "amihook send")) {
        return AST_TEST_FAIL;
    }
 
    return wait_for_hook(test) ? AST_TEST_FAIL : AST_TEST_PASS;
}

References ast_cli_command, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, CATEGORY, done, TEST_EXECUTE, TEST_INIT, and wait_for_hook().

handle_cli_amihook_register_hook()

static char * handle_cli_amihook_register_hook ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 156 of file test_amihooks.c.

{
    switch (cmd) {
    case CLI_INIT:
        e->command = "amihook register";
        e->usage = ""
            "Usage: amihook register"
            "";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    case CLI_HANDLER:
        register_hook();
        return CLI_SUCCESS;
    }
 
    return CLI_FAILURE;
}

References CLI_FAILURE, CLI_GENERATE, CLI_HANDLER, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, NULL, register_hook(), and ast_cli_entry::usage.

handle_cli_amihook_send()

static char * handle_cli_amihook_send ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 137 of file test_amihooks.c.

{
    switch (cmd) {
    case CLI_INIT:
        e->command = "amihook send";
        e->usage = ""
            "Usage: amihook send"
            "";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    case CLI_HANDLER:
        hook_send();
        return CLI_SUCCESS;
    }
 
    return CLI_FAILURE;
}

References CLI_FAILURE, CLI_GENERATE, CLI_HANDLER, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, hook_send(), NULL, and ast_cli_entry::usage.

handle_cli_amihook_unregister_hook()

static char * handle_cli_amihook_unregister_hook ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 175 of file test_amihooks.c.

{
    switch (cmd) {
    case CLI_INIT:
        e->command = "amihook unregister";
        e->usage = ""
            "Usage: amihook unregister"
            "";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    case CLI_HANDLER:
        unregister_hook();
        return CLI_SUCCESS;
    }
 
    return CLI_FAILURE;
}

References CLI_FAILURE, CLI_GENERATE, CLI_HANDLER, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, NULL, unregister_hook(), and ast_cli_entry::usage.

hook_send()

static int hook_send ( void  )

static

Definition at line 111 of file test_amihooks.c.

                           {
    int res;
 
    /* Send a test action (core show version) to the AMI */
    res = ast_hook_send_action(&test_hook, "Action: Command\nCommand: core show version\nActionID: 987654321\n");
 
    return res;
}

References ast_hook_send_action(), and test_hook.

Referenced by handle_cli_amihook_send().

load_module()

static int load_module ( void  )

static

Definition at line 207 of file test_amihooks.c.

{
    int res;
 
    res = ast_cli_register_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
 
    AST_TEST_REGISTER(amihook_cli_send);
 
    return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_TEST_REGISTER, and cli_amihook_evt.

register_hook()

static void register_hook ( void  )

static

Definition at line 120 of file test_amihooks.c.

                                {
 
    /* Unregister the hook, we don't want a double-registration (Bad Things(tm) happen) */
    ast_manager_unregister_hook(&test_hook);
 
    /* Register the hook for AMI events */
    ast_manager_register_hook(&test_hook);
 
}

References ast_manager_register_hook(), ast_manager_unregister_hook(), and test_hook.

Referenced by handle_cli_amihook_register_hook().

unload_module()

static int unload_module ( void  )

static

Definition at line 200 of file test_amihooks.c.

{
    AST_TEST_UNREGISTER(amihook_cli_send);
    ast_manager_unregister_hook(&test_hook);
    return ast_cli_unregister_multiple(cli_amihook_evt, ARRAY_LEN(cli_amihook_evt));
}

References ARRAY_LEN, ast_cli_unregister_multiple(), ast_manager_unregister_hook(), AST_TEST_UNREGISTER, cli_amihook_evt, and test_hook.

unregister_hook()

static void unregister_hook ( void  )

static

Definition at line 130 of file test_amihooks.c.

                                  {
 
    /* Unregister the hook */
    ast_manager_unregister_hook(&test_hook);
 
}

References ast_manager_unregister_hook(), and test_hook.

Referenced by handle_cli_amihook_unregister_hook().

wait_for_hook()

static int wait_for_hook ( struct ast_test *  test )

static

Definition at line 50 of file test_amihooks.c.

{
    struct timeval start = ast_tvnow();
    struct timespec timeout = {
        .tv_sec = start.tv_sec + 2,
        .tv_nsec = start.tv_usec * 1000
    };
    int res = 0;
 
    ast_mutex_lock(&hook_lock);
    while (!done) {
        if (ast_cond_timedwait(&hook_cond, &hook_lock, &timeout) == ETIMEDOUT) {
            ast_test_status_update(test, "Test timed out while waiting for hook event\n");
            res = -1;
            break;
        }
    }
    ast_mutex_unlock(&hook_lock);
 
    return res;
}

References ast_cond_timedwait, ast_mutex_lock, ast_mutex_unlock, ast_test_status_update, ast_tvnow(), done, hook_cond, and hook_lock.

Referenced by AST_TEST_DEFINE().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "AMI Hook Test Module" , .key = ASTERISK_GPL_KEY , .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 218 of file test_amihooks.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 218 of file test_amihooks.c.

cli_amihook_evt

struct ast_cli_entry cli_amihook_evt[]

static

Initial value:

= {
    { .handler =  handle_cli_amihook_send , .summary =  "Send an AMI event" ,},
    { .handler =  handle_cli_amihook_register_hook , .summary =  "Register module for AMI hook" ,},
    { .handler =  handle_cli_amihook_unregister_hook , .summary =  "Unregister module for AMI hook" ,},
}

Definition at line 194 of file test_amihooks.c.

                                                {
    AST_CLI_DEFINE(handle_cli_amihook_send, "Send an AMI event"),
    AST_CLI_DEFINE(handle_cli_amihook_register_hook, "Register module for AMI hook"),
    AST_CLI_DEFINE(handle_cli_amihook_unregister_hook, "Unregister module for AMI hook"),
};

Referenced by load_module(), and unload_module().

done

int done

Definition at line 48 of file test_amihooks.c.

Referenced by __ast_answer(), __ast_cli_register(), __ast_read(), __ast_sorcery_wizard_register(), amihook_helper(), anonymous_identify(), app_exec(), ast_cli_command_full(), ast_dsp_process(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), ast_write_stream(), ast_xmpp_chatroom_invite(), bridge_exec(), bridge_stasis_push_peek(), close_mailbox(), dial_exec_full(), dial_trunk(), dictate_exec(), filter_cmp_fn(), forward_message(), httpd_helper_thread(), iax2_indicate(), load_modules(), loader_config_init(), make_channel(), message_range_and_existence_check(), native_rtp_bridge_start(), pbx_builtin_background(), playback_exec(), read_test(), retrydial_exec(), session_do(), sla_stop_ringing_station(), sms_exec(), speech_background(), tds_log(), tds_log(), wait_for_hook(), xmpp_client_set_group_presence(), xmpp_client_set_presence(), xmpp_client_unsubscribe_user(), xmpp_component_register_get_hook(), xmpp_component_register_set_hook(), xmpp_component_service_discovery_get_hook(), and xmpp_component_service_discovery_items_hook().

hook_cond

ast_cond_t hook_cond

Definition at line 47 of file test_amihooks.c.

Referenced by amihook_helper(), and wait_for_hook().

hook_lock

ast_mutex_t hook_lock = AST_MUTEX_INIT_VALUE

static

Definition at line 46 of file test_amihooks.c.

Referenced by amihook_helper(), and wait_for_hook().

test_hook

struct manager_custom_hook test_hook

static

Initial value:

= {
    .file = __FILE__,
    .helper = &amihook_helper,
}

Definition at line 106 of file test_amihooks.c.

                                              {
    .file = __FILE__,
    .helper = &amihook_helper,
};

Referenced by hook_send(), register_hook(), unload_module(), and unregister_hook().