Add --curl option to export executed requests to curl commands

Orange-OpenSource · Nov 7, 2024 · f759b6b · f759b6b
1 parent fb85f78
commit f759b6b
Show file tree

Hide file tree

Showing 28 changed files with 151 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1229,6 +1229,7 @@ will follow a redirection only for the second entry.
 | <a href="#continue-on-error" id="continue-on-error"><code>--continue-on-error</code></a>                          | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br>By default, Hurl exits after an assert error in the HTTP response.<br><br>Note that this option does not affect the behavior with multiple input Hurl files.<br><br>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br><br>This is a cli-only option.<br> |
 | <a href="#cookie" id="cookie"><code>-b, --cookie &lt;FILE&gt;</code></a>                                          | Read cookies from FILE (using the Netscape cookie file format).<br><br>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                        |
 | <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;FILE&gt;</code></a>                              | Write cookies to FILE after running the session (only for one session).<br>The file will be written using the Netscape cookie file format.<br><br>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                     |
+| <a href="#curl" id="curl"><code>--curl &lt;FILE&gt;</code></a>                                                    | Export each request to a list of curl commands.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                                |
 | <a href="#delay" id="delay"><code>--delay &lt;MILLISECONDS&gt;</code></a>                                         | Sets delay before each request. The delay is not applied to requests that have been retried because of [`--retry`](#retry). See [`--retry-interval`](#retry-interval) to space retried requests.<br><br>You can specify time units in the delay expression. Set Hurl to use a delay of 2 seconds with `--delay 2s` or set it to 500 milliseconds with `--delay 500ms`. No spaces allowed.<br>                                        |
 | <a href="#error-format" id="error-format"><code>--error-format &lt;FORMAT&gt;</code></a>                          | Control the format of error message (short by default or long)<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                 |
 | <a href="#file-root" id="file-root"><code>--file-root &lt;DIR&gt;</code></a>                                      | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.<br>When it is not explicitly defined, files are relative to the Hurl file's directory.<br><br>This is a cli-only option.<br>                                                                                                                                                                            |

diff --git a/completions/_hurl b/completions/_hurl
@@ -26,6 +26,7 @@ _hurl() {
     '--continue-on-error[Continue executing requests even if an error occurs]' \
     '(-b --cookie)'{-b,--cookie}'[Read cookies from FILE]: :_files' \
     '(-c --cookie-jar)'{-c,--cookie-jar}'[Write cookies to FILE after running the session (only for one session)]: :_files' \
+    '--curl[Export each request to a list of curl commands]: :_files' \
     '--delay[Sets delay before each request]: :' \
     '--error-format[Control the format of error messages]: :' \
     '--fail-at-end[Fail at end]' \

diff --git a/completions/_hurl.ps1 b/completions/_hurl.ps1
@@ -31,6 +31,7 @@ Register-ArgumentCompleter -Native -CommandName 'hurl' -ScriptBlock {
             [CompletionResult]::new('--continue-on-error', 'continue-on-error', [CompletionResultType]::ParameterName, 'Continue executing requests even if an error occurs')
             [CompletionResult]::new('--cookie', 'cookie', [CompletionResultType]::ParameterName, 'Read cookies from FILE')
             [CompletionResult]::new('--cookie-jar', 'cookie-jar', [CompletionResultType]::ParameterName, 'Write cookies to FILE after running the session (only for one session)')
+            [CompletionResult]::new('--curl', 'curl', [CompletionResultType]::ParameterName, 'Export each request to a list of curl commands')
             [CompletionResult]::new('--delay', 'delay', [CompletionResultType]::ParameterName, 'Sets delay before each request')
             [CompletionResult]::new('--error-format', 'error-format', [CompletionResultType]::ParameterName, 'Control the format of error messages')
             [CompletionResult]::new('--fail-at-end', 'fail-at-end', [CompletionResultType]::ParameterName, 'Fail at end')

diff --git a/completions/hurl.bash b/completions/hurl.bash
@@ -5,7 +5,7 @@ _hurl()
     _init_completion || return
 
     if [[ $cur == -* ]]; then
-        COMPREPLY=($(compgen -W '--aws-sigv4 --cacert --cert --key --color --compressed --connect-timeout --connect-to --continue-on-error --cookie --cookie-jar --delay --error-format --fail-at-end --file-root --location --location-trusted --from-entry --glob --http1.0 --http1.1 --http2 --http3 --ignore-asserts --include --insecure --interactive --ipv4 --ipv6 --jobs --json --limit-rate --max-filesize --max-redirs --max-time --netrc --netrc-file --netrc-optional --no-color --no-output --noproxy --output --parallel --path-as-is --proxy --repeat --report-html --report-json --report-junit --report-tap --resolve --retry --retry-interval --ssl-no-revoke --test --to-entry --unix-socket --user --user-agent --variable --variables-file --verbose --very-verbose --help --version' -- "$cur"))
+        COMPREPLY=($(compgen -W '--aws-sigv4 --cacert --cert --key --color --compressed --connect-timeout --connect-to --continue-on-error --cookie --cookie-jar --curl --delay --error-format --fail-at-end --file-root --location --location-trusted --from-entry --glob --http1.0 --http1.1 --http2 --http3 --ignore-asserts --include --insecure --interactive --ipv4 --ipv6 --jobs --json --limit-rate --max-filesize --max-redirs --max-time --netrc --netrc-file --netrc-optional --no-color --no-output --noproxy --output --parallel --path-as-is --proxy --repeat --report-html --report-json --report-junit --report-tap --resolve --retry --retry-interval --ssl-no-revoke --test --to-entry --unix-socket --user --user-agent --variable --variables-file --verbose --very-verbose --help --version' -- "$cur"))
         return
     fi
 

diff --git a/completions/hurl.fish b/completions/hurl.fish
@@ -9,6 +9,7 @@ complete -c hurl -l connect-to -d 'For a request to the given HOST1:PORT1 pair,
 complete -c hurl -l continue-on-error -d 'Continue executing requests even if an error occurs'
 complete -c hurl -l cookie -d 'Read cookies from FILE'
 complete -c hurl -l cookie-jar -d 'Write cookies to FILE after running the session (only for one session)'
+complete -c hurl -l curl -d 'Export each request to a list of curl commands'
 complete -c hurl -l delay -d 'Sets delay before each request'
 complete -c hurl -l error-format -d 'Control the format of error messages'
 complete -c hurl -l fail-at-end -d 'Fail at end'

diff --git a/docs/manual.md b/docs/manual.md
@@ -159,6 +159,7 @@ will follow a redirection only for the second entry.
 | <a href="#continue-on-error" id="continue-on-error"><code>--continue-on-error</code></a>                          | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br>By default, Hurl exits after an assert error in the HTTP response.<br><br>Note that this option does not affect the behavior with multiple input Hurl files.<br><br>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br><br>This is a cli-only option.<br> |
 | <a href="#cookie" id="cookie"><code>-b, --cookie &lt;FILE&gt;</code></a>                                          | Read cookies from FILE (using the Netscape cookie file format).<br><br>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                        |
 | <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;FILE&gt;</code></a>                              | Write cookies to FILE after running the session (only for one session).<br>The file will be written using the Netscape cookie file format.<br><br>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                     |
+| <a href="#curl" id="curl"><code>--curl &lt;FILE&gt;</code></a>                                                    | Export each request to a list of curl commands.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                                |
 | <a href="#delay" id="delay"><code>--delay &lt;MILLISECONDS&gt;</code></a>                                         | Sets delay before each request. The delay is not applied to requests that have been retried because of [`--retry`](#retry). See [`--retry-interval`](#retry-interval) to space retried requests.<br><br>You can specify time units in the delay expression. Set Hurl to use a delay of 2 seconds with `--delay 2s` or set it to 500 milliseconds with `--delay 500ms`. No spaces allowed.<br>                                        |
 | <a href="#error-format" id="error-format"><code>--error-format &lt;FORMAT&gt;</code></a>                          | Control the format of error message (short by default or long)<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                 |
 | <a href="#file-root" id="file-root"><code>--file-root &lt;DIR&gt;</code></a>                                      | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.<br>When it is not explicitly defined, files are relative to the Hurl file's directory.<br><br>This is a cli-only option.<br>                                                                                                                                                                            |

diff --git a/docs/manual/hurl.1 b/docs/manual/hurl.1
@@ -1,4 +1,4 @@
-.TH hurl 1 "28 Oct 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual"
+.TH hurl 1 "07 Nov 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurl - run and test HTTP requests.
@@ -197,6 +197,12 @@ Combined with \fI-b, --cookie\fP, you can simulate a cookie storage between succ
 
 This is a cli-only option.
 
+.IP "--curl <FILE> "
+
+Export each request to a list of curl commands.
+
+This is a cli-only option.
+
 .IP "--delay <MILLISECONDS> "
 
 Sets delay before each request. The delay is not applied to requests that have been retried because of \fI--retry\fP. See \fI--retry-interval\fP to space retried requests.

diff --git a/docs/manual/hurl.md b/docs/manual/hurl.md
@@ -216,6 +216,12 @@ Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage betwe
 
 This is a cli-only option.
 
+### --curl <FILE> {#curl}
+
+Export each request to a list of curl commands.
+
+This is a cli-only option.
+
 ### --delay <MILLISECONDS> {#delay}
 
 Sets delay before each request. The delay is not applied to requests that have been retried because of [`--retry`](#retry). See [`--retry-interval`](#retry-interval) to space retried requests.

diff --git a/docs/manual/hurlfmt.1 b/docs/manual/hurlfmt.1
@@ -1,4 +1,4 @@
-.TH hurl 1 "28 Oct 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual"
+.TH hurl 1 "07 Nov 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurlfmt - format Hurl files

diff --git a/docs/spec/options/hurl/curl.option b/docs/spec/options/hurl/curl.option
@@ -0,0 +1,8 @@
+name: curl
+long: curl
+value: FILE
+help: Export each request to a list of curl commands
+help_heading: Output options
+cli_only: true
+---
+Export each request to a list of curl commands.
diff --git a/integration/hurl/tests_ok/assert_body.ps1 b/integration/hurl/tests_ok/assert_body.ps1
@@ -1,3 +1,4 @@
 Set-StrictMode -Version latest
 $ErrorActionPreference = 'Stop'
+
 hurl --verbose tests_ok/assert_body.hurl
diff --git a/integration/hurl/tests_ok/assert_body.sh b/integration/hurl/tests_ok/assert_body.sh
@@ -1,3 +1,4 @@
 #!/bin/bash
 set -Eeuo pipefail
+
 hurl --verbose tests_ok/assert_body.hurl
diff --git a/integration/hurl/tests_ok/assert_body_curl.out b/integration/hurl/tests_ok/assert_body_curl.out
@@ -0,0 +1,4 @@
+curl 'http://localhost:8000/assert-body'
+curl 'http://localhost:8000/assert-body'
+curl 'http://localhost:8000/assert-body-with-crlf'
+curl 'http://localhost:8000/assert-body'
diff --git a/integration/hurl/tests_ok/assert_body_curl.ps1 b/integration/hurl/tests_ok/assert_body_curl.ps1
@@ -0,0 +1,6 @@
+Set-StrictMode -Version latest
+$ErrorActionPreference = 'Stop'
+
+hurl --curl build/assert_body.curl --no-output tests_ok/assert_body.hurl
+
+Write-Host (Get-Content build/assert_body.curl -Raw) -NoNewLine
diff --git a/integration/hurl/tests_ok/assert_body_curl.sh b/integration/hurl/tests_ok/assert_body_curl.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+set -Eeuo pipefail
+
+hurl --curl build/assert_body.curl --no-output  tests_ok/assert_body.hurl
+
+cat build/assert_body.curl
diff --git a/integration/hurl/tests_ok/help.out.pattern b/integration/hurl/tests_ok/help.out.pattern
@@ -72,6 +72,7 @@ HTTP options:
 
 Output options:
       --color                  Colorize output
+      --curl <FILE>            Export each request to a list of curl commands
       --error-format <FORMAT>  Control the format of error messages [default: short] [possible
                                values: short, long]
   -i, --include                Include the HTTP headers in the output

diff --git a/integration/hurl/tests_ok/multilines.ps1 b/integration/hurl/tests_ok/multilines.ps1
@@ -1,3 +1,4 @@
 Set-StrictMode -Version latest
 $ErrorActionPreference = 'Stop'
-hurl tests_ok/multilines.hurl --verbose
+
+hurl --verbose tests_ok/multilines.hurl
diff --git a/integration/hurl/tests_ok/multilines.sh b/integration/hurl/tests_ok/multilines.sh
@@ -1,3 +1,4 @@
 #!/bin/bash
 set -Eeuo pipefail
-hurl tests_ok/multilines.hurl --verbose
+
+hurl --verbose tests_ok/multilines.hurl
diff --git a/integration/hurl/tests_ok/multilines_curl.out b/integration/hurl/tests_ok/multilines_curl.out
@@ -0,0 +1,4 @@
+curl --header 'Content-Type:' --data $'line1\nline2\nline3\n' 'http://localhost:8000/multilines/plain-text'
+curl --header 'Content-Type: application/json' --data $'{\n  "foo": "bar"\n  "baz": 123456\n}\n' 'http://localhost:8000/multilines/json'
+curl --header 'Content-Type: application/xml' --data $'<?xml version="1.0"?>\n<catalog>\n    <book id="bk101">\n        <author>Gambardella, Matthew</author>\n        <title>XML Developer\'s Guide</title>\n        <genre>Computer</genre>\n        <price>44.95</price>\n        <publish_date>2000-10-01</publish_date>\n        <description>An in-depth look at creating applications\n        with XML.</description>\n    </book>\n</catalog>\n' 'http://localhost:8000/multilines/xml'
+curl --header 'Content-Type: application/json' --data '{"query":"{\n  hero {\n    name\n    # Queries can have comments!\n    friends {\n      name\n    }\n  }\n}"}' 'http://localhost:8000/multilines/graphql'
diff --git a/integration/hurl/tests_ok/multilines_curl.ps1 b/integration/hurl/tests_ok/multilines_curl.ps1
@@ -0,0 +1,6 @@
+Set-StrictMode -Version latest
+$ErrorActionPreference = 'Stop'
+
+hurl --verbose --no-output --curl build/multilines.curl tests_ok/multilines.hurl
+
+Write-Host (Get-Content build/multilines.curl -Raw) -NoNewLine
diff --git a/integration/hurl/tests_ok/multilines_curl.sh b/integration/hurl/tests_ok/multilines_curl.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+set -Eeuo pipefail
+
+hurl --verbose --no-output --curl build/multilines.curl tests_ok/multilines.hurl
+
+cat build/multilines.curl
diff --git a/packages/hurl/README.md b/packages/hurl/README.md
@@ -1229,6 +1229,7 @@ will follow a redirection only for the second entry.
 | <a href="#continue-on-error" id="continue-on-error"><code>--continue-on-error</code></a>                          | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br>By default, Hurl exits after an assert error in the HTTP response.<br><br>Note that this option does not affect the behavior with multiple input Hurl files.<br><br>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br><br>This is a cli-only option.<br> |
 | <a href="#cookie" id="cookie"><code>-b, --cookie &lt;FILE&gt;</code></a>                                          | Read cookies from FILE (using the Netscape cookie file format).<br><br>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                        |
 | <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;FILE&gt;</code></a>                              | Write cookies to FILE after running the session (only for one session).<br>The file will be written using the Netscape cookie file format.<br><br>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br><br>This is a cli-only option.<br>                                                                                                                                     |
+| <a href="#curl" id="curl"><code>--curl &lt;FILE&gt;</code></a>                                                    | Export each request to a list of curl commands.<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                                |
 | <a href="#delay" id="delay"><code>--delay &lt;MILLISECONDS&gt;</code></a>                                         | Sets delay before each request. The delay is not applied to requests that have been retried because of [`--retry`](#retry). See [`--retry-interval`](#retry-interval) to space retried requests.<br><br>You can specify time units in the delay expression. Set Hurl to use a delay of 2 seconds with `--delay 2s` or set it to 500 milliseconds with `--delay 500ms`. No spaces allowed.<br>                                        |
 | <a href="#error-format" id="error-format"><code>--error-format &lt;FORMAT&gt;</code></a>                          | Control the format of error message (short by default or long)<br><br>This is a cli-only option.<br>                                                                                                                                                                                                                                                                                                                                 |
 | <a href="#file-root" id="file-root"><code>--file-root &lt;DIR&gt;</code></a>                                      | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.<br>When it is not explicitly defined, files are relative to the Hurl file's directory.<br><br>This is a cli-only option.<br>                                                                                                                                                                            |

diff --git a/packages/hurl/src/cli/options/commands.rs b/packages/hurl/src/cli/options/commands.rs
@@ -128,6 +128,15 @@ pub fn cookies_output_file() -> clap::Arg {
         .num_args(1)
 }
 
+pub fn curl() -> clap::Arg {
+    clap::Arg::new("curl")
+        .long("curl")
+        .value_name("FILE")
+        .help("Export each request to a list of curl commands")
+        .help_heading("Output options")
+        .num_args(1)
+}
+
 pub fn delay() -> clap::Arg {
     clap::Arg::new("delay")
         .long("delay")