File: outbound_http_test.go

package info (click to toggle)
golang-gitlab-gitlab-org-labkit 1.17.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,092 kB
  • sloc: sh: 210; javascript: 49; makefile: 4
file content (163 lines) | stat: -rw-r--r-- 4,562 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
package correlation

import (
	"context"
	"errors"
	"net/http"
	"testing"

	"github.com/stretchr/testify/require"
)

var httpCorrelationTests = []struct {
	name          string
	ctx           context.Context
	correlationID string
	clientName    string
	hasHeader     bool
}{
	{
		name:          "context with value",
		ctx:           context.Background(),
		correlationID: "CORRELATION_ID",
		clientName:    "test_client",
		hasHeader:     true,
	},
	{
		name:          "context without value",
		ctx:           context.Background(),
		correlationID: "",
		clientName:    "",
		hasHeader:     false,
	},
}

func Test_injectRequest(t *testing.T) {
	for _, tt := range httpCorrelationTests {
		t.Run(tt.name, func(t *testing.T) {
			require := require.New(t)

			ctx := context.WithValue(tt.ctx, keyCorrelationID, tt.correlationID)
			req, err := http.NewRequest("GET", "http://example.com", nil)
			require.NoError(err)

			req = req.WithContext(ctx)

			mockTransport := roundTripperFunc(func(req *http.Request) (*http.Response, error) {
				return &http.Response{}, nil
			})

			roundTripper := NewInstrumentedRoundTripper(mockTransport, WithClientName(tt.clientName))
			roundTripper.(*instrumentedRoundTripper).injectRequest(req)

			value := req.Header.Get(propagationHeader)
			clientName := req.Header.Get(clientNameHeader)
			require.True(tt.hasHeader == (value != ""), "Expected header existence %v. Instead got header %v", tt.hasHeader, value)
			require.Equal(tt.clientName, clientName, "Expected client name value %v, got %v", tt.clientName, clientName)
			if tt.hasHeader {
				require.Equal(tt.correlationID, value, "Expected header value %v, got %v", tt.correlationID, value)
			}
		})
	}
}

type delegatedRoundTripper struct {
	delegate func(req *http.Request) (*http.Response, error)
}

func (c delegatedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
	return c.delegate(req)
}

func roundTripperFunc(delegate func(req *http.Request) (*http.Response, error)) http.RoundTripper {
	return &delegatedRoundTripper{delegate}
}

func TestInstrumentedRoundTripper(t *testing.T) {
	for _, tt := range httpCorrelationTests {
		t.Run(tt.name, func(t *testing.T) {
			require := require.New(t)

			response := &http.Response{}
			mockTransport := roundTripperFunc(func(req *http.Request) (*http.Response, error) {
				value := req.Header.Get(propagationHeader)
				require.True(tt.hasHeader == (value != ""), "Expected header existence %v. Instead got header %v", tt.hasHeader, value)

				if tt.hasHeader {
					require.Equal(tt.correlationID, value, "Expected header value %v, got %v", tt.correlationID, value)
				}

				return response, nil
			})

			client := &http.Client{
				Transport: NewInstrumentedRoundTripper(mockTransport),
			}

			ctx := context.WithValue(tt.ctx, keyCorrelationID, tt.correlationID)
			req, err := http.NewRequest("GET", "http://example.com", nil)
			require.NoError(err)

			req = req.WithContext(ctx)

			res, err := client.Do(req)
			require.NoError(err)
			require.Equal(response, res)
		})
	}
}

func TestInstrumentedRoundTripperFailures(t *testing.T) {
	for _, tt := range httpCorrelationTests {
		t.Run(tt.name+" - with errors", func(t *testing.T) {
			require := require.New(t)

			testErr := errors.New("test")

			mockTransport := roundTripperFunc(func(req *http.Request) (*http.Response, error) {
				value := req.Header.Get(propagationHeader)
				require.True(tt.hasHeader == (value != ""), "Expected header existence %v. Instead got header %v", tt.hasHeader, value)

				if tt.hasHeader {
					require.Equal(tt.correlationID, value, "Expected header value %v, got %v", tt.correlationID, value)
				}

				return nil, testErr
			})

			client := &http.Client{
				Transport: NewInstrumentedRoundTripper(mockTransport),
			}

			ctx := context.WithValue(tt.ctx, keyCorrelationID, tt.correlationID)
			req, err := http.NewRequest("GET", "http://example.com", nil)
			require.NoError(err)

			req = req.WithContext(ctx)

			res, err := client.Do(req)
			require.Error(err)
			require.Nil(res)
		})
	}
}

func TestInstrumentedRoundTripperWithoutContext(t *testing.T) {
	require := require.New(t)

	response := &http.Response{}
	mockTransport := roundTripperFunc(func(req *http.Request) (*http.Response, error) {
		return response, nil
	})

	client := &http.Client{
		Transport: NewInstrumentedRoundTripper(mockTransport),
	}

	req, err := http.NewRequest("GET", "http://example.com", nil)
	require.NoError(err)

	res, err := client.Do(req)
	require.NoError(err)
	require.Equal(response, res)
}