#include <switch.h>
#include <test/switch_fct.h>

Include dependency graph for switch_test.h:

Macros
#define	fst_getenv(env, default_value) char env = fst_getenv_default(#env, (char )default_value, SWITCH_FALSE);

#define	fst_getenv_required(env) char *env = fst_getenv_default(#env, NULL, SWITCH_TRUE);

#define	SWITCH_TEST_BASE_DIR_OVERRIDE "."

#define	fst_session_park(session)

#define	fst_requires fct_req

#define	fst_requires_module(modname) fct_req(switch_loadable_module_exists(modname) == SWITCH_STATUS_SUCCESS)

#define	fst_check fct_chk

#define	fst_check_int_equals fct_chk_eq_int

#define	fst_check_string_equals fct_chk_eq_str

#define	fst_check_string_not_equals fct_chk_neq_str

#define	fst_check_string_starts_with fct_chk_startswith_str

#define	fst_check_string_ends_with fct_chk_endswith_str

#define	fst_check_string_has fct_chk_incl_str

#define	fst_check_string_does_not_have fct_chk_excl_str

#define	fst_time_mark() fst_time_start = switch_time_now();

#define	fst_xcheck(expr, error_msg) (fct_xchk(expr, "%s", error_msg))

#define	fst_fail(error_msg) (fct_xchk(0, "%s", error_msg))

#define	fst_check_duration(duration_ms, precision_ms)

#define	fst_check_int_range(actual, expected, precision)

#define	fst_check_double_range(actual, expected, precision)

#define	FST_BEGIN()

#define	FST_END()

#define	FST_CORE_EX_BEGIN(confdir, flags)

#define	FST_CORE_END()

#define	FST_CORE_BEGIN(confdir) FST_CORE_EX_BEGIN(confdir, 0)

#define	FST_CORE_DB_BEGIN(confdir) FST_CORE_EX_BEGIN(confdir, SCF_USE_SQL)

#define	FST_MINCORE_BEGIN(confdir)

#define	FST_MINCORE_END FST_CORE_END

#define	FST_MODULE_BEGIN(modname, suite)

#define	FST_MODULE_END()

#define	FST_SUITE_BEGIN(suite)

#define	FST_SUITE_END FCT_FIXTURE_SUITE_END

#define	FST_SETUP_BEGIN()

#define	FST_SETUP_END FCT_SETUP_END

#define	FST_TEARDOWN_BEGIN()

#define	FST_TEARDOWN_END FCT_TEARDOWN_END

#define	FST_TEST_BEGIN(name)

#define	FST_TEST_END

#define	FST_SESSION_BEGIN_RATE_VIDEO(name, rate, video_codec)

#define	FST_SESSION_BEGIN(name) FST_SESSION_BEGIN_RATE(name, 8000)

#define	FST_SESSION_BEGIN_RATE(name, rate) FST_SESSION_BEGIN_RATE_VIDEO(name, rate, "")

#define	FST_SESSION_END()

#define	fst_test_core_asr_open(recognizer)

#define	fst_test_core_asr(grammar, input_filename)

#define	fst_test_core_asr_pause()

#define	fst_test_core_asr_resume()

#define	fst_test_core_asr_close()

#define	fst_play_and_detect_speech_test_begin()

#define	fst_play_and_detect_speech_app_test(recognizer, grammar, prompt_filename, input_filename)

#define	fst_play_and_detect_speech_test(recognizer, grammar, prompt_filename, input_filename, input_args)

#define	fst_play_and_detect_speech_test_end() }

#define	fst_check_extension_apps(expected, extension)

#define	fst_sched_recv_dtmf(when, digits)

#define	fst_xml_start()

#define	fst_xml_open_tag(tag_name)

#define	fst_xml_attr(attr) if (!zstr(attr)) fst_xml_stream.write_function(&fst_xml_stream, " %s=\"%s\"", #attr, attr);

#define	fst_xml_close_tag(tag_name)

#define	fst_xml_body(body)

#define	fst_xml_end() switch_xml_parse_str_dynamic((char *)fst_xml_stream.data, SWITCH_FALSE);

#define	fst_parse_json_file(varname, file)

Functions
static char *	fst_getenv_default (const char env, char default_value, switch_bool_t required)

static switch_status_t	fst_init_core_and_modload (const char confdir, const char basedir, int minimal, switch_core_flag_t flags)

Variables
int	fst_tag_children = 0

int	fst_tag_body = 0

Macro Definition Documentation

◆ FST_BEGIN

#define FST_BEGIN ( )

Value:

