_setMode([$applicationType])

Sahi Pro Flowcharts Action :Set Mode

Details

_setMode tells the script to start executing further steps on a different mode (application type). Look at Sahi Pro multiple modes for available modes.

_setMode("BROWSER"); // Further steps in script will be sent to browser.
_setMode("WINDOWS"); // Further steps in script will be sent to Windows applications.

_wait($timeout[, $condition])

Sahi Pro Flowcharts Action :Wait

Details

Forces script to wait for given time or given condition to be true, which ever comes first

_wait(1000); // Will stop execution for a second

// Wait till div by id "ajaxConfirm" is populated for max 5 seconds.
_wait(5000, _getText(_div("ajaxConfirm"))!="");

// Wait till button becomes visible
_wait(5000, _isVisible(_button("Confirm")));

// Wait till "Loading ..." message disappears
_wait(1000); // may take a second before that message appears.
_wait(5000, !_isVisible(_div("Loading ..."))); // wait max 5 seconds for it to disappear.

_setXHRReadyStatesToWaitFor($readyStates[, $forURL])

Sahi Pro Flowcharts Action :Set XHR Ready States To Wait For

Details

Sets what readyStates of an XMLHttpRequest (XHR) Sahi should wait for. Sahi normally monitors all AJAX requests and proceeds only if the XHR readyState is 4. In some applications which use long polling or comet requests, there may be XHRs in readyState 1. Sahi would wait for a long time and then timeout in such cases.

//Setting _setXHRReadyStatesToWaitFor to "2,3" will allow Sahi to proceed if the readyStates are either 1 or 4.
_setXHRReadyStatesToWaitFor("2,3");

//Setting _setXHRReadyStatesToWaitFor to "1,2,3" for the window URL that matches regular expression /formTest/.
_setXHRReadyStatesToWaitFor("1,2,3","/formTest/");

_byPassWaitMechanism($enable[, $url[, $urlType]])

Sahi Pro Flowcharts Action :By Pass Wait Mechanism

Details

Sahi Pro automatically waits for page loads and ajax activity. To achieve this, Sahi Pro monitors the URL requests triggered from your application using Javascript's Fetch API as well as XMLHttpRequest(XHR).

When $enable parameter is set to true, Sahi Pro's automatic waiting mechanism will not be used. It will be bypassed. To stop bypassing the waiting mechanism, set this parameter to false again.

// Below step will bypass all the URL requests
_byPassWaitMechanism(true);

When $enable parameter is set to true, all the URL requests will be bypassed. To bypass only a specific URL, specify them using the parameter $url.

// Below step will bypass URLs that contain the string 'connect'
_byPassWaitMechanism(true, "/connect/");

Your application may trigger URLs using Javascript's Fetch API as well as XMLHttpRequest(XHR). Thus, these URL requests can be termed to be of type 'fetch' or 'xhr'. Type of a URL request can be observed from the network logs in the browser's Developer Tools.
Parameters $url and $urlType can be used together to bypass a specific url of the specified type as shown in the example below.

// Below step will bypass URLs of type 'fetch' that contain the string 'ping'
_byPassWaitMechanism(true, "/ping/", "fetch");

Sample Script:

// Example 1
//start bypassing wait mechanism
_byPassWaitMechanism(true);

_setValue(_textbox("user"), "test");
_setValue(_password("pass"), "secret");
_click(_button("Login"));

//stop bypassing wait mechanism
_byPassWaitMechanism(false);

// Example 2
//start bypassing wait mechanism but ignore only specific URLs
_byPassWaitMechanism(true, "/formTest/");
_byPassWaitMechanism(true, "/connect/", "xhr");

_setValue(_textbox("user"), "test");
_setValue(_password("pass"), "secret");
_click(_button("Login"));

//stop bypassing wait mechanism
_byPassWaitMechanism(false);

_setWaitTimes($windowLoadTime, $ajaxLoadTime, $flexLoadTime)

Sahi Pro Flowcharts Action :Set Wait Times

Details

Modify the Windows, AJAX and Flex wait times. Sahi will wait for the specified time after start of every step, following which it will move on to execute the next step, even if the activity(page/ajax/flex) is under execution. Pass the value as null to keep the last defined wait time.

_setWaitTimes(5000, 0, 0);
_navigateTo("http://sahi.co.in/demo/training/");//Sahi will wait for 5000ms following this step to load the page.
//If the page is not loaded within 5000ms, the execution will go to next step.
_click(_submit("Login"));
_setWaitTimes(null, 7000, 0);//Sahi will not wait for flex loads if any. It will wait for 7000ms for any AJAX activity and 5000ms for page load
//following this step before moving to next step.

_setStrictVisibilityCheck($doCheck[, $checkZIndex[, $doScroll]])

Sahi Pro Flowcharts Action :Set Strict Visibility Check

Details

Use _setStrictVisibilityCheck with parameter $doCheck as true to strictly look for only visible elements and ignore elements which are not visible.

// make Sahi ignore elements which are not visible.
// do operations on visible elements ...
_setStrictVisibilityCheck(true); //doesn't check z-index

_setStrictVisibilityCheck(true, true);   //checks z-index
_assertExists(_textbox("textbox_id"));

_setStrictVisibilityCheck(true, true,true); //checks z-index after scrolling
_assertExists(_textbox("textbox_id"));


// make sahi revert to original behavior of considering all elements in the DOM.
_setStrictVisibilityCheck(false);

_setAutomaticBlur($enable)

Sahi Pro Flowcharts Action :Set Automatic Blur

Details

