feat(http): support cookies in redirects (#866)

Signed-off-by: Gabriel Augendre <gabriel.augendre@ovhcloud.com>

Author: Crocmagnon

executors/http/README.md

@@ -155,3 +155,8 @@ Example if you want to get value of `path` key of *second* element in `apis` arr
 ```yaml
 result.statuscode ShouldEqual 200
 ```
+
+## Cookies
+
+Cookies are automatically handled when following a redirect in a single step.
+They are not supported between successive steps.

executors/http/http.go

@@ -11,6 +11,7 @@ import (
 	"mime/multipart"
 	"net"
 	"net/http"
+	"net/http/cookiejar"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -172,7 +173,14 @@ func (Executor) Run(ctx context.Context, step venom.TestStep) (interface{}, erro
 		tr.Proxy = http.ProxyURL(proxyURL)
 	}
 
-	client := &http.Client{Transport: tr}
+	// cookie jar can be used with redirects in the same call
+	// this doesn't support cross steps cookies.
+	jar, err := cookiejar.New(nil)
+	if err != nil {
+		return nil, err
+	}
+
+	client := &http.Client{Transport: tr, Jar: jar}
 	if e.NoFollowRedirect {
 		client.CheckRedirect = func(req *http.Request, via []*http.Request) error {
 			return http.ErrUseLastResponse

executors/http/http_test.go

@@ -4,8 +4,11 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"net/http"
+	"net/http/httptest"
 	"os"
 	"os/exec"
+	"sync/atomic"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -123,3 +126,54 @@ func TestInterpolation_without_match_Of_String(t *testing.T) {
 	_, err := e.getRequest(ctx, "../../")
 	require.Errorf(t, err, "unable to interpolate file due to unresolved variables {{.name}}")
 }
+
+func TestCookieRedirect(t *testing.T) {
+	callCount := atomic.Int32{}
+	ctx := context.Background()
+
+	mux := http.NewServeMux()
+	mux.HandleFunc("GET /set", func(w http.ResponseWriter, r *http.Request) {
+		http.SetCookie(w, &http.Cookie{
+			Name:     "some-cookie",
+			Value:    "some-value",
+			Path:     "/",
+			MaxAge:   100,
+			Secure:   false,
+			HttpOnly: true,
+		})
+		w.Header().Set("Location", "/get")
+		w.WriteHeader(http.StatusSeeOther)
+	})
+
+	mux.HandleFunc("GET /get", func(w http.ResponseWriter, r *http.Request) {
+		callCount.Add(1)
+		cookie, err := r.Cookie("some-cookie")
+		if err != nil {
+			w.WriteHeader(http.StatusBadRequest)
+			return
+		}
+		if cookie.Value != "some-value" {
+			w.WriteHeader(http.StatusBadRequest)
+			return
+		}
+		w.WriteHeader(http.StatusOK)
+	})
+
+	srv := httptest.NewServer(mux)
+	t.Cleanup(srv.Close)
+
+	e := &Executor{}
+	res, err := e.Run(ctx, venom.TestStep{
+		"method": http.MethodGet,
+		"url":    srv.URL,
+		"path":   "/set",
+	})
+	require.NoError(t, err)
+
+	result, ok := res.(Result)
+	require.True(t, ok)
+
+	require.Equal(t, result.StatusCode, http.StatusOK)
+
+	require.Equal(t, int32(1), callCount.Load())
+}