FCT_BGN() \
        { \
                int fst_core = 0; \
                switch_time_t fst_time_start = 0; \
                switch_timer_t fst_timer = { 0 }; \
                switch_memory_pool_t *fst_pool = NULL; \
                int fst_timer_started = 0; \
                fst_getenv_default("FST_SUPPRESS_UNUSED_STATIC_WARNING", NULL, SWITCH_FALSE); \
                if (fst_core) { \
                        fst_init_core_and_modload(NULL, NULL, 0, 0); /* shuts up compiler */ \
                } \
                { \

Run test without loading FS core

Definition at line 256 of file switch_test.h.

◆ fst_check

#define fst_check fct_chk

test boolean expression - continue test execution on failure

Definition at line 159 of file switch_test.h.

◆ fst_check_double_range

#define fst_check_double_range	(	actual,
		expected,
		precision
	)

Value:

fct_xchk( \
                fabs((actual - expected)) <= precision, \
                "fst_check_double_range: %f != %f +/- %f", \
                (actual), \
                (expected), \
                (precision) \
        )

Check if double-precision number is in range

Definition at line 244 of file switch_test.h.

◆ fst_check_duration

#define fst_check_duration	(	duration_ms,
		precision_ms
	)

Value:

{ \
                int actual_duration_ms = (int)((switch_time_now() - fst_time_start) / 1000); \
                fct_xchk( \
                        abs((actual_duration_ms - duration_ms)) <= precision_ms, \
                        "fst_check_duration: %d != %d +/- %d", \
                        (actual_duration_ms), \
                        (duration_ms), \
                        (precision_ms) \
                ); \
        }

Check duration relative to test start, last marked time, or last check.

Definition at line 217 of file switch_test.h.

◆ fst_check_extension_apps

#define fst_check_extension_apps	(	expected,
		extension
	)

Value:

{ \
                fst_xcheck(extension != NULL, "Missing extension\n"); \
                if (extension) { \
                        int i; \
                        switch_caller_application_t *cur_app = extension->applications; \
                        for (i = 0; ; i += 2, cur_app = cur_app->next) { \
                                int cur_app_num = i / 2 + 1; \
                                if (!expected[i]) { \
                                        if (cur_app != NULL) { \
                                                fst_fail(switch_core_sprintf(fst_pool, "Unexpected application #%d \"%s\"\n", cur_app_num, cur_app->application_name)); \
                                        } \
                                        break; \
                                } \
                                fst_xcheck(cur_app != NULL, switch_core_sprintf(fst_pool, "Extension application #%d \"%s\" is missing", cur_app_num, expected[i])); \
                                if (!cur_app) { \
                                        break; \
                                } \
                                fst_xcheck(cur_app->application_name && !strcmp(expected[i], cur_app->application_name), switch_core_sprintf(fst_pool, "Expected application #%d name is \"%s\", but is \"%s\"\n", cur_app_num, expected[i], cur_app->application_name)); \
                                fst_xcheck(cur_app->application_data && !strcmp(expected[i + 1], cur_app->application_data), switch_core_sprintf(fst_pool, "Expected application #%d %s data is \"%s\", but is \"%s\"\n", cur_app_num, expected[i], expected[i + 1], cur_app->application_data)); \
                        } \
                } \
        }

Compare extension dialplan apps and args with expected apps and args

Parameters

expected	NULL terminated string array of app arg and names. const char *expected[] = { "playback", "https://example.com/foo.wav", "park", "", NULL };
extension	the switch_caller_extension_t to check

Definition at line 780 of file switch_test.h.

◆ fst_check_int_equals

#define fst_check_int_equals fct_chk_eq_int

test integers for equality - continue test execution on failure

Definition at line 164 of file switch_test.h.

◆ fst_check_int_range

#define fst_check_int_range	(	actual,
		expected,
		precision
	)

Value:

fct_xchk( \
                abs((actual - expected)) <= precision, \
                "fst_check_int_range: %d != %d +/- %d", \
                (actual), \
                (expected), \
                (precision) \
        )

Check if integer is in range

Definition at line 232 of file switch_test.h.

◆ fst_check_string_does_not_have

#define fst_check_string_does_not_have fct_chk_excl_str

Test string for exclusion of substring

Definition at line 194 of file switch_test.h.

◆ fst_check_string_ends_with

#define fst_check_string_ends_with fct_chk_endswith_str

Test string for matching suffix

Definition at line 184 of file switch_test.h.

◆ fst_check_string_equals

#define fst_check_string_equals fct_chk_eq_str

test string for equality - continue test execution on failure

Definition at line 169 of file switch_test.h.

◆ fst_check_string_has

#define fst_check_string_has fct_chk_incl_str

Test string for substring

Definition at line 189 of file switch_test.h.

◆ fst_check_string_not_equals

#define fst_check_string_not_equals fct_chk_neq_str

test string for inequality - continue test execution on failure

Definition at line 174 of file switch_test.h.

◆ fst_check_string_starts_with

#define fst_check_string_starts_with fct_chk_startswith_str

Test string for matching prefix

Definition at line 179 of file switch_test.h.

◆ FST_CORE_BEGIN

#define FST_CORE_BEGIN ( confdir ) FST_CORE_EX_BEGIN(confdir, 0)

Definition at line 315 of file switch_test.h.

◆ FST_CORE_DB_BEGIN

