STDLIB Testing Capture Function Reference

Index

_capture.assertion_failure

Captures the output of a command that is expected to fail.

  • STDLIB_TESTING_TRACEBACK_REGEX string keyword: A regex used to identify and remove traceback lines (default=”$’^([^:]+:[0-9]+|environment:[0-9]+):.+$’”).

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The captured output from the failing command.

Exit codes

  • 0: If the assertion failed as expected.

  • 1: If the assertion succeeded unexpectedly.

Output on stdout

  • The filtered output of the failing command.

Output on stderr

  • The error message if the assertion fails.

_capture.output

Captures the stdout and stderr of a command.

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The combined stdout and stderr from the command.

Exit codes

  • 0: If the output was captured successfully.

_capture.output_raw

Captures the stdout and stderr of a command (raw).

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The combined stdout and stderr from the command.

Exit codes

  • 0: If the command succeeded.

  • 1: If the command failed.

  • 126: If an invalid argument has been provided.

  • 127: If the wrong number of arguments were provided.

_capture.rc

Captures the return code of a command.

Arguments

  • (array): The command to execute.

Variables set

  • TEST_RC (integer): The return code from the command.

Exit codes

  • 0: If the return code was captured successfully.

_capture.stderr

Captures the stderr of a command.

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The captured stderr from the command.

Exit codes

  • 0: If the command succeeded.

  • 1: If the command failed.

  • 126: If an invalid argument has been provided.

  • 127: If the wrong number of arguments were provided.

_capture.stderr_raw

Captures the stderr of a command (raw).

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The captured stderr from the command.

Exit codes

  • 0: If the command succeeded.

  • 1: If the command failed.

  • 126: If an invalid argument has been provided.

  • 127: If the wrong number of arguments were provided.

_capture.stdout

Captures the stdout of a command.

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The captured stdout from the command.

Exit codes

  • 0: If the stdout was captured successfully.

_capture.stdout_raw

Captures the stdout of a command (raw).

Arguments

  • (array): The command to execute.

Variables set

  • TEST_OUTPUT (string): The captured stdout from the command.

Exit codes

  • 0: If the command succeeded.

  • 1: If the command failed.

  • 126: If an invalid argument has been provided.

  • 127: If the wrong number of arguments were provided.