Instructs the probe to fail gracefully and force failure on all other probes running the script, providing a verbose fail reason. This command will also cause all other probes to stop executing their script and fail (without collecting logs).
rtcFailAll() can be used to fail a running script at a given point in time and provide a textual explanation for the failure reason. This can be useful in functional tests where certain conditions are sought after.
Arguments
Name | Type | Description |
---|---|---|
reason | string | The failure reason to use. |
Notes
- The reason provided in the string will be used as the failure reason for the probe in the test result
- Other probes will be forced to fail, and not collect logs
- See also rtcWarning() and rtcFail()