#define FST_CORE_DB_BEGIN ( confdir ) FST_CORE_EX_BEGIN(confdir, SCF_USE_SQL)

Definition at line 316 of file switch_test.h.

◆ FST_CORE_END

#define FST_CORE_END ( )

Value:

switch_core_destroy(); \
                } \
                if (fst_time_start) { \
                        /* shut up compiler */ \
                        fst_time_start = 0; \
                } \
        } \
        FCT_END()

Define the end of a freeswitch core test driver.

Definition at line 305 of file switch_test.h.

◆ FST_CORE_EX_BEGIN

#define FST_CORE_EX_BEGIN	(	confdir,
		flags
	)

Value:

FCT_BGN() \
        { \
                int fst_core = 0; \
                switch_time_t fst_time_start = 0; \
                switch_timer_t fst_timer = { 0 }; \
                switch_memory_pool_t *fst_pool = NULL; \
                int fst_timer_started = 0; \
                fst_getenv_default("FST_SUPPRESS_UNUSED_STATIC_WARNING", NULL, SWITCH_FALSE); \
                if (fst_init_core_and_modload(confdir, confdir, 0, flags | SCF_LOG_DISABLE) == SWITCH_STATUS_SUCCESS) { \
                        fst_core = 2; \
                } else { \
                        fprintf(stderr, "Failed to load FS core\n"); \
                        exit(1); \
                } \
                {

Define the beginning of a freeswitch core test driver. Only one per test application allowed.

Parameters

confdir directory containing freeswitch.xml configuration

Definition at line 284 of file switch_test.h.

◆ FST_END

#define FST_END ( )

Value:

} \
                if (fst_time_start) { \
                        /* shut up compiler */ \
                        fst_time_start = 0; \
                } \
        } \
        FCT_END()

Definition at line 271 of file switch_test.h.

◆ fst_fail

#define fst_fail ( error_msg ) (fct_xchk(0, "%s", error_msg))

Fail a test

Definition at line 211 of file switch_test.h.

◆ fst_getenv

#define fst_getenv	(	env,
		default_value
	)	char env = fst_getenv_default(#env, (char )default_value, SWITCH_FALSE);

Get environment variable and save to var

Definition at line 57 of file switch_test.h.

◆ fst_getenv_required

#define fst_getenv_required ( env ) char *env = fst_getenv_default(#env, NULL, SWITCH_TRUE);

Get mandatory environment variable and save to var. Exit with error if missing.

Definition at line 63 of file switch_test.h.

◆ FST_MINCORE_BEGIN

#define FST_MINCORE_BEGIN ( confdir )

Value:

FCT_BGN() \
        { \
                int fst_core = 0; \
                switch_time_t fst_time_start = 0; \
                switch_timer_t fst_timer = { 0 }; \
                switch_memory_pool_t *fst_pool = NULL; \
                int fst_timer_started = 0; \
                fst_getenv_default("FST_SUPPRESS_UNUSED_STATIC_WARNING", NULL, SWITCH_FALSE); \
                if (fst_init_core_and_modload(confdir, NULL, 1, 0 | SCF_LOG_DISABLE) == SWITCH_STATUS_SUCCESS) { /* minimal load */ \
                        fst_core = 1; \
                } else { \
                        fprintf(stderr, "Failed to load FS core\n"); \
                        exit(1); \
                } \
                {

Minimal FS core load

Definition at line 321 of file switch_test.h.

◆ FST_MINCORE_END

#define FST_MINCORE_END FST_CORE_END

Definition at line 338 of file switch_test.h.

◆ FST_MODULE_BEGIN

#define FST_MODULE_BEGIN	(	modname,
		suite
	)

Value:

{ \
                const char *fst_test_module = #modname; \
                if (fst_core && !zstr(fst_test_module)) { \
                        const char *err; \
                        char path[1024]; \
                        sprintf(path, "%s%s%s", SWITCH_TEST_BASE_DIR_OVERRIDE, SWITCH_PATH_SEPARATOR, "../.libs/"); \
                        switch_loadable_module_load_module((char *)path, (char *)fst_test_module, SWITCH_TRUE, &err); \
                } \
                FCT_FIXTURE_SUITE_BGN(suite);

Define the beginning of a FreeSWITCH module test suite. Loads the module for test.

Parameters

modname	name of module to load.
suite	the name of this test suite

Definition at line 355 of file switch_test.h.

◆ FST_MODULE_END

#define FST_MODULE_END ( )

Value:

FCT_FIXTURE_SUITE_END(); \
                if (!zstr(fst_test_module) && switch_loadable_module_exists(fst_test_module) == SWITCH_STATUS_SUCCESS) { \
                        const char *err; \
                        char path[1024]; \
                        sprintf(path, "%s%s%s", SWITCH_TEST_BASE_DIR_OVERRIDE, SWITCH_PATH_SEPARATOR, "../.libs/"); \
                        switch_loadable_module_unload_module((char*)path, (char *)fst_test_module, SWITCH_FALSE, &err); \
                } \
        }

Define the end of a FreeSWITCH module test suite.

Definition at line 379 of file switch_test.h.

◆ fst_parse_json_file

#define fst_parse_json_file	(	varname,
		file
	)

Value:

cJSON *varname = NULL; \
{ \
        char *buf; \
        struct stat s; \
        int size; \
        int fd = open(file, O_RDONLY); \
        fst_requires(fd >= 0); \
        fstat(fd, &s); \
        switch_zmalloc(buf, s.st_size + 1); \
        fst_requires(buf); \
        size = read(fd, buf, s.st_size); \
        fst_requires(size == s.st_size); \
        close(fd); \
        varname = cJSON_Parse(buf); \
        free(buf); \
        fst_requires(varname); \
}

Parse JSON file and save to varname

Test Requires: JSON file can be opened and parsed

Test Output: varname points at cJSON object

Parameters

varname	name of var to store the resulting cJSON object
file	name of file to parse

Definition at line 874 of file switch_test.h.

◆ fst_play_and_detect_speech_app_test

#define fst_play_and_detect_speech_app_test	(	recognizer,
		grammar,
		prompt_filename,
		input_filename
	)

