Skip to content
Get Free Trial

Debug Helper Functions

Some functions are good for debugging Sahi scripts. They are mostly removed once debugging is done.

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_debug($message)

Arguments

NameTypeDescription
$messagestringMessage to write to Sahi console

Returns

null

Debug messages are written in the Sahi console and not in the test run reports. It is useful when correlating to messages appearing on the Sahi console.

// Example:
_debug("Current count is " + $i);
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_debugToErr($message)

Arguments

NameTypeDescription
$messagestringMessage to write to Sahi console error stream

Returns

null

Same as _debug, but prints to the error stream.

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_debugToFile($message, $filePath)

Arguments

NameTypeDescription
$messagestringMessage to write to file
$filePathstringPath to file. Relative path resolves relative to where Sahi's process is started from.

Returns

null

Prints the message into a file for debugging purposes.

Since
Sahi Pro 5.1.0
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_pause()

Arguments

NameTypeDescription
None

Returns

null

Runs the script till that point and pauses execution. Acts like a debugger breakpoint. The rest of the run can be controlled from the Controller with Step or Play buttons.

Since
Sahi Pro 3.5

Modes Browser

_alert($message)

Arguments

NameTypeDescription
$messagestringMessage to be alerted on browser.

Returns

null

Alerts the message on the browser. This allows a very handy, interactive way of debugging scripts.

//Example:
_alert("Current count is " + $i);
Since
Sahi Pro 3.5

Modes Browser

_confirm($message)

Arguments

NameTypeDescription
$messagestringMessage to confirm

Returns

null

Brings up a javascript confirm dialog with given message. Use only while debugging.

Since
Sahi Pro 3.5

Modes Browser

_prompt($message)

Arguments

NameTypeDescription
$messagestringMessage to prompt

Returns

null

Brings up a javascript prompt with given message. Use only while debugging.

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_highlight($element)

Arguments

NameTypeDescription
$elementHTML DOM elementElement to highlight

Returns

null

Highlights an element with a red border. Used for debugging purposes.