FrontPage 

Fuego 1.1 wiki

Login or create account

function report append in split format

NAME [edit section]

= NAME =
report_append

SYNOPSIS [edit section]

= SYNOPSIS =
 * report_append <test-command> [<log-filename>]

DESCRIPTION [edit section]

test_run function, to actually execute the test on the target.
= DESCRIPTION =
This function performs the indicated command on the target device, and
records it's output to the test log (appending it to the data already there).  This is commonly called
by a test's [[function_test_run|test_run]] function, to actually execute
the test on the target.
See Log files for a description of the test log on the target.
See [[Log files]] for a description of the test log on the target.
Note that the exit code from the command is preserved across the 'tee' used to capture the output from the command, and used with the 'exit' statement to have this be the return code from the 'report' operation.
Note that the exit code from the command is preserved across the 'tee' used
to capture the output from the command, and used with the 'exit' statement
to have this be the return code from the 'report' operation.

EXAMPLES [edit section]

= EXAMPLES =
FIXTHIS - need an example call for report_append

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
The arguments to this function are:
 * $1 - the command to execute on the target
 * $2 - (optional) the filename of the test log, on the target.  If this is not specified, the value $BOARD_TESTDIR/fuego.$TESTDIR/$TESTDIR.log is used.
The following variables are used: * FEUGO_HOME * TESTDIR
The following variables are used:
 * FEUGO_HOME
 * TESTDIR
These are used to construct the default test log filename on the target, if a log filename is not specified in the positional arguments.
These are used to construct the default test log filename on the target, if a
log filename is not specified in the positional arguments.

RETURN [edit section]

= RETURN =
Returns non-zero on error.

SOURCE [edit section]

= SOURCE =
Located in ''scripts/functions.sh''

SEE ALSO [edit section]

test_run, report
= SEE ALSO =
 * [[function_test_run|test_run]], [[function_report|report]]
TBWiki engine 1.8.3 by Tim Bird