test_ari.c File Reference

Test ARI API.

Author

David M. Lee, II <dlee@digium.com> 

.

More...

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

Include dependency graph for test_ari.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 (get_docs)
	AST_TEST_DEFINE (get_docs_hackerz)
	AST_TEST_DEFINE (get_docs_nohost)
	AST_TEST_DEFINE (get_docs_notfound)
	AST_TEST_DEFINE (invoke_bad_post)
	AST_TEST_DEFINE (invoke_delete)
	AST_TEST_DEFINE (invoke_delete_forbidden)
	AST_TEST_DEFINE (invoke_get)
	AST_TEST_DEFINE (invoke_no_user)
	AST_TEST_DEFINE (invoke_not_found)
	AST_TEST_DEFINE (invoke_post)
	AST_TEST_DEFINE (invoke_wildcard)
static enum ast_test_result_state	invoke_delete_common (struct ast_test_info *info, enum ast_test_command cmd, struct ast_test *test, const char *creds, int expect_pass, int expect_rc)
static int	load_module (void)
static struct ast_ari_response *	response_alloc (void)
static void	response_free (struct ast_ari_response *resp)
static void *	setup_invocation_test (void)
static void	tear_down_invocation_test (void *ignore)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "ARI testing" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_ari", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct stasis_rest_handlers	bam
static struct stasis_rest_handlers	bang
static struct stasis_rest_handlers	bar
static void	handler (const char *name, int response_code, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
#define	HANDLER(name, response_code)
static int	invocation_count
static struct stasis_rest_handlers	test_root

Detailed Description

Test ARI API.

Author

David M. Lee, II <dlee@digium.com> 

.

Definition in file test_ari.c.

Macro Definition Documentation

HANDLER

#define HANDLER	(		name,
			response_code
	)

