Add --unix-socket option

This is a feature provided by cURL that allows sending requests to
a web server via a Unix Domain Socket. Some use cases
include:

* Querying docker API
* Running a web server w/o opening a TCP port for security and/or performance reasons

https://curl.se/docs/manpage.html#--unix-socket

README.md

@@ -972,6 +972,7 @@ will follow a redirection only for the second entry.
 | <a href="#ssl-no-revoke" id="ssl-no-revoke"><code>--ssl-no-revoke</code></a>                                      | (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.<br>                                                                                                                                                                                                                     |
 | <a href="#test" id="test"><code>--test</code></a>                                                                 | Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.<br>                                                                                                                                                                                                       |
 | <a href="#to-entry" id="to-entry"><code>--to-entry &lt;ENTRY_NUMBER&gt;</code></a>                                | Execute Hurl file to ENTRY_NUMBER (starting at 1).<br>Ignore the remaining of the file. It is useful for debugging a session.<br>                                                                                                                                                                                                                                                                  |
+| <a href="#unix-socket" id="unix-socket"><code>--unix-socket &lt;PATH&gt;</code></a>                               | (HTTP) Connect through this Unix domain socket, instead of using the network.<br>                                                                                                                                                                                                                                                                                                                                                                       |
 | <a href="#user" id="user"><code>-u, --user &lt;USER:PASSWORD&gt;</code></a>                                       | Add basic Authentication header to each request.<br>                                                                                                                                                                                                                                                                                                                                               |
 | <a href="#user-agent" id="user-agent"><code>-A, --user-agent &lt;NAME&gt;</code></a>                              | Specify the User-Agent string to send to the HTTP server.<br>                                                                                                                                                                                                                                                                                                                                      |
 | <a href="#variable" id="variable"><code>--variable &lt;NAME=VALUE&gt;</code></a>                                  | Define variable (name/value) to be used in Hurl templates.<br>                                                                                                                                                                                                                                                                                                                                     |

bin/test/test_prerequisites.sh

@@ -61,6 +61,9 @@ echo -e "\n------------------ Starting ssl/server.py (Self-signed certificate +
 nohup python3 ssl/server.py 8003 ssl/server/cert.selfsigned.pem true > build/server-ssl-client-authent.log 2>&1 &
 check_listen_port "ssl/server.py" 8003 || cat_and_exit_err build/server-ssl-client-authent.log
 
+echo -e "\n------------------ Starting unix_socket/server.py"
+python3 unix_socket/server.py > build/server-unix-socket.log 2>&1 &
+
 echo -e "\n------------------ Starting squid (proxy)"
 if [ -f /var/run/squid.pid ] ; then
   sudo squid -k shutdown || true

contrib/npm/hurl/docs/hurl.1

@@ -306,6 +306,10 @@ Duration in milliseconds between each retry. Default is 1000 ms.
 
 (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.
 
+.IP "--unix-socket <PATH> "
+
+(HTTP) Connect through this Unix domain socket, instead of using the network.
+
 .IP "--test "
 
 Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.

contrib/sample/src/main.rs

@@ -76,6 +76,7 @@ fn main() {
         .retry(Retry::None)
         .retry_interval(Duration::from_secs(1))
         .ssl_no_revoke(false)
+        .unix_socket(None)
         .timeout(Duration::from_secs(300))
         .to_entry(None)
         .user(None)

docs/manual.md

@@ -191,6 +191,7 @@ will follow a redirection only for the second entry.
 | <a href="#ssl-no-revoke" id="ssl-no-revoke"><code>--ssl-no-revoke</code></a>                                      | (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.<br>                                                                                                                                                                                                                     |
 | <a href="#test" id="test"><code>--test</code></a>                                                                 | Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.<br>                                                                                                                                                                                                       |
 | <a href="#to-entry" id="to-entry"><code>--to-entry &lt;ENTRY_NUMBER&gt;</code></a>                                | Execute Hurl file to ENTRY_NUMBER (starting at 1).<br>Ignore the remaining of the file. It is useful for debugging a session.<br>                                                                                                                                                                                                                                                                  |
+| <a href="#unix-socket" id="unix-socket"><code>--unix-socket &lt;PATH&gt;</code></a>                               | (HTTP) Connect through this Unix domain socket, instead of using the network.<br>                                                                                                                                                                                                                                                                                                                                                                       |
 | <a href="#user" id="user"><code>-u, --user &lt;USER:PASSWORD&gt;</code></a>                                       | Add basic Authentication header to each request.<br>                                                                                                                                                                                                                                                                                                                                               |
 | <a href="#user-agent" id="user-agent"><code>-A, --user-agent &lt;NAME&gt;</code></a>                              | Specify the User-Agent string to send to the HTTP server.<br>                                                                                                                                                                                                                                                                                                                                      |
 | <a href="#variable" id="variable"><code>--variable &lt;NAME=VALUE&gt;</code></a>                                  | Define variable (name/value) to be used in Hurl templates.<br>                                                                                                                                                                                                                                                                                                                                     |

docs/manual/hurl.1

@@ -332,6 +332,10 @@ Duration in milliseconds between each retry. Default is 1000 ms.
 
 (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.
 
+.IP "--unix-socket <PATH> "
+
+(HTTP) Connect through this Unix domain socket, instead of using the network.
+
 .IP "--test "
 
 Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.

docs/manual/hurl.md

@@ -361,6 +361,10 @@ Activate test mode: with this, the HTTP response is not outputted anymore, progr
 Execute Hurl file to ENTRY_NUMBER (starting at 1).
 Ignore the remaining of the file. It is useful for debugging a session.
 
+### --unix-socket <PATH> {#unix-socket}
+
+(HTTP) Connect through this Unix domain socket, instead of using the network.
+
 ### -u, --user <USER:PASSWORD> {#user}
 
 Add basic Authentication header to each request.

docs/spec/grammar/hurl.grammar

@@ -139,6 +139,7 @@ option:
   | retry-option
   | retry-interval-option
   | skip-option
+  | unix-socket-option
   | variable-option
   | verbose-option
   | very-verbose-option
@@ -190,6 +191,8 @@ retry-interval-option: "retry-interval" ":" integer-option lt
 
 skip-option: "skip" ":" boolean-option lt
 
+unix-socket-option: "unix-socket" ":" value-string lt
+
 variable-option: "variable" ":" variable-definition lt
 
 verbose-option: "verbose" ":" boolean-option lt

docs/spec/options/hurl/unix_socket.option

@@ -0,0 +1,6 @@
+name: unix_socket
+long: unix-socket
+value: <path>
+help: (HTTP) Connect through this Unix domain socket, instead of using the network
+---
+(HTTP) Connect through this Unix domain socket, instead of using the network.

integration/README.md

@@ -25,7 +25,7 @@ virtual environment and install required dependencies:
 ```shell
 $ python3 -m venv .venv
 $ source .venv/bin/activate
-$ pip install --requirements bin/requirements-fozen.txt
+$ pip install --requirement bin/requirements-frozen.txt
 ```
 
 ### Proxy

integration/hurl/tests_error_parser/invalid_option.err

@@ -2,6 +2,6 @@ error: Parsing option
   --> tests_error_parser/invalid_option.hurl:3:1
    |
  3 | foo: true
-   | ^ the option name is not valid. Valid values are aws-sigv4, cacert, cert, compressed, connect-to, delay, insecure, http1.0, http1.1, http2, http3, ipv4, ipv6, key, location, max-redirs, output, path-as-is, proxy, resolve, retry, retry-interval, skip, variable, verbose, very-verbose
+   | ^ the option name is not valid. Valid values are aws-sigv4, cacert, cert, compressed, connect-to, delay, insecure, http1.0, http1.1, http2, http3, ipv4, ipv6, key, location, max-redirs, output, path-as-is, proxy, resolve, retry, retry-interval, skip, unix-socket, variable, verbose, very-verbose
    |
 

integration/hurl/tests_failed/unix_socket.err.pattern

@@ -0,0 +1,7 @@
+error: HTTP connection
+  --> tests_ok/unix_socket.hurl:1:5
+   |
+ 1 | GET http://example/hello
+   |     ^^^^^^^^^^^^^^^^^^^^ (7) ~~~
+   |
+

integration/hurl/tests_failed/unix_socket.exit

@@ -0,0 +1 @@
+3

integration/hurl/tests_failed/unix_socket.ps1

@@ -0,0 +1,8 @@
+Set-StrictMode -Version latest
+
+# The python test server for testing Unix Domain Sockets
+# (../unix_socket/server.py) does not currently support AF_UNIX on Windows.
+# See https://github.com/python/cpython/issues/77589
+# Skip for now until this can be easily tested.
+$ErrorActionPreference = 'Continue'
+exit 255

integration/hurl/tests_failed/unix_socket.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -Eeuo pipefail
+hurl --unix-socket /unknown tests_ok/unix_socket.hurl

integration/hurl/tests_ok/help.out.pattern

@@ -97,6 +97,8 @@ Options:
           Activate test mode
       --to-entry <ENTRY_NUMBER>
           Execute Hurl file to ENTRY_NUMBER (starting at 1)
+      --unix-socket <PATH>
+          (HTTP) Connect through this Unix domain socket, instead of using the network.
   -A, --user-agent <NAME>
           Specify the User-Agent string to send to the HTTP server
   -u, --user <USER:PASSWORD>

integration/hurl/tests_ok/unix_socket.curl

@@ -0,0 +1 @@
+curl --unix-socket 'build/unix_socket.sock' 'http://example/hello'

integration/hurl/tests_ok/unix_socket.hurl

@@ -0,0 +1,4 @@
+GET http://example/hello
+HTTP 200
+[Asserts]
+`Hello World!`

integration/hurl/tests_ok/unix_socket.out

@@ -0,0 +1 @@
+Hello World!

integration/hurl/tests_ok/unix_socket.ps1

@@ -0,0 +1,8 @@
+Set-StrictMode -Version latest
+
+# The python test server for testing Unix Domain Sockets
+# (../unix_socket/server.py) does not currently support AF_UNIX on Windows.
+# See https://github.com/python/cpython/issues/77589
+# Skip for now until this can be easily tested.
+$ErrorActionPreference = 'Continue'
+exit 255

integration/hurl/tests_ok/unix_socket.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -Eeuo pipefail
+hurl --unix-socket build/unix_socket.sock --verbose tests_ok/unix_socket.hurl

integration/hurl/unix_socket/server.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+from os import path, unlink
+from socket import socket, AF_UNIX
+from flask import Flask
+
+app = Flask("Unix Domain Sockets Server")
+
+
+@app.route("/hello")
+def hello():
+    return "Hello World!"
+
+
+def main():
+    sock = socket(AF_UNIX)
+    socket_path = "build/unix_socket.sock"
+
+    try:
+        unlink(socket_path)
+    except OSError:
+        if path.exists(socket_path):
+            raise
+
+    sock.bind(socket_path)
+
+    try:
+        app.run(host="unix://" + socket_path)
+    finally:
+        unlink(socket_path)
+
+
+if __name__ == "__main__":
+    main()

integration/hurlfmt/tests_export/unix_socket_option.html

@@ -0,0 +1,9 @@
+<pre><code class="language-hurl"><span class="hurl-entry"><span class="request"><span class="line"></span><span class="comment"># Go through a Unix Domain Socket</span>
+<span class="line"></span><span class="comment"># Requests will be sent to the Unix Domain Socket instead of over the network</span>
+<span class="line"><span class="method">GET</span> <span class="url">http://example/hello</span></span>
+<span class="line"><span class="section-header">[Options]</span></span>
+<span class="line"><span class="string">unix-socket</span>: <span class="string">build/unix_socket.sock</span></span>
+</span><span class="response"><span class="line"><span class="version">HTTP</span> <span class="number">200</span></span>
+<span class="line"><span class="section-header">[Asserts]</span></span>
+<span class="line"><span class="string">`Hello World!`</span></span>
+</span></span></code></pre>

integration/hurlfmt/tests_export/unix_socket_option.hurl

@@ -0,0 +1,8 @@
+# Go through a Unix Domain Socket
+# Requests will be sent to the Unix Domain Socket instead of over the network
+GET http://example/hello
+[Options]
+unix-socket: build/unix_socket.sock
+HTTP 200
+[Asserts]
+`Hello World!`

integration/hurlfmt/tests_export/unix_socket_option.json

@@ -0,0 +1 @@
+{"entries":[{"request":{"method":"GET","url":"http://example/hello","options":[{"name":"unix-socket","value":"build/unix_socket.sock"}]},"response":{"status":200,"body":{"type":"text","value":"Hello World!"}}}]}

packages/hurl/README.md

@@ -964,6 +964,7 @@ will follow a redirection only for the second entry.
 | <a href="#ssl-no-revoke" id="ssl-no-revoke"><code>--ssl-no-revoke</code></a>                                      | (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.<br>                                                                                                                                                                                                                     |
 | <a href="#test" id="test"><code>--test</code></a>                                                                 | Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.<br>                                                                                                                                                                                                       |
 | <a href="#to-entry" id="to-entry"><code>--to-entry &lt;ENTRY_NUMBER&gt;</code></a>                                | Execute Hurl file to ENTRY_NUMBER (starting at 1).<br>Ignore the remaining of the file. It is useful for debugging a session.<br>                                                                                                                                                                                                                                                                  |
+| <a href="#unix-socket" id="unix-socket"><code>--unix-socket &lt;PATH&gt;</code></a>                               | (HTTP) Connect through this Unix domain socket, instead of using the network.<br>                                                                                                                                                                                                                                                                                                                                                                       |
 | <a href="#user" id="user"><code>-u, --user &lt;USER:PASSWORD&gt;</code></a>                                       | Add basic Authentication header to each request.<br>                                                                                                                                                                                                                                                                                                                                               |
 | <a href="#user-agent" id="user-agent"><code>-A, --user-agent &lt;NAME&gt;</code></a>                              | Specify the User-Agent string to send to the HTTP server.<br>                                                                                                                                                                                                                                                                                                                                      |
 | <a href="#variable" id="variable"><code>--variable &lt;NAME=VALUE&gt;</code></a>                                  | Define variable (name/value) to be used in Hurl templates.<br>                                                                                                                                                                                                                                                                                                                                     |

packages/hurl/src/cli/options/commands.rs

@@ -405,6 +405,14 @@ pub fn to_entry() -> clap::Arg {
         .num_args(1)
 }
 
+pub fn unix_socket() -> clap::Arg {
+    clap::Arg::new("unix_socket")
+        .long("unix-socket")
+        .value_name("PATH")
+        .help("(HTTP) Connect through this Unix domain socket, instead of using the network.")
+        .num_args(1)
+}
+
 pub fn user() -> clap::Arg {
     clap::Arg::new("user")
         .long("user")

packages/hurl/src/cli/options/matches.rs

@@ -320,6 +320,10 @@ pub fn to_entry(arg_matches: &ArgMatches) -> Option<usize> {
     get::<u32>(arg_matches, "to_entry").map(|x| x as usize)
 }
 
+pub fn unix_socket(arg_matches: &ArgMatches) -> Option<String> {
+    get::<String>(arg_matches, "unix_socket")
+}
+
 pub fn user(arg_matches: &ArgMatches) -> Option<String> {
     get::<String>(arg_matches, "user")
 }