test_func_file.c File Reference

Function FILE tests. More...

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

Include dependency graph for test_func_file.c:

Go to the source code of this file.

Macros
#define	C1024   "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
	AST_TEST_DEFINE (test_func_file)
static char *	file2display (struct ast_str **buf, ssize_t len, const char *input)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "FILE() Tests" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
struct {
const char *   args
const char *   contents
const char *   value
}	read_tests []
struct {
const char *   args
const char *   contents
const char *   contents2
const char *   value
}	write_tests []

Detailed Description

Function FILE tests.

Author

Tilghman Lesher <tlesher AT digium DOT com> 

Definition in file test_func_file.c.

Macro Definition Documentation

C1024

#define C1024   "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF"

Definition at line 41 of file test_func_file.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 399 of file test_func_file.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 399 of file test_func_file.c.

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 399 of file test_func_file.c.

AST_TEST_DEFINE()

AST_TEST_DEFINE

(

test_func_file

)

Definition at line 248 of file test_func_file.c.

References args, ARRAY_LEN, ast_free, ast_func_write(), ast_str_buffer(), ast_str_create, ast_str_substitute_variables(), AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, buf, contents, contents2, errno, make_ari_stubs::file, file2display(), sip_to_pjsip::info(), mkdtemp(), NULL, read_tests, TEST_EXECUTE, TEST_INIT, value, and write_tests.