Value:

{ \
        char *args = NULL; \
        fst_requires(fst_core > 1); \
        fst_requires_module("mod_dptools"); \
        switch_channel_set_variable(fst_channel, "detect_speech_result", ""); \
        fst_requires(switch_ivr_displace_session(fst_session, input_filename, 0, "mrf") == SWITCH_STATUS_SUCCESS); \
        args = switch_core_session_sprintf(fst_session, "%s detect:%s %s", prompt_filename, recognizer, grammar); \
        fst_requires(switch_core_session_execute_application(fst_session, "play_and_detect_speech", args) == SWITCH_STATUS_SUCCESS); \
        fst_asr_result = switch_channel_get_variable(fst_channel, "detect_speech_result"); \
        fst_check(fst_asr_result != NULL); \
}

Use play_and_detect_speech APP to test recognizer

Test Requires: switch_ivr_displace_session(input_filename) == SWITCH_STATUS_SUCCESS switch_core_session_execute_application(play_and_detect_speech) == SWITCH_STATUS_SUCCESS mod_dptools is loaded

Test Checks: fst_asr_result != NULL after recognition completes

Test Output: fst_asr_result has the result from detect_speech_result channel variable.

Parameters

recognizer	name of recognizer
grammar	recognizer grammar
prompt_filename	name of prompt to play
input_filename	name of file containing input audio for the recognizer

Definition at line 726 of file switch_test.h.

◆ fst_play_and_detect_speech_test

#define fst_play_and_detect_speech_test	(	recognizer,
		grammar,
		prompt_filename,
		input_filename,
		input_args
	)

Value:

{ \
        char *args = NULL; \
        fst_asr_result = NULL; \
        fst_requires(fst_core > 1); \
        fst_requires(switch_ivr_displace_session(fst_session, input_filename, 0, "mrf") == SWITCH_STATUS_SUCCESS); \
        switch_status_t status = switch_ivr_play_and_detect_speech(fst_session, prompt_filename, recognizer, grammar, (char **)&fst_asr_result, 0, input_args); \
        fst_check(fst_asr_result != NULL); \
}

Use play_and_detect_speech core function to test recognizer

Test Requires: switch_ivr_displace_session(input_filename) == SWITCH_STATUS_SUCCESS

Test Checks: fst_asr_result != NULL after recognition completes

Test Output: fst_asr_result has the result from detect_speech_result channel variable.

Parameters

recognizer	name of recognizer
grammar	recognizer grammar
prompt_filename	name of prompt to play
input_filename	name of file containing input audio for the recognizer
input_args	input callback args

Definition at line 757 of file switch_test.h.

◆ fst_play_and_detect_speech_test_begin

#define fst_play_and_detect_speech_test_begin ( )

Value:

{ \
        const char *fst_asr_result = NULL; \
        fst_requires(fst_core > 1);

Define beginning of play_and_detect_speech recognizer test

Defined vars: const char *fst_asr_result; Result of last recognition. Allocated from test memory pool.

Definition at line 702 of file switch_test.h.

◆ fst_play_and_detect_speech_test_end

#define fst_play_and_detect_speech_test_end ( ) }

Define end of play_and_detect_speech recognizer test

Definition at line 770 of file switch_test.h.

◆ fst_requires

#define fst_requires fct_req

check for test requirement - execute teardown on failure

Definition at line 149 of file switch_test.h.

◆ fst_requires_module

#define fst_requires_module ( modname ) fct_req(switch_loadable_module_exists(modname) == SWITCH_STATUS_SUCCESS)

check for required module - execute teardown on failure

Definition at line 154 of file switch_test.h.

◆ fst_sched_recv_dtmf

#define fst_sched_recv_dtmf	(	when,
		digits
	)

