Reference

Mail_file Procedure

Open_logs Procedure

Close_logs Procedure

Isbuild Procedure

Tests for a particular build host environment. If the currently configured host matches the argument string, the result is 1; otherwise the result is 0. host must be a full three-part configure host name; in particular, you may not use the shorter nicknames supported by configure (but you can use wildcard characters, using shell syntax, to specify sets of names). If it is passed a NULL string, then it returns the name of the build canonical configuration.

Is_remote Procedure

is3way Procedure

Tests for a canadian cross. This is when the tests will be run on a remotly hosted cross compiler. If it is a canadian cross, then the result is 1; otherwise the result is 0.

Ishost Procedure

Tests for a particular host environment. If the currently configured host matches the argument string, the result is 1; otherwise the result is 0. host must be a full three-part configure host name; in particular, you may not use the shorter nicknames supported by configure (but you can use wildcard characters, using shell syntax, to specify sets of names).

Istarget Procedure

Tests for a particular target environment. If the currently configured target matches the argument string, the result is 1 ; otherwise the result is 0. target must be a full three-part configure target name; in particular, you may not use the shorter nicknames supported by configure (but you can use wildcard characters, using shell syntax, to specify sets of names). If it is passed a NULL string, then it returns the name of the build canonical configuration.

Isnative Procedure

Tests whether the current configuration has the same host and target. When it runs in a native configuration this procedure returns a 1; otherwise it returns a 0.

Unknown Procedure

Clone_output Procedure

Reset_vars Procedure

Log_and_exit Procedure

Log_summary Procedure

Cleanup Procedure

Setup_xfail Procedure

Declares that the test is expected to fail on a particular set of configurations. The config argument must be a list of full three-part configure target name; in particular, you may not use the shorter nicknames supported by configure (but you can use the common shell wildcard characters to specify sets of names). The bugid argument is optional, and used only in the logging file output; use it as a link to a bug-tracking system such as GNATS.

Once you use setup_xfail, the fail and pass procedures produce the messages XFAIL and XPASS respectively, allowing you to distinguish expected failures (and unexpected success!) from other test outcomes.

Warning you must clear the expected failure after using setup_xfail in a test case. Any call to pass or faill clears the expected failure implicitly; if the test has some other outcome, e.g. an error, you can call clear_xfail to clear the expected failure explicitly. Otherwise, the expected-failure declaration applies to whatever test runs next, leading to surprising results.

Record_test Procedure

Pass Procedure

Declares a test to have passed. pass writes in the log files a message beginning with PASS (or XPASS, if failure was expected), appending the argument string.

Fail Procedure

Declares a test to have failed. fail writes in the log files a message beginning with FAIL (or XFAIL, if failure was expected), appending the argument string.

Xpass Procedure

Declares a test to have unexpectably passed, when it was expected to be a failure. xpass writes in the log files a message beginning with XPASS (or XFAIL, if failure was expected), appending the argument string.

Xfail Procedure

Declares a test to have expectably failed. xfail writes in the log files a message beginning with XFAIL (or PASS, if success was expected), appending the argument string.

Set_warning_threshold Procedure

Sets the value of warning_threshold. A value of 0 disables it: calls to warning will not turn a PASS or FAIL into an UNRESOLVED.

Get_warning_threshold Procedure

