feat: added serializable http.Header type (#321)

Author: cbosss

util/headers.go

@@ -0,0 +1,48 @@
+package util
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+// Headers is a serializable version of http.Header it supports both yaml & json formats.
+// Headers expects the yaml/json representation to be a map[string]string.
+type Headers struct {
+	http.Header
+}
+
+func (h Headers) MarshalYAML() (interface{}, error) {
+	return h.Header, nil
+}
+
+func (h Headers) MarshalJSON() ([]byte, error) {
+	return json.Marshal(h.Header)
+}
+
+func (h *Headers) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var headers map[string]string
+	if err := unmarshal(&headers); err != nil {
+		return err
+	}
+
+	h.Header = http.Header{}
+	for k, v := range headers {
+		h.Add(k, v)
+	}
+
+	return nil
+}
+
+func (h *Headers) UnmarshalJSON(b []byte) error {
+	var headers map[string]string
+	if err := json.Unmarshal(b, &headers); err != nil {
+		return err
+	}
+
+	h.Header = http.Header{}
+	for k, v := range headers {
+		h.Add(k, v)
+	}
+
+	return nil
+}

util/headers_test.go

@@ -0,0 +1,90 @@
+package util
+
+import (
+	"encoding/json"
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
+)
+
+func TestHeaders_Unmarshal(t *testing.T) {
+	testCases := []struct {
+		name      string
+		url       string
+		expected  http.Header
+		errCheck  require.ErrorAssertionFunc
+		unmarshal func([]byte, interface{}) error
+	}{
+		{"invalid-json", `{"h": "<>:hey>"}`, nil, require.Error, json.Unmarshal},
+		{"null-json", `{"h": null}`, http.Header{}, require.NoError, json.Unmarshal},
+		{"empty-json", `{"h": {}}`, http.Header{}, require.NoError, json.Unmarshal},
+		{
+			"valid-json",
+			`{"h": {"X-NF-TEST-A": "aAa", "x-nf-test-b": "bBb"}}`,
+			http.Header{"X-Nf-Test-A": {"aAa"}, "X-Nf-Test-B": {"bBb"}},
+			require.NoError,
+			json.Unmarshal,
+		},
+		{
+			"duplicate-json",
+			`{"h": {"X-NF-TEST-A": "aAa", "X-Nf-Test-A": "bBb", "x-nf-test-a": "cCc"}}`,
+			http.Header{"X-Nf-Test-A": {"aAa", "bBb", "cCc"}},
+			require.NoError,
+			json.Unmarshal,
+		},
+
+		{"invalid-yaml", `h: ""`, nil, require.Error, yaml.Unmarshal},
+		{"null-yaml", `h: null`, http.Header{}, require.NoError, yaml.Unmarshal},
+		{"empty-yaml", `h: {}`, http.Header{}, require.NoError, yaml.Unmarshal},
+		{
+			"valid-yaml",
+			`h: {"X-NF-TEST-A": "aAa", "x-nf-test-b": "bBb"}`,
+			http.Header{"X-Nf-Test-A": {"aAa"}, "X-Nf-Test-B": {"bBb"}},
+			require.NoError,
+			yaml.Unmarshal,
+		},
+		{
+			"duplicate-yaml",
+			`h: {"X-NF-TEST-A": "aAa", "X-Nf-Test-A": "bBb", "x-nf-test-a": "cCc"}`,
+			http.Header{"X-Nf-Test-A": {"aAa", "bBb", "cCc"}},
+			require.NoError,
+			yaml.Unmarshal,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			var s struct {
+				H Headers `json:"h"`
+			}
+			tc.errCheck(t, tc.unmarshal([]byte(tc.url), &s))
+			assert.ObjectsAreEqualValues(tc.expected, s.H.Header)
+		})
+	}
+}
+
+func TestHeaders_Marshal(t *testing.T) {
+	testCases := []struct {
+		name     string
+		marshal  func(interface{}) ([]byte, error)
+		expected string
+	}{
+		{"json", json.Marshal, `{"h":{"X-Nf-Test-A":["aAa","bBb"]}}`},
+		{"yaml", yaml.Marshal, "h:\n    X-Nf-Test-A:\n        - aAa\n        - bBb\n"},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			h := struct {
+				H Headers `json:"h" yaml:"h"`
+			}{H: Headers{http.Header{"X-Nf-Test-A": {"aAa", "bBb"}}}}
+
+			serialized, err := tc.marshal(h)
+			require.NoError(t, err)
+			assert.Equal(t, tc.expected, string(serialized))
+		})
+	}
+}