Value:

{ \
        switch_status_t api_result; \
        switch_stream_handle_t stream = { 0 }; \
        SWITCH_STANDARD_STREAM(stream); \
        fst_requires(fst_core > 1); \
        fst_requires_module("mod_commands"); \
        api_result = switch_api_execute("sched_api", switch_core_session_sprintf(fst_session, "%s none uuid_recv_dtmf %s %s", when, switch_core_session_get_uuid(fst_session), digits), NULL, &stream); \
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(fst_session), SWITCH_LOG_INFO, "Injecting DTMF %s at %s\n", digits, when); \
        fst_requires(api_result == SWITCH_STATUS_SUCCESS); \
        switch_safe_free(stream.data); \
}

Inject DTMF into the session to be detected.

Test Requires: switch_api_execute(sched_api) == SWITCH_STATUS_SUCCESS mod_commands is loaded

Parameters

when	string describing when to send dtmf
digits	to send

Definition at line 815 of file switch_test.h.

◆ FST_SESSION_BEGIN

#define FST_SESSION_BEGIN ( name ) FST_SESSION_BEGIN_RATE(name, 8000)

Define a session test in a test suite. This can be used to test IVR functions. See FST_SESSION_BEGIN_RATE_VIDEO

Definition at line 533 of file switch_test.h.

◆ FST_SESSION_BEGIN_RATE

#define FST_SESSION_BEGIN_RATE	(	name,
		rate
	)	FST_SESSION_BEGIN_RATE_VIDEO(name, rate, "")

Definition at line 534 of file switch_test.h.

◆ FST_SESSION_BEGIN_RATE_VIDEO

#define FST_SESSION_BEGIN_RATE_VIDEO	(	name,
		rate,
		video_codec
	)

Define a session test in a test suite. This can be used to test IVR functions.

Records session audio to /tmp/name.wav where name is the name of the test.

Required modules: mod_loopback - for null endpoint mod_sndfile - for wav file support

Defined vars: switch_memory_pool_t *fst_pool; A memory pool that is torn down on test completion switch_core_timer_t *fst_timer; A 8kHz, 20ms soft timer (160 samples per frame) switch_core_session_t *fst_session; The outbound null session. L16, 1 channel, 8kHz. switch_core_session_t *fst_session_pool; The outbound null session's pool. switch_channel_t *fst_channel; The outbound null session's channel.

Parameters

name	the name of this test
rate	the rate of the channel
video_codec	the rate of the channel

Definition at line 490 of file switch_test.h.

◆ FST_SESSION_END

#define FST_SESSION_END ( )

Value:

break; \
                        } \
                        if (switch_channel_ready(fst_channel)) { \
                                switch_channel_hangup(fst_channel, SWITCH_CAUSE_NORMAL_CLEARING); \
                        } \
                        if (fst_originate_vars) { \
                                switch_event_destroy(&fst_originate_vars); \
                        } \
                        if (fst_session_pool) { \
                                fst_session_pool = NULL; \
                        } \
                        switch_core_session_rwunlock(fst_session); \
                        if (fst_core) { \
                                switch_log_level_t level = SWITCH_LOG_DISABLE; \
                                switch_core_session_ctl(SCSC_LOGLEVEL, &level); \
                        } \
                        switch_sleep(1000000); \
                } \
        } \
        FCT_TEST_END()

Define the end of a session test in a test suite. Hangs up session under test.

Definition at line 542 of file switch_test.h.

◆ fst_session_park

#define fst_session_park ( session )

Value:

switch_ivr_park_session(session); \

switch_channel_wait_for_flag(switch_core_session_get_channel(session), CF_PARK, SWITCH_TRUE, 10000, NULL);

SWITCH_TRUE

Definition: switch_types.h:439

switch_core_session_get_channel

_Ret_ switch_channel_t * switch_core_session_get_channel(_In_ switch_core_session_t *session)

Retrieve a pointer to the channel object associated with a given session.

switch_ivr_park_session

void switch_ivr_park_session(switch_core_session_t *session)

Definition: switch_ivr.c:3571

CF_PARK

Definition: switch_types.h:1502

Park FreeSWITCH session. This is handy when wanting to use switch_core_session_execute_async() on the test session.

Parameters

session to park

Definition at line 142 of file switch_test.h.

◆ FST_SETUP_BEGIN

#define FST_SETUP_BEGIN ( )

Value:

FCT_SETUP_BGN() \
                if (fst_core) { \
                        switch_core_new_memory_pool(&fst_pool); \
                        if (fst_core > 1) { \
                                fst_timer_started = (switch_core_timer_init(&fst_timer, "soft", 20, 160, fst_pool) == SWITCH_STATUS_SUCCESS); \
                        } \
                }

Define the test suite setup. This is run before each test or session test.

Definition at line 407 of file switch_test.h.

◆ FST_SETUP_END

#define FST_SETUP_END FCT_SETUP_END

Define the end of test suite setup.