Returns the current value of {warning_threshold. The default value is 3. This value controls how many warning procedures can be called before becoming UNRESOLVED.

Warning Procedure

Declares detection of a minor error in the test case itself. warning writes in the log files a message beginning with WARNING, appending the argument string. Use warning rather than perror for cases (such as communication failure to be followed by a retry) where the test case can recover from the error. If the optional number is supplied, then this is used to set the internal count of warnings to that value.

As a side effect, warning_threshold or more calls to warning in a single test case also changes the effect of the next pass or fail command: the test outcome becomes UNRESOLVED since an automatic PASS or FAIL may not be trustworthy after many warnings. If the optional numeric value is 0, then there are no further side effects to calling this function, and the following test outcome doesn't become UNRESOLVED. This can be used for errors with no known side effects.

Perror Procedure

Declares a severe error in the testing framework itself. perror writes in the log files a message beginning with ERROR, appending the argument string.

As a side effect, perror also changes the effect of the next pass or fail command: the test outcome becomes UNRESOLVED, since an automatic PASS or FAIL cannot be trusted after a severe error in the test framework. If the optional numeric value is 0, then there are no further side effects to calling this function, and the following test outcome doesn't become UNRESOLVED. This can be used for errors with no known side effects.

Note Procedure

Appends an informational message to the log file. note writes in the log files a message beginning with NOTE, appending the argument string. Use note sparingly. The verbose should be used for most such messages, but in cases where a message is needed in the log file regardless of the verbosity level use note.

Untested Procedure

Declares a test was not run. untested writes in the log file a message beginning with UNTESTED, appending the argument string. For example, you might use this in a dummy test whose only role is to record that a test does not yet exist for some feature.

Unresolved Procedure

Declares a test to have an unresolved outcome. unresolved writes in the log file a message beginning with UNRESOLVED, appending the argument string. This usually means the test did not execute as expected, and a human being must go over results to determine if it passed or failed (and to improve the test case).

Unsupported Procedure

Declares that a test case depends on some facility that does not exist in the testing environment. unsupported writes in the log file a message beginning with UNSUPPORTED, appending the argument string.

Init_testcounts Procedure

Incr_count Procedure

transform Procedure

Generates a string for the name of a tool as it was configured and installed, given its native name (as the argument toolname). This makes the assumption that all tools are installed using the same naming conventions: For example, for a cross compiler supporting the m68k-vxworks configuration, the result of transform gcc is m68k-vxworks-gcc.

Check_conditional_xfail Procedure

This procedure adds a conditional xfail, based on compiler options used to create a test case executable. If an include options is found in the compiler flags, and it's the right architecture, it'll trigger an XFAIL. Otherwise it'll produce an ordinary FAIL. You can also specify flags to exclude. This makes a result be a FAIL, even if the included options are found. To set the conditional, set the variable compiler_conditional_xfail_data to the fields

"[message string] [targets list] [includes
	  list] [excludes list]"

	  set compiler_conditional_xfail_data { \
	       "I sure wish I knew why this was hosed" \
               "sparc*-sun*-* *-pc-*-*" \
               {"-Wall -v" "-O3"} \
               {"-O1" "-Map"} \
          }
	  

What this does is it matches only for these two targets if "-Wall -v" or "-O3" is set, but neither "-O1" or "-Map" is set. For a set to match, the options specified are searched for independantly of each other, so a "-Wall -v" matches either "-Wall -v" or "-v -Wall". A space seperates the options in the string. Glob-style regular expressions are also permitted.

Clear_xfail Procedure

Cancel an expected failure (previously declared with setup_xfail) for a particular set of configurations. The config argument is a list of configuration target names. It is only necessary to call clear_xfail if a test case ends without calling either pass or fail, after calling setup_xfail.

Verbose Procedure

Test cases can use this function to issue helpful messages depending on the number of --verbose options on the runtest command line. It prints string if the value of the variable verbose is higher than or equal to the optional number. The default value for number is 1. Use the optional -log argument to cause string to always be added to the log file, even if it won't be printed. Use the optional -x argument to log the test results into a parsable XML file. Use the optional -n argument to print string without a trailing newline. Use the optional -- argument if string begins with "-".

Load_lib Procedure

Loads a DejaGnu library file by searching a fixed path built into DejaGnu. If DejaGnu has been installed, it looks in a path starting with the installed library directory. If you are running DejaGnu directly from a source directory, without first running make install, this path defaults to the current directory. In either case, it then looks in the current directory for a directory called lib. If there are duplicate definitions, the last one loaded takes precedence over the earlier ones.

Call_remote Procedure

Check_for_board_status Procedure

File_on_build Procedure

File_on_host Procedure

Local_exec Procedure

Remote_binary Procedure

Remote_close Procedure

Remote_download Procedure

Remote_exec Procedure

Remote_expect Procedure

Remote_file Procedure

Remote_ld Procedure

Remote_load Procedure

Remote_open Procedure

Remote_pop_conn Procedure

Remote_push_conn Procedure

Remote_raw_binary Procedure

Remote_raw_close Procedure

Remote_raw_file Procedure

remote_raw_ld Procedure

Remote_raw_load Procedure

Remote_raw_open Procedure

Remote_raw_send Procedure

Remote_raw_spawn Procedure

Remote_raw_transmit Procedure

Remote_raw_wait Procedure

Remote_reboot Procedure

Remote_send Procedure

Remote_spawn Procedure

Remote_swap_conn Procedure

Remote_transmit Procedure

Remote_upload Procedure

Remote_wait Procedure

