Add httpassert header validation

Author: stefanTolksdorf

pkg/httpassert/matcher.go

@@ -6,6 +6,7 @@ package httpassert
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -45,3 +46,13 @@ func Contains(v string) Matcher {
 		return valid
 	}
 }
+
+// Regex checks if a string matches the given regular expression
+// Example: ExpectJsonPath("$.data.name", httpassert.Regex("^foo.*bar$"))
+func Regex(expr string) Matcher {
+	re := regexp.MustCompile(expr)
+
+	return func(t *testing.T, value any) bool {
+		return assert.Regexp(t, re, value)
+	}
+}

pkg/httpassert/response.go

@@ -36,13 +36,32 @@ type Response interface {
 	JsonTemplateFile(path string, values map[string]any) Response
 	JsonFile(path string) Response
 
+	Header(name string, value any) Response
+
 	Body(body string) Response
 	GetJsonBodyObject(target any) Response
 	GetBody() string
 
 	Log() Response
 }
 
+func (r *responseImpl) Header(name string, value any) Response {
+	out := r.response.Header().Get(name)
+
+	switch v := value.(type) {
+	case Extractor:
+		v(r.t, out)
+		return r
+	case Matcher:
+		v(r.t, out)
+		return r
+
+	default:
+		assert.Equal(r.t, value, out)
+		return r
+	}
+}
+
 func (r *responseImpl) StatusCode(expected int) Response {
 	require.Equal(r.t, expected, r.response.Code)
 	return r

pkg/httpassert/response_test.go

@@ -143,6 +143,40 @@ func TestResponse(t *testing.T) {
 		})
 	})
 
+	t.Run("Header", func(t *testing.T) {
+		router := http.NewServeMux()
+		router.HandleFunc("/api", func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "application/json")
+			w.WriteHeader(http.StatusOK)
+		})
+
+		t.Run("compare string", func(t *testing.T) {
+			m := New(t, router)
+
+			m.Get("/api").
+				Expect().
+				Header("Content-Type", "application/json")
+		})
+
+		t.Run("extract value to variable", func(t *testing.T) {
+			m := New(t, router)
+
+			var value string
+			m.Get("/api").
+				Expect().
+				Header("Content-Type", ExtractTo(&value))
+			assert.Equal(t, "application/json", value)
+		})
+
+		t.Run("use matcher", func(t *testing.T) {
+			m := New(t, router)
+
+			m.Get("/api").
+				Expect().
+				Header("Content-Type", Regex("application/[json]"))
+		})
+	})
+
 	t.Run("POST basic JSON", func(t *testing.T) {
 		request.Post("/json").
 			ContentType("application/json").