Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-12-15 02:51:47 +03:00
Code Issues Packages Projects Releases Wiki Activity
88e748b787
hurl/docs/tutorial/debug-tips.md

458 lines
14 KiB
Markdown
Raw Normal View History

Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
# Debug Tips
fix grammar in docs
2022-09-28 11:24:24 +03:00
Now that we have many requests in our test file, let's review some tips on how to debug the executed HTTP exchanges.
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
## Verbose Mode
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
### Using --verbose and --very-verbose for all entries
fix grammar in docs
2022-09-28 11:24:24 +03:00
We can run our test with [`-v/--verbose` option]. In this mode, each entry is displayed with debugging
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
information like request HTTP headers, response HTTP headers, cookie storage, duration etc...
```shell
fix typos in docs
2022-09-25 13:52:24 +03:00
$ hurl --verbose --no-output basic.hurl
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
* Options:
* fail fast: true
* insecure: false
* follow redirect: false
* max redirect: 50
* ------------------------------------------------------------------------------
* Executing entry 1
*
* Cookie store:
*
* Request:
* GET http://localhost:8080
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080'
*
> GET / HTTP/1.1
> Host: localhost:8080
> Accept: */*
> User-Agent: hurl/1.7.0-snapshot
>
* Response:
*
< HTTP/1.1 200
< Set-Cookie: JSESSIONID=361948EF00AA04CB6659954A8D3EBC9D; Path=/; HttpOnly
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: text/html;charset=UTF-8
< Content-Language: en-FR
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 07:30:15 GMT
<
*
* ------------------------------------------------------------------------------
* Executing entry 2
*
* Cookie store:
* #HttpOnly_localhost FALSE / FALSE 0 JSESSIONID 361948EF00AA04CB6659954A8D3EBC9D
*
* Request:
* GET http://localhost:8080/not-found
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080/not-found' --cookie 'JSESSIONID=361948EF00AA04CB6659954A8D3EBC9D'
*
> GET /not-found HTTP/1.1
> Host: localhost:8080
> Accept: */*
> Cookie: JSESSIONID=361948EF00AA04CB6659954A8D3EBC9D
> User-Agent: hurl/1.7.0-snapshot
>
* Response:
*
< HTTP/1.1 404
< Vary: Origin
< Vary: Access-Control-Request-Method
< Vary: Access-Control-Request-Headers
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: text/html;charset=UTF-8
< Content-Language: en-FR
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 07:30:15 GMT
<
*
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
...
```
fix grammar in docs
2022-09-28 11:24:24 +03:00
Lines beginning with `*` are debug info, lines that begin with `>` are HTTP request headers and lines that begin with
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
`<` are HTTP response headers.
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
In verbose mode, HTTP request and response bodies are not displayed in the debug logs. If you need to inspect the
request or response body, you can display more logs with [`--very-verbose`] option:
```shell
fix typos in docs
2022-09-25 13:52:24 +03:00
$ hurl --very-verbose --no-output basic.hurl
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
* Options:
* fail fast: true
* insecure: false
* follow redirect: false
* max redirect: 50
* ------------------------------------------------------------------------------
* Executing entry 1
*
* Cookie store:
*
* Request:
* GET http://localhost:8080
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080'
*
> GET / HTTP/1.1
> Host: localhost:8080
> Accept: */*
> User-Agent: hurl/1.7.0-snapshot
>
* Request body:
*
* Response:
*
< HTTP/1.1 200
< Set-Cookie: JSESSIONID=0B417BD5890C001B5B25A9B321FE4800; Path=/; HttpOnly
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: text/html;charset=UTF-8
< Content-Language: en-FR
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 07:42:46 GMT
<
* Response body:
* <!doctype html>
* <html lang="en">
* <head>
* <meta charset="UTF-8" />
* <meta name="viewport" content="width=device-width, initial-scale=1.0" />
* <title>Welcome to Quiz!</title>
* <link rel="stylesheet" href="/style.css">
* <!--<script src="script.js"></script>-->
* </head>
* <body>
* <div>
...
* </body>
* </html>
*
*
* ------------------------------------------------------------------------------
* Executing entry 2
*
* Cookie store:
* #HttpOnly_localhost FALSE / FALSE 0 JSESSIONID 0B417BD5890C001B5B25A9B321FE4800
*
* Request:
* GET http://localhost:8080/not-found
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080/not-found' --cookie 'JSESSIONID=0B417BD5890C001B5B25A9B321FE4800'
*
> GET /not-found HTTP/1.1
> Host: localhost:8080
> Accept: */*
> Cookie: JSESSIONID=0B417BD5890C001B5B25A9B321FE4800
> User-Agent: hurl/1.7.0-snapshot
>
* Request body:
*
* Response:
*
< HTTP/1.1 404
< Vary: Origin
< Vary: Access-Control-Request-Method
< Vary: Access-Control-Request-Headers
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: text/html;charset=UTF-8
< Content-Language: en-FR
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 07:42:46 GMT
<
* Response body:
* <!doctype html>
* <html lang="en">
* <head>
* <meta charset="UTF-8" />
* <meta name="viewport" content="width=device-width, initial-scale=1.0" />
* <title>Error 404 - Quiz</title>
* <link rel="stylesheet" href="/style.css">
* <!--<script src="script.js"></script>-->
* </head>
* <body>
* <div>
* <a href="/"><img class="logo-img" src="/quiz.svg" alt="Quiz logo"></a>
* </div>
* <div class="main">
*
* <h1>Error 404, Page not Found!</h1>
*
...
* </body>
* </html>
*
*
...
```
### Debugging a specific entry
fix grammar in docs
2022-09-28 11:24:24 +03:00
If you have a lot of entries (request / response pairs) in your Hurl file, using [`--verbose`] or [`--very-verbose`]
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
can produce a lot of logs and can be difficult to analyse. Instead of passing options to the command line, you can
use an `[Options]` section that will activate logs only for the specified entry:
```hurl
# Checking our home page:
# ...
# Check that we have a 404 response for broken links:
# ...
change "api" to "API" in docs
2022-09-28 11:34:00 +03:00
# Check our health API:
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
# ...
change "api" to "API" in docs
2022-09-28 11:34:00 +03:00
# Check question API:
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
GET http://localhost:8080/api/questions
# You can pass options to this entry only
[Options]
verbose: true
[QueryStringParams]
offset: 0
size: 20
sort: oldest
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
HTTP 200
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
# ...
```
And run it without [`--verbose`] option:
```shell
fix typos in docs
2022-09-25 13:52:24 +03:00
$ hurl --no-output basic.hurl
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
* ------------------------------------------------------------------------------
* Executing entry 4
*
* Entry options:
* verbose: true
*
* Cookie store:
* #HttpOnly_localhost FALSE / FALSE 0 JSESSIONID 31818147FB20A7085AC54C372318BAF1
*
* Request:
* GET http://localhost:8080/api/questions
* [QueryStringParams]
* offset: 0
* size: 20
* sort: oldest
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080/api/questions?offset=0&size=20&sort=oldest' --cookie 'JSESSIONID=31818147FB20A7085AC54C372318BAF1'
*
> GET /api/questions?offset=0&size=20&sort=oldest HTTP/1.1
> Host: localhost:8080
> Accept: */*
> Cookie: JSESSIONID=31818147FB20A7085AC54C372318BAF1
> User-Agent: hurl/1.7.0-snapshot
>
* Response:
*
< HTTP/1.1 200
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: application/json
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 08:11:50 GMT
<
*
```
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
## Interactive Mode
We can run the whole Hurl file request by request, with the [`--interactive` option]:
```shell
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
* Options:
* fail fast: true
* insecure: false
* follow redirect: false
* max redirect: 50
Interactive mode:
Next request:
GET http://localhost:8080
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
Press Q (Quit) or C (Continue)
Update shell Hurl snippets with colored output.
2022-08-16 16:30:48 +03:00
* ------------------------------------------------------------------------------
* Executing entry 1
*
* Cookie store:
*
* Request:
* GET http://localhost:8080
*
* Request can be run with the following curl command:
* curl 'http://localhost:8080'
*
> GET / HTTP/1.1
> Host: localhost:8080
> Accept: */*
> User-Agent: hurl/1.7.0-snapshot
>
* Response:
*
< HTTP/1.1 200
< Set-Cookie: JSESSIONID=B08BF0F6F83E91750A76E97713A5C144; Path=/; HttpOnly
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Frame-Options: DENY
< Content-Type: text/html;charset=UTF-8
< Content-Language: en-FR
< Transfer-Encoding: chunked
< Date: Wed, 17 Aug 2022 08:18:36 GMT
<
*
Interactive mode:
Next request:
GET http://localhost:8080/not-found
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
Press Q (Quit) or C (Continue)
```
## Include Headers Like curl
We can also run our file to only output HTTP headers, with [`-i/--include` option].
In this mode, headers of the last entry are displayed:
```shell
$ hurl -i basic.hurl
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
HTTP/1.1 200
Set-Cookie: JSESSIONID=76984131F0D0821C4A8D5CB3FC27CD3B; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 13 Jan 2023 12:49:47 GMT
{"status":"RUNNING","reportedDate":"2023-01-13T13:49:47+01:00","healthy":true,"operationId":3183000623}
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
```
fix grammar in docs
2022-09-28 11:24:24 +03:00
If you want to inspect any entry other than the last one, you can run your test to a
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
given entry with the [`--to-entry` option], starting at index 1:
```shell
$ hurl -i --to-entry 2 basic.hurl
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
HTTP/1.1 404
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: text/html;charset=UTF-8
Content-Language: en-FR
Transfer-Encoding: chunked
Date: Fri, 13 Jan 2023 12:50:52 GMT
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
<!doctype html>
<html lang="en">
<head>
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Error 404 - Quiz</title>
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
<link rel="stylesheet" href="/style.css">
<!--<script src="script.js"></script>-->
</head>
<body>
<div>
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
<a href="/"><img class="logo-img" src="/quiz.svg" alt="Quiz logo"></a>
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
</div>
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
<div class="main">
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
<h1>Error 404, Page not Found!</h1>
<a href="/">Quiz Home</a>
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
</div>
<footer>
<div class="footer">
<div class="footer-body">a game by <a href="https://hurl.dev">Hurl&RightArrowLeftArrow; Team</a></div>
</div>
</footer>
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
</body>
</html>
Update docs for Hurl 2.0.0.
2022-12-19 23:30:08 +03:00
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
```
## Using a Proxy
Finally, you can use a proxy between Hurl and your server to inspect requests and responses.
Update docs.
2023-04-17 19:05:07 +03:00
For instance, with [mitmproxy]:
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
Update docs.
2023-04-17 19:05:07 +03:00
1. First, launch mitmproxy, it will listen to connections on 8888 port
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
```shell
Update docs.
2023-04-17 19:05:07 +03:00
$ mitmweb -p 8888 --web-port 8889 --web-open-browser
Web server listening at http://127.0.0.1:8889/
Proxy server listening at http://*:8888
Import of the canonical docs (raw Markdown, without ant Jekyll specificities.)
2022-05-31 15:36:54 +03:00
```
2. Then, run Hurl with [`-x/--proxy` option]
```shell
$ hurl --proxy localhost:8888 basic.hurl
```
Update docs.
2023-04-17 19:05:07 +03:00
The web interface of mitmproxy allows you to inspect, intercept any requests run by Hurl, and see
the returned response to Hurl.
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
[`-v/--verbose` option]: /docs/manual.md#verbose
[`--very-verbose`]: /docs/manual.md#very-verbose
[`--verbose`]: /docs/manual.md#verbose
[`--interactive` option]: /docs/manual.md#interactive
[`-i/--include` option]: /docs/manual.md#include
[`--to-entry` option]: /docs/manual.md#to-entry
Update docs.
2023-04-17 19:05:07 +03:00
[mitmproxy]: https://mitmproxy.org
Rename manual-page.md to manual.md
2022-09-02 15:45:54 +03:00
[`-x/--proxy` option]: /docs/manual.md#proxy
Reference in New Issue Copy Permalink