DejaGnu provides these Tcl procedures.
open_logs();close_logs();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.
isbuild(pattern);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.
is3way();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).
ishost(pattern);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.
istarget(args);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.
isnative();reset_vars();log_and_exit();cleanup();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 |
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. |
setup_xfail(config
bugid);The config triplet to trigger whether this is an unexpected or expect failure.
The optional bugid, used to tie it this test case to a bug tracking system.
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.
pass(string);The string to use for this PASS message.
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.
fail(string);The string to use for this FAIL message.
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.
xpass(string);The string to use for this output state.
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.
xpass(string);The string to use for this output state.
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.
set_warning_threshold(threshold);This is the value of the new warning threshold.
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.
get_warning_threshold();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.
warning(string
number
);The optional number to set the error counter. Thius is only used to fake out the counter when using the xfail procedure to control when it flips the output over to UNRESOLVED state.
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.
perror(string
number
);The optional number to set the error counter. Thius is only used to fake out the counter when using the xfail procedure to control when it flips the output over to UNRESOLVED state.
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.
note(string);The string to use for this note.
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.
untested(string);The string to use for this output state.
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).
unresolved(string);The string to use for this output state.
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.
unsupported(string);The string to use for this output state.
init_testcounts();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.
transform(toolname);The name of the cross-development program to transform.
This procedure adds a condition 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]" |
check_conditional_xfail(message
targets
includes
excludes);This is the message to print with the normal test result.
This is a string with the list targets to activate this conditional on.
This is a list of sets of options to search for in the compiler options to activate this conditional. If any set of the options matches, then this conditional is true.
This is a list of sets of options to search for in the compiler options to activate this conditional. If any set of the options matches, (regardless of whether any of the include sets match) then this conditional is de-activated.
Example 6-1. Specifying the conditional xfail data
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.
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.
clear_xfail(config);The configuration triplets to clear.
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 -n argument to print string without a trailing newline. Use the optional -- argument if string begins with "-".
verbose(-log
-n
-r
string
number);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.
load_lib(filespec);The name of the DejaGnu library file to load.
lib/remote.exp defines these functions, for establishing and managing communications. Each of these procedures tries to establish the connection up to three times before returning. Warnings (if retries will continue) or errors (if the attempt is abandoned) report on communication failures. The result for any of these procedures is either -1, when the connection cannot be established, or the spawn ID returned by the Expect command spawn.
It use the value of the connect field in the target_info array (was connectmode as the type of connection to make. Current supported connection types are tip, kermit, telnet, rsh, rlogin, and netdata. If the --reboot option was used on the runtest command line, then the target is rebooted before the connection is made.
remote_close(shellid);This is the value returned by a call to remote_open. This closes the connection to the target so resources can be used by others. This parameter can be left off if the fileid field in the target_info array is set.
remote_open(type);This is passed host or target. Host or target refers to whether it is a connection to a remote target, or a remote host. This opens the connection to the desired target or host using the default values in the configuration system. It returns that spawn_id of the process that manages the connection. This value can be used in Expect or exp_send statements, or passed to other procedures that need the connection process's id. This also sets the fileid field in the target_info array.
telnet, rsh, tip, kermit
rsh(hostname);This refers to the IP address or name (for example, an entry in /etc/hosts) for this target. The procedure names reflect the Unix utility used to establish a connection. The optional port is used to specify the IP port number. The value of the netport field in the target_info array is used. (was $netport) This value has two parts, the hostname and the port number, seperated by a :. If host or target is used in the hostname field, than the config array is used for all information.
tip(port);Connect using the Unix utility tip. Portmust be a name from the tip configuration file /etc/remote. Often, this is called hardwire, or something like ttya. This file holds all the configuration data for the serial port. The value of the serial field in the target_info array is used. (was $serialport) If host or target is used in the port field, than the config array is used for all information. the config array is used for all information.
kermit(port
bps);Connect using the program kermit. Port is the device name, e.g. /dev/ttyb.
bps is the line speed to use (in its per second) for the connection. The value of the serial field in the target_info array is used. (was $serialport) If host or target is used in the port field, than the config array is used for all information. the config array is used for all information.
tip_download(spawnid
file);Download file to the process spawnid (the value returned when the connection was established), using the ~put command under tip. Most often used for single board computers that require downloading programs in ASCII S-records. Returns 1 if an error occurs, 0 otherwise.
This is the filename to downlaod.
default_target_compile(source
destfile
type
options);reboot_target();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.
push_target(name);The name of the target to make current connection.
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.
push_host(name);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.
compile(file);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.
archive(file);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.
ranlib(file);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.
execute_anywhere(cmdline);Each combination of target and tool requires some target-dependent procedures. The names of these procedures have a common form: the tool name, followed by an underbar _, and finally a suffix describing the procedure's purpose. For example, a procedure to extract the version from GDB is called gdb_version.
runtest itself calls only two of these procedures, ${tool}_exit and ${tool}_version; these procedures use no arguments.
The other two procedures, ${tool}_start and ${tool}_load}, are only called by the test suites themselves (or by testsuite-specific initialization code); they may take arguments or not, depending on the conventions used within each test suite.
The usual convention for return codes from any of these procedures (although it is not required by runtest) is to return 0 if the procedure succeeded, 1 if it failed, and -1 if there was a communication error.
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}_start();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}_load();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}_exit();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.
${tool}_version();Returns a list of all the directories in the single directory a single directory that match an optional pattern.
getdirs(rootdir
pattern);If you do not specify pattern, Getdirs assumes a default pattern of *. You may use the common shell wildcard characters in the pattern. If no directories match the pattern, then a NULL string is returned
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.
find(rootdir
pattern);The top level directory to search the search from.
A csh "glob" style regular expression reprsenting the files to find.
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.
which(file);The executable program or shell script to look for.
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.)
grep(filename
regexp
--line);The file to search.
The Unix style regular expression (as used by the grep Unix utility) to search for.
Prefix the line number to each line where the regexp matches.
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.
prune(list
pattern);A Tcl list containing the original data. Commonly this is the output of a batch executed command, like running a compiler.
The csh shell "glob" style pattern to search for.
This look in the process table for name and send it a unix SIGINT, killing the process. This will only work under NT if you have Cygwin or another Unix system for NT installed.
slay(name);The name of the program to kill.
This procedure takes the relative path, and converts it to an absolute path.
absolute(path);The path to convert.
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.
psource(file);The filename to Tcl script to source.
Search runtests for testcase and return 1 if found, 0 if not. runtests is a list of two elements. The first is the pathname of the testsuite expect script running. The second is a copy of what was on the right side of the = if
foo.exp="..." |
runtest_file_p(runtests
testcase);The pathname of the testsuite expect script running
The test case filename.
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.
diff(file_1
file_2);The first file to compare.
The second file to compare.
Sets the environment variable var to the value val.
setenv(var
val);The environment variable to set.
The value to set the variable to.
Unsets the environment variable var.
unsetenv(var);The environment variable to unset.
Returns the value of var in the environment if it exists, otherwise it returns NULL.
getenv(var);The environment variable to get the value of.
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.
prune_system_crud(system
test);The system error messages to look for to screen out .
The Tcl variable containing the text.
Libgloss is a free BSP (Board Support Package) commonly used with GCC and G++ to produce a fully linked executable image for an embedded systems.
find_gcc();find_gcj();find_g++();find_g77();find_gas();find_ld();lib/debugger.expdefines these utility procedures:
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.
dumpvars(vars);The variables to dump.
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.
dumplocals(args);This takes a csh style regular expression (glob rules) and prints the body of all procs that match. It is abbreviated as dp.
dumprocs(pattern);The csh "glob" style pattern to look for.
This takes a csh style regular expression (glob rules) and prints all the watchpoints. It is abbreviated as dw.
dumpwatch(pattern);The csh "glob" style pattern to look for.
This breaks program execution when the variable var is unset. It is abbreviated as wu.
watchunset(arg);This breaks program execution when the variable var is written. It is abbreviated as ww.
watchwrite(var);The variable to watch.
This breaks program execution when the variable var is read. It is abbreviated as wr.
watchread(var);The variable to watch.
This deletes a the watchpoint from the watch list. It is abbreviated as wd.
watchdel(args);