Data Driven Suites
This section describes using Sahi's inbuilt data driven suite mechanism.
Introduction
info
Sahi Pro provides support for Data Driven Suites from version v5.1 onwards.
Data Driven suites (also referred to as ddcsv) can be used to
- run scripts, suites, test_case csv and other data driven suites files
- pass arguments to functions defined in Sahi scripts
- tag scripts/suites and run selective scripts/suites based on those tags
- control the execution of scripts/suites/csv depends upon other scripts/suites/csv status
Structure
A | B | C | D | E | F | G | |
1 | #script | url | tags | depends | modes | Argument1 | Argument2 |
2 | ScriptName.sah | StartURL | "tag1,tag2" | Browser | Argument1_Value | Argument2_Value | |
3 | ScriptName1.sah | StartURL | "tag1,tag2" | ScriptName.sah | Windows | Argument1_Value | Argument2_Value |
Structure Explained
ddcsv can be used to run the same script file with different sets of arguments. eg. invalidLogin.sah in the example above.A | B | C | D | E | F | G | H | ||
1 | #script | url | tags | depends | modes | username | password | empId | Header Row |
2 | login.sah | http://sahi.co.in/demo/training/login.htm | user,high | Browser | test | secret | 12345 | ||
3 | invalidLogin.sah | http://sahi.co.in/demo/training/login.htm | user,medium | login.sah | Browser | test | s1234 | 46789 | |
4 | |||||||||
5 | #script | url | tags | username | password | Header Row | |||
6 | invalidLogin.sah | http://sahi.co.in/demo/training/login.htm | user,medium | aa | dd | ||||
7 | |||||||||
8 | #script | Header Row | |||||||
9 | scriptWithoutTags.sah | ||||||||
10 | |||||||||
11 | #script | tags | depends | Header Row | |||||
12 | ddcsvInsideddcsv.dd.csv | admin,high | |||||||
13 | ddcsv.dd.csv | user | ddcsvInsideddcsv.dd.csv | ||||||
14 | suiteInsideddcsv.suite | admin,high | PREV |
-
Header Rows give Sahi an outline format about the coming rows. They start with #script. There are 4 predefined header values.
#script Signifies a new header row. The value under this column header is the name of the Sahi script to be run. url The start URL for the script tags Specifies the tags applicable to this script depends Specifies the scripts/suites/csv to which this scripts/suites/csv to be depended modes Specifies the modes which are required to run the script. Start mode is considered as the required mode for all the script specified in a suite.
To explain line 2,
2 login.sah http://sahi.co.in/demo/training/login.htm user,high test secret 12345 login.sah
will be executed with start URLhttp://sahi.co.in/demo/training/login.htm
with variables$username = "test"; $password = "secret"; $empId = "12345";
-
For any script, if the argument name, number of arguments or the order of arguments needs to be changed,
a new
#script
row needs to be added to specify the intended change to Sahi. This can be seen in line number 5, 8 and 11. eg. In line 3,
A B C D E F G H 1 #script url tags depends modes username password empId Header Row 2 login.sah http://sahi.co.in/demo/training/login.htm user,high Browser test secret 12345 3 invalidLogin.sah http://sahi.co.in/demo/training/login.htm user,medium login.sah Browser test s1234 46789 4 5 #script url tags username password Header Row 6 invalidLogin.sah http://sahi.co.in/demo/training/login.htm user,medium aa dd -
In line 9,
8 #script Header Row 9 scriptWithoutTags.sah -
Suites, test_case csv, and other data driven suites can also be invoked from dd.csv file. This is shown in above table (rows 11-14).
11 #script tags depends Header Row 12 ddcsvInsideddcsv.dd.csv admin,high 13 ddcsv.dd.csv user ddcsvInsideddcsv.dd.csv 14 suiteInsideddcsv.suite admin,high PREV -
tags
,url
,depends
,modes
and any variables passed to a ddcsv file get cascaded to all ddcsvs and scripts inside it. For example, all scripts/ddcsvs insideddcsvInsideddcsv.dd.csv
will also be assignedadmin
andhigh
tags -
depends
is used to specify the name of the scripts/suites/csv to which the current script/suite/csv is depended. The current script/suite/csv will start execute only if all the depended scripts/suites/csv have executed successfully. If any of the depended scripts/suites/csv is FAILED or ABORTED or SKIPPED the current script will be moved to SKIPPED status.PREV
command can be used instead of mentioning the immediate previous script/suite/csv name.
Consider lines 12, 13 and 14, the ddcsvInsideddcsv.dd.csv mentioned under depends column in line 13 indicate that the ddcsv.dd.csv is depended on ddcsvInsideddcsv.dd.csv. So ddcsv.dd.csv will wait for the completion of ddcsvInsideddcsv.dd.csv and will start execution only if the status is SUCCESS. If any of the scripts inside ddcsvInsideddcsv.dd.csv is FAILED or ABORTED, ddcsv.dd.csv will not get executed and labeled as SKIPPED status. ThePREV
command in the line 14 refers to ddcsv.dd.csv if the main suite execute with no tags. If the status of ddcsv.dd.csv suite is SKIPPED, the suiteInsideddcsv.suite also will be moved to SKIPPED status. If the main suite is executed with admin or high tag, thePREV
command will be referred to ddcsvInsideddcsv.dd.csv as the ddcsv.dd.csv will not be considered for execution due to the tags mismatch. -
modes
is used to specify the requirement of the script. In distributed playback, script will be run on that node only in which all the specified modes are supported.
Consider lines 2, login.sah requiresBROWSER
mode to run the script.//specify multiple modes for a particular script. Browser,Android
11 #script tags modes Header Row 12 login.sah admin,high Browser,Android //specify multiple modes with the instances for a particular script. //here Android mode requires 2 device instances. Browser,Android:2
11 #script tags modes Header Row 12 login.sah admin,high Browser,Android:2 //specify multiple browsers with the instances for a particular script. //here script requires 1 chrome instance and 2 firefox instances. chrome,firefox:2
11 #script tags modes Header Row 12 login.sah admin,high chrome:1,firefox:2
Data Driven Suites with testcases
warning
This feature was added to facilitate playback of only failed scenarios when running a failed scripts suite.
The
From Sahi Pro V6.2.0 onwards, along with three predefined header values (#script, url, tags) the testcases
column is automatically added to the failed scripts suite.
It should not ideally be added or modified by testers in their original suites.
testcases
header is also recognized.
Only those testcases which are specified in this column will run during playback.
For example,
test.dd.csv
is a data driven suite.
#script | url | tags | testcases |
scenario.s.csv | http://sahitest.com/demo/ | auth | testLoginLogout |
another.s.csv | http://sahitest.com/demo/ | admin |
Here's how
scenario.s.csv
looks like.
Comment | Tags | TestCase | Keyword | Argument1 | Argument2 | Argument3 |
loadSahi | sample_lib.sah | |||||
Simple test for adding books and verifying total | auth,bookspage | checkShoppingCartTotal | [Documentation] | Smoke test | ||
login | test | secret | ||||
addBooks | 3 | 2 | 1 | |||
verifyTotal | 1650 | |||||
logout | ||||||
Test for login logout | auth | testLoginLogout | [Documentation] | Check Invalid | ||
login | test | bad password | ||||
logout |
testLoginLogout
testcase will be run when the above test.dd.csv
is executed. No other scripts or scenario files or testcases will be run.
infoIn scenario file, the column is
TestCase
while in the data driven suite the column header is testcases
warningSpecifying
testcases
will cause the tags
attribute to be ignored.
Testcases will run even if the tags are not matched.
Running Data Driven Suites
Data Driven Suites are run the same way as normal suites. They can be run from command prompt using testrunner or drun or ant the same way as .suite files are run. The steps to run a dd.csv file are mentioned below.- Open cmd prompt by clicking on the "bin" link on "Sahi Dashboard".
- Run the following cmd
or for distributed run:testrunner demo/ddcsv/test.dd.csv http://sahi.co.in/demo/ ie "admin||medium"
drun demo/ddcsv/test.dd.csv http://sahi.co.in/demo/ ie "admin||medium"
The parameters passed in the above commands are explained below:
demo/ddcsv/test.dd.csv path and file name of Data Driven Suite http://sahi.co.in/demo/ Start URL ie browser on which the scripts will run "admin||medium" This specifies the tags and hence the scripts that need to be run. Here scipts on line 3,6,12,14 will run.
Variable $isDataPassed and _isDataPassed()
Along with user defined variables, Sahi passes a variable named$isDataPassed
to the script with value true
if user variables are passed to script.
$isDataPassed
is useful during development of scripts which take arguments.
When scripts are played back from Sahi Controller, arguments can not be passed to the script file.
In such cases, default values of variables can be defined as given below.
if(typeof $isDataPassed == "undefined"){
// entered if executed from Controller
// NOT entered if run from dd.csv
$username = "default_name";
$password = "default_pwd";
}
// or
if(!_isDataPassed()){
// entered if executed from Controller
// NOT entered if run from dd.csv
$username = "default_name";
$password = "default_pwd";
}
A script with the above code behaves thus:
- if it is run from the Controller,
$isDataPassed
will beundefined
and_isDataPassed()
will returnfalse
. So theif
block will be executed and$username
and$password
will be assigned"default_name"
and"default_pwd"
respectively. - if it is run from a
dd.csv
file,$isDataPassed
and_isDataPassed()
will betrue
. So theif
block will not be executed.