Instructs the probe to fail gracefully at the call of this command, providing a verbose fail reason.
rtcFail() 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 saught after.
This command will cause only the probe calling rtcFail() to fail. Other probes in the test will continue executing regularly.
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 not be affected if this probe fails
- See also rtcWarning() and rtcFailAll()