hurl/docs/running-tests.md

Running Tests

Use --test Option

Hurl is run by default as an HTTP client, returning the body of the last HTTP response.

$ hurl hello.hurl
Hello World!

When multiple input files are provided, Hurl outputs the body of the last HTTP response of each file.

$ hurl hello.hurl assert_json.hurl
Hello World![
  { "id": 1, "name": "Bob"},
  { "id": 2, "name": "Bill"}
]

For testing, we are only interested in the asserts results, we don't need the HTTP body response. To use Hurl as a test tool with an adapted output, you can use --test option:

$ hurl --test hello.hurl assert_json.hurl
hello.hurl: Success (6 request(s) in 245 ms)
assert_json.hurl: Success (8 request(s) in 308 ms)
--------------------------------------------------------------------------------
Executed files:    2
Executed requests: 10 (17.82/s)
Succeeded files:   2 (100.0%)
Failed files:      0 (0.0%)
Duration:          561 ms

Or, in case of errors:

$ hurl --test hello.hurl error_assert_status.hurl 
hello.hurl: Success (6 request(s) in 258 ms)
error: Assert status code
  --> assert_json.hurl:6:8
   |
 6 | HTTP 200
   |        ^^^ actual value is <301>
   |

assert_json.hurl: Failure (5 request(s) in 230 ms)
--------------------------------------------------------------------------------
Executed files:    2
Executed requests: 7 (14.02/s)
Succeeded files:   1 (50.0%)
Failed files:      1 (50.0%)
Duration:         499 ms

You can use --glob option to test files that match a given pattern:

$ hurl --test --glob "test/integration/**/*.hurl"

In test mode, files are executed in parallel to speed-ud the execution. If a sequential run is needed, you can use --jobs 1 option to execute one test by one test.

$ hurl --test --jobs 1 *.hurl

Generating Report

In the different reports, files are always referenced in the input order (which, as tests are executed in parallel, can be different from the execution order).

HTML Report

Hurl can generate an HTML report by using the --report-html DIR option.

If the HTML report already exists, the test results will be appended to it.

The input Hurl files (HTML version) are also included and are easily accessed from the main page.

JSON Report

A JSON report can be produced by using the --report-json DIR. The report directory will contain a report.json file, including each test file executed with --json option and a reference to each HTTP response of the run dumped to disk.

If the JSON report already exists, it will be updated with the new test results.

JUnit Report

A JUnit report can be produced by using the --report-junit FILE option.

If the JUnit report already exists, it will be updated with the new test results.

TAP Report

A TAP report (Test Anything Protocol) can be produced by using the --report-tap FILE option.

If the TAP report already exists, it will be updated with the new test results.

Use Variables in Tests

To use variables in your tests, you can:

• use --variable option
• use --variables-file option
• define environment variables, for instance HURL_foo=bar

You will find a detailed description in the Injecting Variables section of the docs.