Definition at line 419 of file switch_test.h.

◆ FST_SUITE_BEGIN

#define FST_SUITE_BEGIN ( suite )

Value:

const char *fst_test_module = NULL; \

FCT_FIXTURE_SUITE_BGN(suite)

Define the beginning of a test suite not associated with a module.

Parameters

suite the name of this test suite

Definition at line 394 of file switch_test.h.

◆ FST_SUITE_END

#define FST_SUITE_END FCT_FIXTURE_SUITE_END

Define the end of a test suite.

Definition at line 401 of file switch_test.h.

◆ FST_TEARDOWN_BEGIN

#define FST_TEARDOWN_BEGIN ( )

Value:

FCT_TEARDOWN_BGN() \
                if (fst_core) { \
                        if (fst_pool) switch_core_destroy_memory_pool(&fst_pool); \
                        if (fst_core > 1) { \
                                if (fst_timer_started) switch_core_timer_destroy(&fst_timer); \
                        } \
                }

Define the test suite teardown. This is run after each test or session test.

Definition at line 425 of file switch_test.h.

◆ FST_TEARDOWN_END

#define FST_TEARDOWN_END FCT_TEARDOWN_END

Define the test suite teardown end.

Definition at line 437 of file switch_test.h.

◆ FST_TEST_BEGIN

#define FST_TEST_BEGIN ( name )

Value:

FCT_TEST_BGN(name) \
                if (fst_core) { \
                        switch_log_level_t level = SWITCH_LOG_DEBUG; \
                        switch_core_session_ctl(SCSC_LOGLEVEL, &level); \
                        fst_requires(fst_pool != NULL); \
                        if (fst_core > 1) { \
                                fst_requires(fst_timer_started); \
                        } \
                        fst_time_mark(); \
                } \
                if (fst_test_module) { \
                        fst_requires_module(fst_test_module); \
                }

Define a test in a test suite. Defined vars: switch_memory_pool_t *fst_pool; A memory pool that is torn down on test completion switch_core_timer_t *fst_timer; A 8kHz, 20ms soft timer (160 samples per frame)

Parameters

name	the name of this test

Definition at line 446 of file switch_test.h.

◆ fst_test_core_asr

#define fst_test_core_asr	(	grammar,
		input_filename
	)

Execute test on opened recognizer. Reads audio from input file and passes it to the recognizer.

Test Requires: switch_core_asr_load_grammar(grammar) == SWITCH_STATUS_SUCCESS switch_core_file_open(input_filename) == SWITCH_STATUS_SUCCESS switch_core_file_close() == SWITCH_STATUS_SUCCESS

Test Checks: Got result from recognizer.

Test Output: fst_asr_result has the xmlstr from switch_core_file_get_results()

Parameters

grammar	recognizer grammar
input_filename	name of file containing audio to send to recognizer.

Definition at line 608 of file switch_test.h.

◆ fst_test_core_asr_close

#define fst_test_core_asr_close ( )

Value:

fst_requires(fst_core > 1); \
        switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Close recognizer\n"); \
        flags = SWITCH_ASR_FLAG_NONE; \
        fst_requires(switch_core_asr_close(&ah, &flags) == SWITCH_STATUS_SUCCESS); \
}

Close an open recognizer

Test Requires: switch_core_asr_close(&ah, flags) == SWITCH_STATUS_SUCCESS

Definition at line 685 of file switch_test.h.

◆ fst_test_core_asr_open

#define fst_test_core_asr_open ( recognizer )

Value:

{\
        char *fst_asr_result = NULL; \
        switch_asr_handle_t ah = { 0 }; \
        switch_asr_flag_t flags = SWITCH_ASR_FLAG_NONE; \
        fst_requires(fst_core > 1); \
        switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Open recognizer: %s\n", recognizer); \
        /* open ASR interface and feed recorded audio into it and collect result */ \
        fst_requires(switch_core_asr_open(&ah, recognizer, "L16", 8000, "", &flags, fst_pool) == SWITCH_STATUS_SUCCESS); \

Open core ASR for a recognizer module. Opens for L16, 1 channel, 8KHz.

Test Requires: switch_core_asr_open() == SWITCH_STATUS_SUCCESS

Defined vars: switch_asr_handle_t ah; Core ASR handle switch_asr_flag_t flags; Core ASR flags used to open recognizer. char *fst_asr_result; Result of last recognition. Allocated from test memory pool.

Parameters

recognizer name of recognizer to open (like gcloud_dialogflow)

Definition at line 581 of file switch_test.h.

◆ fst_test_core_asr_pause

#define fst_test_core_asr_pause ( )

Value:

fst_requires(fst_core > 1); \
        switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Pause recognizer\n"); \
        flags = SWITCH_ASR_FLAG_NONE; \
        fst_requires(switch_core_asr_pause(&ah) == SWITCH_STATUS_SUCCESS);

Pause an open recognizer.

Test Requires: switch_core_asr_pause(&ah) == SWITCH_STATUS_SUCCESS

Definition at line 661 of file switch_test.h.

◆ fst_test_core_asr_resume

#define fst_test_core_asr_resume ( )

Value:

fst_requires(fst_core > 1); \
        switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Resume recognizer\n"); \
        flags = SWITCH_ASR_FLAG_NONE; \
        fst_requires(switch_core_asr_resume(&ah) == SWITCH_STATUS_SUCCESS);

Resumes an open recognizer

Test Requires: switch_core_asr_resume(&ah) == SWITCH_STATUS_SUCCESS

Definition at line 673 of file switch_test.h.

◆ FST_TEST_END

#define FST_TEST_END

Value:

if (fst_core) { \
                switch_log_level_t level = SWITCH_LOG_DISABLE; \
                switch_core_session_ctl(SCSC_LOGLEVEL, &level); \
        } \
        FCT_TEST_END

Definition at line 461 of file switch_test.h.

◆ fst_time_mark

#define fst_time_mark ( ) fst_time_start = switch_time_now();

Mark reference for time measure

Definition at line 199 of file switch_test.h.

◆ fst_xcheck

#define fst_xcheck	(	expr,
		error_msg
	)	(fct_xchk(expr, "%s", error_msg))

