Include APIs
To reuse a function from one script in another, we include the relevant script using the include APIs.
You may also like to see Including Sahi script globally
You may also like to see Including Sahi script globally
Includes the script at scriptPath in the current script.
Include is dynamically evaluated since Sahi Pro V5.0.
infoNOTE: Kindly do not pass variable in Include(), it will fail in distributed (multiple machines) run.
Parameters
| $scriptPath | string | File path of sahi script.
If scriptPath is a relative path, it is evaluated relative to including scripts's path.
File path of sahi script.
If scriptPath is a relative path, it is evaluated relative to files folder of the current project. |
Return Value
Modes Supported :
Raw Script
// Suppose the current script is in
// D:/sahi/userdata/scripts/sahitests/ folder
// include lib.sah located in the current script's directory
// D:/sahi/userdata/scripts/sahitests/lib.sah
_include("lib.sah"); // using relative path
// Include using full path
_include("D:/sahi/userdata/scripts/sahitests/lib.sah"); // using absolute path
// Use of back and front slashes
_include("D:\sahi\userdata\scripts\sahitests\lib.sah"); // WRONG
_include("D:/sahi/userdata/scripts/sahitests/lib.sah"); // CORRECT
_include("D:\\sahi\\userdata\\scripts\\sahitests\\lib.sah"); // CORRECT
// Include from a subfolder
// D:/sahi/userdata/scripts/sahitests/common/lib.sah
_include("common/lib.sah");
// Include from a parent's sub folder
// D:/sahi/userdata/scripts/common/lib.sah
_include("../common/lib.sah");
// Using a variable
var $includePath = "../common/lib.sah";
_include($includePath);
Sahi Pro Classic API :_include
Similar to _include but Include Once only includes the script once even when called multiple times.
This is useful in a scenario, where during development a single flow is broken into multiple scripts and each is developed and tested independently, and then included all together into one script.
This is useful in a scenario, where during development a single flow is broken into multiple scripts and each is developed and tested independently, and then included all together into one script.
infoNOTE: Kindly do not pass variable in Include Once(), it will fail in distributed (multiple machines) run.
Parameters
| $scriptPath | string | File path of sahi script.
If scriptPath is a relative path, it is evaluated relative to including scripts's path.
File path of sahi script.
If scriptPath is a relative path, it is evaluated relative to files folder of the current project. |
Return Value
Modes Supported :
Raw Script
_includeOnce("lib.sah"); // includes lib.sah
_includeOnce("lib.sah"); // second call. Will do nothing.
// For more details on usage, look at _include
Sahi Pro Classic API :_includeOnce
infoNOTE: $resourcePath was added Since Sahi Pro: 6.1.1. For old document Refer here
In a distributed run, only the participating scripts in the suite are zipped and sent over to the nodes.
Hence if your scripts refer to any resources like CSV files (through CSV APIs) or Excel files (through Excel APIs) or images etc, they have to be explicitly included in your scripts using the Resource API.
Use relative path for resources so that they can work on all the nodes.
In summary, any resource that your script uses (other than scripts themselves), needs to be included through Resource APIs.
info
Distributed runs involve multiple nodes and Sahi installation folders could be at different locations on these nodes. Hence it is advisable to use relative paths for resources, so that they are resolved correctly on all nodes.
Kindly do not pass variable in Resource(), it will fail in distributed run.
Kindly do not pass variable in Resource(), it will fail in distributed run.
Parameters
| $resourcePath | string | File path of the resource files such as image, excel, csv etc which are used inside script.
If resourcePath is a relative path, it is evaluated relative to the script that includes it. Can be folder path. Wildcard * is also supported. File path of the resource files such as image, excel, csv etc which are used inside script.
If resourcePath is a relative path, it is evaluated relative to the files folder of the current project. Can be folder path. Wildcard * is also supported. |
Return Value
Modes Supported :
Raw Script
// Some examples:
_resource("../excel/users.xlsx"); // Include excel file as resource.
var $data = _readExcelFile("../excel/users.xlsx");
Sahi Pro Classic API :_resource
- Creates a new instance of the Java Class and sets it into a presumed variable name.
Variable name will be in this format:
$<className>.<functionName>. First letter of the java class will be in lower case.
For example: If the class name isUserModule, instance variable name will be$userModule. - Using
"*", new instance is created for all the classes, defined inside the package.
Methods of these classes can be invoked using the presumed variable name.
Parameters
| $fullyQualifiedJavaClassName | string | Fully Qualified Java Class Name. |
Return Value
Modes Supported :
Raw Script
_importJava("demo.training.UserModule");
//using the instance variable, methods of that class can be invoked.
$userModule.login("test", "secret");
_importJava("demo.training.*");
//using the instance variable, methods of that class can be invoked.
$userModule.login("test", "secret");
Sahi Pro Classic API :_importJava
Load Java Instance returns the class instance.
Parameters
| $fullyQualifiedJavaClassName | string | Fully Qualified JavaClass Name. |
Return Value
| Object | instance variable to access methods of class. |
Modes Supported :
Raw Script
$userModuleInstance = _loadJavaInstance("demo.training.UserModule");
//using this instance variable, methods of that class can be invoked.
$userModuleInstance.login("test", "secret");
Sahi Pro Classic API :_loadJavaInstance