function_log_this 

Fuego wiki

Login or create account

function log this

NAME [edit section]

log_this

SYNOPSIS [edit section]

  • log_this <test-command>

DESCRIPTION [edit section]

This function performs the indicated command on the host, inside the docker container, and records it's output. Ultimately, the output is places in the test log for this test. This function is commonly called by a test's test_run function, when it needs to record data for a test from a command on the host. To record data from a command run on the board, use report.

See Log files for a description of the test logs.

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 'log' operation.

EXAMPLES [edit section]

Here are some sample invocations:
        log_this "clitest ftc-tests"

ENVIRONMENT and ARGUMENTS [edit section]

The arguments to this function are:
  • $1 - the command to execute on the host

The following variables are used:

  • LOGDIR

RETURN [edit section]

Returns non-zero on error.

SOURCE [edit section]

Located in scripts/functions.sh

SEE ALSO [edit section]

TBWiki engine 1.8.2 by Tim Bird