Check a test /w error message

Definition at line 205 of file switch_test.h.

◆ fst_xml_attr

#define fst_xml_attr ( attr ) if (!zstr(attr)) fst_xml_stream.write_function(&fst_xml_stream, " %s=\"%s\"", #attr, attr);

Definition at line 838 of file switch_test.h.

◆ fst_xml_body

#define fst_xml_body ( body )

Value:

if (fst_tag_body) { \
                fst_xml_stream.write_function(&fst_xml_stream, "%s", body); \
        } else { \
                fst_tag_body = 1; \
                fst_xml_stream.write_function(&fst_xml_stream, ">%s", body); \
        }

Definition at line 850 of file switch_test.h.

◆ fst_xml_close_tag

#define fst_xml_close_tag ( tag_name )

Value:

--fst_tag_children; \
        if (fst_tag_children > 0 || fst_tag_body) { \
                fst_xml_stream.write_function(&fst_xml_stream, "</%s>", #tag_name); \
        } else { \
                fst_xml_stream.write_function(&fst_xml_stream, "/>"); \
        } \
        fst_tag_body = 0;

Definition at line 841 of file switch_test.h.

◆ fst_xml_end

#define fst_xml_end ( ) switch_xml_parse_str_dynamic((char *)fst_xml_stream.data, SWITCH_FALSE);

Definition at line 858 of file switch_test.h.

◆ fst_xml_open_tag

#define fst_xml_open_tag ( tag_name )

Value:

fst_xml_stream.write_function(&fst_xml_stream, "<%s", #tag_name); \

fst_tag_children++;

Definition at line 834 of file switch_test.h.

◆ fst_xml_start

#define fst_xml_start ( )

Value:

switch_stream_handle_t fst_xml_stream = { 0 }; \

SWITCH_STANDARD_STREAM(fst_xml_stream);

switch_stream_handle

Definition: switch_module_interfaces.h:94

Definition at line 828 of file switch_test.h.

◆ SWITCH_TEST_BASE_DIR_OVERRIDE

#define SWITCH_TEST_BASE_DIR_OVERRIDE "."

Referenced by fst_init_core_and_modload().

Function Documentation

◆ fst_getenv_default()

static char* fst_getenv_default	(	const char *	env,
		char *	default_value,
		switch_bool_t	required
	)

static

Get environment variable and save to var

Definition at line 41 of file switch_test.h.

 {
         char *val = getenv(env);
         if (!val) {
                 if (required) {
                         fprintf(stderr, "Failed to start test: environment variable \"%s\" is not set!\n", env);
                         exit(1);
                 }
                 return default_value;
         }
         return val;
 }

◆ fst_init_core_and_modload()

static switch_status_t fst_init_core_and_modload	(	const char *	confdir,
		const char *	basedir,
		int	minimal,
		switch_core_flag_t	flags
	)

static

initialize FS core from optional configuration dir

Definition at line 69 of file switch_test.h.

 {
         switch_status_t status;
         const char *err;
         unsigned long pid = switch_getpid();
         // Let FreeSWITCH core pick these
         //SWITCH_GLOBAL_dirs.base_dir = strdup("/usr/local/freeswitch");
         //SWITCH_GLOBAL_dirs.mod_dir = strdup("/usr/local/freeswitch/mod");
         //SWITCH_GLOBAL_dirs.lib_dir = strdup("/usr/local/freeswitch/lib");
         //SWITCH_GLOBAL_dirs.temp_dir = strdup("/tmp");
 
 #ifdef SWITCH_TEST_BASE_DIR_OVERRIDE
         basedir = SWITCH_TEST_BASE_DIR_OVERRIDE;
 #else
 #define SWITCH_TEST_BASE_DIR_OVERRIDE "."
 #endif
 
         if (zstr(basedir)) {
                 basedir = ".";
         }
 
         // Allow test to define the runtime dir
         if (!zstr(confdir)) {
 #ifdef SWITCH_TEST_BASE_DIR_FOR_CONF
                 SWITCH_GLOBAL_dirs.conf_dir = switch_mprintf("%s%s%s", SWITCH_TEST_BASE_DIR_FOR_CONF, SWITCH_PATH_SEPARATOR, confdir);
 #else
                 if (confdir[0] != '/') {
                         SWITCH_GLOBAL_dirs.conf_dir = switch_mprintf(".%s%s", SWITCH_PATH_SEPARATOR, confdir);
                 } else {
                         SWITCH_GLOBAL_dirs.conf_dir = strdup(confdir);
                 }
 #endif
         } else {
                 SWITCH_GLOBAL_dirs.conf_dir = switch_mprintf("%s%sconf", basedir, SWITCH_PATH_SEPARATOR);
         }
 
         SWITCH_GLOBAL_dirs.log_dir = switch_mprintf("%s%s%lu%s", basedir, SWITCH_PATH_SEPARATOR, pid, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.run_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.recordings_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.sounds_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.cache_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.db_dir = switch_mprintf("%s%s%lu%s", basedir, SWITCH_PATH_SEPARATOR, pid, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.script_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.htdocs_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.grammar_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.fonts_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.images_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.storage_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.data_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
         SWITCH_GLOBAL_dirs.localstate_dir = switch_mprintf("%s%s", basedir, SWITCH_PATH_SEPARATOR);
 
         switch_core_set_globals();
 
         if (!minimal) {
                 status = switch_core_init_and_modload(flags, SWITCH_TRUE, &err);
                 switch_sleep(1 * 1000000);
                 switch_core_set_variable("sound_prefix", "." SWITCH_PATH_SEPARATOR);
                 if (status != SWITCH_STATUS_SUCCESS && err) {
                         fprintf(stderr, "%s", err);
                 }
                 return status;
         }
         status = switch_core_init(SCF_MINIMAL, SWITCH_TRUE, &err);
         if (status != SWITCH_STATUS_SUCCESS && err) {
                 fprintf(stderr, "%s", err);
         }
         return status;
 }

Variable Documentation

◆ fst_tag_body

int fst_tag_body = 0

Definition at line 832 of file switch_test.h.

◆ fst_tag_children

int fst_tag_children = 0

Definition at line 831 of file switch_test.h.

Macros

Functions

Variables

Macro Definition Documentation

◆ FST_BEGIN

◆ fst_check

◆ fst_check_double_range

◆ fst_check_duration

◆ fst_check_extension_apps

◆ fst_check_int_equals

◆ fst_check_int_range

◆ fst_check_string_does_not_have

◆ fst_check_string_ends_with

◆ fst_check_string_equals

◆ fst_check_string_has

◆ fst_check_string_not_equals

◆ fst_check_string_starts_with

◆ FST_CORE_BEGIN

◆ FST_CORE_DB_BEGIN

◆ FST_CORE_END

◆ FST_CORE_EX_BEGIN

◆ FST_END

◆ fst_fail

◆ fst_getenv

◆ fst_getenv_required

◆ FST_MINCORE_BEGIN

◆ FST_MINCORE_END

◆ FST_MODULE_BEGIN

◆ FST_MODULE_END

◆ fst_parse_json_file

◆ fst_play_and_detect_speech_app_test

◆ fst_play_and_detect_speech_test

◆ fst_play_and_detect_speech_test_begin

◆ fst_play_and_detect_speech_test_end

◆ fst_requires

◆ fst_requires_module

◆ fst_sched_recv_dtmf

◆ FST_SESSION_BEGIN

◆ FST_SESSION_BEGIN_RATE

◆ FST_SESSION_BEGIN_RATE_VIDEO

◆ FST_SESSION_END

◆ fst_session_park

◆ FST_SETUP_BEGIN

◆ FST_SETUP_END

◆ FST_SUITE_BEGIN

◆ FST_SUITE_END

◆ FST_TEARDOWN_BEGIN

◆ FST_TEARDOWN_END

◆ FST_TEST_BEGIN

◆ fst_test_core_asr

◆ fst_test_core_asr_close

◆ fst_test_core_asr_open

◆ fst_test_core_asr_pause

◆ fst_test_core_asr_resume

◆ FST_TEST_END

◆ fst_time_mark

◆ fst_xcheck

◆ fst_xml_attr

◆ fst_xml_body

◆ fst_xml_close_tag

◆ fst_xml_end

◆ fst_xml_open_tag

◆ fst_xml_start

◆ SWITCH_TEST_BASE_DIR_OVERRIDE

Function Documentation

◆ fst_getenv_default()

◆ fst_init_core_and_modload()

Variable Documentation

◆ fst_tag_body

◆ fst_tag_children