Standard_close Procedure

Standard_download Procedure

Standard_exec Procedure

Standard_file Procedure

Standard_load Procedure

Standard_reboot Procedure

Standard_send Procedure

Standard_spawn Procedure

Standard_transmit Procedure

Standard_upload Procedure

Standard_wait Procedure

Unix_clean_filename Procedure

telnet Procedure

rsh Procedure

Tip Procedure

Kermit Procedure

kermit_open Procedure

Kermit_command Procedure

Kermit_send Procedure

Kermit_transmit Procedure

Telnet_open Procedure

Telnet_binary Procedure

Telnet_transmit Procedure

Tip_open Procedure

Rlogin_open Procedure

Rlogin_spawn Procedure

Rsh_open Procedure

Rsh_download Procedure

Rsh_upload Procedure

Rsh_exec Procedure

Ftp_open Procedure

Ftp_upload Procedure

Ftp_download Procedure

Ftp_close Procedure

Tip_download Procedure

Default_link Procedure

Default_target_assemble Procedure

default_target_compile Procedure

Pop_config Procedure

Prune_warnings Procedure

Push_build Procedure

push_config Procedure

Reboot_target Procedure

Target_assemble Procedure

Target_compile Procedure

Board_info Procedure

Host_info Procedure

Set_board_info Procedure

Set_currtarget_info Procedure

Target_info Procedure

Unset_board_info Procedure

Unset_currtarget_info Procedure

Push_target Procedure

This makes the target named name be the current target connection. The value of name is an index into the target_info array and is set in the global config file.

Pop_target Procedure

This unsets the current target connection.

List_targets Procedure

This lists all the supported targets for this architecture.

Push_host Procedure

This makes the host named name be the current remote host connection. The value of name is an index into the target_info array and is set in the global config file.

Pop_host Procedure

This unsets the current host connection.

Compile Procedure

This invokes the compiler as set by CC to compile the file file. The default options for many cross compilation targets are guessed by DejaGnu, and these options can be added to by passing in more parameters as arguments to compile. Optionally, this will also use the value of the cflags field in the target config array. If the host is not the same as the build machines, then then compiler is run on the remote host using execute_anywhere.

Archive Procedure

This produces an archive file. Any parameters passed to archive are used in addition to the default flags. Optionally, this will also use the value of the arflags field in the target config array. If the host is not the same as the build machines, then then archiver is run on the remote host using execute_anywhere.

Ranlib Procedure

This generates an index for the archive file for systems that aren't POSIX yet. Any parameters passed to ranlib are used in for the flags.

Execute_anywhere Procedure

This executes the cmdline on the proper host. This should be used as a replacement for the Tcl command exec as this version utilizes the target config info to execute this command on the build machine or a remote host. All config information for the remote host must be setup to have this command work. If this is a canadian cross, (where we test a cross compiler that runs on a different host then where DejaGnu is running) then a connection is made to the remote host and the command is executed there. It returns either REMOTERROR (for an error) or the output produced when the command was executed. This is used for running the tool to be tested, not a test case.

${tool}_start Procedure

Starts a particular tool. For an interactive tool, ${tool}_start starts and initializes the tool, leaving the tool up and running for the test cases; an example is gdb_start, the start function for GDB. For a batch oriented tool, ${tool}_start is optional; the recommended convention is to let ${tool}_start run the tool, leaving the output in a variable called comp_output. Test scripts can then analyze $comp_output to determine the test results. An example of this second kind of start function is gcc_start, the start function for GCC.

DejaGnu itself does not call ${tool}_start. The initialization module ${tool}_init.exp must call ${tool}_start for interactive tools; for batch-oriented tools, each individual test script calls ${tool}_start (or makes other arrangements to run the tool).

${tool}_load Procedure

Loads something into a tool. For an interactive tool, this conditions the tool for a particular test case; for example, gdb_load loads a new executable file into the debugger. For batch oriented tools, ${tool}_load may do nothing---though, for example, the GCC support uses gcc_load to load and run a binary on the target environment. Conventionally, ${tool}_load leaves the output of any program it runs in a variable called $exec_output. Writing ${tool}_load can be the most complex part of extending DejaGnu to a new tool or a new target, if it requires much communication coding or file downloading. Test scripts call ${tool}_load.

${tool}_exit Procedure

Cleans up (if necessary) before DejaGnu exits. For interactive tools, this usually ends the interactive session. You can also use ${tool}_exit to remove any temporary files left over from the tests. runtest calls ${tool}_exit.