When an action(like click, type, etc.) is performed on a HTML element, the focus gets removed from the previously focused element. Similarly, when a action (like _click, _setValue, etc.) is performed on a HTML element, Sahi Pro by default triggers a blur event on the previously focused element to remove focus from it. However, this behaviour may not be desired for some HTML elements. In such cases, disable this automatic blur using _setAutomaticBlur API.

// make Sahi to stop automatic blur.
_setAutomaticBlur(false);

_setValue(_textbox("category"), "Automation"); // for this automatic blur is not desired.

// make Sahi revert to original behavior of automatic blur.
_setAutomaticBlur(true);

_setSpeed($speed)

Sahi Pro Flowcharts Action :Set Speed

Details

Sets the speed of execution of steps.

_setSpeed(2000);
//Each step will execute with a gap of 2000 milliseconds (2 seconds).
//Default execution speed is 100ms;

_setPingDelayAfterStep($delay)

Sahi Pro Flowcharts Action :Set Ping Delay After Step

Details

Sahi Pro continuously pings the proxy server to await commands. In some very rare cases, it may be required to silence all ping activity after execution of a step (For example, if you are monitoring CPU or browser usage statistics after a step). In such case, calling _setPingDelayAfterStep will disable pinging for the given delay time.

_setPingDelayAfterStep(5000);
_click(_link("Link Test")); // pinging will stop for 5000 ms after this step
_click(_link("Back")); // pinging will stop for 5000 ms after this step
_setPingDelayAfterStep(0);
_click(_link("Abc"));  // Normal pinging will resume.

_stopOnError()

Sahi Pro Flowcharts Action :Stop On Error

Details

Forces script to fail and abort on any error. Further steps will not be executed. This is the default behaviour of Sahi.

_stopOnError();

_continueOnError()

Sahi Pro Flowcharts Action :Continue On Error

Details

Forces script to continue inspite of error. Further steps will be executed.

_continueOnError();

_runUnitTests([$testsArray])

Details

Executes all functions whose name starts with "test". If testsArray is specified, runs only tests in that array. If functions setUp() and tearDown() are defined, they are executed before and after each test, irrespective of errors in the test functions.

function setUp(){
  _log("In setUp");
}
function tearDown(){
  _log("In tearDown");
}
function testAddition() {
  _assertEqual(3, 1+2);
}
function testSubtraction() {
  _assertEqual(3, 5-2);
}
function testMultiplication() {
  _assertEqual(8, 2*4);
}
// Invoke all tests:
_runUnitTests();

// Invoke only testAddition and testMultiplication
// Use this for debugging when you are fixing just one test
// and don't want to run all the tests.
_runUnitTests(["testAddition", "testMultiplication"]);

_fail([$message])

Sahi Pro Flowcharts Action :Fail

Details

Causes a script to stop as a failure and log the given message. Can be used in the middle of a script.

_stop()

Sahi Pro Flowcharts Action :Stop

Details

Causes a script to stop execution.

_stopTestCase([$message])

Details

Causes a scenario file to stop execution of a testcase. When called from inside a testcase in a scenario file, that particular testcase execution will be stopped. Execution will proceed to the next testcase.

_lock($name[, $timeout])

Sahi Pro Flowcharts Action :Lock

Details

Acquires a lock with given name. If another script calls _lock with the same name, that script will wait till this lock is unlocked or till timeout happens. If timeout is not specified, the default timeout defined by sahi.lock.timeout property in sahi.properties is used. (Default is 60 seconds. Can be overridden in userdata.properties)

If you wish to lock a portion of code that deals with browser windows, example: focusing a window and taking a screenshot or focusing a window and doing file uploads, use _lockWindow instead of _lock. For example usage, refer to the _lockWindow example below. Use _lock and _unlock for functionality other than dealing with windows.

_unlock($key)

Sahi Pro Flowcharts Action :Unlock

Details

Unlocks or releases the lock (acquired through the _lock API) that matches the given key.

_lockWindow([$timeout])

Sahi Pro Flowcharts Action :Lock Window

Details



This is a more specific version of the _lock API.

Acquires a lock with a name internal to Sahi. The same lock is used by Sahi when launching new browser windows.

If another script calls _lockWindow, that script will wait till this _lockWindow is unlocked or till timeout happens. If timeout is not specified, the default timeout defined by sahi.lock.timeout property in sahi.properties is used. (Default is 60 seconds. Can be overridden in userdata.properties)

_unlockWindow()

Sahi Pro Flowcharts Action :Unlock Window

Details

Unlocks or releases the lock acquired by calling _lockWindow.

Used in conjunction with _lockWindow.

onScriptFailure($exception)

Details

This is a callback function. It needs to be implemented by the tester. It is called whenever an assertion failure occurs in the script. $exception is the actual exception that Sahi threw. Can be used with _logException and _logExceptionAsFailure. $exception added since Sahi Pro V4.3

onScriptError($exception)

Details

This is a callback function. It needs to be implemented by the tester. It is called whenever an error occurs in the script. $exception is the actual exception that Sahi threw. Can be used with _logException and _logExceptionAsFailure. If the function returns true, the script will continue to execute. Default is false.

onScriptEnd()

Details

This is a callback function. It needs to be implemented by the tester. It is called at the end of a script (even if there are errors in the script and the script stops in the middle).

onBeforeStep($step, $debugInfo)

Details

This is a callback function. It needs to be implemented by the tester. It is called before every step in the script.

onAfterStep($step, $debugInfo, $status)

Details

This is a callback function. It needs to be implemented by the tester. It is called after every step in the script.