1package headless
2
3import (
4 "context"
5 "errors"
6 "image"
7 "image/color"
8 "image/png"
9 "maps"
10 "os"
11 "path/filepath"
12 "sync"
13 "testing"
14 "time"
15
16 "github.com/bnema/neferwl/internal/logging"
17 portsmocks "github.com/bnema/neferwl/internal/mocks/ports"
18 "github.com/bnema/neferwl/internal/ports"
19 "github.com/stretchr/testify/mock"
20)
21
22// frames records what the mocked renderer is asked to draw.
23type frames struct {
24 mu sync.Mutex
25 scenes []ports.Scene
26 contents []map[ports.WindowID]ports.SurfaceContent
27}
28
29func (f *frames) snapshot() ([]ports.Scene, []map[ports.WindowID]ports.SurfaceContent) {
30 f.mu.Lock()
31 defer f.mu.Unlock()
32 return append([]ports.Scene(nil), f.scenes...), append([]map[ports.WindowID]ports.SurfaceContent(nil), f.contents...)
33}
34
35// recordingRenderer returns a generated mock whose Render records each frame
36// and returns err. Close must be called exactly once.
37func recordingRenderer(t *testing.T, err error) (*portsmocks.MockRenderer, *frames) {
38 r := portsmocks.NewMockRenderer(t)
39 f := &frames{}
40 r.EXPECT().Render(mock.Anything, mock.Anything).RunAndReturn(func(s ports.Scene, c map[ports.WindowID]ports.SurfaceContent) (*os.File, error) {
41 f.mu.Lock()
42 defer f.mu.Unlock()
43 f.scenes = append(f.scenes, s)
44 f.contents = append(f.contents, maps.Clone(c))
45 return nil, err
46 }).Maybe()
47 r.EXPECT().Pixels().Return(image.NewRGBA(image.Rect(0, 0, 2, 2))).Maybe()
48 r.EXPECT().Close().Return().Once()
49 return r, f
50}
51
52// waitFrames polls until the renderer drew at least n frames.
53func waitFrames(t *testing.T, f *frames, n int) {
54 t.Helper()
55 deadline := time.After(3 * time.Second)
56 for {
57 if s, _ := f.snapshot(); len(s) >= n {
58 return
59 }
60 select {
61 case <-deadline:
62 t.Fatal("no frame")
63 case <-time.After(10 * time.Millisecond):
64 }
65 }
66}
67
68func TestRun(t *testing.T) {
69 dir := t.TempDir()
70 scenes := make(chan ports.Scene, 8)
71 contents := make(chan ports.SurfaceContent, 8)
72 r, f := recordingRenderer(t, nil)
73 contents <- ports.SurfaceContent{ID: 1, SHM: &ports.SHMBuffer{Pool: 1}}
74 shown := []ports.SceneWindow{{ID: 1, Rect: ports.Rect{W: 2, H: 2}}, {ID: 2, Rect: ports.Rect{W: 2, H: 2}}}
75 scenes <- ports.Scene{Seq: 1, OutputWidth: 2, OutputHeight: 2, Windows: shown}
76 scenes <- ports.Scene{Seq: 2, OutputWidth: 2, OutputHeight: 2, Windows: shown}
77 contents <- ports.SurfaceContent{ID: 2, SHM: &ports.SHMBuffer{Pool: 2}}
78 ctx, cancel := context.WithCancel(context.Background())
79 done := make(chan error, 1)
80 go func() {
81 done <- Run(ctx, Options{Width: 2, Height: 2, ScreenshotDir: dir, NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, contents, nil, nil)
82 }()
83 waitFrames(t, f, 1)
84 if s, c := f.snapshot(); len(s) != 1 || s[0].Seq != 2 || len(c[0]) != 2 {
85 t.Errorf("coalescing: %+v %+v", s, c)
86 }
87 contents <- ports.SurfaceContent{ID: 1}
88 waitFrames(t, f, 2)
89 if _, c := f.snapshot(); len(c) < 2 {
90 t.Fatal("no second frame")
91 } else if _, ok := c[1][1]; ok {
92 t.Error("content not deleted")
93 }
94 cancel()
95 if err := <-done; err != nil {
96 t.Fatal(err)
97 }
98 for _, name := range []string{"frame-000001.png", "frame-000002.png", "latest.png"} {
99 file, err := os.Open(filepath.Join(dir, name))
100 if err != nil {
101 t.Fatal(err)
102 }
103 _, err = png.Decode(file)
104 _ = file.Close()
105 if err != nil {
106 t.Fatal(err)
107 }
108 }
109}
110
111// Content of a window the output does not show draws no frame.
112func TestRunSkipsContentNotShown(t *testing.T) {
113 scenes := make(chan ports.Scene, 1)
114 contents := make(chan ports.SurfaceContent, 2)
115 scenes <- ports.Scene{Seq: 1, OutputWidth: 2, OutputHeight: 2, Windows: []ports.SceneWindow{{ID: 1, Rect: ports.Rect{W: 2, H: 2}}, {ID: 3, Hidden: true}}}
116 r, f := recordingRenderer(t, nil)
117 ctx, cancel := context.WithCancel(context.Background())
118 done := make(chan error, 1)
119 go func() {
120 done <- Run(ctx, Options{Width: 2, Height: 2, NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, contents, nil, nil)
121 }()
122 waitFrames(t, f, 1)
123 contents <- ports.SurfaceContent{ID: 2, SHM: &ports.SHMBuffer{Pool: 2}}
124 contents <- ports.SurfaceContent{ID: 3, SHM: &ports.SHMBuffer{Pool: 3}}
125 time.Sleep(50 * time.Millisecond)
126 if s, _ := f.snapshot(); len(s) != 1 {
127 t.Fatalf("%d frames for content not shown", len(s))
128 }
129 contents <- ports.SurfaceContent{ID: 1, SHM: &ports.SHMBuffer{Pool: 1}}
130 waitFrames(t, f, 2)
131 if _, c := f.snapshot(); c[1][2].SHM == nil {
132 t.Error("content not shown was dropped")
133 }
134 cancel()
135 if err := <-done; err != nil {
136 t.Fatal(err)
137 }
138}
139
140func TestErrors(t *testing.T) {
141 expected := errors.New("failure")
142 scenes := make(chan ports.Scene, 1)
143 scenes <- ports.Scene{}
144 if err := Run(context.Background(), Options{NewRenderer: func(int, int) (ports.Renderer, error) { return nil, expected }}, scenes, nil, nil, nil); !errors.Is(err, expected) {
145 t.Fatal(err)
146 }
147 r, _ := recordingRenderer(t, expected)
148 if err := Run(context.Background(), Options{NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, nil, nil, nil); !errors.Is(err, expected) {
149 t.Fatal(err)
150 }
151}
152
153// Each trim tick lets the idle renderer free what it no longer draws,
154// without a frame; a failed trim stops the output.
155func TestRunTrimsRendererOnTick(t *testing.T) {
156 ticks := make(chan time.Time)
157 clk := portsmocks.NewMockClock(t)
158 tk := portsmocks.NewMockTicker(t)
159 clk.EXPECT().NewTicker(trimEvery).Return(tk).Once()
160 tk.EXPECT().C().Return(ticks)
161 tk.EXPECT().Stop().Return().Once()
162 now := time.Unix(1000, 0)
163 clk.EXPECT().Now().Return(now)
164 r, f := recordingRenderer(t, nil)
165 trimmed := make(chan time.Time, 2)
166 failure := errors.New("trim failed")
167 calls := 0 // Run's goroutine only
168 r.EXPECT().Trim(now).RunAndReturn(func(at time.Time) error {
169 trimmed <- at
170 if calls++; calls == 2 {
171 return failure
172 }
173 return nil
174 }).Twice()
175 done := make(chan error, 1)
176 go func() {
177 done <- Run(context.Background(), Options{Width: 2, Height: 2, Clock: clk, NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, nil, nil, nil, nil)
178 }()
179 ticks <- now
180 if got := <-trimmed; !got.Equal(now) {
181 t.Fatalf("trimmed at %v", got)
182 }
183 ticks <- now
184 if err := <-done; !errors.Is(err, failure) {
185 t.Fatalf("run: %v", err)
186 }
187 if s, _ := f.snapshot(); len(s) != 0 {
188 t.Fatalf("%d frames for a trim", len(s))
189 }
190}
191
192func TestWritePNGAtomic(t *testing.T) {
193 dir := t.TempDir()
194 img := image.NewRGBA(image.Rect(0, 0, 1, 1))
195 for _, name := range []string{"frame-000001.png", "latest.png"} {
196 path := filepath.Join(dir, name)
197 if err := writePNGSecure(path, img, nil, ports.SecurityState{}); err != nil {
198 t.Fatal(err)
199 }
200 f, err := os.Open(path)
201 if err != nil {
202 t.Fatal(err)
203 }
204 if _, err := png.Decode(f); err != nil {
205 t.Fatal(err)
206 }
207 _ = f.Close()
208 }
209 entries, err := os.ReadDir(dir)
210 if err != nil {
211 t.Fatal(err)
212 }
213 if len(entries) != 2 {
214 t.Fatalf("unexpected files: %v", entries)
215 }
216}
217
218func TestRunPassesLayerContent(t *testing.T) {
219 scenes := make(chan ports.Scene, 1)
220 contents := make(chan ports.SurfaceContent, 1)
221 layer := ports.SceneLayer{ID: 42, Layer: ports.LayerTop, Rect: ports.Rect{W: 2, H: 2}}
222 scenes <- ports.Scene{Layers: []ports.SceneLayer{layer}}
223 contents <- ports.SurfaceContent{ID: 42, Width: 1, Height: 1, SHM: &ports.SHMBuffer{Pool: 42, Stride: 4}}
224 r, f := recordingRenderer(t, nil)
225 ctx, cancel := context.WithCancel(context.Background())
226 done := make(chan error, 1)
227 go func() {
228 done <- Run(ctx, Options{Width: 2, Height: 2, NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, contents, nil, nil)
229 }()
230 deadline := time.After(3 * time.Second)
231 for {
232 s, c := f.snapshot()
233 if len(c) > 0 && len(s[0].Layers) == 1 && c[0][42].SHM != nil {
234 break
235 }
236 select {
237 case <-deadline:
238 cancel()
239 <-done
240 t.Fatal("layer content not passed to renderer")
241 case <-time.After(10 * time.Millisecond):
242 }
243 }
244 cancel()
245 if err := <-done; err != nil {
246 t.Fatal(err)
247 }
248}
249
250func TestCaptureForcesFreshHeadlessFrame(t *testing.T) {
251 scenes := make(chan ports.Scene, 1)
252 requests := make(chan ports.CaptureRequest, 1)
253 replies := make(chan ports.CaptureDone, 1)
254 r, frames := recordingRenderer(t, nil)
255
256 frame := portsmocks.NewMockCaptureFrame(t)
257 frame.EXPECT().Done().Return(nil)
258 frame.EXPECT().Read(image.Rect(0, 0, 2, 2), mock.MatchedBy(func(p []byte) bool { return len(p) >= 16 }), 8).RunAndReturn(func(_ image.Rectangle, dst []byte, _ int) error { copy(dst, []byte{1, 2, 3, 255}); return nil }).Once()
259 r.EXPECT().BeginCapture().Return(frame, nil).Once()
260 r.EXPECT().EndCapture(frame).Return().Once()
261 ctx, cancel := context.WithCancel(context.Background())
262 done := make(chan error, 1)
263 go func() {
264 done <- Run(ctx, Options{Width: 2, Height: 2, Captured: replies, NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, nil, nil, requests)
265 }()
266 scenes <- ports.Scene{Background: "#000000"}
267 waitFrames(t, frames, 1)
268 f, err := os.CreateTemp(t.TempDir(), "shot")
269 if err != nil {
270 t.Fatal(err)
271 }
272 if err := f.Truncate(16); err != nil {
273 t.Fatal(err)
274 }
275 requests <- ports.CaptureRequest{ID: 1, Region: image.Rect(0, 0, 2, 2), Width: 2, Height: 2, Stride: 8, Dst: ports.SHMBuffer{File: f}}
276 select {
277 case result := <-replies:
278 if result.Err != nil {
279 t.Fatal(result.Err)
280 }
281 case <-time.After(3 * time.Second):
282 t.Fatal("no capture")
283 }
284 frame.Calls = nil // Testify must not inspect unmapped slice during expectation cleanup.
285 if _, err := f.Stat(); err == nil {
286 t.Fatal("descriptor not closed")
287 }
288 if s, _ := frames.snapshot(); len(s) < 2 {
289 t.Fatal("no fresh frame")
290 }
291 cancel()
292 if err := <-done; err != nil {
293 t.Fatal(err)
294 }
295}
296
297// RawHDR writes the renderer's raw PQ codes as a 16-bit latest-pq.png next
298// to the 8-bit screenshots.
299func TestHeadlessRawHDRScreenshot(t *testing.T) {
300 dir := t.TempDir()
301 want := image.NewRGBA64(image.Rect(0, 0, 2, 2))
302 for i := range 4 {
303 want.SetRGBA64(i%2, i/2, color.RGBA64{R: uint16(i*0x1111 + 0x0123), G: 0x8000 + uint16(i), B: 0xffc0, A: 0xffff})
304 }
305 f, err := os.CreateTemp(t.TempDir(), "target")
306 if err != nil {
307 t.Fatal(err)
308 }
309 r := portsmocks.NewMockRenderer(t)
310 r.EXPECT().SetHDR(float64(203)).Return().Once()
311 r.EXPECT().ExportTargets(1, []uint64(nil)).Return([]ports.DMABuf{{Planes: []ports.DMABufPlane{{File: f}}}}, nil).Once()
312 rendered := make(chan struct{}, 4)
313 r.EXPECT().Render(mock.Anything, mock.Anything).RunAndReturn(func(ports.Scene, map[ports.WindowID]ports.SurfaceContent) (*os.File, error) {
314 rendered <- struct{}{}
315 return nil, nil
316 }).Maybe()
317 r.EXPECT().Pixels().Return(image.NewRGBA(image.Rect(0, 0, 2, 2))).Maybe()
318 r.EXPECT().HDRPixels().Return(want).Maybe()
319 r.EXPECT().Close().Return().Once()
320 scenes := make(chan ports.Scene, 1)
321 scenes <- ports.Scene{Seq: 1, OutputWidth: 2, OutputHeight: 2}
322 ctx, cancel := context.WithCancel(context.Background())
323 done := make(chan error, 1)
324 go func() {
325 done <- Run(ctx, Options{Width: 2, Height: 2, HDR: true, RawHDR: true, ScreenshotDir: dir, Log: logging.For(ctx, "render"), NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, scenes, nil, nil, nil)
326 }()
327 select {
328 case <-rendered:
329 case <-time.After(3 * time.Second):
330 t.Fatal("no frame")
331 }
332 // The files are written after Render returns.
333 path := filepath.Join(dir, "latest-pq.png")
334 deadline := time.Now().Add(3 * time.Second)
335 for {
336 if _, err := os.Stat(path); err == nil {
337 break
338 }
339 if time.Now().After(deadline) {
340 t.Fatal("no latest-pq.png")
341 }
342 time.Sleep(10 * time.Millisecond)
343 }
344 cancel()
345 if err := <-done; err != nil {
346 t.Fatal(err)
347 }
348 file, err := os.Open(path)
349 if err != nil {
350 t.Fatal(err)
351 }
352 defer file.Close()
353 got, err := png.Decode(file)
354 if err != nil {
355 t.Fatal(err)
356 }
357 if _, ok := got.(*image.NRGBA64); !ok && got.ColorModel() != color.RGBA64Model {
358 t.Fatalf("not a 16-bit image: %T", got)
359 }
360 for y := range 2 {
361 for x := range 2 {
362 if g, w := color.RGBA64Model.Convert(got.At(x, y)), want.RGBA64At(x, y); g != color.Color(w) {
363 t.Errorf("(%d,%d) = %v, want %v", x, y, g, w)
364 }
365 }
366 }
367 if _, err := os.Stat(filepath.Join(dir, "latest.png")); err != nil {
368 t.Errorf("8-bit screenshot: %v", err)
369 }
370}
371
372// Only the output which successfully prepared HDR reports confirmed HDR.
373// The fallback must explicitly withdraw it, and close exported descriptors.
374func TestHeadlessHDRFormatsConfirmed(t *testing.T) {
375 for _, success := range []bool{true, false} {
376 t.Run(map[bool]string{true: "confirmed", false: "fallback"}[success], func(t *testing.T) {
377 r := portsmocks.NewMockRenderer(t)
378 r.EXPECT().SetHDR(float64(203)).Return().Once()
379 if success {
380 f, err := os.CreateTemp(t.TempDir(), "target")
381 if err != nil {
382 t.Fatal(err)
383 }
384 r.EXPECT().ExportTargets(1, []uint64(nil)).Return([]ports.DMABuf{{Planes: []ports.DMABufPlane{{File: f}}}}, nil).Once()
385 t.Cleanup(func() {
386 if _, err := f.Stat(); err == nil {
387 t.Error("exported fd not closed")
388 }
389 })
390 } else {
391 r.EXPECT().ExportTargets(1, []uint64(nil)).Return(nil, errors.New("no compatible target")).Once()
392 r.EXPECT().SetHDR(float64(0)).Return().Once()
393 r.EXPECT().ExportTargets(0, []uint64(nil)).Return(nil, nil).Once()
394 }
395 r.EXPECT().Close().Return().Once()
396 formats := make(chan ports.OutputFormats, 1)
397 ctx, cancel := context.WithCancel(context.Background())
398 done := make(chan error, 1)
399 go func() {
400 done <- Run(ctx, Options{Width: 2, Height: 2, HDR: true, Name: "HEADLESS-1", Formats: formats, Log: logging.For(ctx, "render"), NewRenderer: func(int, int) (ports.Renderer, error) { return r, nil }}, nil, nil, nil, nil)
401 }()
402 select {
403 case f := <-formats:
404 if f.Output != "HEADLESS-1" || (f.HDR != nil) != success {
405 t.Fatalf("report %+v, success=%t", f, success)
406 }
407 if success && (f.HDR.MaxLuminance != 1000 || f.HDR.MaxFrameAverage != 400 || f.HDR.MinLuminance != .005) {
408 t.Fatalf("HDR metadata %+v", f.HDR)
409 }
410 case <-time.After(2 * time.Second):
411 t.Fatal("no format report")
412 }
413 cancel()
414 if err := <-done; err != nil {
415 t.Fatal(err)
416 }
417 })
418 }
419}