Introduction To Sahi Script

04 September 2020

Sahi Scripting Basics

Sahi script is JavaScript based. The parsed sahi script by sahi is fully valid javascript executed by rhino javascript engine. The constructs used in sahi script are given below. The constructs are the same as javascript except the $ used for the variables.

Statements:

Statements are normal lines of code. They end with a semicolon.

Eg:

_click(_link("Login"));

Variable Declaration: 

Syntax:

var $variableName = value;

All variables start with a $. The keyword var is used for local variables.

Comments:

 Syntax1:

// This is a single line comment

Syntax2:

/*

This is a multiline comment.

This has two lines

*/

If Statements:

Syntax:

if (condition) {

// statements

}

Eg:

// Comparing normal values

if ($username == "PartnerUser"){

  _click(_link("Partner Login"));

}

for loops:

 Syntax:

for (var $i=0; $i<$max; $i++){

// statements

}

While loops:

Syntax:

while (condition) {

// statements

}

Structuring Sahi Code

While recording gives us the low level steps to be performed on the browser, code needs to be restructured for better readability and maintainability. This section explains how to structure your code for effective but simple use of Sahi.

Functions:

Functions are the basic building blocks in your automation. Functions are used to club together multiple steps into one logical action.

Functions reduce code duplication and allow easier maintenance of scripts.

Syntax:

function functionName($parameter1, $parameter2) {

// statements

}

Some Basic Data Types and Data Structures

Data Types:

Most interactions with browsers require us to validate either string or integer data. Both these can be stored in regular javascript variables.

Data Structures:

Since we work with web UIs, Sahi’s need for data structures is fairly minimal. The few that are used are:

• Single Dimensional array:
  

  var $ar = ["Ram", "Sam", "Jam"];
  var $firstUser = $ar[0]; // returns "Ram"

• Two dimensional array:
  

  var $ar2d = [["Ram",18], ["Sam",20], ["Jam",25]];
  var $firstRow = $ar2d[0]; // returns ["Ram",18]
  var $firstUser = $firstRow[0] // returns "Ram"

• Associative Array:
  

  var $userInfo = {"name":"Ram", "age":"18"};
  var $userName = $userInfo["name"];
  var $userAge = $userInfo["age"];

Exception handling and Recovery

Try Catch:

For anticipated exceptions, one may use try catch blocks.

Syntax:

try{

// sahi statements

}catch($e){

// Corrective action

// Can print exact source of error in log

// Can throw the same or another exception

}

Corrective Action:

Syntax:

try{

  _click(_link("does not exist"));

}catch($e){

  _log("Exception occured"); // simple logging. no failure

  _click(_link("linkByHtml")); // Corrective action

}

🔊 Listen