Generic Automated Test Framework (GATF)
GATF is an automated test generator and acceptance testing framework. It provides multiple components namely the Test Generator, the Test Executor , the Config Tool and the Robotic Process Automation Tool
GATF Acceptance Test executor is data-type agnostic, which means that your testcases can be in any formats like XML, JSON or plain old CSV. Whereas the Test generator generates only XML files (so that even complex data structures can be supported within your testcases)
The primary goal of GATF is Automation with Simplicity.
Important features
- Robotic Process Automation
- Comparative Env Testing
- Concurrent User Testing
- Performance Testing
- Load Testing (API and UI both) [wrk, wrk2, vegeta, autocannon, embedded]
- UI Testing with seleasy language + seleasy debugger
- Reporting Engine
- Remote Agent for Distributed Load Testing
- Workflow Testing
- Data Source Integrations
- SQL
- MongoDB
- Files (XML/JSON/CSV/XLS/XLSX/ODT)
Test HTML Generator Plugin
You can also refer the test-html-generator-plugin home page if you want to generate HTML pages for all you REST endpoints automatically.
GATF Test Generator
The Test Generator plugin is responsible for generating test cases automatically by just looking at either,
- All your REST-full service classes annotated with JAX RS annotations (@Path...) or spring based Controller annotations (@RequestMapping..)
- All your soap based WSDL locations
The default format of the testcases is XML, but this can be overridden in the plugin configuration to either JSON or CSV. Moreover the generator is also able to generate POSTMAN collections while generating test cases with the help of a simple plugin configuration parameter. It also generates input request objects based on the API request parameters and also provides default object sets with random values.
Maven Configuration
<!-- Add jitpack artifact repositories for gatf dependencies -->
<pluginRepositories>
<pluginRepository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</pluginRepository>
</pluginRepositories>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<!-- Add the generator plugin which will be invoked during the test phase -->
<build>
<plugins>
<plugin>
<groupId>com.github.sumeetchhetri.gatf</groupId>
<artifactId>gatf-plugin</artifactId>
<version>1.0.6</version>
<executions>
<execution>
<id>gatf-rest-json-xml</id>
<configuration>
<testPaths>
<!-- The package name where all API's will be found -->
<testPath>com.pkg.services.*</testPath>
</testPaths>
<!-- If there is a URL prefix that gatf should know -->
<urlPrefix>api/rest</urlPrefix>
<!-- The type of input request formats (json/xml) -->
<requestDataType>json</requestDataType>
<!-- The type of ouput request formats (json/xml) -->
<responseDataType>json</responseDataType>
<!-- Are all API endpoints proected -->
<overrideSecure>true</overrideSecure>
<!-- Where do we generate the test cases -->
<resourcepath>${project.reporting.outputDirectory}/generated-rest-json-xml</resourcepath>
<!-- Do we also generate postman collections for the endpoints -->
<postmanCollectionVersion>2</postmanCollectionVersion>
<enabled>true</enabled>
</configuration>
<goals>
<goal>gatf-generator</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</body>
The generated test cases are outlined below assuming an imaginary Get user API, every API endpoint class will have a corresponding test case file (either json, xml or csv)
Testcase (XML)
<TestCase url="jsonapi/users/1" name="GetUser" method="GET" expectedResCode="200" expectedResContentType="application/json" skipTest="false" detailedLog="false" secure="false" soapBase="false">
<description>Get a user with id = 1</description>
<headers>
<entry>
<string>someheader</string>
<string>value</string>
</entry>
<entry>
<string>anotherheader</string>
<string>value</string>
</entry>
</headers>
<expectedNodes>
<string>id</string>
</expectedNodes>
</TestCase>
Best format for specifying all types of test cases
Testcase (JSON)
{
"url": "\/jsonapi\/users/1",
"name": "GetUser",
"method": "GET",
"description": "Get a user with id = 1",
"headers": {
"Content-Type": "application\/json"
},
"expectedResCode": 200,
"expectedResContentType": "application\/json",
"skipTest": false,
"expectedNodes": [
"id"
]
}
Better than CSV at represnting data but difficult to represent complex request/response content
Testcase (CSV)
#URL,NAME,HTTPMETHOD,DESCRIPTION,CONTENT,HEADERS,EXQUERYPART,EXPECTEDSTATUSCODE,EXPECTEDCONTTYPE,EXPECTEDCONT,EXPECTEDNODES,SKIPTEST,LOG,SECURE,SOAPBASE,SOAPPARAMVALUES,WSDLKEY,OPERATIONNM
jsonapi/users/1,GetUser,GET,Get a user with id = 1,,someheader:val|anotherheader:val,,200,application/json,,id,false,false,true
Simplest data format but cannot be used or complex request/response content
Direct Execution
For direct execution, we just need to specify a simple config.xml(any name .xml) file with the contents as follows,on the command line,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest -generator /workdir/path-to-gatf-gen-config.xml-file
Sample config.xml
<configuration>
<!--The package(s)/classes(s) to be scanned for JAX-RS annotations for generating testcases-->
<testPaths>
<testPath>com.sample.services.*</testPath>
</testPaths>
<!-- Whether a soap client/http client is used to execute SOAP tests
the useSoapClient, soapWsdlKeyPairs properties in the configuration are only
required if we want to generate testcases for SOAP endpoints as well -->
<useSoapClient>true</useSoapClient>
<!--The WSDL Key/Location pair, the WSDL location will be looked up to generate the possible soap testcases-->
<soapWsdlKeyPairs>
<soapWsdlKeyPair>AuthService,http://localhost:8080/soap/auth?wsdl</soapWsdlKeyPair>
<soapWsdlKeyPair>UserService,http://localhost:8080/soap/users?wsdl</soapWsdlKeyPair>
</soapWsdlKeyPairs>
<!--The REST API service URL suffix-->
<urlSuffix>_param=value</urlSuffix>
<!--The REST API service URL prefix-->
<urlPrefix>rest</urlPrefix>
<!--The request data type, when generating request entities-->
<requestDataType>json</requestDataType>
<!--The expected response data type-->
<responseDataType>json</responseDataType>
<!--The resource path where the testcases and wsdl-locations.csv will be generated-->
<resourcepath>src/test/resources/generated</resourcepath>
<!-- Generate postman collections for a given Postman Testcase version-->
<postmanCollectionVersion>2</postmanCollectionVersion>
<!-- The generated testcase format, can be either xml,json or csv -->
<testCaseFormat>xml</testCaseFormat>
<!--Whether this plugin is enabled-->
<enabled>true</enabled>
</configuration>
Lets see what the GATF Test Executor is,
GATF Test Executor
The GATF Test Executor module provides a consolidated testing tool for,
- Single Session Test case execution
- Performance Test case execution
- Scenario/Workflow based Test case execution
- Concurrent User Simulation
- Comparative Test case study against multiple environments
- Load (Distributed) Testing
It also provides the following,
- Pie charts for overall test status (Success/Failure reports)
- Line/Bar charts for overall performance results
- Detailed test case reports with comprehensive information about a test execution request/response
- Maven/Executable-Jar test case execution options
It uses a highly performant asynchronous http client library - async-http-client and hence achieves very good execution times.
GATF Test Data Providers
The GATF framework provides the option to integrate to multiple data sources for fetching test case data, which include the following,
- Any SQL compliant database
- MongoDB
- Files - CSV/JSON/XML
- Inline/Value based
- Custom Provider
- Random Value Provider
The framework provides automatic built-in providers for easy integration to the above mentioned data sources. But we can also define custom providers if required.
GATF Pre/Post Test Case Execution Hooks
The framework also provides the facility to plug in pre/post test case execution logic in order to control the test case execution flow, it provides 2 simple annotations,
- @PreTestCaseExecutionHook - Marks a method as a pre-test-case execution hook
- @PostTestCaseExecutionHook - Marks a method as a post-test-case execution hook
GATF Executor Configuration File
The complete configuration for the GATF executor framework is listed below, We just need to define a file with the contents below and configure it in maven or provide the path to the file to the executor executable to execute your test cases.
<gatf-execute-config>
<!-- Whether auto authentication support is enabled -->
<authEnabled>true</authEnabled>
<!-- Authentication token parameters - name(token), where to find it(json),
name(token) and usage of token in subsequent secure calls(query parameter) -->
<authExtractAuth>token,json,token,queryparam</authExtractAuth>
<!-- The authentication URL -->
<authUrl>api/rest/auth/loginh</authUrl>
<!-- The username and password parameters and their point of presence in the request -->
<authParamsDetails>username,header,password,header</authParamsDetails>
<!-- The environment base URL, all requests(authentication and other testcases)
having relative URL's will be using this URL as their base -->
<baseUrl>http://localhost:8080/sampleApp</baseUrl>
<!-- Whether the plugin is enabled -->
<enabled>true</enabled>
<!-- Where should the testcase execution reports be generated, default folder name is out -->
<outFilesDir>out</outFilesDir>
<!-- Where to find all the testcases(xml,json,csv files), default folder name is data -->
<testCaseDir>data</testCaseDir>
<!-- Whether HTTP compression is enabled, default true -->
<httpCompressionEnabled>true</httpCompressionEnabled>
<!-- The HTTP connection timeout, default 10000 (10sec), time in ms -->
<httpConnectionTimeout>100000</httpConnectionTimeout>
<!-- The HTTP request timeout, default 10000 (10sec), time in ms -->
<httpRequestTimeout>10000</httpRequestTimeout>
<!-- The plugin enables the use of pre/post testcase execution hooks,
with the help of the @PreTestCaseExecutionHook and @PostTestCaseExecutionHook annotations,
Custom logic can be written using these annotations for pre/post testcase execution control,
this parameter defines the pacakage to scan to find the custom defined java classes defining
the hooks using the annotation -->
<testCaseHooksPaths>
<testCaseHooksPath>com.*</testCaseHooksPath>
</testCaseHooksPaths>
<!-- The number of concurrent users to simulate, default 0 -->
<concurrentUserSimulationNum>1</concurrentUserSimulationNum>
<!-- The number of concurrent connections to the Base environment HTTP Server, default 1 -->
<numConcurrentExecutions>1</numConcurrentExecutions>\
<!-- The provider name that will be used to fetch user/password details for user credentials -->
<simulationUsersProviderName>file-auth-provider</simulationUsersProviderName>
<!-- Whether comparative analysis is enabled, if yes then the compareEnvBaseUrls property inside
gatfTestDataConfig element needs to define the multiple environments where a comparison
of test case executions is desired -->
<compareEnabled>false</compareEnabled>
<!-- Whether load testing is enabled -->
<loadTestingEnabled>false</loadTestingEnabled>
<!-- Load testing execution time, time in ms -->
<loadTestingTime>40000</loadTestingTime>
<!-- The concurrent user ramp up time during load testing, time in ms -->
<concurrentUserRampUpTime>500</concurrentUserRampUpTime>
<!-- The number of report samples to be generated during the load testing window -->
<loadTestingReportSamples>6</loadTestingReportSamples>
<!-- Whether debug logs are enabled or not -->
<debugEnabled>true</debugEnabled>
<!-- The WSDL Location file with the wsdl endpoints -->
<wsdlLocFile>wsdl-locations.csv</wsdlLocFile>
<!-- The test data configuration parameters including the global parameters, compare
environment URL's and the list of all the test data providers you may define-->
<gatfTestDataConfig>
<!-- The list of compare environment URL's -->
<compareEnvBaseUrls>
<string>http://localhost:8081/sampleApp</string>
</compareEnvBaseUrls>
<!-- The global parameter list -->
<globalVariables>
<gvar1>gvalue</gvar1>
</globalVariables>
<!-- The list of test data providers -->
<providerTestDataList>
<!-- The MongoDB test data provider -->
<gatf-testdata-provider>
<!-- Provider name -->
<providerName>mongodb-auth-provider</providerName>
<!-- Provider class -->
<providerClass>com.gatf.executor.dataprovider.MongoDBTestDataProvider
</providerClass>
<args>
<!-- MongoDB Host -->
<arg>localhost</arg>
<!-- MongoDB Port -->
<arg>27017</arg>
<!-- MongoDB Database name -->
<arg>wellogic</arg>
<!-- MongoDB Collection -->
<arg>User</arg>
<!-- MongoDB Query -->
<arg>{"status": "ACTIVE"}</arg>
<!-- MongoDB Collection property names -->
<arg>user,password</arg>
<!-- Provider variable names -->
<arg>username,password</arg>
</args>
</gatf-testdata-provider>
<!-- The Database test data provider -->
<gatf-testdata-provider>
<providerName>database-auth-provider</providerName>
<providerClass>com.gatf.executor.dataprovider.DatabaseTestCaseDataProvider
</providerClass>
<args>
<!-- Database JDBC Url -->
<arg>jdbc:mysql://localhost/globaldb</arg>
<!-- Database driver class name -->
<arg>com.mysql.jdbc.Driver</arg>
<!-- Database username -->
<arg>root</arg>
<!-- Database Password -->
<arg></arg>
<!-- SQL Query -->
<arg>SELECT USER_NAME,PASSWORD FROM BASE_USER</arg>
<!-- Provider variable names -->
<arg>username,password</arg>
</args>
</gatf-testdata-provider>
<!-- The File test data provider -->
<gatf-testdata-provider>
<enabled>true</enabled>
<providerName>file-auth-provider</providerName>
<providerClass>com.gatf.executor.dataprovider.FileTestCaseDataProvider
</providerClass>
<args>
<!-- File path, relative to 'testCaseDir' folder -->
<arg>authfile.csv</arg>
<!-- File Type, can be csv,json or xml -->
<arg>csv</arg>
<!-- Provider variable names -->
<arg>username,password</arg>
</args>
</gatf-testdata-provider>
<!-- The inline test data provider -->
<gatf-testdata-provider>
<enabled>true</enabled>
<providerName>inline-auth-provider</providerName>
<providerClass>com.gatf.executor.dataprovider.InlineValueTestCaseDataProvider
</providerClass>
<args>
<!-- Provider variable names -->
<arg>username,password</arg>
<!-- Inline values follow -->
<arg>user1,password</arg>
<arg>user2,password</arg>
</args>
</gatf-testdata-provider>
<!-- The Random values test data provider -->
<gatf-testdata-provider>
<enabled>true</enabled>
<providerName>random-auth-provider</providerName>
<providerClass>com.gatf.executor.dataprovider.RandomValueTestCaseDataProvider</providerClass>
<args>
<!-- Provider variable names -->
<arg>username,password</arg>
<!-- Provider variable types, can be one of alpha, alphanum, number, boolean,
-number, +number and date(format) -->
<arg>alpha,alphanum</arg>
</args>
</gatf-testdata-provider>
<!-- The Custom test data provider -->
<gatf-testdata-provider>
<enabled>true</enabled>
<providerName>custom-auth-provider</providerName>
<providerClass>com.CustomTestDataProvider</providerClass>
<args>
<!-- Provider variable names -->
<arg>username,password</arg>
</args>
</gatf-testdata-provider>
</providerTestDataList>
</gatfTestDataConfig>
</gatf-execute-config>
Assuming the above configuration is present in a file named gatf-config.xml, the maven configuration required to execute the API testcases would be,
Maven Configuration
<!-- Add jitpack artifact repositories for gatf dependencies -->
<pluginRepositories>
<pluginRepository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</pluginRepository>
</pluginRepositories>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<!-- Add the generator plugin which will be invoked during the test phase -->
<build>
<plugins>
<plugin>
<groupId>com.github.sumeetchhetri.gatf</groupId>
<artifactId>gatf-plugin</artifactId>
<version>1.0.6</version>
<executions>
<execution>
<id>gatf-execution</id>
<configuration>
<configFile>gatf-config.xml</configFile>
</configuration>
<phase>test</phase>
<goals>
<goal>gatf-executor</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</body>
Direct Execution
For direct execution, we just need to specify a simple config.xml(any name .xml) file with the contents as follows, on the command line,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest -executor /workdir/path-to-gatf-executor-config.xml-file
For direct execution for RPA (selenium), we just need to specify a simple config.xml(any name .xml) file with the contents as follows, on the command line,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest -selenium /workdir/path-to-gatf-executor-config.xml-file
For validating test script for RPA (selenium), use the following command,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest -validate-sel test-script-name-relative-to-workdir.sel /local/gatf-config-sel.xml
For running gatf in distributed mode as a listener, use the following command,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest -listener
GATF Robotic Process Automation Tool
The GATF RPA tool provides an easy to use language to write process automation tests called seleasy, using seleasy it becomes super easy to write any simple or complex test cases also utilizing the full capabilities of the workflow and provider logic described in the configuration above, moreover UI load and Distributed load testing can now be very easily performed with gatf.
Moreover a javascript library is provided as an additional support system to automatically record and playback browser actions, this small script when injected into the (Inspect Element - Chrome), (Developer Tools - Firefox) etc, provides an initial bootstrap to generate most of the automation scripts.
Just to give a glimpse of how easy it is to write process automation test cases with seleasy(gatf) assume we have a login page hosted at http://example.com and after logging in we need to see the Name of the user in the Profile section under the xpath /html/body/div[4]/div[1]/div/div[2]/div[1]/div/p[1], an example gatf script to execute the test in 4 different browsers would look like,
open chrome
open firefox
open ie
open opera
goto http://example.com
??10 id@username type "user"
??10 id@password type "password"
??10 class@loginBtn click
??10 xpath@"/html/body/div[4]/div[1]/div/div[2]/div[1]/div/p[1]" click
Simplicity lies at the core of the seleasy language which was invented just to ensure that we focus on the problem at hand instead of writing lengthy selenium scripts in java.
To start recording browser actions just type into the Inspect Element -> Console (Chrome)
Fg.startRecording()
To stop recording
Fg.stopRecording()
Seleasy Syntax Reference
Execute javascript code in the browser
execjs {javascript statement}
Examples :-
execjs 'console.log("Hello");'
execjs '$("#elid").click();'
Execute embedded code in java/js/ruby/groovy/python
<<<(java|js|ruby|groovy|python) a,b,c
code
>>>
Available variables in context -
1. @driver - WebDriver instance (Java only)
2. @window - WebDriver instance (Java only)
3. @element - Currently selected WebElement instance (Java only)
4. @sc - Currently selected SearchContext instance (Java only)
5. @printProvJson - Print Provider data as json (Java only)
6. @printProv - Print Provider data (Java only)
7. @print - System.out.println (Java only)
8. @index - Current provider index under interation (Java only)
9. @cntxtParam - Add variable to current context
Examples :-
<<<(java) a,b,c
System.out.println(a);
>>>
<<<(js) a,b,c
console.log(a);
>>>
<<<(groovy) a,b,c
println a
>>>
<<<(ruby) a,b,c
puts a
>>>
<<<(python) a,b,c
print(a)
>>>
Js Variable definition
jsvar {javascript statement returning value}
Examples :-
jsvar var1 'return "123"'
jsvar var1 'return $("#elid").val()'
Execute java code
exec {java statement}
Available variables in context -
1. @driver - WebDriver instance
2. @window - WebDriver instance
3. @element - Currently selected WebElement instance
4. @sc - Currently selected SearchContext instance
5. @printProvJson - Print Provider data as json
6. @printProv - Print Provider data
7. @print - System.out.println
8. @index - Current provider index under interation
Examples :-
exec @driver.refresh()
exec @window.back()
exec @element.click()
exec @sc.findElement(org.openqa.selenium.By.id("id")
exec @printProvJson("provider-name")
exec @printProv("provider-name")
exec @print("something-to-console")
exec @print(@index)
Close window
close
Value List
[{primtive-value},...,{primtive-value}]
Examples :-
['abc', 'sss']
[123, 234]
[true, false]
Wait for element to be visible/invisible
??(+|-) {find-expr}
'+' - wait till element is visible
'-' - wait till element is not visible
Examples :-
??+ id@'eleid'
??- id@'eleid'
Variable definition
var name @{another-variable-name}|plugin ...|{primitive-value}
Examples :-
var var0 "Some text"
var var1 @var0
var var1 plugin jsonpath $v{myvar} out.x.y.z
var var1 123455
var var1 123.455
var var1 true
var var1 new java.util.Date()
Define test mode
mode {normal|integration}
Examples :-
mode normal
mode integration
Hover over an element and click some other element
hoverclick {find-expr} {find-expr}
Examples :-
hoverclick id@'hoverele' id@'clickele'
Find Expression
{id|name|class|xpath|tag|cssselector|css|text|partialLinkText|linkText|active}(@selector) (title|currentUrl|pageSource|width|height|xpos|ypos|alerttext) {matching-value|matching-value-in-list}
Select frame
frame main|parent|1..N|{some-name}
Examples :-
frame main
frame parent
frame 2
frame "my-frame"
Mobile hide keypad
hidekeypad
Sleep for milliseconds
sleep {time-in-ms}
Examples :-
sleep 10000
Take screenshot
screenshot {image-file-path-to-save-screenshot-to}
Examples :-
screenshot
screenshot "/path/to/image/file/file.jpg"
Clear element value
clear {find-expr}
Examples :-
clear id@'ele1'
Mobile Touch
touch ({press|moveto|tap {find-expr}|{find-expr} {x-co-ordinate} {y-co-ordinate}|{x-co-ordinate} {y-co-ordinate}}|longpress|{longpress {find-expr} {x-co-ordinate} {y-co-ordinate} {duration}|{find-expr} {x-co-ordinate} {y-co-ordinate}|{find-expr} {duration}|{x-co-ordinate} {y-co-ordinate} {duration}|{x-co-ordinate} {y-co-ordinate}}|{wait {duration}}|release) ... ({press|moveto|tap {find-ex...
Examples :-
touch moveto id@'ele' longpress moveto id@'ele2' wait 1000 release
touch moveto id@'ele' longpress id@'ele1' moveto id@'ele2' wait 1000 release
Select/Open Window
window {optional main|0}
Examples :-
window
window 0
window main
Handle Confirm Dialog
confirm ok|cancel|yes|no {optional button-text-to-check}
Examples :-
confirm ok
confirm yes
confirm cancel
confirm no
confirm yes 'Confirm'
Open URL in window
goto {url}
Examples :-
goto http://abc.com/testpage.html
Mobile Pinch
pinch ({x-co-ordinate} {y-co-ordinate}|{find-expr})
Examples :-
pinch 123 234
pinch id@'ele'
Specify Java Imports
require [{classname1},..{classnameN}]
Examples :-
require java.util.Date
require [java.util.List, java.math.BigDecimal]
Else-If block, needs to be superseded by an If block
:? {find-expr}
{
code
}
Examples :-
:? xpath@"ddd"
{
exec @print("else-if")
}
Show alert with message
alert {value}
Examples :-
alert('Hello')
Upload file
upload {filepath} {find-expr}
Examples :-
upload '/path/to/file.txt' id@'ele1'
Type UTF-8 or normal ASCII characters in input/textarea elements
chord {utf-8 character1}{utf-8 character2}...{utf-8 characterN} {find-expr}
Examples :-
chord \u0048\u0065\u006c\u006c\u006f\u0020\u0057\u006f\u0072\u006c\u0064 id@'abc'
If block
? {find-expr}
{
code
}
Examples :-
? xpath@"ddd"
{
exec @print("if")
}
Import config properties file
config {file-path}
Examples :-
config a/b/c/t1.props
config t2.props
Fail test/sub-test
fail {error string}
Examples :-
fail "Test failed"
fail "Sub-Test failed"
Select frame
tab main|0..N|{some-name}
Examples :-
tab main
tab 0
tab 2
tab "my-frame"
Transient Provider definition
#transient-provider {provider-name} {variableName1,...,variableNameN} {find-expr} {sub-selector1,...,sub-selectorN}
Examples :-
#transient-provider prov1 var1,var2 id@'abc' text,attr@abc
#tp prov1 var1,var2 id@'abc' text,attr@abc
Open Browser
open {chrome|firefox|ie|opera|edge|safari|appium-android|appium-ios|selendroid|ios-driver..} {optional session-name}
Examples :-
open chrome
open firefox "my-ff-sess"
Double Click element
doubleclick {find-expr}
dblclick {find-expr}
Examples :-
doubleclick id@'ele1'
Take element screenshot
ele-screenshot {element-selector} {optional image-file-path-to-save-screenshot-to}
Examples :-
ele-screenshot id@'eleid'
ele-screenshot id@'eleid' '/path/to/image/file/file.jpg'
Navigate Back/Previous
back
Pass test/sub-test
pass {error string}
Examples :-
pass "Test passed"
pass "Sub-Test passed"
Wait till an element is found and optionally execute actions on it
??[:wait-time-in-secs] {find-expr} {optional action type|hover|hoverclick|click|clear|submit}
Examples :-
??10 id@'eleid'
??20 id@'eleid' click
??20 class@'eleid' type 'abc'
Provider Loop block
#provider {find-expr}
{
code
}
#p {find-expr}
{
code
}
#counter {start-index} {end-index}
{
code
}
#counter {end-index}
{
code
}
#c {start-index} {end-index}
{
code
}
#c {end-index}
{
code
}
Examples :-
#provider "provider-name"
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#provider "provider-name" 0 3
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#provider "provider-name" 2
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#p "provider-name"
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#p "provider-name" 0 3
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#p "provider-name" 2
{
exec @print(@index)
click xpath@'$provider-variable-1'
}
#counter 0 5
{
exec @print(@index)
}
#counter 5
{
exec @print(@index)
}
#c 0 5
{
exec @print(@index)
}
#c 5
{
exec @print(@index)
}
Continue in loop
continue
Mobile Zoom
zoom ({x-co-ordinate} {y-co-ordinate}|{find-expr})
Examples :-
zoom 123 234
zoom id@'ele'
Mobile Tap
tap ({find-expr}|{find-expr} {duration}|{x-co-ordinate} {y-co-ordinate}|{x-co-ordinate} {y-co-ordinate} {duration}|{find-expr} {x-co-ordinate} {y-co-ordinate}|{find-expr} {x-co-ordinate} {y-co-ordinate} {duration})
Examples :-
tap id@'ele'
tap id@'ele' 2000
tap id@'ele' 123 234
tap id@'ele' 123 234 2000
tap 123 234
tap 123 234 2000
Select value from dropdown element
select {text|index|value|first|last}@{value} {find-expr}
Examples :-
select text@'first' id@'abc'
select index@2 id@'abc'
select value@'second' id@'abc'
select first id@'abc'
select last id@'abc'
Transient Variable definition
#transient-variable {variable-name} {find-expr} {sub-selector}
Examples :-
#transient-variable var1 id@'abc' text
#transient-variable var1 id@'abc' html
#transient-variable var1 id@'abc' attr@data-prop
#tv var1 id@'abc' text
#tv var1 id@'abc' html
#tv var1 id@'abc' attr@data-prop
Single line comment or Block level comment
//... | /*...*/
Execute java code
#j{if|else|else if|while|for|continue|break|\{|\}|synchronized} {java statement}
Examples :-
jif(1==1) {} else {}
for(int i=0;i<10;i++){}
Import other seleasy scripts
import {script-path}
Examples :-
import a/b/c/t1.sel
import t2.sel
Mobile Swipe
swipe {start-x-co-ordinate} {start-y-co-ordinate} {end-x-co-ordinate} {end-y-co-ordinate}
Examples :-
swipe 123 234 200 300
Submit element
submit {find-expr}
Examples :-
submit id@'ele1'
Execute javascript code from file in the browser
execjsfile {javascript file path}
Examples :-
execjsfile 'file.js'
Hover over an element
hover {find-expr}
Examples :-
hover id@'abc'
Draw a circle in a canvas element
canvas {canvas-id}
Examples :-
canvas 'somecanvasele'
Import dynamic (code vars) properties file
dynprops {file-path}
Examples :-
dynprops a/b/c/t1.props
dynprops t2.props
Find Expression
{id|name|class|xpath|tag|cssselector|css|text|partialLinkText|linkText|active}(@selector) (title|currentUrl|pageSource|width|height|xpos|ypos|alerttext) {matching-value|matching-value-in-list}
Break from loop
break
Define Screen No-activity layers
layer {find-expr}
Examples :-
layer id@"loader-icon"
layer id@"overlay-div"
Refresh window
refresh
Navigate Forward/Next
forward
Mobile rotate
rotate
Value
{primtive-value}
Examples :-
'abc'
123
true
Set Window Properties
window_set {width|height|posx|posy} {value}
Examples :-
window_set width 100
window_set height 100
window_set posx 100
window_set posy 100
Maximize window
maximize
Click element
click {find-expr}
Examples :-
click id@'ele1'
Else block, needs to be superseded by an If or Else-If block
:
{
code
}
Examples :-
:
{
exec @print("else")
}
Subtest definition
subtest "name" session-name|@session-id
{
code
}
where
session-name - the browser session name for which to run this sub test
session-id - the browser session id prefixed with @ for which to run this sub test
Examples :-
subtest "sb1" "bs1"
{
select index@4 id@"Location"
}
subtest "sb1" @1
{
select index@4 id@"Location"
}
Type Value in input/textarea elements
type {text} {find-expr}
Examples :-
type 'abc' id@'ele1'
Type random values in input/textarea elements
randomize {find-expr} alphanumeric|numeric|alpha|value {optional character count} {optional random words separated by space (for eg, name of person)}
Examples :-
randomize id@'ele1' alphanumeric 12
randomize id@'ele1' alpha 8 3 (first-name middle-name last-name)
randomize id@'ele1' numeric 5
randomize id@'ele1' value 'abcd'
Multiple Chained Actions
actions movetoelement|moveto {find-expr} ({click|clickandhold|release|dblclick|doubleclick|contextclick|clickhold|rightclick}|{keydown|keyup|sendkeys|type {value}}|{movetoelement|moveto {find-expr}}|{draganddrop|dragdrop {find-expr} {find-expr}}|{movebyoffset|moveby {x-offset} {y-offset}}) ... movetoelement|moveto {find-expr} ... ({click|clickan...
Examples :-
actions movetoelement id@'ele' click moveto id@'ele2' clickandhold moveto id@'ele3' release type '123'
actions movetoelement id@'ele' sendkeys 'abc'
Loop block
## {find-expr}
{
code
}
Examples :-
## class@"ddd"
{
exec @print(@index)
click xpath@"ddd-@index"
}
Mobile shake
shake
Send keys using Robot
robot keydown|keyup|keypress {key-code1} ... keydown|keyup|keypress {key-codeN}
scrollup
scrolldown
scrollpageup
scrollpagedown
Examples :-
robot keydown 1
robot keyup 1
robot keypress 1
robot keypress 1 keydown 2 keyup
scrollup
scrolldown
scrollpageup
scrollpagedown
API Plugin
plugin api {test-name}@{optional test-case-file-name}
Examples :-
plugin api api-name
plugin api api-name@test-case-file-path
Curl Plugin
plugin curl get|put|post|delete {url}
{
[
header=value
]
content-body
}
Examples :-
plugin curl get http://abc.com
plugin curl post http://abc.com
{
[
Content-Type=application/xml
]
<abc>abc</abc>
}
XML Plugin
xmlread {xml-text}
xmlwrite {optional-path-to-file} {xml-object-or-map-list-set}
xmlpath {xml-text} {xpath-string}
Examples :-
xmlread '<o><a>abc</a><b>1</b></o>'
xmlwrite '/path/to/file.xml' $xmlObjectVar
xmlpath '<o><a>abc</a><b>1</b></o>' '/o/a'
JSON Plugin
jsonread {json-text}
jsonwrite {optional-path-to-file} {jackson-annotated-json-object-or-map-list-set}
jsonpath {json-text} {json-path-string}
Examples :-
jsonread '{"a": "abc", "b": 1}'
jsonwrite '/path/to/file.json' $jsonObjectVar
jsonpath '{"a": "abc", "b": 1}' '$.a'
GATF Executor Configuration File
<gatf-execute-config>
<authEnabled>true</authEnabled>
<baseUrl>http://localhost:8080/example</baseUrl>
<enabled>true</enabled>
<outFilesDir>out</outFilesDir>
<testCaseDir>data</testCaseDir>
<httpRequestTimeout>100000</httpRequestTimeout>
<authDataProvider>file-auth-provider</authDataProvider>
<gatfTestDataConfig>
<providerTestDataList>
<gatf-testdata-provider>
<providerName>file-auth-provider</providerName>
<providerClass>com.gatf.executor.dataprovider.FileTestDataProvider</providerClass>
<providerProperties>username,password</providerProperties>
<enabled>true</enabled>
<args>
<seleniumScript>users.csv</seleniumScript>
<seleniumScript>csv</seleniumScript>
</args>
</gatf-testdata-provider>
</providerTestDataList>
</gatfTestDataConfig>
<isSeleniumExecutor>true</isSeleniumExecutor>
<javaHome>C:\\Path-to-java\\java-openjdk-1.8.0.191</javaHome>
<gatfJarPath>C:\\Path-to-maven-repo\\.m2\\repository\\com\\github\\sumeetchhetri\\gatf\\gatf-alldep-jar\\1.0.6\\gatf-alldep-jar-1.0.6.jar</gatfJarPath>
<seleniumDriverConfigs>
<seleniumDriverConfig>
<name>chrome</name>
<driverName>webdriver.chrome.driver</driverName>
<path>C:\\Path-to-selenium-drivers\\chromedriver.exe</path>
</seleniumDriverConfig>
</seleniumDriverConfigs>
<seleniumScripts>
<seleniumScript>path-relative-to-testCaseDir-above\\test.sel</seleniumScript>
</seleniumScripts>
<seleniumLoggerPreferences>browser(OFF),client(OFF),driver(OFF),performance(OFF),profiler(OFF),server(OFF)</seleniumLoggerPreferences>
</gatf-execute-config>
Maven Configuration
<!-- Add jitpack artifact repositories for gatf dependencies -->
<pluginRepositories>
<pluginRepository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</pluginRepository>
</pluginRepositories>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<!-- Add the executor plugin which will be invoked during the test phase -->
<build>
<plugins>
<plugin>
<groupId>com.github.sumeetchhetri.gatf</groupId>
<artifactId>gatf-plugin</artifactId>
<version>1.0.6</version>
<executions>
<execution>
<id>gatf-execution</id>
<configuration>
<configFile>gatf-config.xml</configFile>
</configuration>
<phase>test</phase>
<goals>
<goal>gatf-executor</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</body>
GATF Config Tool
Gatf also provides with a User Interface for managing and executing test cases online with the help of an embedded Http server which provides for an easy to to use configuration tool to control gatf, It provides real time statistics on test runs in a single or multi node load scenario.
Maven Configuration
<!-- Add jitpack artifact repositories for gatf dependencies -->
<pluginRepositories>
<pluginRepository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</pluginRepository>
</pluginRepositories>
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<!-- Add the config plugin which will be invoked during the test phase -->
<build>
<plugins>
<plugin>
<groupId>com.github.sumeetchhetri.gatf</groupId>
<artifactId>gatf-plugin</artifactId>
<version>1.0.6</version>
<executions>
<execution>
<id>gatf-config</id>
<phase>test</phase>
<goals>
<goal>gatf-config</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</body>
Direct Execution
For direct execution,
docker run -v /dev/shm:/dev/shm -v /local-folder:/workdir -p 9080:9080 -e TZ=Asia/Kolkata -it sumeetchhetri/gatf-bin:latest
0.0.0.0:9080 - ip/port for embedded http server
. - the current directory where the config file gatf-config.xml and other resource directories and files can be found
Limitations
- The generator assumes that the entities in the application are JACKSON/JAXB compliant (having proper jackson/jaxb annotations), hence it is tightly coupled with these libraries for generating request content
License
Apache License Version 2.0