-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathkitty_test.go
More file actions
422 lines (358 loc) · 11.8 KB
/
Copy pathkitty_test.go
File metadata and controls
422 lines (358 loc) · 11.8 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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
package termimg
import (
"bytes"
"compress/zlib"
"encoding/base64"
"fmt"
"image"
"io"
"os"
"strconv"
"strings"
"testing"
"unicode/utf8"
"github.com/stretchr/testify/assert"
)
func extractFirstKittyImageID(output string) (uint32, error) {
start := strings.Index(output, "i=")
if start == -1 {
return 0, fmt.Errorf("no kitty image id found in output")
}
start += 2
end := start
for end < len(output) && output[end] >= '0' && output[end] <= '9' {
end++
}
if end == start {
return 0, fmt.Errorf("kitty image id token has no digits")
}
id, err := strconv.ParseUint(output[start:end], 10, 32)
if err != nil {
return 0, fmt.Errorf("failed to parse kitty image id: %w", err)
}
return uint32(id), nil
}
func captureStdout(t *testing.T, fn func() error) (string, error) {
t.Helper()
oldStdout := os.Stdout
readPipe, writePipe, err := os.Pipe()
if err != nil {
return "", fmt.Errorf("failed to create stdout pipe: %w", err)
}
os.Stdout = writePipe
var runErr error
var panicValue any
func() {
defer func() {
panicValue = recover()
}()
runErr = fn()
}()
os.Stdout = oldStdout
closeErr := writePipe.Close()
if closeErr != nil {
_ = readPipe.Close()
if panicValue != nil {
panic(panicValue)
}
return "", fmt.Errorf("failed to close write pipe: %w", closeErr)
}
data, readErr := io.ReadAll(readPipe)
_ = readPipe.Close()
if readErr != nil {
if panicValue != nil {
panic(panicValue)
}
return "", fmt.Errorf("failed to read stdout pipe: %w", readErr)
}
if panicValue != nil {
panic(panicValue)
}
return string(data), runErr
}
func TestKittyZlibCompression(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 1, 1))
opts := RenderOptions{
KittyOpts: &KittyOptions{
Compression: true,
},
features: &TerminalFeatures{},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
t.Log(output)
// Handle tmux wrapping if present
if after, ok := strings.CutPrefix(output, "\x1bPtmux;\x1b"); ok {
unwrapped := after
unwrapped = strings.TrimSuffix(unwrapped, "\x1b\\")
output = strings.ReplaceAll(unwrapped, "\x1b\x1b", "\x1b")
}
assert.Contains(t, output, "o=z", "Should contain zlib compression flag")
// Verify that the data is actually compressed
// The structure is: \x1b_G<controls>;<payload>\x1b\\
parts := strings.SplitN(output, ";", 2)
assert.Len(t, parts, 2, "Output should be split into control and payload parts")
encodedData := strings.TrimSuffix(parts[1], "\x1b\\")
decodedData, err := base64.StdEncoding.DecodeString(encodedData)
assert.NoError(t, err)
// Attempt to decompress the data
r, err := zlib.NewReader(bytes.NewReader(decodedData))
assert.NoError(t, err, "Should be able to decompress data")
if r != nil {
r.Close()
}
}
func TestKittyPNGTransfer(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 1, 1))
opts := RenderOptions{
KittyOpts: &KittyOptions{
PNG: true,
},
features: &TerminalFeatures{},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "f=100", "Should contain PNG data format flag")
}
func TestKittyTempFileTransfer(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 1, 1))
opts := RenderOptions{
KittyOpts: &KittyOptions{
TempFile: true,
},
features: &TerminalFeatures{},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "t=t", "Should contain temporary file transfer flag")
}
func TestKittyImageNumber(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 1, 1))
opts := RenderOptions{
KittyOpts: &KittyOptions{
ImageNum: 42,
},
features: &TerminalFeatures{},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "I=42", "Should contain image number")
}
func TestKittyUnicodeTracksLastImageID(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
opts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
renderedID, err := extractFirstKittyImageID(output)
assert.NoError(t, err)
assert.Equal(t, renderedID, renderer.GetLastImageID(), "last image ID should match transmitted Unicode image ID")
}
func TestKittyUnicodeHonorsImageNumber(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
opts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
ImageNum: 42,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "i=42", "Unicode path should use caller-provided image number")
renderedID, err := extractFirstKittyImageID(output)
assert.NoError(t, err)
assert.Equal(t, uint32(42), renderedID)
assert.Equal(t, uint32(42), renderer.GetLastImageID(), "last image ID should match caller-provided Unicode image number")
}
func TestKittyUnicodeUsesRawTransferWithPlacementCommandByDefault(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
opts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
ImageNum: 42,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "f=32,s=16,v=16,t=d,i=42", "Unicode path should transmit image data using raw RGBA by default")
assert.Contains(t, output, "a=p,U=1,i=42", "Unicode path should emit explicit virtual placement command")
}
func TestKittyUnicodeUsesPngTransferWhenRequested(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
opts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
ImageNum: 42,
PNG: true,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "f=100,t=d,i=42", "Unicode path should transmit PNG when explicitly requested")
assert.Contains(t, output, "a=p,U=1,i=42", "Unicode path should emit explicit virtual placement command")
}
func TestKittyVirtualWithoutUnicodeDoesNotEmitPlaceholders(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
opts := RenderOptions{
Virtual: true,
KittyOpts: &KittyOptions{
UseUnicode: false,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
renderer := &KittyRenderer{}
output, err := renderer.Render(img, opts)
assert.NoError(t, err)
assert.Contains(t, output, "U=1", "virtual transfer should still create a virtual placement")
assert.NotContains(t, output, PLACEHOLDER_CHAR, "non-unicode virtual transfer should not append placeholder text")
}
func TestProcessImageUnicodeHonorsExplicitResize(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 20, 20))
opts := RenderOptions{
WidthPixels: 10,
HeightPixels: 10,
ScaleMode: ScaleFit,
KittyOpts: &KittyOptions{
UseUnicode: true,
},
features: &TerminalFeatures{},
}
processed, err := processImage(img, opts)
assert.NoError(t, err)
assert.Equal(t, 10, processed.Bounds().Dx())
assert.Equal(t, 10, processed.Bounds().Dy())
}
func TestProcessImageUnicodeScaleAutoWithSingleDimension(t *testing.T) {
img := image.NewRGBA(image.Rect(0, 0, 20, 10))
opts := RenderOptions{
WidthPixels: 10,
ScaleMode: ScaleAuto,
KittyOpts: &KittyOptions{
UseUnicode: true,
},
features: &TerminalFeatures{},
}
processed, err := processImage(img, opts)
assert.NoError(t, err)
assert.Equal(t, 10, processed.Bounds().Dx())
assert.Equal(t, 5, processed.Bounds().Dy())
}
func TestKittyUnicodeInvalidImageNumberDoesNotMutateLastID(t *testing.T) {
if strconv.IntSize < 64 {
t.Skip("requires 64-bit int to construct value > 0xFFFFFFFF")
}
img := image.NewRGBA(image.Rect(0, 0, 16, 16))
renderer := &KittyRenderer{}
validOpts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
ImageNum: 42,
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
_, err := renderer.Render(img, validOpts)
assert.NoError(t, err)
assert.Equal(t, uint32(42), renderer.GetLastImageID())
invalidOpts := RenderOptions{
KittyOpts: &KittyOptions{
UseUnicode: true,
ImageNum: int(uint64(^uint32(0)) + 1), // exceeds 32-bit limit
},
features: &TerminalFeatures{
FontWidth: 8,
FontHeight: 16,
},
}
_, err = renderer.Render(img, invalidOpts)
assert.Error(t, err)
assert.Equal(t, uint32(42), renderer.GetLastImageID(), "failed render should not overwrite last successful image ID")
}
func TestRenderPlaceholderAreaWithImageIDUsesBigEndianRGB(t *testing.T) {
area := CreatePlaceholderArea(0x123456, 1, 1)
rendered := RenderPlaceholderAreaWithImageID(area, 0x123456)
assert.Contains(t, rendered, "\x1b[38;2;18;52;86m", "RGB encoding should match (R<<16 | G<<8 | B)")
assert.NotContains(t, rendered, "\x1b[38;2;86;52;18m", "little-endian RGB encoding should not be used")
}
func TestRenderPlaceholderAreaWithImageIDUsesTruecolorForLowIDs(t *testing.T) {
area := CreatePlaceholderArea(1, 1, 1)
rendered := RenderPlaceholderAreaWithImageID(area, 1)
assert.Contains(t, rendered, "\x1b[38;2;0;0;1m", "low IDs should still be encoded as truecolor bytes")
assert.NotContains(t, rendered, "\x1b[38;5;1m", "palette mode should not be used for ID encoding")
}
func TestRenderPlaceholderAreaWithImageIDUsesInheritedPlaceholders(t *testing.T) {
area := CreatePlaceholderArea(1, 1, 3)
rendered := RenderPlaceholderAreaWithImageID(area, 1)
assert.Contains(t, rendered, CreatePlaceholder(0, 0, 0)+PLACEHOLDER_CHAR+PLACEHOLDER_CHAR)
assert.NotContains(t, rendered, CreatePlaceholder(0, 1, 0))
assert.NotContains(t, rendered, CreatePlaceholder(0, 2, 0))
}
func TestRenderAnchoredPlaceholderAreaPositionsEveryRow(t *testing.T) {
rendered := renderAnchoredPlaceholderArea(1, 5, 5, 2, 3)
assert.Contains(t, rendered, "\x1b[6;6H")
assert.Contains(t, rendered, "\x1b[7;6H")
assert.Contains(t, rendered, "\x1b[8;6H")
assert.NotContains(t, rendered, "\n")
assert.Equal(t, 3, strings.Count(rendered, "\x1b[39m"))
}
func TestRenderAnchoredPlaceholderAreaUsesInheritedPlaceholders(t *testing.T) {
rendered := renderAnchoredPlaceholderArea(1, 0, 0, 3, 1)
assert.Contains(t, rendered, CreatePlaceholder(0, 0, 0)+PLACEHOLDER_CHAR+PLACEHOLDER_CHAR)
assert.NotContains(t, rendered, CreatePlaceholder(0, 1, 0))
assert.NotContains(t, rendered, CreatePlaceholder(0, 2, 0))
}
func TestRenderAnchoredPlaceholderAreaEmptyWhenInvalidDimensions(t *testing.T) {
assert.Equal(t, "", renderAnchoredPlaceholderArea(1, 0, 0, 0, 3))
assert.Equal(t, "", renderAnchoredPlaceholderArea(1, 0, 0, 3, 0))
}
func TestPlaceImageWithSizeDoesNotWrapPlaceholderTextInTmuxPassthrough(t *testing.T) {
ForceTmux(true)
defer ForceTmux(false)
renderer := &KittyRenderer{}
output, err := captureStdout(t, func() error {
return renderer.PlaceImageWithSize("42", 1, 2, 0, 2, 1)
})
assert.NoError(t, err)
assert.Contains(t, output, "\x1b[3;2H", "place command should move cursor to requested absolute coordinates")
assert.NotContains(t, output, "\x1bPtmux;\x1b", "placeholder text should remain in-band and not be tmux passthrough wrapped")
}
func TestCreatePlaceholderIncludesExtraDiacriticFor24BitIDs(t *testing.T) {
placeholder := CreatePlaceholder(1, 2, 0)
assert.Equal(t, 4, utf8.RuneCountInString(placeholder), "24-bit IDs should still include the extra-id diacritic")
}
func TestCreatePlaceholderIncludesExtraDiacriticFor32BitIDs(t *testing.T) {
placeholder := CreatePlaceholder(1, 2, 1)
assert.Equal(t, 4, utf8.RuneCountInString(placeholder), "32-bit IDs should include the high-byte diacritic")
}