]> git.giacomolli.uk - onechat/blob - turn_test.go
Name and order the tool code
[onechat] / turn_test.go
1 package main
2
3 import (
4 "context"
5 "encoding/json"
6 "errors"
7 "net/http"
8 "path/filepath"
9 "strings"
10 "sync"
11 "testing"
12 "time"
13
14 "github.com/stretchr/testify/require"
15 )
16
17 func TestTurnRunsToolsUntilTheFinalAnswer(t *testing.T) {
18 server := newModelFake(t)
19 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
20 if call.number == 0 {
21 modelWriteEvents(w, modelCompletedEvent([]any{
22 modelReasoningItem("rs_1", "opaque thought"),
23 modelFunctionCallItem("fc_1", "call_1", "shell", `{"command":"echo hi"}`),
24 }, 100, 0, 5))
25
26 return
27 }
28
29 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("It said hi.")}, 120, 100, 5))
30 }
31
32 test := newTestTurnLoop(t, server)
33 _, err := test.loop.Submit(terminalSource, "Run echo hi.")
34 require.NoError(t, err)
35 test.events.WaitFor(t, "idle", 1)
36 require.Equal(t, 2, server.Calls())
37
38 first := server.Call(0).body
39 second := server.Call(1).body
40 instructions, err := test.agent.Prompt()
41 require.NoError(t, err)
42 require.Equal(t, instructions, first["instructions"])
43 require.Equal(t, test.agent.config.Model, first["model"])
44
45 // The second request begins with the whole first one.
46 firstInput := first["input"].([]any)
47 secondInput := second["input"].([]any)
48 require.Equal(t, firstInput, secondInput[:len(firstInput)])
49 require.Equal(t, []any{
50 map[string]any{"type": "reasoning", "encrypted_content": "opaque thought", "summary": []any{}},
51 map[string]any{"type": "function_call", "call_id": "call_1", "name": "shell", "arguments": `{"command":"echo hi"}`},
52 map[string]any{"type": "function_call_output", "call_id": "call_1", "output": "hi\n"},
53 }, secondInput[len(firstInput):])
54
55 require.Equal(t, []string{
56 "user: Run echo hi.",
57 `tool: shell {"command":"echo hi"}`,
58 "echo: hi\n",
59 "reply: It said hi.",
60 }, test.Log(t))
61 require.Equal(t, []string{"user", "busy", "tool", "echo", "reply", "idle"}, test.events.Kinds())
62
63 var turns []string
64 for _, record := range modelReadUsage(t, test.usagePath) {
65 turns = append(turns, record.Turn)
66 }
67
68 require.Equal(t, []string{"first", "next"}, turns)
69 }
70
71 func TestFirstRequestHoldsTheViewTheStateAndTheMessage(t *testing.T) {
72 server := newModelFake(t)
73 test := newTestTurnLoop(t, server)
74 _, err := test.memory.Append("user", "an earlier message")
75 require.NoError(t, err)
76
77 _, err = test.loop.Submit(terminalSource, "The new message.")
78 require.NoError(t, err)
79 test.events.WaitFor(t, "idle", 1)
80
81 require.Equal(t, []string{
82 "<chat>\n0+1|user: an earlier message\n",
83 "</chat>\n\nNow: Thursday 2026-01-01 12:00 +00:00",
84 "The new message.",
85 }, turnInputTexts(t, server.Call(0)))
86 }
87
88 func TestMessageDuringATurnJoinsTheNextRequest(t *testing.T) {
89 server := newModelFake(t)
90 arrived := make(chan struct{})
91 release := make(chan struct{})
92 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
93 if call.number == 0 {
94 close(arrived)
95 <-release
96 modelWriteEvents(w, modelCompletedEvent([]any{modelFunctionCallItem("fc_1", "call_1", "date", `{"id":0}`)}, 100, 0, 5))
97
98 return
99 }
100
101 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("done")}, 100, 0, 5))
102 }
103
104 test := newTestTurnLoop(t, server)
105 _, err := test.loop.Submit(terminalSource, "first")
106 require.NoError(t, err)
107
108 <-arrived
109 _, err = test.loop.Submit(terminalSource, "second, during the turn")
110 require.NoError(t, err)
111 close(release)
112
113 test.events.WaitFor(t, "idle", 1)
114 input := server.Call(1).body["input"].([]any)
115 require.Equal(t, map[string]any{
116 "role": "user",
117 "content": []any{map[string]any{"type": "input_text", "text": "second, during the turn"}},
118 }, input[len(input)-1])
119
120 time.Sleep(50 * time.Millisecond)
121 require.Equal(t, 2, server.Calls())
122 require.Equal(t, 1, test.events.Count("busy"))
123 }
124
125 func TestMessageDuringTheFinalRequestStartsANewTurn(t *testing.T) {
126 server := newModelFake(t)
127 arrived := make(chan struct{})
128 release := make(chan struct{})
129 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
130 if call.number == 0 {
131 close(arrived)
132 <-release
133 }
134
135 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("answer")}, 100, 0, 5))
136 }
137
138 test := newTestTurnLoop(t, server)
139 _, err := test.loop.Submit(terminalSource, "first")
140 require.NoError(t, err)
141
142 <-arrived
143 _, err = test.loop.Submit(terminalSource, "second")
144 require.NoError(t, err)
145 close(release)
146
147 test.events.WaitFor(t, "idle", 2)
148 require.Equal(t, 2, server.Calls())
149
150 texts := turnInputTexts(t, server.Call(1))
151 require.Equal(t, "second", texts[len(texts)-1])
152 require.Contains(t, strings.Join(texts, ""), "|reply: answer\n")
153 }
154
155 func TestTurnWaitsForTheSummaries(t *testing.T) {
156 server := newModelFake(t)
157 summarizer := newFakeSummarizer()
158 summarizer.gate = make(chan struct{})
159 test := newTestTurnLoopWith(t, server, summarizer)
160
161 _, err := test.memory.Append("echo", strings.Repeat("long output ", 100))
162 require.NoError(t, err)
163
164 _, err = test.loop.Submit(terminalSource, "go on")
165 require.NoError(t, err)
166
167 time.Sleep(50 * time.Millisecond)
168 require.Equal(t, 0, server.Calls())
169
170 close(summarizer.gate)
171 test.events.WaitFor(t, "idle", 1)
172 require.Equal(t, 1, server.Calls())
173 require.NotContains(t, turnInputTexts(t, server.Call(0))[0], viewPending)
174 }
175
176 func TestInterruptEndsTheTurn(t *testing.T) {
177 server := newModelFake(t)
178 arrived := make(chan struct{})
179 release := make(chan struct{})
180 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
181 if call.number == 0 {
182 close(arrived)
183 <-release
184 }
185
186 modelWriteEvents(w, modelCompletedEvent([]any{modelMessageItem("answer")}, 100, 0, 5))
187 }
188
189 test := newTestTurnLoop(t, server)
190 _, err := test.loop.Submit(terminalSource, "a long task")
191 require.NoError(t, err)
192
193 <-arrived
194 require.True(t, test.loop.Interrupt())
195 test.events.WaitFor(t, "idle", 1)
196 close(release)
197
198 require.Equal(t, "interrupted", test.events.Last("error"))
199 require.Equal(t, []string{"user: a long task"}, test.Log(t))
200 require.False(t, test.loop.Interrupt())
201
202 _, err = test.loop.Submit(terminalSource, "again")
203 require.NoError(t, err)
204 test.events.WaitFor(t, "idle", 2)
205 require.Equal(t, "reply: answer", test.Log(t)[2])
206 }
207
208 func TestFailedCallEndsTheTurnWithoutARetry(t *testing.T) {
209 server := newModelFake(t)
210 server.reply = func(w http.ResponseWriter, call ModelFakeCall) {
211 http.Error(w, "busy", http.StatusServiceUnavailable)
212 }
213
214 test := newTestTurnLoop(t, server)
215 _, err := test.loop.Submit(terminalSource, "hello")
216 require.NoError(t, err)
217 test.events.WaitFor(t, "idle", 1)
218
219 time.Sleep(50 * time.Millisecond)
220 require.Equal(t, 1, server.Calls())
221 require.Contains(t, test.events.Last("error"), "HTTP 503")
222 }
223
224 func TestViewMessagesOnlyGrowBetweenTurns(t *testing.T) {
225 server := newModelFake(t)
226 test := newTestTurnLoop(t, server)
227 for n, text := range []string{"one", "two", "three"} {
228 _, err := test.loop.Submit(terminalSource, text)
229 require.NoError(t, err)
230 test.events.WaitFor(t, "idle", n+1)
231 }
232
233 first := server.Call(1).body["input"].([]any)
234 second := server.Call(2).body["input"].([]any)
235 require.Len(t, first, 4)
236 require.Len(t, second, 5)
237 require.Equal(t, first[:2], second[:2])
238 require.Equal(t, []string{
239 "<chat>\n",
240 "0+1|user: one\n1+1|reply: a line\n",
241 "2+1|user: two\n3+1|reply: a line\n",
242 "</chat>\n\nNow: Thursday 2026-01-01 12:00 +00:00",
243 "three",
244 }, turnInputTexts(t, server.Call(2)))
245 }
246
247 // TurnTestLoop is a loop that runs in the background of a test, with its parts.
248 type TurnTestLoop struct {
249 agent *Agent
250 memory *Memory
251 loop *TurnLoop
252 events *TurnEventRecorder
253 usagePath string
254 }
255
256 // Log returns the logged messages as "kind: text".
257 func (l *TurnTestLoop) Log(t *testing.T) []string {
258 t.Helper()
259
260 var lines []string
261 for id := range l.memory.Len() {
262 message, err := l.memory.Message(id)
263 require.NoError(t, err)
264
265 lines = append(lines, message.Kind+": "+message.Text)
266 }
267
268 return lines
269 }
270
271 // TurnEventRecorder keeps the events of a loop.
272 type TurnEventRecorder struct {
273 mutex sync.Mutex
274 events []Event
275 }
276
277 // WaitFor waits until count events of kind came.
278 func (r *TurnEventRecorder) WaitFor(t *testing.T, kind string, count int) {
279 t.Helper()
280
281 require.Eventually(t, func() bool {
282 return r.Count(kind) >= count
283 }, 10*time.Second, time.Millisecond)
284 }
285
286 func (r *TurnEventRecorder) Kinds() []string {
287 r.mutex.Lock()
288 defer r.mutex.Unlock()
289
290 kinds := make([]string, len(r.events))
291 for n, event := range r.events {
292 kinds[n] = event.Kind
293 }
294
295 return kinds
296 }
297
298 func (r *TurnEventRecorder) Count(kind string) int {
299 count := 0
300 for _, each := range r.Kinds() {
301 if each == kind {
302 count++
303 }
304 }
305
306 return count
307 }
308
309 // Last returns the text of the last event of kind.
310 func (r *TurnEventRecorder) Last(kind string) string {
311 r.mutex.Lock()
312 defer r.mutex.Unlock()
313
314 for n := len(r.events) - 1; n >= 0; n-- {
315 if r.events[n].Kind == kind {
316 return r.events[n].Text
317 }
318 }
319
320 return ""
321 }
322
323 func (r *TurnEventRecorder) Add(event Event) {
324 r.mutex.Lock()
325 defer r.mutex.Unlock()
326
327 r.events = append(r.events, event)
328 }
329
330 func newTestTurnLoop(t *testing.T, server *ModelFake) *TurnTestLoop {
331 t.Helper()
332
333 return newTestTurnLoopWith(t, server, newFakeSummarizer())
334 }
335
336 // turnInputTexts returns the text of each user message of the input of call.
337 func turnInputTexts(t *testing.T, call ModelFakeCall) []string {
338 t.Helper()
339
340 var body struct {
341 Input []struct {
342 Role string `json:"role"`
343 Content []struct {
344 Text string `json:"text"`
345 } `json:"content"`
346 } `json:"input"`
347 }
348
349 require.NoError(t, json.Unmarshal(call.raw, &body))
350
351 var texts []string
352 for _, item := range body.Input {
353 if item.Role != "user" {
354 continue
355 }
356
357 var text strings.Builder
358 for _, part := range item.Content {
359 text.WriteString(part.Text)
360 }
361
362 texts = append(texts, text.String())
363 }
364
365 return texts
366 }
367
368 // newTestTurnLoopWith returns a running loop on a new agent whose builds use
369 // summarizer and whose commands run in a temporary directory.
370 func newTestTurnLoopWith(t *testing.T, server *ModelFake, summarizer Summarizer) *TurnTestLoop {
371 t.Helper()
372
373 agent, err := openAgent(t.TempDir())
374 require.NoError(t, err)
375
376 agent.config.Workdir = t.TempDir()
377 clock := newTestClock()
378 memory, err := openMemory(t.Context(), t.TempDir(), clock.Now, summarizer)
379 require.NoError(t, err)
380
381 test := &TurnTestLoop{
382 agent: agent,
383 memory: memory,
384 events: &TurnEventRecorder{},
385 usagePath: filepath.Join(t.TempDir(), "usage.jsonl"),
386 }
387
388 client := newModelClient(server.URL, ModelAPIKey(modelTestKey), agent.CacheKey(), test.usagePath)
389 test.loop, err = newTurnLoop(agent, memory, client, clock.Now, test.events.Add)
390 require.NoError(t, err)
391 ctx, cancel := context.WithCancel(t.Context())
392 done := make(chan error)
393 go func() {
394 done <- test.loop.Run(ctx)
395 }()
396
397 t.Cleanup(func() {
398 cancel()
399 require.True(t, errors.Is(<-done, context.Canceled))
400 require.NoError(t, memory.Close())
401 })
402
403 return test
404 }