{
   int res = AST_TEST_PASS;
   int i;
   char dir[] = "/tmp/test_func_file.XXXXXX";
   char file[80], expression[256];
   struct ast_str *buf, *disp[2] = { NULL, NULL };
   char fbuf[8192];
   FILE *fh;

   switch (cmd) {
   case TEST_INIT:
      info->name = "func_file";
      info->category = "/funcs/func_env/";
      info->summary = "Verify behavior of the FILE() dialplan function";
      info->description =
         "Verifies that the examples of the FILE() dialplan function documentation work as described.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (!mkdtemp(dir)) {
      ast_test_status_update(test, "Cannot create temporary directory: %s\n", strerror(errno));
      return AST_TEST_FAIL;
   }

   disp[0] = ast_str_create(16);
   disp[1] = ast_str_create(16);
   if (!(buf = ast_str_create(16)) || !disp[0] || !disp[1]) {
      ast_free(buf);
      ast_free(disp[0]);
      ast_free(disp[1]);
      rmdir(dir);
      return AST_TEST_FAIL;
   }

   snprintf(file, sizeof(file), "%s/test.txt", dir);

   for (i = 0; i < ARRAY_LEN(read_tests); i++) {
      if (!(fh = fopen(file, "w"))) {
         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
         ast_free(buf);
         ast_free(disp[0]);
         ast_free(disp[1]);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      if (fwrite(read_tests[i].contents, 1, strlen(read_tests[i].contents), fh) < strlen(read_tests[i].contents)) {
         ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
         ast_free(buf);
         ast_free(disp[0]);
         ast_free(disp[1]);
         fclose(fh);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      fclose(fh);

      snprintf(expression, sizeof(expression), "${FILE(%s,%s)}", file, read_tests[i].args);
      ast_str_substitute_variables(&buf, 0, NULL, expression);

      if (strcmp(ast_str_buffer(buf), read_tests[i].value)) {
         ast_test_status_update(test, "Expression '${FILE(...,%s)}' did not produce ('%s') the expected value ('%s')\n",
            read_tests[i].args, file2display(&disp[0], 0, ast_str_buffer(buf)), file2display(&disp[1], 0, read_tests[i].value));
         res = AST_TEST_FAIL;
      }
   }

   ast_free(buf);

   for (i = 0; i < ARRAY_LEN(write_tests); i++) {
      if (!(fh = fopen(file, "w"))) {
         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
         ast_free(disp[0]);
         ast_free(disp[1]);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      if (fwrite(write_tests[i].contents, 1, strlen(write_tests[i].contents), fh) < strlen(write_tests[i].contents)) {
         ast_test_status_update(test, "Cannot write initial values into test file: %s\n", strerror(errno));
         ast_free(disp[0]);
         ast_free(disp[1]);
         fclose(fh);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      fclose(fh);

      snprintf(expression, sizeof(expression), "FILE(%s,%s)", file, write_tests[i].args);
      ast_func_write(NULL, expression, write_tests[i].value);

      if (!(fh = fopen(file, "r"))) {
         ast_test_status_update(test, "Cannot open test file: %s\n", strerror(errno));
         ast_free(disp[0]);
         ast_free(disp[1]);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      memset(fbuf, 0, sizeof(fbuf));
      if (!fread(fbuf, 1, sizeof(fbuf), fh)) {
         ast_test_status_update(test, "Cannot read write results from test file: %s\n", strerror(errno));
         ast_free(disp[0]);
         ast_free(disp[1]);
         fclose(fh);
         unlink(file);
         rmdir(dir);
         return AST_TEST_FAIL;
      }

      fclose(fh);

      if (strcmp(fbuf, write_tests[i].contents2)) {
         ast_test_status_update(test, "Expression 'FILE(...,%s)=%s' did not produce ('%s') the expected result ('%s')\n",
            write_tests[i].args, write_tests[i].value, file2display(&disp[0], 0, fbuf), file2display(&disp[1], 0, write_tests[i].contents2));
         res = AST_TEST_FAIL;
      } else {
         ast_test_status_update(test, "Expression 'FILE(...,%s)=%s'... OK!\n", write_tests[i].args, write_tests[i].value);
      }
   }

   ast_free(disp[0]);
   ast_free(disp[1]);
   unlink(file);
   rmdir(dir);

   return res;
}

file2display()

static char* file2display ( struct ast_str **  buf, ssize_t  len, const char *  input  )

static

Definition at line 228 of file test_func_file.c.

References ast_str_append(), ast_str_buffer(), and ast_str_reset().

Referenced by AST_TEST_DEFINE().

{
   const char *ptr;
   ast_str_reset(*buf);
   for (ptr = input; *ptr; ptr++) {
      if (*ptr == '\n') {
         ast_str_append(buf, len, "\\n");
      } else if (*ptr == '\r') {
         ast_str_append(buf, len, "\\r");
      } else if (*ptr == '\t') {
         ast_str_append(buf, len, "\\t");
      } else if (*ptr < ' ' || *ptr > 125) {
         ast_str_append(buf, len, "\\x%hhX", *ptr);
      } else {
         ast_str_append(buf, len, "%c", *ptr);
      }
   }
   return ast_str_buffer(*buf);
}

load_module()

static int load_module ( void  )

static

Definition at line 393 of file test_func_file.c.

References AST_MODULE_LOAD_SUCCESS, and AST_TEST_REGISTER.

{
   AST_TEST_REGISTER(test_func_file);
   return AST_MODULE_LOAD_SUCCESS;
}

unload_module()

static int unload_module ( void  )

static

Definition at line 387 of file test_func_file.c.

References AST_TEST_UNREGISTER.

{
   AST_TEST_UNREGISTER(test_func_file);
   return 0;
}

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "FILE() Tests" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 399 of file test_func_file.c.

args

const char* args

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 46 of file test_func_file.c.

Referenced by __ast_sorcery_object_field_register(), __find_call(), acf_abs_exec(), acf_curl_exec(), acf_curl_write(), acf_isexten_exec(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_max_exec(), acf_min_exec(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_strftime(), acf_strptime(), acf_transaction_read(), acf_transaction_write(), acf_version_exec(), acf_vmcount_exec(), add_action_to_menu_entry(), add_cfg_entry(), add_format_information_cb(), add_rt_cfg_entry(), add_rt_multi_cfg_entry(), adsi_process(), aelsub_exec(), aes_helper(), agent_function_read(), agent_login_exec(), agent_request_exec(), agi_exec_full(), aMYSQL_connect(), aMYSQL_fetch(), aMYSQL_nextresult(), aMYSQL_query(), aMYSQL_set(), answer_exec_enable(), app_control_dial(), app_exec(), applicationmap_handler(), aqm_exec(), ast_ari_sounds_list(), ast_beep_start(), ast_cc_agent_callback(), ast_cc_agent_status_response(), ast_cli_command_full(), ast_eivr_senddtmf(), ast_func_read(), ast_func_read2(), ast_func_write(), ast_json_pack(), ast_json_stringf(), ast_queue_log(), AST_TEST_DEFINE(), asyncgoto_exec(), attended_transfer_exec(), audiosocket_exec(), audiosocket_request(), background_detect_exec(), blind_transfer_exec(), bridge_exec(), bridgewait_exec(), build_profile(), calendar_query_exec(), calendar_query_result_exec(), callerid_read(), cb_events(), cc_agent_callback_helper(), cc_do_state_change(), cc_request_state_change(), cc_status_response(), cdr_prop_write_callback(), cdr_read_callback(), cdr_write(), cdr_write_callback(), celgenuserevent_exec(), chanavail_exec(), channel_set_debug(), channelvars_handler(), chanspy_exec(), cli_odbc_read(), cli_odbc_write(), confbridge_exec(), config_function_read(), confkick_exec(), control_dial_args_alloc(), control_dial_args_destroy(), controlplayback_exec(), cut_internal(), dahdi_call(), dahdiras_exec(), destroy_all_channels(), detect_write(), determine_starting_point(), dial_exec_full(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dtmfstore_exec(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enable_jack_hook(), enum_query_read(), enum_result_read(), exec_exec(), extenspy_exec(), festival_exec(), file_count_line(), file_read(), file_write(), filter(), find_by_name(), find_by_uniqueid(), find_realtime_gw(), forkcdr_exec(), func_args(), func_confbridge_helper(), func_confbridge_info(), func_get_parkingslot_channel(), func_header_read(), func_headers_read2(), func_mixmonitor_read(), func_read_header(), func_write_header(), function_amiclient(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldnum_helper(), function_fieldqty_helper(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_write(), function_txtcidname(), gosubif_exec(), handle_cli_presencestate_change(), hangupcause_read(), hint_read(), hook_on(), iconv_read(), import_helper(), isAnsweringMachine(), isexten_function_read(), jb_debug_output(), jb_error_output(), jb_helper(), jb_warning_output(), jingle_request(), listfilter(), load_channelvars(), log_exec(), main(), man_do_variable_value(), manager_mixmonitor(), math(), mbl_sendsms_exec(), mbl_status_exec(), meetme_stasis_generate_msg(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), msg_send_exec(), multicast_rtp_request(), my_on_hook(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_and_announce_app_exec(), park_app_parse_data(), parked_call_app_exec(), parse_uri_cb(), pbx_builtin_answer(), pbx_builtin_background(), pbx_builtin_saycharacters_case(), pbx_builtin_setvar_multiple(), pbx_builtin_waitdigit(), pbx_builtin_waitexten(), peek_read(), pickupchan_exec(), pjsip_acf_channel_read(), pjsip_acf_dial_contacts_read(), pjsip_acf_parse_uri_read(), pjsip_aor_function_read(), pjsip_contact_function_read(), pjsip_endpoint_function_read(), play_moh_exec(), playback_exec(), pp_each_extension_helper(), pqm_exec(), presence_read(), presence_write(), privacy_exec(), pvalAppCallWalkArgs(), pvalMacroCallWalkArgs(), ql_exec(), queue_exec(), queue_function_mem_read(), queue_function_mem_write(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), queue_function_queuegetchannel(), qupd_exec(), rcvfax_exec(), realtimefield_read(), receivefax_exec(), record_exec(), recordthread(), reg_source_db(), regex(), reload_single_member(), replace(), request(), resetcdr_exec(), retrydial_exec(), rqm_exec(), saycountedadj_exec(), saycountednoun_exec(), sayfile_exec(), sayunixtime_exec(), scramble_write(), senddtmf_exec(), sendfax_exec(), sendmf_exec(), sendurl_exec(), shared_read(), shared_write(), shift_pop(), sip_acf_channel_read(), sip_request_call(), sip_tcptls_client_args_destructor(), smdi_msg_read(), smdi_msg_retrieve_read(), sndfax_exec(), softhangup_exec(), sorcery_function_read(), spawn_ras(), speech_background(), speech_load(), srv_result_read(), stackpeek_read(), start_mixmonitor_callback(), start_moh_exec(), start_monitor_exec(), stasis_app_control_dial(), static_realtime_cb(), statsd_exec(), stir_shaken_read(), stop_mixmonitor_full(), stream_echo_exec(), strreplace(), talk_detect_fn_write(), test_jb_debug_output(), test_jb_error_output(), test_jb_warn_output(), tls_method_to_str(), transfer_exec(), tryexec_exec(), unicast_rtp_request(), unshift_push(), upqm_exec(), user_chan_cb(), userevent_exec(), verbose_exec(), vm_exec(), vm_execmain(), vm_playmsgexec(), volume_read(), volume_write(), wait_exec(), waitfor_exec(), websocket_client_args_create(), websocket_client_args_destroy(), xmpp_join_exec(), xmpp_leave_exec(), xmpp_send_exec(), xmpp_sendgroup_exec(), and zapateller_exec().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 399 of file test_func_file.c.

contents

const char* contents

Definition at line 45 of file test_func_file.c.

Referenced by AST_TEST_DEFINE(), and call_pickup_to_ami().

contents2

const char* contents2

Definition at line 91 of file test_func_file.c.

Referenced by AST_TEST_DEFINE().

read_tests

struct { ... } read_tests[]

Referenced by AST_TEST_DEFINE().

value

const char* value

Definition at line 47 of file test_func_file.c.

Referenced by AST_TEST_DEFINE().

write_tests

struct { ... } write_tests[]

Referenced by AST_TEST_DEFINE().