-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplator_test.go
More file actions
614 lines (517 loc) · 13.5 KB
/
Copy pathtemplator_test.go
File metadata and controls
614 lines (517 loc) · 13.5 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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
package templator
import (
"bytes"
"context"
"errors"
"fmt"
"html/template"
"io"
"strings"
"sync"
"testing"
"testing/fstest"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type TestData struct {
Title string
Content string
}
const testHTMLTemplate = `<!DOCTYPE html>
<html>
<head>
<title>{{.Title}}</title>
</head>
<body>
<h1>{{.Content}}</h1>
</body>
</html>`
func TestNewRegistry(t *testing.T) {
t.Parallel()
tests := []struct {
name string
fs fstest.MapFS
opts []Option[TestData]
wantErr bool
}{
{
name: "successful initialization with default options",
fs: fstest.MapFS{
"templates/template1.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
},
opts: nil,
wantErr: false,
},
{
name: "successful initialization with custom path",
fs: fstest.MapFS{
"custom/template1.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
},
opts: []Option[TestData]{WithTemplatesPath[TestData]("custom")},
wantErr: false,
},
{
name: "error with non-existent directory",
fs: fstest.MapFS{},
opts: []Option[TestData]{WithTemplatesPath[TestData]("non-existent")},
wantErr: false, // Registry creation succeeds, template loading happens later
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
got, err := NewRegistry(tt.fs, tt.opts...)
if tt.wantErr {
require.Error(t, err)
require.Nil(t, got)
return
}
require.NoError(t, err)
require.NotNil(t, got)
})
}
}
func TestRegistry_Get(t *testing.T) {
t.Parallel()
t.Run("can get templates concurrently", func(t *testing.T) {
fs := fstest.MapFS{
"custom/template1.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
}
opts := []Option[TestData]{WithTemplatesPath[TestData]("custom")}
registry, err := NewRegistry(fs, opts...)
require.NoError(t, err)
var wg sync.WaitGroup
errs := make(chan error, 2)
wg.Add(2)
for range 2 {
go func(wg *sync.WaitGroup) {
defer wg.Done()
_, err := registry.Get("template1")
errs <- err
}(&wg)
}
wg.Wait()
close(errs)
for err := range errs {
require.NoError(t, err)
}
})
}
func TestHandler(t *testing.T) {
t.Parallel()
fs := fstest.MapFS{
"templates/test.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
}
reg, err := NewRegistry[TestData](fs)
require.NoError(t, err)
tests := []struct {
name string
data TestData
wantErr bool
}{
{
name: "successful template execution",
data: TestData{
Title: "Test Title",
Content: "Test Content",
},
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
handler, err := reg.Get("test")
require.NoError(t, err)
var buf bytes.Buffer
err = handler.Execute(context.TODO(), &buf, tt.data)
if tt.wantErr {
require.Error(t, err)
return
}
require.NoError(t, err)
assert.Contains(t, buf.String(), tt.data.Title)
assert.Contains(t, buf.String(), tt.data.Content)
})
}
}
type cancelOnFirstWriteWriter struct {
w io.Writer
cancel context.CancelFunc
canceled bool
}
func (w *cancelOnFirstWriteWriter) Write(p []byte) (int, error) {
n, err := w.w.Write(p)
if !w.canceled {
w.canceled = true
w.cancel()
}
return n, err
}
type cancelAndFailWriter struct {
cancel context.CancelFunc
}
func (w cancelAndFailWriter) Write(_ []byte) (int, error) {
w.cancel()
return 0, io.ErrClosedPipe
}
func TestHandler_ExecuteContext(t *testing.T) {
t.Parallel()
fs := fstest.MapFS{
"templates/test.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
}
reg, err := NewRegistry[TestData](fs)
require.NoError(t, err)
handler, err := reg.Get("test")
require.NoError(t, err)
t.Run("returns cancellation error when context already canceled", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithCancel(context.Background())
cancel()
var buf bytes.Buffer
err := handler.Execute(ctx, &buf, TestData{Title: "Title", Content: "Content"})
require.Error(t, err)
assert.ErrorIs(t, err, context.Canceled)
var execErr ErrTemplateExecution
require.ErrorAs(t, err, &execErr)
})
t.Run("returns error for nil context", func(t *testing.T) {
t.Parallel()
var nilCtx context.Context
var buf bytes.Buffer
err := handler.Execute(nilCtx, &buf, TestData{Title: "Title", Content: "Content"})
require.Error(t, err)
assert.True(t, errors.Is(err, ErrNilContext))
var execErr ErrTemplateExecution
require.ErrorAs(t, err, &execErr)
})
t.Run("returns cancellation error when canceled during write", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
var buf bytes.Buffer
writer := &cancelOnFirstWriteWriter{w: &buf, cancel: cancel}
err := handler.Execute(ctx, writer, TestData{Title: "Title", Content: "Content"})
require.Error(t, err)
assert.ErrorIs(t, err, context.Canceled)
var execErr ErrTemplateExecution
require.ErrorAs(t, err, &execErr)
})
t.Run("returns deadline exceeded when context deadline has passed", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(-time.Second))
defer cancel()
var buf bytes.Buffer
err := handler.Execute(ctx, &buf, TestData{Title: "Title", Content: "Content"})
require.Error(t, err)
assert.ErrorIs(t, err, context.DeadlineExceeded)
var execErr ErrTemplateExecution
require.ErrorAs(t, err, &execErr)
})
t.Run("prefers context cancellation over writer error", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
err := handler.Execute(ctx, cancelAndFailWriter{cancel: cancel}, TestData{Title: "Title", Content: "Content"})
require.Error(t, err)
assert.ErrorIs(t, err, context.Canceled)
assert.NotErrorIs(t, err, io.ErrClosedPipe)
var execErr ErrTemplateExecution
require.ErrorAs(t, err, &execErr)
})
t.Run("executes normally with active context", func(t *testing.T) {
t.Parallel()
var buf bytes.Buffer
err := handler.Execute(context.Background(), &buf, TestData{Title: "Title", Content: "Content"})
require.NoError(t, err)
assert.Contains(t, buf.String(), "Title")
assert.Contains(t, buf.String(), "Content")
})
}
func TestGet_Error(t *testing.T) {
t.Parallel()
fs := fstest.MapFS{
"templates/valid.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
"templates/invalid.html": &fstest.MapFile{
Data: []byte("{{.InvalidSyntax}}{{end}}"), // Invalid syntax: missing begin block
},
"templates/execution_error.html": &fstest.MapFile{
Data: []byte("{{.NonexistentField}}"), // Valid syntax but will fail during execution because TestData has no such field
},
"templates/nested_error.html": &fstest.MapFile{
Data: []byte("{{.Title}}{{.Content}}{{.Nested.Field}}"), // Will fail when accessing nested field
},
}
reg, err := NewRegistry[TestData](fs)
require.NoError(t, err)
tests := []struct {
name string
template string
data TestData
wantParseErr bool
wantExecErr bool
}{
{
name: "non-existent template",
template: "nonexistent",
data: TestData{},
wantParseErr: true,
wantExecErr: false,
},
{
name: "invalid template syntax",
template: "invalid",
data: TestData{},
wantParseErr: true, // Should fail during parsing
wantExecErr: false,
},
{
name: "execution error - nonexistent field",
template: "execution_error",
data: TestData{Title: "Test", Content: "Test"},
wantParseErr: false,
wantExecErr: true, // Execution fails when accessing NonexistentField
},
{
name: "execution error - nested field",
template: "nested_error",
data: TestData{Title: "Test", Content: "Test"},
wantParseErr: false,
wantExecErr: true, // Execution fails when accessing Nested.Field
},
{
name: "valid template",
template: "valid",
data: TestData{},
wantParseErr: false,
wantExecErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
handler, err := reg.Get(tt.template)
if tt.wantParseErr {
require.Error(t, err, "expected parse error")
require.Nil(t, handler)
return
}
require.NoError(t, err)
require.NotNil(t, handler)
var buf bytes.Buffer
err = handler.Execute(context.TODO(), &buf, tt.data)
if tt.wantExecErr {
require.Error(t, err, "expected execution error")
return
}
require.NoError(t, err)
})
}
}
func TestHandler_WithFuncs(t *testing.T) {
t.Parallel()
const templateWithFunc = `{{.Title | upper}}`
fs := fstest.MapFS{
"templates/withfunc.html": &fstest.MapFile{
Data: []byte(templateWithFunc),
},
}
funcMap := template.FuncMap{
"upper": strings.ToUpper,
}
reg, err := NewRegistry[TestData](fs, WithTemplateFuncs[TestData](funcMap))
require.NoError(t, err)
handler, err := reg.Get("withfunc")
require.NoError(t, err)
var buf bytes.Buffer
err = handler.Execute(context.TODO(), &buf, TestData{Title: "hello"})
require.NoError(t, err)
assert.Equal(t, "HELLO", buf.String())
}
func TestConcurrentAccess(t *testing.T) {
t.Parallel()
fs := fstest.MapFS{
"templates/concurrent.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
}
reg, err := NewRegistry[TestData](fs)
require.NoError(t, err)
var wg sync.WaitGroup
numGoroutines := 10
errs := make(chan error, numGoroutines)
for i := range numGoroutines {
wg.Add(1)
go func(i int) {
defer wg.Done()
handler, err := reg.Get("concurrent")
if err != nil {
errs <- err
return
}
var buf bytes.Buffer
data := TestData{
Title: fmt.Sprintf("Title %d", i),
Content: fmt.Sprintf("Content %d", i),
}
err = handler.Execute(context.TODO(), &buf, data)
if err != nil {
errs <- err
return
}
if !strings.Contains(buf.String(), data.Title) {
errs <- fmt.Errorf("output missing title %q", data.Title)
return
}
if !strings.Contains(buf.String(), data.Content) {
errs <- fmt.Errorf("output missing content %q", data.Content)
return
}
errs <- nil
}(i)
}
wg.Wait()
close(errs)
for err := range errs {
require.NoError(t, err)
}
}
func TestRegistry_Options(t *testing.T) {
t.Parallel()
tests := []struct {
name string
fs fstest.MapFS
opts []Option[TestData]
templateName string
expectedPath string
shouldSucceed bool
}{
{
name: "custom path option",
fs: fstest.MapFS{
"custom/path/test.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
},
opts: []Option[TestData]{WithTemplatesPath[TestData]("custom/path")},
templateName: "test",
expectedPath: "custom/path",
shouldSucceed: true,
},
{
name: "empty path falls back to default",
fs: fstest.MapFS{
"templates/test.html": &fstest.MapFile{
Data: []byte(testHTMLTemplate),
},
},
opts: []Option[TestData]{WithTemplatesPath[TestData]("")},
templateName: "test",
expectedPath: DefaultTemplateDir,
shouldSucceed: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
reg, err := NewRegistry(tt.fs, tt.opts...)
require.NoError(t, err)
assert.Equal(t, tt.expectedPath, reg.config.path) // Updated from reg.path to reg.config.path
handler, err := reg.Get(tt.templateName)
if tt.shouldSucceed {
require.NoError(t, err)
require.NotNil(t, handler)
} else {
require.Error(t, err)
}
})
}
}
func TestWithTemplateFuncs(t *testing.T) {
t.Parallel()
funcMap := template.FuncMap{
"upper": strings.ToUpper,
"lower": strings.ToLower,
}
reg, err := NewRegistry(fstest.MapFS{}, WithTemplateFuncs[TestData](funcMap))
require.NoError(t, err)
require.Equal(t, funcMap, reg.config.funcMap)
}
func TestWithFieldValidation(t *testing.T) {
t.Parallel()
type ComplexData struct {
Title string
Content string
SubTitle *string
}
tests := []struct {
name string
templateStr string
model ComplexData
data ComplexData
shouldError bool
expectedErr string
}{
{
name: "valid fields",
templateStr: "{{.Title}} {{.Content}}",
model: ComplexData{},
data: ComplexData{Title: "Test", Content: "Content"},
shouldError: false,
},
{
name: "invalid field usage",
templateStr: "{{.InvalidField}}",
model: ComplexData{},
data: ComplexData{},
shouldError: true,
expectedErr: "field 'InvalidField' not found",
},
{
name: "nested pointer field valid",
templateStr: "{{if .SubTitle}}{{.SubTitle}}{{end}}",
model: ComplexData{},
data: ComplexData{},
shouldError: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
fs := fstest.MapFS{
"templates/test.html": &fstest.MapFile{
Data: []byte(tt.templateStr),
},
}
reg, err := NewRegistry[ComplexData](fs, WithFieldValidation(tt.model))
require.NoError(t, err)
require.True(t, reg.config.validateFields)
require.Equal(t, tt.model, reg.config.validationModel)
handler, err := reg.Get("test")
if tt.shouldError {
require.Error(t, err)
if tt.expectedErr != "" {
require.Contains(t, err.Error(), tt.expectedErr)
}
return
}
require.NoError(t, err)
var buf bytes.Buffer
err = handler.Execute(context.TODO(), &buf, tt.data)
require.NoError(t, err)
})
}
}