File: api_test.go

package info (click to toggle)
gitlab-agent 16.1.3-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 6,324 kB
  • sloc: makefile: 175; sh: 52; ruby: 3
file content (135 lines) | stat: -rw-r--r-- 3,283 bytes parent folder | download
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
package modagent

import (
	"bytes"
	"errors"
	"io"
	"net/http"
	"net/url"
	"testing"

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

func TestApplyRequestOptions(t *testing.T) {
	tests := []struct {
		name           string
		opts           []GitLabRequestOption
		expectedMethod string
		expectedHeader http.Header
		expectedQuery  url.Values
		expectedBody   []byte
		expectedErr    string
	}{
		{
			name:           "defaults",
			expectedMethod: http.MethodGet,
			expectedHeader: http.Header{},
			expectedQuery:  url.Values{},
		},
		{
			name: "typical usage",
			opts: []GitLabRequestOption{
				WithRequestMethod(http.MethodGet),
				WithRequestHeader("xx1", "x1", "x2"),
				WithRequestHeader("xx2", "x3", "x4"),
				WithRequestQueryParam("z1", "z1", "z2"),
				WithRequestQueryParam("z2", "z3", "z4"),
				WithRequestBody(bytes.NewReader([]byte{1, 2, 3}), "bla"),
			},
			expectedMethod: http.MethodGet,
			expectedHeader: http.Header{
				"Xx1":          []string{"x1", "x2"},
				"Xx2":          []string{"x3", "x4"},
				"Content-Type": []string{"bla"},
			},
			expectedQuery: url.Values{
				"z1": []string{"z1", "z2"},
				"z2": []string{"z3", "z4"},
			},
			expectedBody: []byte{1, 2, 3},
		},
		{
			name: "nil body",
			opts: []GitLabRequestOption{
				WithRequestBody(nil, "bla"),
			},
			expectedMethod: http.MethodGet,
			expectedHeader: http.Header{},
			expectedQuery:  url.Values{},
		},
		{
			name: "json body",
			opts: []GitLabRequestOption{
				WithJsonRequestBody(struct {
					A int
				}{
					A: 42,
				}),
			},
			expectedMethod: http.MethodGet,
			expectedHeader: http.Header{
				"Content-Type": []string{"application/json"},
			},
			expectedQuery: url.Values{},
			expectedBody:  []byte(`{"A":42}`),
		},
		{
			name: "json marshaling error",
			opts: []GitLabRequestOption{
				WithJsonRequestBody(&invalidJson{}),
			},
			expectedErr: "WithJsonRequestBody: json: error calling MarshalJSON for type *modagent.invalidJson: boom",
		},
	}
	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			config, err := ApplyRequestOptions(tc.opts)
			if tc.expectedErr != "" {
				assert.EqualError(t, err, tc.expectedErr)
				assert.Nil(t, config)
			} else {
				require.NoError(t, err)
				assert.Equal(t, tc.expectedMethod, config.Method)
				assert.Equal(t, tc.expectedHeader, config.Header)
				assert.Equal(t, tc.expectedQuery, config.Query)
				var body []byte
				if config.Body != nil {
					body, err = io.ReadAll(config.Body)
					require.NoError(t, err)
				}
				assert.Equal(t, tc.expectedBody, body)
			}
		})
	}
}

func TestApplyRequestOptions_BodyClosedOnError(t *testing.T) {
	c := &closeableReader{}
	_, err := ApplyRequestOptions([]GitLabRequestOption{
		WithRequestBody(c, ""),
		WithJsonRequestBody(&invalidJson{}),
	})
	assert.EqualError(t, err, "WithJsonRequestBody: json: error calling MarshalJSON for type *modagent.invalidJson: boom")
	assert.True(t, c.closed)
}

type invalidJson struct{}

func (i *invalidJson) MarshalJSON() ([]byte, error) {
	return nil, errors.New("boom")
}

type closeableReader struct {
	closed bool
}

func (c *closeableReader) Read(d []byte) (int, error) {
	return 0, nil
}

func (c *closeableReader) Close() error {
	c.closed = true
	return nil
}