function assert has program

NAME [edit section]

assert_has_program

SYNOPSIS [edit section]

assert_has_program <program_name>

DESCRIPTION [edit section]

This function checks that the indicated program is present on the target board. It checks for the program in the directories specified by the PATH on the board. If the program is not found the currently running test is aborted, with a message indicating that the program is missing.

If this function is successful, it sets an environment variable with the path to the program. The variable name is the program name, in upper case, prefixed with the string 'PROGRAM_'.

For example, if the following call were made:

assert_has_program ls

and ls was found on the target board in the PATH (specifically, at /bin/ls), then assert_has_program would return success (0), and would set the shell environment variable PROGRAM_LS with the value '/bin/ls'.

The main purpose of this function is to check that auxiliary programs that are required by the test are present. Usually, calls to 'assert_has_program' will be put in the test_pre_check function of a test.

Use the function check_for_program to determine if a program is on the board, without aborting the job if it is not found.

EXAMPLES [edit section]

Here are some sample invocations:

    assert_has_program atq

If found, the environment variable PROGRAM_ATQ will be set, with the path on the target board where 'atq' is found.

    assert_has_program expect

If found, the environment variable PROGRAM_EXPECT will be set, with the path on the target board where 'expect' is found.

ENVIRONMENT and ARGUMENTS [edit section]

The positional arguments to assert_has_program are:

$1 - the filename of the program to check for the presence of

RETURN [edit section]

Returns non-zero on error.

PROGRAM_<prog_name> is set to the path on the target board where the program is found.

SOURCE [edit section]

Located in scripts/functions.sh