#include "asterisk.h"
#include "asterisk/test.h"
#include "asterisk/module.h"
#include "asterisk/file.h"
#include "asterisk/http_websocket.h"
#include "asterisk/json.h"
#include "asterisk/res_aeap.h"
#include "asterisk/res_aeap_message.h"

Include dependency graph for test_aeap.c:

Macros
#define	ADDR "127.0.0.1:8088"

#define	AEAP_CONNECTION_TIMEOUT 2000

#define	AEAP_MESSAGE_ID "foo"

#define	AEAP_REMOTE_PROTOCOL "echo"

#define	AEAP_REMOTE_URL "ws://" ADDR "/ws"

#define	AEAP_TRANSPORT_TYPE "ws"

#define	CATEGORY "/res/aeap/"

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

struct ast_module *	AST_MODULE_SELF_SYM (void)

	AST_TEST_DEFINE (create_and_connect)

	AST_TEST_DEFINE (send_msg_handle_request)

	AST_TEST_DEFINE (send_msg_handle_response)

	AST_TEST_DEFINE (send_msg_handle_string)

static int	handle_msg (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static void	handle_string (struct ast_aeap aeap, const char buf, intmax_t size)

static void	handle_timeout (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static int	load_module (void)

static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Asterisk External Application Protocol Object Tests" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_aeap", }

static const struct ast_module_info *	ast_module_info = &__mod_info

static const struct ast_aeap_message_handler	handlers []

static struct ast_http_server *	http_server

Macro Definition Documentation

◆ ADDR

#define ADDR "127.0.0.1:8088"

Definition at line 38 of file test_aeap.c.

◆ AEAP_CONNECTION_TIMEOUT

#define AEAP_CONNECTION_TIMEOUT 2000

Definition at line 43 of file test_aeap.c.

◆ AEAP_MESSAGE_ID

#define AEAP_MESSAGE_ID "foo"

Definition at line 42 of file test_aeap.c.

◆ AEAP_REMOTE_PROTOCOL

#define AEAP_REMOTE_PROTOCOL "echo"

Definition at line 41 of file test_aeap.c.

◆ AEAP_REMOTE_URL

#define AEAP_REMOTE_URL "ws://" ADDR "/ws"

Definition at line 40 of file test_aeap.c.

◆ AEAP_TRANSPORT_TYPE

#define AEAP_TRANSPORT_TYPE "ws"

Definition at line 39 of file test_aeap.c.

◆ CATEGORY

#define CATEGORY "/res/aeap/"

Definition at line 36 of file test_aeap.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 252 of file test_aeap.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 252 of file test_aeap.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 252 of file test_aeap.c.

◆ AST_TEST_DEFINE() [1/4]

AST_TEST_DEFINE ( create_and_connect )

Definition at line 45 of file test_aeap.c.

{
    RAII_VAR(struct ast_aeap *, aeap, NULL, ao2_cleanup);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->explicit_only = 0;
        info->category = CATEGORY;
        info->summary = "test creating and connecting to an AEAP application";
        info->description = info->summary;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    ast_test_validate(test, (aeap = ast_aeap_create_and_connect(AEAP_TRANSPORT_TYPE,
        NULL, AEAP_REMOTE_URL, AEAP_REMOTE_PROTOCOL, AEAP_CONNECTION_TIMEOUT)));
 
    return AST_TEST_PASS;
}

References AEAP_CONNECTION_TIMEOUT, AEAP_REMOTE_PROTOCOL, AEAP_REMOTE_URL, AEAP_TRANSPORT_TYPE, ao2_cleanup, ast_aeap_create_and_connect(), AST_TEST_NOT_RUN, AST_TEST_PASS, CATEGORY, NULL, RAII_VAR, TEST_EXECUTE, and TEST_INIT.

◆ AST_TEST_DEFINE() [2/4]

AST_TEST_DEFINE ( send_msg_handle_request )

Definition at line 179 of file test_aeap.c.

{
    int passed = 0;
    RAII_VAR(struct ast_aeap *, aeap, NULL, ao2_cleanup);
    char *name = "foo";
    struct ast_aeap_params aeap_params = {
        .request_handlers = handlers,
        .request_handlers_size = ARRAY_LEN(handlers),
    };
    struct ast_aeap_tsx_params tsx_params = {0};
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->explicit_only = 0;
        info->category = CATEGORY;
        info->summary = "test an AEAP application request handler";
        info->description = info->summary;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    aeap_params.msg_type = ast_aeap_message_type_json;
 
    tsx_params.timeout = 2000;
    tsx_params.wait = 1;
    tsx_params.obj = name;
 
    ast_test_validate(test, (aeap = ast_aeap_create_and_connect(AEAP_TRANSPORT_TYPE,
        &aeap_params, AEAP_REMOTE_URL, AEAP_REMOTE_PROTOCOL, AEAP_CONNECTION_TIMEOUT)));
    ast_test_validate(test, (!ast_aeap_user_data_register(aeap, AEAP_MESSAGE_ID, &passed, NULL)));
    ast_test_validate(test, (tsx_params.msg = ast_aeap_message_create_request(
        ast_aeap_message_type_json, name, AEAP_MESSAGE_ID, NULL)));
    ast_test_validate(test, !ast_aeap_send_msg_tsx(aeap, &tsx_params));
    ast_aeap_user_data_unregister(aeap, AEAP_MESSAGE_ID);
 
    return passed ? AST_TEST_PASS : AST_TEST_FAIL;
}

References AEAP_CONNECTION_TIMEOUT, AEAP_MESSAGE_ID, AEAP_REMOTE_PROTOCOL, AEAP_REMOTE_URL, AEAP_TRANSPORT_TYPE, ao2_cleanup, ARRAY_LEN, ast_aeap_create_and_connect(), ast_aeap_message_create_request(), ast_aeap_message_type_json, ast_aeap_send_msg_tsx(), ast_aeap_user_data_register(), ast_aeap_user_data_unregister(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, CATEGORY, handlers, ast_aeap_tsx_params::msg, ast_aeap_params::msg_type, name, NULL, ast_aeap_tsx_params::obj, RAII_VAR, ast_aeap_params::request_handlers, TEST_EXECUTE, TEST_INIT, ast_aeap_tsx_params::timeout, and ast_aeap_tsx_params::wait.

◆ AST_TEST_DEFINE() [3/4]

AST_TEST_DEFINE ( send_msg_handle_response )

Definition at line 139 of file test_aeap.c.

{
    int passed = 0;
    RAII_VAR(struct ast_aeap *, aeap, NULL, ao2_cleanup);
    char *name = "foo";
    struct ast_aeap_params aeap_params = {
        .response_handlers = handlers,
        .response_handlers_size = ARRAY_LEN(handlers),
    };
    struct ast_aeap_tsx_params tsx_params = {0};
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->explicit_only = 0;
        info->category = CATEGORY;
        info->summary = "test an AEAP application response handler";
        info->description = info->summary;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    aeap_params.msg_type = ast_aeap_message_type_json;
 
    tsx_params.timeout = 2000;
    tsx_params.wait = 1;
    tsx_params.obj = name;
 
    ast_test_validate(test, (aeap = ast_aeap_create_and_connect(AEAP_TRANSPORT_TYPE,
        &aeap_params, AEAP_REMOTE_URL, AEAP_REMOTE_PROTOCOL, AEAP_CONNECTION_TIMEOUT)));
    ast_test_validate(test, (!ast_aeap_user_data_register(aeap, AEAP_MESSAGE_ID, &passed, NULL)));
    ast_test_validate(test, (tsx_params.msg = ast_aeap_message_create_response(
        ast_aeap_message_type_json, name, AEAP_MESSAGE_ID, NULL)));
    ast_test_validate(test, !ast_aeap_send_msg_tsx(aeap, &tsx_params));
    ast_aeap_user_data_unregister(aeap, AEAP_MESSAGE_ID);
 
    return passed ? AST_TEST_PASS : AST_TEST_FAIL;
}

References AEAP_CONNECTION_TIMEOUT, AEAP_MESSAGE_ID, AEAP_REMOTE_PROTOCOL, AEAP_REMOTE_URL, AEAP_TRANSPORT_TYPE, ao2_cleanup, ARRAY_LEN, ast_aeap_create_and_connect(), ast_aeap_message_create_response(), ast_aeap_message_type_json, ast_aeap_send_msg_tsx(), ast_aeap_user_data_register(), ast_aeap_user_data_unregister(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, CATEGORY, handlers, ast_aeap_tsx_params::msg, ast_aeap_params::msg_type, name, NULL, ast_aeap_tsx_params::obj, RAII_VAR, ast_aeap_params::response_handlers, TEST_EXECUTE, TEST_INIT, ast_aeap_tsx_params::timeout, and ast_aeap_tsx_params::wait.

◆ AST_TEST_DEFINE() [4/4]

AST_TEST_DEFINE ( send_msg_handle_string )

Definition at line 83 of file test_aeap.c.

{
    int passed = 0;
    RAII_VAR(struct ast_aeap *, aeap, NULL, ao2_cleanup);
    struct ast_aeap_tsx_params tsx_params = {0};
    struct ast_aeap_params aeap_params = {
        .on_string = handle_string,
    };
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->explicit_only = 0;
        info->category = CATEGORY;
        info->summary = "test an AEAP application string handler";
        info->description = info->summary;
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    tsx_params.timeout = 2000; /* Test will end by timing out */
    tsx_params.on_timeout = handle_timeout;
    tsx_params.wait = 1;
 
    ast_test_validate(test, (aeap = ast_aeap_create_and_connect(AEAP_TRANSPORT_TYPE,
        &aeap_params, AEAP_REMOTE_URL, AEAP_REMOTE_PROTOCOL, AEAP_CONNECTION_TIMEOUT)));
 
    ast_test_validate(test, (!ast_aeap_user_data_register(aeap, AEAP_MESSAGE_ID, &passed, NULL)));
    ast_test_validate(test, (tsx_params.msg = ast_aeap_message_create_request(
        ast_aeap_message_type_json, "foo", AEAP_MESSAGE_ID, NULL)));
    ast_test_validate(test, ast_aeap_send_msg_tsx(aeap, &tsx_params)); /* Returns fail on timeout */
    ast_aeap_user_data_unregister(aeap, AEAP_MESSAGE_ID);
 
    return passed == 2 ? AST_TEST_PASS : AST_TEST_FAIL;
}

References AEAP_CONNECTION_TIMEOUT, AEAP_MESSAGE_ID, AEAP_REMOTE_PROTOCOL, AEAP_REMOTE_URL, AEAP_TRANSPORT_TYPE, ao2_cleanup, ast_aeap_create_and_connect(), ast_aeap_message_create_request(), ast_aeap_message_type_json, ast_aeap_send_msg_tsx(), ast_aeap_user_data_register(), ast_aeap_user_data_unregister(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, CATEGORY, handle_string(), handle_timeout(), ast_aeap_tsx_params::msg, NULL, ast_aeap_params::on_string, ast_aeap_tsx_params::on_timeout, RAII_VAR, TEST_EXECUTE, TEST_INIT, ast_aeap_tsx_params::timeout, and ast_aeap_tsx_params::wait.

◆ handle_msg()

static int handle_msg	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 120 of file test_aeap.c.

{
    int *passed = ast_aeap_user_data_object_by_id(aeap, AEAP_MESSAGE_ID);
 
    *passed = !strcmp(ast_aeap_message_id(message), AEAP_MESSAGE_ID) &&
        ast_aeap_message_is_named(message, data);
 
    if (!*passed) {
        ast_log(LOG_ERROR, "Name '%s' did not equal '%s' for message '%s'",
            ast_aeap_message_name(message), (char *)data, ast_aeap_message_id(message));
    }
 
    return 0;
}

References AEAP_MESSAGE_ID, ast_aeap_message_id(), ast_aeap_message_is_named(), ast_aeap_message_name(), ast_aeap_user_data_object_by_id(), ast_log, and LOG_ERROR.

◆ handle_string()

static void handle_string	(	struct ast_aeap *	aeap,
		const char *	buf,
		intmax_t	size
	)

static

Definition at line 67 of file test_aeap.c.

{
    int *passed = ast_aeap_user_data_object_by_id(aeap, AEAP_MESSAGE_ID);
 
    if (strstr(buf, AEAP_MESSAGE_ID)) {
        ++*passed;
    }
}

References AEAP_MESSAGE_ID, ast_aeap_user_data_object_by_id(), and buf.

Referenced by AST_TEST_DEFINE().

◆ handle_timeout()

static void handle_timeout	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 76 of file test_aeap.c.

{
    int *passed = ast_aeap_user_data_object_by_id(aeap, AEAP_MESSAGE_ID);
 
    ++*passed;
}

References AEAP_MESSAGE_ID, and ast_aeap_user_data_object_by_id().

Referenced by AST_TEST_DEFINE().

◆ load_module()

static int load_module ( void )

static

Definition at line 221 of file test_aeap.c.

{
    if (!(http_server = ast_http_test_server_get("aeap transport http server", NULL))) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    AST_TEST_REGISTER(create_and_connect);
    AST_TEST_REGISTER(send_msg_handle_string);
    AST_TEST_REGISTER(send_msg_handle_response);
    AST_TEST_REGISTER(send_msg_handle_request);
 
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_TEST_REGISTER, http_server, and NULL.

◆ unload_module()

static int unload_module ( void )

static

Definition at line 235 of file test_aeap.c.

{
    AST_TEST_UNREGISTER(send_msg_handle_request);
    AST_TEST_UNREGISTER(send_msg_handle_response);
    AST_TEST_UNREGISTER(send_msg_handle_string);
    AST_TEST_UNREGISTER(create_and_connect);
 
    ast_http_test_server_discard(http_server);
 
    return 0;
}

References AST_TEST_UNREGISTER, and http_server.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Asterisk External Application Protocol Object Tests" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_aeap", }

static

Definition at line 252 of file test_aeap.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 252 of file test_aeap.c.

◆ handlers

const struct ast_aeap_message_handler handlers[]

static

Initial value:

= {
    { "foo", handle_msg },
}

Definition at line 135 of file test_aeap.c.

                                                          {
    { "foo", handle_msg },
};

Referenced by ast_pbx_hangup_handler_destroy(), ast_pbx_hangup_handler_init(), ast_pbx_hangup_handler_pop(), ast_pbx_hangup_handler_push(), ast_pbx_hangup_handler_run(), ast_pbx_hangup_handler_show(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), channel_do_masquerade(), and raise_msg_handler().

◆ http_server

struct ast_http_server* http_server

static

Definition at line 219 of file test_aeap.c.

Referenced by load_module(), and unload_module().

Macros

Functions

Variables

Macro Definition Documentation

◆ ADDR

◆ AEAP_CONNECTION_TIMEOUT

◆ AEAP_MESSAGE_ID

◆ AEAP_REMOTE_PROTOCOL

◆ AEAP_REMOTE_URL

◆ AEAP_TRANSPORT_TYPE

◆ CATEGORY

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ AST_MODULE_SELF_SYM()

◆ AST_TEST_DEFINE() [1/4]

◆ AST_TEST_DEFINE() [2/4]

◆ AST_TEST_DEFINE() [3/4]

◆ AST_TEST_DEFINE() [4/4]

◆ handle_msg()

◆ handle_string()

◆ handle_timeout()

◆ load_module()

◆ unload_module()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ handlers

◆ http_server