CheatHurl HTTP requests as tests
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
hurl <file.hurl>
Run a file, print last body
hurl --test <file.hurl>
Run as test, show summary
hurl --variable <name>=<value>
<file>
Inject a variable
hurl -v <file>
Show request and response
hurl --very-verbose <file>
Debug incl. bodies
hurl --test --report-html <dir> <files>
HTML test report
hurl --retry <n> <file>
Retry failed entries
hurl --glob "<pattern>"
Run files by pattern
Concepts
- Request METHOD URL, headers, body
- Response HTTP 200
- Variables {{name}}
- [Asserts] pass or fail, exit code
Run
hurl <file.hurl>
Run a file
hurl <a.hurl> <b.hurl>
Run several files in order
hurl --test <files>
Test mode: progress and summary
hurl --glob "<pattern>"
Run files matching a glob
hurl --continue-on-error <file>
Do not stop at the first failed assert
hurl --retry <n> --retry-interval <ms>
<file>
Retry failed entries
Request
GET <url>First line: method and URL
<Name>: <value>
Header lines straight after the URL
[Query] <key>: <value>
Query string params, unencoded
[Form] <key>: <value>
URL-encoded form fields
[BasicAuth] <user>: <password>
Basic authentication
[Options] <option>: <value>
Per-request options
{ "key": "value" }
JSON body, Content-Type set for you
```json ... ```Multiline body, with templates
Response & Asserts
HTTP 200Expect this status
[Asserts]Section of checks, one per line
status < 300Status check
header "<Name>" contains
"<text>"
Header check
jsonpath "$.a.b" == "<value>"
Check a JSON value
jsonpath "$.items" count == <n>
Check list length
xpath "//h1" exists
Check HTML or XML
body contains "<text>"
Substring of the body
jsonpath "$.x" not exists
Negate any predicate with not
Predicates
== != > >= < <=
Compare values
startsWith endsWith contains
String and list checks
matches /<re>/
Regex match
exists isEmptyPresence checks
isString isInteger isBoolean
Type checks (also isFloat, isList...)
Captures & Variables
[Captures]Section that stores response values
id: jsonpath "$.id"
Capture a JSON value
tok: header "X-Token"
Capture a header
pass: header "token" redact
Hide a captured value in logs
{{name}}Use a variable in URL, header, body
hurl --variable <name>=<value>
Set a variable
hurl --variables-file <file>
Variables from name=value lines
hurl --secret <name>=<value>
Variable redacted from logs
Filters
HTTP options
-L, --locationFollow redirects
-H, --header <Name:value>
Add a header to every request
-u, --user <user:password>
Basic authentication
-k, --insecureSkip TLS verification
--compressedAsk for and decode compression
--resolve <host:port:addr>
Override DNS for a host
-b <file> / -c <file>
Read or write cookies (Netscape)
Output & Reports
-v, --verboseRequest and response details on stderr
--very-verboseDebug output with bodies
-i, --includePrint response headers too
-o, --output <file>
Write the body to a file
--jsonOutput results as JSON
--error-format long
Detailed error messages
-h, --help / -V, --version
Help and version
--report-html <dir>
HTML report
--report-junit <file>
JUnit XML for CI
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Bad command-line options |
2 |
Hurl file parse error |
3 |
Runtime error (e.g. connection) |
4 |
Assert failed |
Recipes
POST https://api.example.com/login{ "user": "{{user}}", "pass": "{{pass}}" }HTTP 200[Captures]token: jsonpath "$.token" redactGET https://api.example.com/meAuthorization: Bearer {{token}}HTTP 200[Asserts]jsonpath "$.name" == "{{user}}"GET https://api.example.com/jobs/{{id}}[Options]retry: 10retry-interval: 2000HTTP 200[Asserts]jsonpath "$.status" == "done"hurl --test --variable host=https://staging.example.com \ --report-junit build/hurl.xml tests/*.hurlPOST https://api.example.com/upload[Query]folder: docs[Multipart]file: file,report.pdf; application/pdfHTTP 201