Definition at line 97 of file test_ari.c.

    {                               \
        handler(#name, response_code, get_params, path_vars, headers, body, response); \
    }

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 661 of file test_ari.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 661 of file test_ari.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 661 of file test_ari.c.

AST_TEST_DEFINE() [1/12]

AST_TEST_DEFINE

(

get_docs

)

Definition at line 201 of file test_ari.c.

{
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    RAII_VAR(struct ast_variable *, headers, NULL, ast_variables_destroy);
    struct ast_json *basePathJson;
    const char *basePath;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test simple API get.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    response = response_alloc();
    headers = ast_variable_new("Host", "stasis.asterisk.org", __FILE__);
    ast_ari_get_docs("resources.json", "", headers, response);
    ast_test_validate(test, 200 == response->response_code);
 
    /* basePath should be relative to the Host header */
    basePathJson = ast_json_object_get(response->message, "basePath");
    ast_test_validate(test, NULL != basePathJson);
    basePath = ast_json_string_get(basePathJson);
    ast_test_validate(test, 0 == strcmp("http://stasis.asterisk.org/ari", basePath));
 
    return AST_TEST_PASS;
}

References ast_ari_get_docs(), ast_json_object_get(), ast_json_string_get(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_new, ast_variables_destroy(), ast_ari_response::headers, NULL, RAII_VAR, response_alloc(), response_free(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [2/12]

AST_TEST_DEFINE

(

get_docs_hackerz

)

Definition at line 284 of file test_ari.c.

{
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test API get for a file outside the rest-api path";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    response = response_alloc();
    ast_ari_get_docs("../../../../sbin/asterisk", "", headers, response);
    ast_test_validate(test, 404 == response->response_code);
 
    return AST_TEST_PASS;
}

References ast_ari_get_docs(), AST_TEST_NOT_RUN, AST_TEST_PASS, NULL, RAII_VAR, response_alloc(), response_free(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [3/12]

AST_TEST_DEFINE

(

get_docs_nohost

)

Definition at line 233 of file test_ari.c.

{
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *headers = NULL;
    struct ast_json *basePathJson;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test API get without a Host header";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    response = response_alloc();
    ast_ari_get_docs("resources.json",  "", headers, response);
    ast_test_validate(test, 200 == response->response_code);
 
    /* basePath should be relative to the Host header */
    basePathJson = ast_json_object_get(response->message, "basePath");
    ast_test_validate(test, NULL == basePathJson);
 
    return AST_TEST_PASS;
}

References ast_ari_get_docs(), ast_json_object_get(), AST_TEST_NOT_RUN, AST_TEST_PASS, NULL, RAII_VAR, response_alloc(), response_free(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [4/12]

AST_TEST_DEFINE

(

get_docs_notfound

)

Definition at line 261 of file test_ari.c.

{
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test API get for invalid resource";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    response = response_alloc();
    ast_ari_get_docs("i-am-not-a-resource.json", "", headers, response);
    ast_test_validate(test, 404 == response->response_code);
 
    return AST_TEST_PASS;
}

References ast_ari_get_docs(), AST_TEST_NOT_RUN, AST_TEST_PASS, NULL, RAII_VAR, response_alloc(), response_free(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [5/12]

AST_TEST_DEFINE

(

invoke_bad_post

)

Definition at line 525 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test POST on a resource that doesn't support it.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
 
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", "aritest:aritestpw", __FILE__));
    ast_assert(tail != NULL);
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo", AST_HTTP_POST, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 0 == invocation_count);
    ast_test_validate(test, 405 == response->response_code);
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_POST, ast_json_null(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [6/12]

AST_TEST_DEFINE

(

invoke_delete

)

Definition at line 438 of file test_ari.c.

{
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test DELETE of an HTTP resource.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    return invoke_delete_common(info, cmd, test, "aritest:aritestpw", 1, 204);
}

References AST_TEST_NOT_RUN, invoke_delete_common(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [7/12]

AST_TEST_DEFINE

(

invoke_delete_forbidden

)

Definition at line 454 of file test_ari.c.

{
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test forbidden DELETE of an HTTP resource.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    return invoke_delete_common(info, cmd, test, "aritestro:aritestropw", 0, 403);
}

References AST_TEST_NOT_RUN, invoke_delete_common(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [8/12]

AST_TEST_DEFINE

(

invoke_get

)

Definition at line 307 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    RAII_VAR(struct ast_variable *, headers, NULL, ast_variables_destroy);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test simple GET of an HTTP resource.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("get1", "get-one", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("get2", "get-two", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", "aritestro:aritestropw", __FILE__));
    ast_assert(tail != NULL);
 
    tail = ast_variable_list_append_hint(&headers, NULL, ast_variable_new("head1", "head-one", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&headers, NULL, ast_variable_new("head2", "head-two", __FILE__));
    ast_assert(tail != NULL);
 
    expected = ast_json_pack("{s: s, s: {s: s, s: s, s: s}, s: {s: s, s: s}, s: {}}",
                 "name", "foo_get",
                 "get_params",
                 "get1", "get-one",
                 "get2", "get-two",
                 "api_key", "aritestro:aritestropw",
                 "headers",
                 "head1", "head-one",
                 "head2", "head-two",
                 "path_vars");
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo", AST_HTTP_GET, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 1 == invocation_count);
    ast_test_validate(test, 200 == response->response_code);
    ast_test_validate(test, ast_json_equal(expected, response->message));
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_GET, ast_json_equal(), ast_json_null(), ast_json_pack(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [9/12]

AST_TEST_DEFINE

(

invoke_no_user

)

Definition at line 559 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *get_params = NULL;
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test POST on a resource that doesn't support it.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo", AST_HTTP_POST, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 0 == invocation_count);
    ast_test_validate(test, 401 == response->response_code);
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), AST_HTTP_POST, ast_json_null(), AST_TEST_NOT_RUN, AST_TEST_PASS, invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [10/12]

AST_TEST_DEFINE

(

invoke_not_found

)

Definition at line 588 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test GET on a resource that does not exist.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
 
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", "aritest:aritestpw", __FILE__));
    ast_assert(tail != NULL);
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo/fizzle/i-am-not-a-resource", AST_HTTP_GET, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 0 == invocation_count);
    ast_test_validate(test, 404 == response->response_code);
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_GET, ast_json_null(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [11/12]

AST_TEST_DEFINE

(

invoke_post

)

Definition at line 470 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    RAII_VAR(struct ast_variable *, headers, NULL, ast_variables_destroy);
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test POST of an HTTP resource.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("get1", "get-one", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("get2", "get-two", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", "aritest:aritestpw", __FILE__));
    ast_assert(tail != NULL);
 
    tail = ast_variable_list_append_hint(&headers, NULL, ast_variable_new("head1", "head-one", __FILE__));
    ast_assert(tail != NULL);
    tail = ast_variable_list_append_hint(&headers, NULL, ast_variable_new("head2", "head-two", __FILE__));
    ast_assert(tail != NULL);
 
    expected = ast_json_pack("{s: s, s: {s: s, s: s, s: s}, s: {s: s, s: s}, s: {}}",
                 "name", "bar_post",
                 "get_params",
                 "get1", "get-one",
                 "get2", "get-two",
                 "api_key", "aritest:aritestpw",
                 "headers",
                 "head1", "head-one",
                 "head2", "head-two",
                 "path_vars");
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo/bar", AST_HTTP_POST, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 1 == invocation_count);
    ast_test_validate(test, 200 == response->response_code);
    ast_test_validate(test, ast_json_equal(expected, response->message));
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_POST, ast_json_equal(), ast_json_null(), ast_json_pack(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

AST_TEST_DEFINE() [12/12]

AST_TEST_DEFINE

(

invoke_wildcard

)

Definition at line 362 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    struct ast_variable *headers = NULL;
 
    switch (cmd) {
    case TEST_INIT:
        info->name = __func__;
        info->category = "/res/ari/";
        info->summary = "Test GET of a wildcard resource.";
        info->description = "Test ARI binding logic.";
        return AST_TEST_NOT_RUN;
    case TEST_EXECUTE:
        break;
    }
 
    fixture = setup_invocation_test();
    response = response_alloc();
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", "aritestro:aritestropw", __FILE__));
    ast_assert(tail != NULL);
 
    expected = ast_json_pack("{s: s, s: {s: s}, s: {}, s: {s: s}}",
                 "name", "bam_get",
                 "get_params",
                 "api_key", "aritestro:aritestropw",
                 "headers",
                 "path_vars",
                 "bam", "foshizzle");
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo/foshizzle", AST_HTTP_GET, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, 1 == invocation_count);
    ast_test_validate(test, 200 == response->response_code);
    ast_test_validate(test, ast_json_equal(expected, response->message));
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_GET, ast_json_equal(), ast_json_null(), ast_json_pack(), ast_json_unref(), AST_TEST_NOT_RUN, AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), tear_down_invocation_test(), TEST_EXECUTE, and TEST_INIT.

handler()

static void handler ( const char *  name, int  response_code, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Definition at line 59 of file test_ari.c.

{
    struct ast_json *message = ast_json_pack("{s: s, s: {}, s: {}, s: {}}",
                         "name", name,
                         "get_params",
                         "path_vars",
                         "headers");
    struct ast_json *get_params_obj = ast_json_object_get(message, "get_params");
    struct ast_json *path_vars_obj = ast_json_object_get(message, "path_vars");
    struct ast_json *headers_obj = ast_json_object_get(message, "headers");
 
    for (; get_params != NULL; get_params = get_params->next) {
        ast_json_object_set(get_params_obj, get_params->name, ast_json_string_create(get_params->value));
    }
 
    for (; path_vars != NULL; path_vars = path_vars->next) {
        ast_json_object_set(path_vars_obj, path_vars->name, ast_json_string_create(path_vars->value));
    }
 
    for (; headers != NULL; headers = headers->next) {
        ast_json_object_set(headers_obj, headers->name, ast_json_string_create(headers->value));
    }
 
    ++invocation_count;
    response->response_code = response_code;
    response->message = message;
}

References ast_json_object_get(), ast_json_object_set(), ast_json_pack(), ast_json_string_create(), invocation_count, ast_ari_response::message, name, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

Referenced by __aco_option_register(), __stasis_app_register(), add_allow_header(), add_sdp_streams(), allocate_subscription(), app_create(), app_handle_subscriptions(), app_send(), app_update(), ast_ari_add_handler(), ast_ari_invoke(), ast_ari_remove_handler(), ast_msg_handler_register(), ast_msg_handler_unregister(), ast_msg_has_destination(), ast_mwi_state_callback_all(), ast_mwi_state_callback_subscribed(), ast_pbx_hangup_handler_push(), ast_sip_create_subscription(), ast_sip_register_event_publisher_handler(), ast_sip_register_publish_handler(), ast_sip_register_subscription_handler(), ast_sip_session_register_sdp_handler(), ast_sip_session_unregister_sdp_handler(), ast_sip_unregister_event_publisher_handler(), ast_sip_unregister_publish_handler(), ast_sip_unregister_subscription_handler(), build_node_children(), build_resource_tree(), channel_hangup_handler_cb(), create_subscription_tree(), create_virtual_subscriptions(), handle_conf_user_join(), handle_conf_user_leave(), handle_debug_or_trace(), handle_incoming_sdp(), handle_negotiated_sdp_session_media(), handle_options(), handle_stasis_state(), msg_q_cb(), publish_add_handler(), publish_hangup_handler_message(), publish_request_initial(), pubsub_on_rx_publish_request(), pubsub_on_rx_subscribe_request(), remove_handler(), root_handler_create(), sdp_requires_deferral(), session_media_set_handler(), session_outgoing_nat_hook(), sip_outbound_publish_synchronize(), stasis_app_register(), stasis_app_register_all(), stasis_state_callback_all(), stasis_state_callback_subscribed(), status_debug_verbose(), stop_publishing(), stream_destroy(), sub_add_handler(), sub_add_handler(), sub_persistence_recreate(), subscription_get_generator_from_rdata(), subscription_get_handler_from_rdata(), and xmpp_action_hook().

invoke_delete_common()

static enum ast_test_result_state invoke_delete_common ( struct ast_test_info *  info, enum ast_test_command  cmd, struct ast_test *  test, const char *  creds, int  expect_pass, int  expect_rc  )

static

Definition at line 405 of file test_ari.c.

{
    RAII_VAR(void *, fixture, NULL, tear_down_invocation_test);
    RAII_VAR(struct ast_ari_response *, response, NULL, response_free);
    RAII_VAR(struct ast_json *, expected, NULL, ast_json_unref);
    struct ast_variable *tail = NULL;
    RAII_VAR(struct ast_variable *, get_params, NULL, ast_variables_destroy);
    struct ast_variable *headers = NULL;
 
    fixture = setup_invocation_test();
    response = response_alloc();
    tail = ast_variable_list_append_hint(&get_params, NULL, ast_variable_new("api_key", creds, __FILE__));
    ast_assert(tail != NULL);
 
    expected = ast_json_pack("{s: s, s: {s: s}, s: {}, s: {s: s}}",
                 "name", "bang_delete",
                 "get_params",
                 "api_key", creds,
                 "headers",
                 "path_vars",
                 "bam", "foshizzle");
 
    ast_ari_invoke(NULL, ARI_INVOKE_SOURCE_TEST, NULL, "foo/foshizzle/bang", AST_HTTP_DELETE, get_params, headers,
        ast_json_null(), response);
 
    ast_test_validate(test, expect_pass == invocation_count);
    ast_test_validate(test, expect_rc == response->response_code);
    ast_test_validate(test, ast_json_equal(expected, response->message) == expect_pass);
 
    return AST_TEST_PASS;
}

References ARI_INVOKE_SOURCE_TEST, ast_ari_invoke(), ast_assert, AST_HTTP_DELETE, ast_json_equal(), ast_json_null(), ast_json_pack(), ast_json_unref(), AST_TEST_PASS, ast_variable_list_append_hint(), ast_variable_new, ast_variables_destroy(), invocation_count, NULL, RAII_VAR, response_alloc(), response_free(), setup_invocation_test(), and tear_down_invocation_test().

Referenced by AST_TEST_DEFINE(), and AST_TEST_DEFINE().

load_module()

static int load_module ( void  )

static

Definition at line 639 of file test_ari.c.

{
    AST_TEST_REGISTER(get_docs);
    AST_TEST_REGISTER(get_docs_nohost);
    AST_TEST_REGISTER(get_docs_notfound);
    AST_TEST_REGISTER(get_docs_hackerz);
    AST_TEST_REGISTER(invoke_get);
    AST_TEST_REGISTER(invoke_wildcard);
    AST_TEST_REGISTER(invoke_delete);
    AST_TEST_REGISTER(invoke_delete_forbidden);
    AST_TEST_REGISTER(invoke_post);
    AST_TEST_REGISTER(invoke_bad_post);
    AST_TEST_REGISTER(invoke_no_user);
    AST_TEST_REGISTER(invoke_not_found);
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, and AST_TEST_REGISTER.

response_alloc()

static struct ast_ari_response * response_alloc ( void  )

static

Definition at line 156 of file test_ari.c.

{
    struct ast_ari_response *resp = ast_calloc(1, sizeof(struct ast_ari_response));
    resp->headers = ast_str_create(24);
    return resp;
}

References ast_calloc, ast_str_create, and ast_ari_response::headers.

Referenced by 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(), and invoke_delete_common().

response_free()

static void response_free ( struct ast_ari_response *  resp )

static

Definition at line 167 of file test_ari.c.

{
    if (!resp) {
        return;
    }
    ast_free(resp->headers);
    ast_json_unref(resp->message);
    ast_free(resp);
}

References ast_free, ast_json_unref(), ast_ari_response::headers, and ast_ari_response::message.

Referenced by 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(), and invoke_delete_common().

setup_invocation_test()

static void * setup_invocation_test ( void  )

static

\ internal Setup test fixture for invocation tests.

Definition at line 181 of file test_ari.c.

                                         {
    int r;
    invocation_count = 0;
    r = ast_ari_add_handler(&test_root);
    ast_assert(r == 0);
    return &invocation_count;
}

References ast_ari_add_handler(), ast_assert, invocation_count, and test_root.

Referenced by AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), and invoke_delete_common().

tear_down_invocation_test()

static void tear_down_invocation_test ( void *  ignore )

static

\ internal Tear down test fixture for invocation tests.

Definition at line 193 of file test_ari.c.

                                                    {
    if (!ignore) {
        return;
    }
    ast_ari_remove_handler(&test_root);
}

References ast_ari_remove_handler(), and test_root.

Referenced by AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), and invoke_delete_common().

unload_module()

static int unload_module ( void  )

static

Definition at line 622 of file test_ari.c.

{
    AST_TEST_UNREGISTER(get_docs);
    AST_TEST_UNREGISTER(get_docs_nohost);
    AST_TEST_UNREGISTER(get_docs_notfound);
    AST_TEST_UNREGISTER(get_docs_hackerz);
    AST_TEST_UNREGISTER(invoke_get);
    AST_TEST_UNREGISTER(invoke_wildcard);
    AST_TEST_UNREGISTER(invoke_delete);
    AST_TEST_UNREGISTER(invoke_delete_forbidden);
    AST_TEST_UNREGISTER(invoke_post);
    AST_TEST_UNREGISTER(invoke_bad_post);
    AST_TEST_UNREGISTER(invoke_no_user);
    AST_TEST_UNREGISTER(invoke_not_found);
    return 0;
}

References AST_TEST_UNREGISTER.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "ARI testing" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_ari", }

static

Definition at line 661 of file test_ari.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 661 of file test_ari.c.

bam

struct stasis_rest_handlers bam

static

Definition at line 133 of file test_ari.c.

                                         {
    .path_segment = "bam",
    .is_wildcard = 1,
    .callbacks = {
        [AST_HTTP_GET] = bam_get,
    },
    .num_children = 1,
    .children = { &bang }
};

bang

struct stasis_rest_handlers bang

static

Definition at line 116 of file test_ari.c.

                                          {
    .path_segment = "bang",
    .callbacks = {
        [AST_HTTP_GET] = bang_get,
        [AST_HTTP_POST] = bang_post,
        [AST_HTTP_DELETE] = bang_delete,
    },
    .num_children = 0
};

bar

struct stasis_rest_handlers bar

static

Definition at line 125 of file test_ari.c.

                                         {
    .path_segment = "bar",
    .callbacks = {
        [AST_HTTP_GET] = bar_get,
        [AST_HTTP_POST] = bar_post,
    },
    .num_children = 0
};

invocation_count

int invocation_count

static

Definition at line 53 of file test_ari.c.

Referenced by AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), handler(), invoke_delete_common(), and setup_invocation_test().

test_root

struct stasis_rest_handlers test_root

static

Definition at line 142 of file test_ari.c.

                                               {
    .path_segment = "foo",
    .callbacks = {
        [AST_HTTP_GET] = foo_get,
    },
    .num_children = 3,
    .children = { &bar, &bam, &bang }
};

Referenced by setup_invocation_test(), and tear_down_invocation_test().