forked from stacklok/toolhive
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmiddleware_test.go
More file actions
279 lines (222 loc) · 8.26 KB
/
Copy pathmiddleware_test.go
File metadata and controls
279 lines (222 loc) · 8.26 KB
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// SPDX-FileCopyrightText: Copyright 2025 Stacklok, Inc.
// SPDX-License-Identifier: Apache-2.0
package ratelimit
import (
"context"
"encoding/json"
"errors"
"io"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/alicebob/miniredis/v2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/mock/gomock"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
v1beta1 "github.com/stacklok/toolhive/cmd/thv-operator/api/v1beta1"
"github.com/stacklok/toolhive/pkg/auth"
"github.com/stacklok/toolhive/pkg/mcp"
transporttypes "github.com/stacklok/toolhive/pkg/transport/types"
transportmocks "github.com/stacklok/toolhive/pkg/transport/types/mocks"
)
// dummyLimiter is a test double for the Limiter interface.
type dummyLimiter struct {
decision *Decision
err error
}
func (d *dummyLimiter) Allow(context.Context, string, string) (*Decision, error) {
return d.decision, d.err
}
// recordingLimiter captures the arguments passed to Allow.
type recordingLimiter struct {
toolName string
userID string
}
func (r *recordingLimiter) Allow(_ context.Context, toolName, userID string) (*Decision, error) {
r.toolName = toolName
r.userID = userID
return &Decision{Allowed: true}, nil
}
// withIdentity adds an auth.Identity with the given subject to the request context.
func withIdentity(r *http.Request, subject string) *http.Request {
identity := &auth.Identity{PrincipalInfo: auth.PrincipalInfo{Subject: subject}}
ctx := auth.WithIdentity(r.Context(), identity)
return r.WithContext(ctx)
}
// withParsedMCPRequest adds a ParsedMCPRequest to the request context.
func withParsedMCPRequest(r *http.Request, method, resourceID string, id any) *http.Request {
parsed := &mcp.ParsedMCPRequest{
Method: method,
ResourceID: resourceID,
ID: id,
IsRequest: true,
}
ctx := context.WithValue(r.Context(), mcp.MCPRequestContextKey, parsed)
return r.WithContext(ctx)
}
func TestRateLimitHandler_ToolCallAllowed(t *testing.T) {
t.Parallel()
limiter := &dummyLimiter{decision: &Decision{Allowed: true}}
handler := rateLimitHandler(limiter)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/call", "echo", 1)
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
}
func TestRateLimitHandler_ToolCallRejected(t *testing.T) {
t.Parallel()
limiter := &dummyLimiter{decision: &Decision{Allowed: false, RetryAfter: 5 * time.Second}}
handler := rateLimitHandler(limiter)(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {
t.Fatal("next handler should not be called when rate limited")
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/call", "echo", 42)
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.Equal(t, http.StatusTooManyRequests, w.Code)
assert.Equal(t, "5", w.Header().Get("Retry-After"))
assert.Equal(t, "application/json", w.Header().Get("Content-Type"))
body, err := io.ReadAll(w.Body)
require.NoError(t, err)
var resp map[string]any
require.NoError(t, json.Unmarshal(body, &resp))
errObj := resp["error"].(map[string]any)
assert.Equal(t, float64(-32029), errObj["code"])
assert.Equal(t, "Rate limit exceeded", errObj["message"])
data := errObj["data"].(map[string]any)
assert.Equal(t, float64(5), data["retryAfterSeconds"])
assert.Equal(t, float64(42), resp["id"])
}
func TestRateLimitHandler_RedisErrorFailOpen(t *testing.T) {
t.Parallel()
limiter := &dummyLimiter{err: errors.New("redis connection refused")}
nextCalled := false
handler := rateLimitHandler(limiter)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
nextCalled = true
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/call", "echo", 1)
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.True(t, nextCalled, "should fail open and call next handler")
assert.Equal(t, http.StatusOK, w.Code)
}
func TestRateLimitHandler_NoParsedMCPRequest_PassesThrough(t *testing.T) {
t.Parallel()
limiter := &dummyLimiter{decision: &Decision{Allowed: false}}
nextCalled := false
handler := rateLimitHandler(limiter)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
nextCalled = true
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
// No MCP context — non-JSON-RPC request (health check, SSE stream).
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.True(t, nextCalled, "should pass through when no MCP context")
assert.Equal(t, http.StatusOK, w.Code)
}
func TestRateLimitHandler_NonToolCallPassesThrough(t *testing.T) {
t.Parallel()
limiter := &dummyLimiter{decision: &Decision{Allowed: false, RetryAfter: time.Second}}
nextCalled := false
handler := rateLimitHandler(limiter)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
nextCalled = true
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/list", "", 1)
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.True(t, nextCalled, "non-tools/call should pass through regardless of limiter")
assert.Equal(t, http.StatusOK, w.Code)
}
func TestRateLimitHandler_PassesUserID(t *testing.T) {
t.Parallel()
recorder := &recordingLimiter{}
handler := rateLimitHandler(recorder)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/call", "echo", 1)
req = withIdentity(req, "alice@example.com")
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
assert.Equal(t, "echo", recorder.toolName)
assert.Equal(t, "alice@example.com", recorder.userID)
}
func TestRateLimitHandler_NoIdentityPassesEmptyUserID(t *testing.T) {
t.Parallel()
recorder := &recordingLimiter{}
handler := rateLimitHandler(recorder)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
}))
req := httptest.NewRequest(http.MethodPost, "/mcp", nil)
req = withParsedMCPRequest(req, "tools/call", "echo", 1)
// No identity in context — unauthenticated request.
w := httptest.NewRecorder()
handler.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
assert.Equal(t, "echo", recorder.toolName)
assert.Empty(t, recorder.userID, "unauthenticated requests should pass empty userID")
}
func TestRateLimitMiddlewareHandlerReturnsConfiguredHandler(t *testing.T) {
t.Parallel()
expected := rateLimitHandler(&dummyLimiter{decision: &Decision{Allowed: true}})
mw := &rateLimitMiddleware{handler: expected}
assert.NotNil(t, mw.Handler())
}
func TestNewMiddlewareReturnsUsableMiddleware(t *testing.T) {
t.Parallel()
mr := miniredis.RunT(t)
middleware, err := NewMiddleware(MiddlewareParams{
Namespace: "default",
ServerName: "server",
RedisAddr: mr.Addr(),
Config: &v1beta1.RateLimitConfig{
Shared: &v1beta1.RateLimitBucket{
MaxTokens: 1,
RefillPeriod: metav1.Duration{Duration: time.Minute},
},
},
})
require.NoError(t, err)
require.NotNil(t, middleware)
require.NotNil(t, middleware.Handler())
require.NoError(t, middleware.Close())
}
func TestCreateMiddlewareRegistersUsableMiddleware(t *testing.T) {
t.Parallel()
mr := miniredis.RunT(t)
cfg, err := transporttypes.NewMiddlewareConfig(MiddlewareType, MiddlewareParams{
Namespace: "default",
ServerName: "server",
RedisAddr: mr.Addr(),
Config: &v1beta1.RateLimitConfig{
Shared: &v1beta1.RateLimitBucket{
MaxTokens: 1,
RefillPeriod: metav1.Duration{Duration: time.Minute},
},
},
})
require.NoError(t, err)
ctrl := gomock.NewController(t)
runner := transportmocks.NewMockMiddlewareRunner(ctrl)
var registered transporttypes.Middleware
runner.EXPECT().
AddMiddleware(MiddlewareType, gomock.AssignableToTypeOf(&rateLimitMiddleware{})).
Do(func(_ string, middleware transporttypes.Middleware) {
registered = middleware
})
require.NoError(t, CreateMiddleware(cfg, runner))
require.NotNil(t, registered)
require.NotNil(t, registered.Handler())
require.NoError(t, registered.Close())
}