Simple golang-based load test application using YAML documents as specification.
For a more full-blown explanation of what Gotling is about, see my blog post here: http://callistaenterprise.se/blogg/teknik/2015/11/22/gotling/
Please note that this is my very first golang program and is probably full of anti-patterns and bad use of golang constructs.
- Provides high-throughput load testing of HTTP services
- Supports GET, POST, PUT and DELETE
- Live metrics using HTML5 canvas from canvasjs
- Request URLs and bodies can contain ${paramName} parameters
- ${paramName} values can be extracted from HTTP response bodies and bound to a User context
- Capturing Set-Cookie response headers
- POST data can be inlined or read from template files
- TCP sockets
- Can send line-terminated text strings
- Possible to use ${varname} variables in payload
- Does not currently support body parsing or variable extraction from data incoming on the TCP socket.
Of course you need the Go SDK, I think I've used version 1.5 or so. These instructions are based on OS X 10.11, but should apply to Windows and Linux too.
git clone https://github.com/eriklupander/gotling.git
Go into the root project directory, for example ~/projects/gotling.
export GOPATH=~/projects/gotling
cd src/github.com/eriklupander/gotling
go get
May take a little while, after go get finishes, you should see
src/github.com/NodePrime/
src/github.com/eriklupander/
src/github.com/gorilla/
src/github.com/tobyhede/
src/gopkg.in/yaml.v2/
4. Or, build with gb
Assume you have gb installed by following the official guide.
# fetch to restore the deps
gb vendor restore
# now build it at project root
gb build
# the generated executable binary is at $PROJECT/bin/To run the standard bundled "demo" simulation, use go run like this:
cd ~/projects/gotling
go run src/github.com/eriklupander/gotling/*.go samples/demosimulation.yml
If you built gotling using gb, a binary now resides in $PROJECT/bin
bin/gotling samples/demosimulation.yml
Define your test setup in a .yml file
---
iterations: 10 # Number of iterations per user
users: 10 # Number of users
rampup: 20 # seconds
actions: # List of actions. Currently supports http, sleep
- http:
method: GET # GET, POST, PUT, DELETE
url: http://localhost:8183/courses # URL. Can include ${paramName} parameters
accept: json # Only 'json' is currently supported
response: # Defines response handling
jsonpath: $[*].id+ # JsonPath expression to capture data from JSON response
variable: courseId # Parameter name for captured value
index: first # If > 1 results found - which result to store in 'variable':
# first, random, last
- sleep:
duration: 3 # Sleep duration in seconds. Will block current user
- http:
method: GET
url: http://localhost:8183/courses/${courseId}
accept: json
response:
jsonpath: $.author+
variable: author
index: first
- sleep:
duration: 3
- tcp:
address: 127.0.0.1:8081 # TCP socket connection
payload: |TYPE|1|${UID}|${email} # Sample data using parameter substitution
Gotling supports POST/PUT bodies either directly inlined in the YAML specification, or read from a template file:
- http:
title: Some title
method: POST
url: http://localhost:9183/mypath
body: '{"id":100,"name":"Some name","author":"${author}-${someId}","created":"2015-10-23T21:33:38.254+02:00","baseLatitude":45.634353,"baseLongitude":11.3424324}'
accept: application/json
Note that we use body in the inlined example
- http:
title: Submit query
method: POST
url: http://localhost:8080/myxmlservice
template: myproject/MyFancySOAPRequest.xml
accept: application/xml
In this example, we use template instead of body. The myproject/ folder should always be placed in the /templates directory in the root of the project. Note that ${varName} variable substitution from feeders (see below) or values captured from previous responses in the action sequence can be used in template files.
Gotling currently support CSV feeds of data. First line needs to be comma-separated headers with the following lines containing data, e.g:
id,name,size
1,Bear,Large
2,Cat,Small
3,Deer,Medium
These values can be accessed through ${varname} matching the column header.
Each "user" gets a unique "UID" assigned to it, typically an integer from 10000 + random(no of users). Perhaps I can tweak this to either use UUID's or configurable intervals. Anyway, the UID can be used using ${UID} and can be useful for grouping data etc.
It's quite common that you need to load-test a secured API. Gotling provides a mechanism that allows you to capture Set-Cookie response headers which then will be automatically applied to subsequent HTTP actions for the current user.
Here is an example where a form-based login POST is used for logging in and storing the returned JSESSIONID cookie
- http:
title: Login
method: POST
url: https://some.host.name/login
body: 'put your urlencoded form data here'
accept: '*/*'
contentType: application/x-www-form-urlencoded
storeCookie: JSESSIONID
It's possible to use jsonpath OR xmlpath to capture variables from HTTP responses (json or xml) and use in subsequent invocations during the ongoing sequence of actions. See ${courseId} in the sample above.
A similar sample for xmlpath:
- http:
method: GET
url: http://www.w3schools.com/xml/cd_catalog.xml
accept: text/xml
response:
xmlpath: //title
variable: myTitleVar
index: random
- http:
method: GET
url: http://some.other.service.maybe/authors/${myTitleVar}
accept: json
Please note that a response definition only may contain either a jsonpath OR an xmlpath. You can't have both.
For more on xmlpath, see xmlpath
Gotling currently supports HTTPS, including hosts using self-signed certificates.
In the future, we'll probably add an option to allow/disallow unsecure https.
Access at http://localhost:8182
Click "connect" to connect to the currently executing test.
Work in progress, not functional right now :(
- github.com/davecheney/profile
- gopkg.in/yaml.v2
- gopkg.in/xmlpath.v2
- NodePrime/jsonpath - https://github.com/NodePrime/jsonpath/blob/master/README.md
- gorilla/websocket
- highcharts
Licensed under the MIT license.
See LICENSE