${tool}_version Procedure

Prints the version label and number for ${tool}. This is called by the DejaGnu procedure that prints the final summary report. The output should consist of the full path name used for the tested tool, and its version number.

Getdirs Procedure

Returns a list of all the directories in the single directory a single directory that match an optional pattern.

Find Procedure

Search for files whose names match pattern (using shell wildcard characters for filename expansion). Search subdirectories recursively, starting at rootdir. The result is the list of files whose names match; if no files match, the result is empty. Filenames in the result include all intervening subdirectory names. If no files match the pattern, then a NULL string is returned.

Which Procedure

Searches the execution path for an executable file binary, like the the BSD which utility. This procedure uses the shell environment variable PATH. It returns 0 if the binary is not in the path, or if there is no PATH environment variable. If binary is in the path, it returns the full path to binary.

Grep Procedure

Search the file called filename (a fully specified path) for lines that contain a match for regular expression regexp. The result is a list of all the lines that match. If no lines match, the result is an empty string. Specify regexp using the standard regular expression style used by the Unix utility program grep.

Use the optional third argument line to start lines in the result with the line number in filename. (This argument is simply an option flag; type it just as shown --line.)

Prune Procedure

Remove elements of the Tcl list list. Elements are fields delimited by spaces. The result is a copy of list, without any elements that match pattern. You can use the common shell wildcard characters to specify the pattern.

Slay Procedure

This look in the process table for name and send it a unix SIGINT, killing the process. This will only work under Windows if you have Cygwin or another Unix subsystem for Windows installed.

Absolute Procedure

This procedure takes the relative path, and converts it to an absolute path.

Psource Procedure

This sources the file filename, and traps all errors. It also ignores all extraneous output. If there was an error it returns a 1, otherwise it returns a 0.

Runtest_file_p Procedure

Search runtests for testcase and return 1 if found, 0 if not. runtests is a list of two elements. The first is a copy of what was on the right side of the = if

foo.exp="..."

Diff Procedure

Compares the two files and returns a 1 if they match, or a 0 if they don't. If verbose is set, then it'll print the differences to the screen.

Setenv Procedure

Sets the environment variable var to the value val.

unsetenv Procedure

Unsets the environment variable var.

Getenv Procedure

Returns the value of var in the environment if it exists, otherwise it returns NULL.

Prune_system_crud Procedure

For system system, delete text the host or target operating system might issue that will interfere with pattern matching of program output in text. An example is the message that is printed if a shared library is out of date.

Libgloss_link_flags Procedure

Libgloss_include_flags Procedure

Newlib_link_flags Procedure

Newlib_include_flags Procedure

Libio_include_flags Procedure

Libio_link_flags Procedure

G++_include_flags Procedure

G++_link_flags Procedure

Libstdc++_include_flags Procedure

Libstdc++_link_flags Procedure

Get_multilibs Procedure

Find_binutils_prog Procedure

Find_gcc Procedure

Find_gcj Procedure

Find_g++ Procedure

Find_g77 Procedure

Process_multilib_options Procedure

Add_multilib_option Procedure

Find_gas Procedure

Find_ld Procedure

Build_wrapper Procedure

Winsup_include_flags Procedure

Winsup_link_flags Procedure

Dumpvars Procedure

This takes a csh style regular expression (glob rules) and prints the values of the global variable names that match. It is abbreviated as dv.

Dumplocals Procedure

This takes a csh style regular expression (glob rules) and prints the values of the local variable names that match. It is abbreviated as dl.

Dumprocs Procedure

This takes a csh style regular expression (glob rules) and prints the body of all procs that match. It is abbreviated as dp.

Dumpwatch Procedure

This takes a csh style regular expression (glob rules) and prints all the watchpoints. It is abbreviated as dw.

Watcharray Procedure

Watchvar Procedure

Watchunset Procedure

This breaks program execution when the variable var is unset. It is abbreviated as wu.

Watchwrite Procedure

This breaks program execution when the variable var is written. It is abbreviated as ww.

Watchread Procedure

This breaks program execution when the variable var is read. It is abbreviated as wr.

Watchdel Procedure

This deletes a the watchpoint from the watch list. It is abbreviated as wd.

Print Procedure

This prints the value of the variable var. It is abbreviated as p.

Quit Procedure

This makes runtest exit. It is abbreviated as q.