This is a karate poc for API testing
mvn archetype:generate ^
-DarchetypeGroupId=com.intuit.karate ^
-DarchetypeArtifactId=karate-archetype ^
-DarchetypeVersion=1.2.0 ^
-DgroupId=com.mycompany ^
-DartifactId=myproject
1 Scenario: Passing param to get call
2 Given path 'articles'
3 And param limit = 10 # note exactly one space surrounding '=' sign 1 And params { limit: 10, offset: 0 }
And match response.tags contains ['Gandhi', 'dragons'] And match response.tags !contains 'cars' And match response.tags == '#array'
mvn clean test -Dtest=UsersTest#testAssertions
//where UserTest is the UsersTest.java runner and test assertions is the test method in the usersTest.java file
mvn test '-Dkarate.options=--tags @test' -Dkarate.config.dir='src/test/java' -Dtest='DemoParallelTest' -Dkarate.env='dev'
mvn clean test "-Dkarate.options=--tags @smoke"
mvn test "-Dkarate.options=--tags @configparams" -Dkarate.env=qa
def responsetoken = call read('classpath:com/karate/helpers/CreateToken.feature') responseToken is an object of all the variables defined in createtoken feature
Hence to retrieve it is responseToken.variablename defined in CreateToken Callonce to call it only once
def responseToken = callonce read('classpath:com/karate/helpers/CreateToken.feature') {'email': 'ravi.gajul@test.com','password': 'Ant3m3an!'}
//passing feature file and config object to callSingle method which returns an object of variables declared in feature file. var accessToken=karate.callSingle('classpath:com/karate/helpers/CreateToken.feature',config).authToken //passing global headers that can be used by all urls karate.configure('headers',{Authorization: 'Token ' + accessToken})
Can be used between thriple double quotes like below """ { "user": { "email": "ravi.gajul@test.com", "password": "Ant3m3an!" } } """"
- def datagenerator = Java.type('classpath:com/karate/helpers/DataGenerator')
This will throw
org.graalvm.polyglot.PolyglotException: TypeError: Access to host class classpath:com/karate/helpers/DataGenerator is not allowed or does not exist.
- <js>.:program(Unnamed:1)
Remove the classpath and it will work
- def datagenerator = Java.type('com/karate/helpers/DataGenerator')Background : Background keyword works for before each scenario Using callonce to execute only once
• Configure afterScenario = call read('classpath:com/test/resources/test.feature') • Configure after
<configuration>
<argLine>-Dfile.encoding=UTF-8</argLine>
<includes>
<include>com/karate/features/RunnerTest.java</include>
</includes>
<systemProperties>
<karate.options>--tags ~@ignore</karate.options>
</systemProperties>
</configuration>Karate.configure('ssl', true) for SSL disabling
- configure ssl = { trustAll: true, keyStore: '#(keyStoreLocation)', keyStorePassword: 'somePass' }
#in the below step article is an object that we are using to retrive slug in AddLikes.feature.
#It wont work if we directly pass the slug value ins callSingle accepts object as parameter
* def article = response.articles[0]
* if (favouritesCount == 0) karate.callSingle('classpath:com/karate/helpers/AddLikes.feature', article)
Another Way
* def result = favoritesCount == 0 ? karate.callSingle('classpath:com/karate/helpers/AddLikes.feature', rticle).likescount:favoritesCount- configure retry = {count:5, interval: 10000} #the below line should be before method call. And retry until response.articles[0].favoritesCount == 5
- def sleep = function(pause){java.lang.Thread.sleep(pause)}
- eval sleep(5000)
-
Foo+'' will convert integer(foo) to String
-
b.Foo*1 will convert String(foo) to Integer
-
c.def json = {"bar": "#(parseInt(boo))"} will parse boo into integer using java script function.
-
vd.def json = {"bar": "#(~~parseInt(boo))"} will parse boo into int using java script function.
- Docker build -t "name of the container--karatetest" .
- Docker run -it karatetest
mvn clean test-compile gatling:test
- karate.pause(5000)
https://gatling.io/docs/gatling/reference/current/core/injection/
setUp(
scn.inject(
nothingFor(4), // 1
atOnceUsers(10), // 2
rampUsers(10).during(5), // 3
constantUsersPerSec(20).during(15), // 4
constantUsersPerSec(20).during(15).randomized, // 5
rampUsersPerSec(10).to(20).during(10.minutes), // 6
rampUsersPerSec(10).to(20).during(10.minutes).randomized, // 7
stressPeakUsers(1000).during(20) // 8
).protocols(httpProtocol)
)
https://gatling.io/docs/gatling/reference/current/core/session/feeder/
val csvfeeder = csv('csvFeeder.csv')
val create = scenario("create and delete article").feed(csvFeeder).exec(karateFeature("classpath:com/performance/data/FeederDemo.feature"))
// default behavior: use an Iterator on the underlying sequence
csv("foo").queue();
// randomly pick an entry in the sequence
csv("foo").random();
// shuffle entries, then behave like queue
csv("foo").shuffle();
// go back to the top of the sequence once the end is reached
csv("foo").circular();__gatling.Title //title is the header in csv file
__gatling.Description //Description is the header in csv file.This is to display a user friendly name in the report instead of end point Add the below step in performance.scala file
protocol.nameResolver = (req, ctx) => req.getHeader("karate-name")
And access it before sending the request in feature file
And header karate-name = 'Create Article'
Is to increase the pool size to some number so that the expected load is hit and no unexpected results are seen. Create a gatling-akka.config file at same level as karate-config and add below lines for achieving a pool of size 100. for more info see below https://github.com/karatelabs/karate/tree/master/karate-gatling#increasing-thread-pool-size
akka {
actor {
default-dispatcher {
type = Dispatcher
executor = "thread-pool-executor"
thread-pool-executor {
fixed-pool-size = 100
}
throughput = 1
}
}
}file.separator" -> Character that separates components of a file path. This is "/" on UNIX and "\" on Windows.
System.getProperty("user.dir")+File.separator+"Other"https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html
https://github.com/karatelabs/karate#fuzzy-matching
https://github.com/karatelabs/karate#schema-validation
https://github.com/karatelabs/karate#self-validation-expressions
And Match response.[0].empid == '#? _ ==1'
# here _ is called self variabefunction() {
var env = karate.env; // get java system property 'karate.env'
karate.log('karate.env system property was:', env);
if (!env) {
env = 'dev'; // a custom 'intelligent' default
}
var config = { // base config JSON
appId: 'my.app.id',
appSecret: 'my.secret',
someUrlBase: 'https://some-host.com/v1/auth/',
anotherUrlBase: 'https://another-host.com/v1/'
};
if (env == 'stage') {
// over-ride only those that need to be
config.someUrlBase = 'https://stage-host/v1/auth';
} else if (env == 'e2e') {
config.someUrlBase = 'https://e2e-host/v1/auth';
}
//read from external json file
var externalConfig = read('classpath:config/config.json');
//merge external config with base config
config = karate.merge(config, externalConfig);
return config;
}mvn test "-Dkarate.env=prod" "-Dkarate.options=--tags @readexternalconfig"@CSVDemo
Scenario Outline: Scenario to demonstrate reading data from csv
* print <FirstName>
* print <LastName>
* print <Email>
* print __row
//This line prints each row of csv as json object
@CSVDemo
Examples:
#| FirstName | LastName | Email |
# | 'Ravi' | 'Gajul' | 'Ravi.Gajul@test.com' |
|read('classpath:com/karate/data/testdata.csv')|* print __row@CSVDemo22
Scenario Outline: Scenario to demonstrate reading data from csv
* print <FirstName>
* print <LastName>
* print <Email>
* print __row
* def filename = <Execute> == 'Y' ? 'ForCSVRead.feature' : 'Dummy.feature'
* def result = call read(filename){"endPointUrl" : <endPointUrl>}
Examples:
| read('classpath:com/karate/data/testdata.csv') |Background:
* def data = read('classpath:com/karate/data/testdata.csv')
# * def filtered = get data[?(@.Execute=="'Y'")]
* def selected = "'Y'"
* def fun = function(x){ return x.Execute == selected }
* def filtered = karate.filter(data, fun)
@csvfilter
Scenario Outline: Scenario name
Given print __row
Examples:
| filtered |Here -DExecute is passed as environment variable which is retrieved by karate.properties['Execute'] during runtime.
# mvn test '-Dkarate.options=--tags @csvfilter' -Dtest=ParallelTest -DExecute="'Y'"
Background:
* def data = read('classpath:com/karate/data/testdata.csv')
# * def filtered = get data[?(@.Execute=="'Y'")]
# * def filtered = "'Y'"
* def selected = karate.properties['Execute']
* def fun = function(x){ return x.Execute == selected }
* def filtered = karate.filter(data, fun)
@csvfilter
Scenario Outline: Scenario name
Given print __row
Examples:
| filtered |@dynamicurl
# mvn clean test '-Dkarate.options=--tags @dynamicurl' -Dtest=ParallelTest '-Dkarate.env=dev'
Feature: Form Dynamic url combining values read from json file plus value passed in maven goal
Background:
* def vConfig = read('classpath:com/karate/data/env.json')
* def vUrl = vConfig[karate.properties['karate.env']].baseurl + vConfig[karate.properties['karate.env']].resource
* print vUrl
@BasicAuth12345678
Scenario: Scenario to generate basic auth token
Given url vUrl
When method GET
Then status 403
* print response
Background:
* def result =
"""{
"UserName": "Ravi",
"Password": "testing123"
}
"""
# mvn test '-Dkarate.options=--tags @dynamicjson' -Dtest=ParallelTest
@BasicAuth12345678
Scenario: Scenario to generate basic auth token
* print result
* def data = read('classpath:com/karate/data/dynamicdata.json')
* print dataThe external dynamicdata.json is here which will be binding with the result data in background. This binding will work even when the json file is externally stored not just within feature file
{
"id": #(result.UserName),
"pwd": #(result.Password)
} * eval
"""
if(a == 10) {
karate.log('Value matches')
} else {
karate.log('Value doesnt match')
}
"""* def cat =
"""
{
name: 'Billie',
kittens: [
{ id: 23, name: 'Bob' },
{ id: 42, name: 'Wild' }
]
}
"""
# find single kitten where id == 23
* def bob = get[0] cat.kittens[?(@.id==23)]
* match bob.name == 'Bob'
# using the karate object if the expression is dynamic
* def temp = karate.jsonPath(cat, "$.kittens[?(@.name=='" + bob.name + "')]")
* match temp[0] == bob
# or alternatively
* def temp = karate.jsonPath(cat, "$.kittens[?(@.name=='" + bob.name + "')]")[0]
* match temp == bobUse below
WHEN SOAP Action //instead of
WHEN METHOD POST#mvn test '-Dkarate.options=--tags @rowswithnonemptyendpointurlcolumn' -Dtest=ParallelTest
@rowswithnonemptyendpointurlcolumn
Scenario: Scenario to fetch the rows with non empty endpoint values
* def testData =
"""
[
{
"ID": "1",
"Execute": "Y",
"FirstName": "Ravi",
"LastName": "Gajul",
"Email": "Ravi.Gajul@test.com",
"endPointUrl": "/api/users?page=2"
},
{
"ID": "2",
"Execute": "N",
"FirstName": "Rajesh",
"LastName": "Sandupatla",
"Email": "Rajesh.Sand@test.com",
"endPointUrl": "/api/users/2"
},
{
"ID": "3",
"Execute": "Y",
"FirstName": "Ravi",
"LastName": "Gajul",
"Email": "Ravi.Gajul@test.com",
"endPointUrl": ""
}
]
"""
* def filteredData = karate.jsonPath(testData, "$.[?(@.Execute == 'Y' && @.endPointUrl != '')]")
* print filteredDataScenario:
Given driver 'https://formy-project.herokuapp.com/form'
And input('#first-name', 'Ravi')
And input('#last-name', 'Gajul')
And input('#job-title', 'QA')
And click('#radio-button-1')
And click('#checkbox-1')
And select('#select-menu', '2')
And input('#datepicker', '01/01/2020')
And input('#datepicker', Key.ENTER)
And click('a.btn.btn-lg.btn-primary')
Then waitForUrl('formy-project.herokuapp.com/thanks')
Then match text('div.alert.alert-success').trim() == 'The form was successfully submitted!'