11 "github.com/stretchr/testify/require"
14 func TestClientSendsTheFixedRequestFields(t *testing.T) {
15 server := newModelFake(t)
16 client := newTestModelClient(t, server)
18 _, err := client.Create(t.Context(), ModelRequest{
21 Instructions: "You are a test.",
25 Parameters: map[string]any{"type": "object"},
27 Input: []any{modelUserMessage("<chat>\n</chat>\n", "hello")},
29 require.NoError(t, err)
31 call := server.Call(0)
32 require.Equal(t, "Bearer "+modelTestKey, call.header.Get("Authorization"))
33 require.Equal(t, "text/event-stream", call.header.Get("Accept"))
34 require.Equal(t, "application/json", call.header.Get("Content-Type"))
37 require.Equal(t, "gpt-test", body["model"])
38 require.Equal(t, "You are a test.", body["instructions"])
39 require.Equal(t, false, body["store"])
40 require.Equal(t, true, body["stream"])
41 require.Equal(t, []any{"reasoning.encrypted_content"}, body["include"])
42 require.Equal(t, "agent-key", body["prompt_cache_key"])
43 require.Equal(t, map[string]any{"effort": "high"}, body["reasoning"])
44 require.NotContains(t, body, "max_output_tokens")
45 require.NotContains(t, body, "metadata")
46 require.Equal(t, []any{map[string]any{
49 map[string]any{"type": "input_text", "text": "<chat>\n</chat>\n"},
50 map[string]any{"type": "input_text", "text": "hello"},
53 require.Len(t, body["tools"], 1)
56 func TestClientSendsTheSessionHeaderToChatGPT(t *testing.T) {
57 login := newChatGPTFake(t)
58 auth := newTestChatGPTAuth(t, login)
59 chatgptWriteTestTokens(t, auth, login.token(time.Hour), "refresh-0")
61 testCases := []struct {
67 name: "ChatGPT backend",
73 auth: ModelAPIKey(modelTestKey),
78 for _, tc := range testCases {
79 t.Run(tc.name, func(t *testing.T) {
80 server := newModelFake(t)
81 client := newModelClient(server.URL, tc.auth, "agent-key", filepath.Join(t.TempDir(), "usage.jsonl"))
82 _, err := client.Create(t.Context(), modelTestRequest())
83 require.NoError(t, err)
85 call := server.Call(0)
86 require.Equal(t, tc.want, call.header.Get("session_id"))
87 require.Equal(t, "agent-key", call.body["prompt_cache_key"])
89 // A subagent has its own key.
90 request := modelTestRequest()
91 request.Agent = "GreenOtter"
92 _, err = client.Create(t.Context(), request)
93 require.NoError(t, err)
97 require.Equal(t, "agent-key-GreenOtter", call.header.Get("session_id"))
100 require.Equal(t, "agent-key-GreenOtter", call.body["prompt_cache_key"])
105 func TestClientReadsTheStream(t *testing.T) {
106 server := newModelFake(t)
107 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
109 map[string]any{"type": "response.created", "response": map[string]any{}},
110 map[string]any{"type": "response.output_item.done", "item": map[string]any{"type": "reasoning", "encrypted_content": "opaque"}},
111 map[string]any{"type": "response.output_text.delta", "delta": "Hel"},
112 map[string]any{"type": "response.output_item.done", "item": modelMessageItem("Hello")},
113 map[string]any{"type": "response.output_item.done", "item": modelMessageItem(" world")},
114 modelCompletedEvent(nil, 1200, 1024, 30),
118 response, err := newTestModelClient(t, server).Create(t.Context(), modelTestRequest())
119 require.NoError(t, err)
120 require.Equal(t, "Hello world", response.Text)
121 require.Len(t, response.Output, 3)
122 require.JSONEq(t, `{"type": "reasoning", "encrypted_content": "opaque"}`, string(response.Output[0]))
123 require.Equal(t, ModelUsage{
130 func TestClientTakesTheOutputOfTheCompletedResponse(t *testing.T) {
131 server := newModelFake(t)
132 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
133 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("only here")}, 10, 0, 2))
136 response, err := newTestModelClient(t, server).Create(t.Context(), modelTestRequest())
137 require.NoError(t, err)
138 require.Equal(t, "only here", response.Text)
141 func TestClientRecordsEachCall(t *testing.T) {
142 server := newModelFake(t)
143 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
144 w.Header().Set("X-Codex-Primary-Used-Percent", "12")
145 w.Header().Set("X-Codex-Plan-Type", "plus")
146 w.Header().Set("X-Other", "not quota")
147 w.Header().Set("X-Codex-Turn-State", "opaque state")
148 if call.number == 1 {
149 w.WriteHeader(http.StatusTooManyRequests)
150 _, _ = io.WriteString(w, `{"detail": "slow down"}`)
155 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("ok")}, 500, 400, 7))
158 client := newTestModelClient(t, server)
159 request := modelTestRequest()
160 request.Node = &NodeKey{2, 5}
161 request.Agent = "GreenOtter"
162 _, err := client.Create(t.Context(), request)
163 require.NoError(t, err)
164 require.NotContains(t, server.Call(0).body, "node")
165 require.NotContains(t, string(server.Call(0).raw), "[2,5]")
166 require.NotContains(t, server.Call(0).body, "agent")
168 _, err = client.Create(t.Context(), modelTestRequest())
169 require.ErrorContains(t, err, "HTTP 429")
170 require.ErrorContains(t, err, "slow down")
172 records := modelReadUsage(t, client.usage.path)
173 require.Len(t, records, 2)
175 quota := map[string]string{
176 "x-codex-primary-used-percent": "12",
177 "x-codex-plan-type": "plus",
179 require.Equal(t, "gpt-test", records[0].Model)
180 require.Equal(t, http.StatusOK, records[0].Status)
181 require.Equal(t, 500, records[0].InputTokens)
182 require.Equal(t, 400, records[0].CachedTokens)
183 require.Equal(t, 7, records[0].OutputTokens)
184 require.Equal(t, quota, records[0].Quota)
185 require.Equal(t, &[2]int{2, 5}, records[0].Node)
186 require.Equal(t, "GreenOtter", records[0].Agent)
187 require.Equal(t, len("ok"), records[0].TextBytes)
188 require.Greater(t, records[0].Seconds, 0.0)
189 require.Empty(t, records[0].Error)
190 require.NotEmpty(t, records[0].Date)
192 require.Nil(t, records[1].Node)
193 require.Empty(t, records[1].Agent)
194 require.Zero(t, records[1].TextBytes)
196 require.Equal(t, http.StatusTooManyRequests, records[1].Status)
197 require.Equal(t, quota, records[1].Quota)
198 require.Contains(t, records[1].Error, "HTTP 429")
200 data, err := os.ReadFile(client.usage.path)
201 require.NoError(t, err)
202 require.NotContains(t, string(data), modelTestKey)
204 info, err := os.Stat(client.usage.path)
205 require.NoError(t, err)
206 require.Equal(t, os.FileMode(0o600), info.Mode().Perm())
209 func TestClientRefusesCallsOverTheLimit(t *testing.T) {
210 server := newModelFake(t)
211 client := newTestModelClient(t, server)
215 require.False(t, client.LimitReached())
216 _, err := client.Create(t.Context(), modelTestRequest())
217 require.NoError(t, err)
220 require.True(t, client.LimitReached())
221 _, err := client.Create(t.Context(), modelTestRequest())
222 require.ErrorIs(t, err, errModelCallLimit)
223 require.Equal(t, 2, server.Calls())
224 require.Len(t, modelReadUsage(t, client.usage.path), 2)
227 func TestClientFailsWhenTheResponseFails(t *testing.T) {
228 testCases := []struct {
234 name: "failed response",
235 events: []any{map[string]any{"type": "response.failed", "response": map[string]any{"error": map[string]any{"code": "server_error", "message": "busy"}}}},
236 want: "server_error: busy",
239 name: "incomplete response",
240 events: []any{map[string]any{"type": "response.incomplete", "response": map[string]any{"incomplete_details": map[string]any{"reason": "content_filter"}}}},
241 want: "content_filter",
245 events: []any{map[string]any{"type": "error", "code": "rate_limit", "message": "too many"}},
246 want: "rate_limit: too many",
249 name: "stream ends early",
250 events: []any{map[string]any{"type": "response.output_item.done", "item": modelMessageItem("cut")}},
251 want: "ended before the response completed",
255 for _, tc := range testCases {
256 t.Run(tc.name, func(t *testing.T) {
257 server := newModelFake(t)
258 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
259 modelWriteEvents(w, tc.events...)
262 client := newTestModelClient(t, server)
263 _, err := client.Create(t.Context(), modelTestRequest())
264 require.ErrorContains(t, err, tc.want)
266 records := modelReadUsage(t, client.usage.path)
267 require.Len(t, records, 1)
268 require.Contains(t, records[0].Error, tc.want)
273 func newTestModelClient(t *testing.T, server *ModelFake) *ModelClient {
276 return newModelClient(server.URL, ModelAPIKey(modelTestKey), "agent-key", filepath.Join(t.TempDir(), "usage.jsonl"))