-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexecx_test.go
More file actions
1417 lines (1315 loc) · 42.1 KB
/
Copy pathexecx_test.go
File metadata and controls
1417 lines (1315 loc) · 42.1 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
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package execx
import (
"bytes"
"context"
"errors"
"io"
"os"
"os/exec"
"os/signal"
"path/filepath"
"runtime"
"strconv"
"strings"
"syscall"
"testing"
"time"
)
// TestHelperProcess provides deterministic subprocess behavior for stream, signal, and exit tests.
func TestHelperProcess(t *testing.T) {
if os.Getenv("EXECX_TEST_HELPER") != "1" {
return
}
args := os.Args
idx := 0
for idx < len(args) && args[idx] != "--" {
idx++
}
if idx >= len(args)-1 {
os.Exit(1)
}
cmd := args[idx+1]
cmdArgs := args[idx+2:]
switch cmd {
case "echo":
_, _ = io.WriteString(os.Stdout, strings.Join(cmdArgs, " "))
case "stderr":
_, _ = io.WriteString(os.Stderr, strings.Join(cmdArgs, " "))
case "cat":
_, _ = io.Copy(os.Stdout, os.Stdin)
case "exit":
code, _ := strconv.Atoi(cmdArgs[0])
os.Exit(code)
case "mix":
_, _ = io.WriteString(os.Stdout, "a")
time.Sleep(10 * time.Millisecond)
_, _ = io.WriteString(os.Stderr, "b")
time.Sleep(10 * time.Millisecond)
_, _ = io.WriteString(os.Stdout, "c")
case "lines":
_, _ = io.WriteString(os.Stdout, "a\nb\n")
_, _ = io.WriteString(os.Stderr, "c\n")
case "env":
_, _ = io.WriteString(os.Stdout, os.Getenv(cmdArgs[0]))
case "sleep":
ms, _ := strconv.Atoi(cmdArgs[0])
time.Sleep(time.Duration(ms) * time.Millisecond)
case "pwd":
wd, _ := os.Getwd()
_, _ = io.WriteString(os.Stdout, wd)
case "signal":
terminateHelperProcess()
time.Sleep(50 * time.Millisecond)
case "ignore-term":
if runtime.GOOS == "windows" {
os.Exit(3)
}
signal.Ignore(syscall.SIGTERM, os.Interrupt)
time.Sleep(200 * time.Millisecond)
default:
os.Exit(1)
}
os.Exit(0)
}
// helperCommand routes deterministic subprocess behavior through the current test binary.
func helperCommand(args ...string) *Cmd {
full := append([]string{"-test.run=TestHelperProcess", "--"}, args...)
cmd := Command(os.Args[0], full...)
cmd.Env("EXECX_TEST_HELPER=1")
return cmd
}
// helperPipe appends a deterministic helper subprocess as one pipeline stage.
func helperPipe(cmd *Cmd, args ...string) *Cmd {
full := append([]string{"-test.run=TestHelperProcess", "--"}, args...)
stage := cmd.Pipe(os.Args[0], full...)
stage.Env("EXECX_TEST_HELPER=1")
return stage
}
type envStringer struct{}
// String provides an environment entry through Env's fmt.Stringer fallback.
func (envStringer) String() string {
return "EXECX_ENV_VALUE=stringer"
}
// TestArgOrderAndArgs ensures heterogeneous arguments retain deterministic command-line order.
func TestArgOrderAndArgs(t *testing.T) {
cmd := helperCommand("echo").Arg("alpha").Arg(map[string]string{"--b": "2", "--a": "1"})
out, err := cmd.Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "alpha --a 1 --b 2" {
t.Fatalf("unexpected output: %q", out)
}
args := cmd.Args()
if len(args) < 1 || args[0] != os.Args[0] {
t.Fatalf("expected argv to include executable, got %v", args)
}
}
// TestArgVariants ensures slices and scalar values share the fluent argument path.
func TestArgVariants(t *testing.T) {
out, err := helperCommand("echo").Arg([]string{"a", "b"}, 123).Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "a b 123" {
t.Fatalf("unexpected output: %q", out)
}
}
// TestEnvModes ensures inheritance, replacement, and appended overrides remain distinct policies.
func TestEnvModes(t *testing.T) {
key := "EXECX_ENV_VALUE"
t.Setenv(key, "base")
out, err := helperCommand("env", key).Output()
if err != nil || out != "base" {
t.Fatalf("expected inherited env, got %q err=%v", out, err)
}
out, err = helperCommand("env", key).EnvOnly(map[string]string{key: "only", "EXECX_TEST_HELPER": "1"}).Output()
if err != nil || out != "only" {
t.Fatalf("expected env only, got %q err=%v", out, err)
}
out, err = helperCommand("env", key).EnvAppend(map[string]string{key: "append"}).Output()
if err != nil || out != "append" {
t.Fatalf("expected env append override, got %q err=%v", out, err)
}
out, err = helperCommand("env", key).EnvOnly(map[string]string{key: "only", "EXECX_TEST_HELPER": "1"}).EnvInherit().Output()
if err != nil || out != "only" {
t.Fatalf("expected env inherit to keep overrides, got %q err=%v", out, err)
}
}
// TestEnvVariants ensures supported environment input forms resolve with deterministic precedence.
func TestEnvVariants(t *testing.T) {
cmd := Command(os.Args[0], "-test.run=TestHelperProcess", "--", "env", "EXECX_ENV_VALUE").
Env(envStringer{}).
Env([]string{"EXECX_TEST_HELPER=1"}).
Env(map[string]string{"EXECX_ENV_VALUE": "map"})
out, err := cmd.Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "map" {
t.Fatalf("unexpected env output: %q", out)
}
}
// TestEnvAppendEmpty ensures append mode starts from the process environment when no explicit map exists.
func TestEnvAppendEmpty(t *testing.T) {
cmd := Command(os.Args[0], "-test.run=TestHelperProcess", "--", "env", "EXECX_ENV_VALUE").
EnvAppend(map[string]string{"EXECX_ENV_VALUE": "append", "EXECX_TEST_HELPER": "1"})
out, err := cmd.Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "append" {
t.Fatalf("unexpected env output: %q", out)
}
}
// TestEnvList ensures environment inspection is sorted and therefore reproducible.
func TestEnvList(t *testing.T) {
cmd := helperCommand("env", "NONE").EnvOnly(map[string]string{"B": "2", "A": "1", "EXECX_TEST_HELPER": "1"})
list := cmd.EnvList()
if strings.Join(list, ",") != "A=1,B=2,EXECX_TEST_HELPER=1" {
t.Fatalf("unexpected env list: %v", list)
}
}
// TestStdinHelpers ensures every supported input source reaches the child process unchanged.
func TestStdinHelpers(t *testing.T) {
cases := []struct {
name string
cmd func() *Cmd
}{
{
name: "string",
cmd: func() *Cmd {
return helperCommand("cat").StdinString("hello")
},
},
{
name: "bytes",
cmd: func() *Cmd {
return helperCommand("cat").StdinBytes([]byte("hello"))
},
},
{
name: "reader",
cmd: func() *Cmd {
return helperCommand("cat").StdinReader(strings.NewReader("hello"))
},
},
{
name: "file",
cmd: func() *Cmd {
file, err := os.CreateTemp(t.TempDir(), "stdin")
if err != nil {
t.Fatalf("temp file: %v", err)
}
if _, err := file.WriteString("hello"); err != nil {
t.Fatalf("write temp: %v", err)
}
if _, err := file.Seek(0, io.SeekStart); err != nil {
t.Fatalf("seek temp: %v", err)
}
return helperCommand("cat").StdinFile(file)
},
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
out, err := tc.cmd().Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "hello" {
t.Fatalf("unexpected output: %q", out)
}
})
}
}
// TestStdinBytesCopiesInput ensures later caller mutation cannot alter a configured command.
func TestStdinBytesCopiesInput(t *testing.T) {
input := []byte("before")
cmd := helperCommand("cat").StdinBytes(input)
copy(input, "mutate")
out, err := cmd.Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "before" {
t.Fatalf("expected configured bytes to be stable, got %q", out)
}
}
// TestOutputVariants ensures string, byte, trimmed, and combined capture preserve their distinct contracts.
func TestOutputVariants(t *testing.T) {
out, err := helperCommand("echo", " spaced ").OutputTrimmed()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "spaced" {
t.Fatalf("unexpected trimmed output: %q", out)
}
bytesOut, err := helperCommand("echo", "hi").OutputBytes()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if string(bytesOut) != "hi" {
t.Fatalf("unexpected bytes output: %q", string(bytesOut))
}
combined, err := helperCommand("mix").CombinedOutput()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if combined != "abc" {
t.Fatalf("unexpected combined output: %q", combined)
}
}
// TestExitHelpers ensures ordinary nonzero exits remain results rather than execution failures.
func TestExitHelpers(t *testing.T) {
res, err := helperCommand("exit", "2").Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if res.OK() {
t.Fatalf("expected not OK")
}
if !res.IsExitCode(2) {
t.Fatalf("expected exit code 2, got %d", res.ExitCode)
}
if res.IsSignal(syscall.SIGTERM) {
t.Fatalf("expected no signal for exit")
}
}
// TestIsSignal ensures signal termination remains distinguishable from numeric exit status.
func TestIsSignal(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("signals not supported on windows")
}
res, err := helperCommand("signal").Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if !res.IsSignal(syscall.SIGTERM) {
t.Fatalf("expected SIGTERM, got %v", res.signal)
}
}
// TestWithTimeout ensures the shortest configured timeout bounds process execution.
func TestWithTimeout(t *testing.T) {
_, err := helperCommand("sleep", "200").WithTimeout(50 * time.Millisecond).Run()
if err == nil {
t.Fatalf("expected timeout error")
}
if !errorsIsContext(err) {
t.Fatalf("expected context error, got %v", err)
}
_, err = helperCommand("sleep", "50").WithTimeout(10 * time.Millisecond).WithTimeout(5 * time.Millisecond).Run()
if err == nil {
t.Fatalf("expected timeout error on repeated call")
}
}
// TestWithDeadline ensures expired deadlines stop work while later replacements permit valid commands.
func TestWithDeadline(t *testing.T) {
_, err := helperCommand("sleep", "100").WithDeadline(time.Now().Add(10 * time.Millisecond)).Run()
if err == nil {
t.Fatalf("expected deadline error")
}
_, err = helperCommand("echo", "ok").WithDeadline(time.Now().Add(2 * time.Second)).WithDeadline(time.Now().Add(3 * time.Second)).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
}
// TestTimeoutPreservesCanceledParent ensures derived timing options cannot hide parent cancellation.
func TestTimeoutPreservesCanceledParent(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cmd := helperCommand("sleep", "200").
WithContext(ctx).
WithTimeout(time.Second).
WithDeadline(time.Now().Add(2 * time.Second))
cancel()
_, err := cmd.Run()
if !errors.Is(err, context.Canceled) {
t.Fatalf("expected canceled parent to remain authoritative, got %v", err)
}
}
// TestWithContext ensures replacing command context consistently controls subsequent execution.
func TestWithContext(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
_, err := helperCommand("sleep", "50").WithContext(ctx).Run()
if err == nil {
t.Fatalf("expected canceled error")
}
_, err = helperCommand("echo", "ok").WithTimeout(500 * time.Millisecond).WithContext(context.Background()).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
}
// TestDir ensures the child process observes the configured working directory.
func TestDir(t *testing.T) {
temp := t.TempDir()
out, err := helperCommand("pwd").Dir(temp).Output()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
resolvedTemp, err := filepath.EvalSymlinks(temp)
if err != nil {
t.Fatalf("resolve temp: %v", err)
}
resolvedOut, err := filepath.EvalSymlinks(out)
if err != nil {
t.Fatalf("resolve out: %v", err)
}
if resolvedOut != resolvedTemp {
t.Fatalf("expected dir %q, got %q", resolvedTemp, resolvedOut)
}
}
// TestPipeModes ensures strict pipelines report any stage failure while best-effort mode follows the last stage.
func TestPipeModes(t *testing.T) {
strictRes, err := helperPipe(helperCommand("exit", "2"), "echo", "ok").Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if strictRes.ExitCode != 2 {
t.Fatalf("expected strict pipeline to return first failure, got %d", strictRes.ExitCode)
}
bestEffortRes, err := helperPipe(helperCommand("exit", "2").PipeBestEffort(), "echo", "ok").Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if bestEffortRes.ExitCode != 0 {
t.Fatalf("expected best effort to return last stage, got %d", bestEffortRes.ExitCode)
}
if bestEffortRes.Stdout != "ok" {
t.Fatalf("expected stdout from last stage, got %q", bestEffortRes.Stdout)
}
}
// TestPipeChain ensures appended stages preserve pipeline order and final output ownership.
func TestPipeChain(t *testing.T) {
root := helperCommand("echo", "a")
stage := helperPipe(root, "echo", "b")
final := helperPipe(stage, "echo", "c")
res, err := final.Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if res.Stdout != "c" {
t.Fatalf("expected last stage output, got %q", res.Stdout)
}
}
// TestPipeBestEffortSetsError ensures context failure remains visible even when the final stage succeeds.
func TestPipeBestEffortSetsError(t *testing.T) {
res, err := helperPipe(helperCommand("sleep", "50").WithTimeout(10*time.Millisecond).PipeBestEffort(), "echo", "ok").Run()
if err == nil || !errorsIsContext(err) {
t.Fatalf("expected context error, got %v", err)
}
if res.Stdout != "ok" {
t.Fatalf("expected stdout from last stage, got %q", res.Stdout)
}
}
// TestPipeStartError ensures an unstartable stage produces an execution error and sentinel exit code.
func TestPipeStartError(t *testing.T) {
bad := Command("execx-does-not-exist")
stage := helperPipe(bad, "echo", "ok")
res, err := stage.Run()
if err == nil {
t.Fatalf("expected start error")
}
var errExec ErrExec
if !errors.As(err, &errExec) {
t.Fatalf("expected ErrExec, got %T", err)
}
if res.ExitCode != -1 {
t.Fatalf("expected exit code -1, got %d", res.ExitCode)
}
}
// TestPipelineDownstreamStartErrorAbortsUpstream ensures partial startup cannot leave an earlier process running.
func TestPipelineDownstreamStartErrorAbortsUpstream(t *testing.T) {
cmd := helperCommand("sleep", "5000").Pipe("execx-does-not-exist")
type outcome struct {
result Result
err error
}
done := make(chan outcome, 1)
go func() {
result, err := cmd.Run()
done <- outcome{result: result, err: err}
}()
select {
case got := <-done:
if got.err == nil {
t.Fatal("expected downstream start error")
}
var execErr ErrExec
if !errors.As(got.err, &execErr) {
t.Fatalf("expected ErrExec, got %T", got.err)
}
if got.result.ExitCode != -1 {
t.Fatalf("expected failed stage result, got exit code %d", got.result.ExitCode)
}
case <-time.After(2 * time.Second):
t.Fatal("pipeline did not abort after downstream start failure")
}
}
// TestStringAndShellEscaped ensures display quoting and shell-safe quoting remain intentionally different.
func TestStringAndShellEscaped(t *testing.T) {
cmd := Command("echo", "hello world", "it's")
if cmd.String() != "echo \"hello world\" it's" {
t.Fatalf("unexpected String(): %q", cmd.String())
}
if cmd.ShellEscaped() != "echo 'hello world' \"it's\"" {
t.Fatalf("unexpected ShellEscaped(): %q", cmd.ShellEscaped())
}
empty := Command("").ShellEscaped()
if empty != "''" {
t.Fatalf("unexpected ShellEscaped empty: %q", empty)
}
noQuote := Command("echo", "plain").ShellEscaped()
if noQuote != "echo plain" {
t.Fatalf("unexpected ShellEscaped plain: %q", noQuote)
}
}
// TestLineCallbacks ensures stdout and stderr lines reach only their respective callbacks.
func TestLineCallbacks(t *testing.T) {
var stdoutLines []string
var stderrLines []string
_, err := helperCommand("lines").OnStdout(func(line string) {
stdoutLines = append(stdoutLines, line)
}).OnStderr(func(line string) {
stderrLines = append(stderrLines, line)
}).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if strings.Join(stdoutLines, ",") != "a,b" {
t.Fatalf("unexpected stdout lines: %v", stdoutLines)
}
if strings.Join(stderrLines, ",") != "c" {
t.Fatalf("unexpected stderr lines: %v", stderrLines)
}
}
// TestLineCallbacksFlushFinalLine ensures unterminated trailing output is not lost at process exit.
func TestLineCallbacksFlushFinalLine(t *testing.T) {
var stdoutLines []string
var stderrLines []string
_, err := helperCommand("echo", "tail").
OnStdout(func(line string) { stdoutLines = append(stdoutLines, line) }).
Run()
if err != nil {
t.Fatalf("expected no stdout error, got %v", err)
}
_, err = helperCommand("stderr", "tail").
OnStderr(func(line string) { stderrLines = append(stderrLines, line) }).
Run()
if err != nil {
t.Fatalf("expected no stderr error, got %v", err)
}
if strings.Join(stdoutLines, ",") != "tail" || strings.Join(stderrLines, ",") != "tail" {
t.Fatalf("expected final lines, got stdout=%v stderr=%v", stdoutLines, stderrLines)
}
}
// TestOutputCallbacksAreSerialized ensures shared callback state is safe across concurrent stdout and stderr reads.
func TestOutputCallbacksAreSerialized(t *testing.T) {
var lines []string
callback := func(line string) {
lines = append(lines, line)
}
_, err := helperCommand("lines").OnStdout(callback).OnStderr(callback).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if len(lines) != 3 {
t.Fatalf("expected every output line, got %v", lines)
}
}
// TestWritersBeforeLineCallbacks ensures byte writers observe output before derived line notifications.
func TestWritersBeforeLineCallbacks(t *testing.T) {
var order []string
var stdoutLines []string
writer := &orderedWriter{order: &order, tag: "writer"}
_, err := helperCommand("lines").StdoutWriter(writer).OnStdout(func(line string) {
if len(stdoutLines) == 0 {
order = append(order, "line")
}
stdoutLines = append(stdoutLines, line)
}).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if len(order) == 0 || order[0] != "writer" {
t.Fatalf("expected writer before line callback, got %v", order)
}
if len(writer.buf) == 0 {
t.Fatalf("expected writer to receive output")
}
}
// TestStderrWriter ensures raw stderr forwarding and line callbacks can coexist without data loss.
func TestStderrWriter(t *testing.T) {
var stderrLines []string
writer := &orderedWriter{tag: "stderr"}
_, err := helperCommand("lines").StderrWriter(writer).OnStderr(func(line string) {
stderrLines = append(stderrLines, line)
}).Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if len(writer.buf) == 0 {
t.Fatalf("expected stderr writer to receive output")
}
if strings.Join(stderrLines, ",") != "c" {
t.Fatalf("unexpected stderr lines: %v", stderrLines)
}
}
// TestStartAndWait ensures asynchronous execution reports the same clean result as Run.
func TestStartAndWait(t *testing.T) {
proc := helperCommand("sleep", "50").Start()
res, err := proc.Wait()
if err != nil || res.ExitCode != 0 {
t.Fatalf("expected clean exit, got code=%d err=%v", res.ExitCode, err)
}
}
// TestStartError ensures startup failures retain ErrExec identity and an unavailable exit code.
func TestStartError(t *testing.T) {
res, err := Command("execx-does-not-exist").Run()
if err == nil {
t.Fatalf("expected start error")
}
var errExec ErrExec
if !errors.As(err, &errExec) {
t.Fatalf("expected ErrExec, got %T", err)
}
if res.ExitCode != -1 {
t.Fatalf("expected exit code -1 for start error, got %d", res.ExitCode)
}
}
// TestLineWriterNil ensures a line splitter without a callback still satisfies io.Writer safely.
func TestLineWriterNil(t *testing.T) {
writer := &lineWriter{}
n, err := writer.Write([]byte("data"))
if err != nil || n != 4 {
t.Fatalf("unexpected write result n=%d err=%v", n, err)
}
}
// TestWithPTYPipelineUnsupported ensures PTY mode rejects pipelines whose stream topology cannot be represented safely.
func TestWithPTYPipelineUnsupported(t *testing.T) {
prevCheck := ptyCheckFunc
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
ptyCheckFunc = prevCheck
})
_, err := Command("printf", "hi").
WithPTY().
Pipe("tr", "a-z", "A-Z").
Run()
if err == nil || !strings.Contains(err.Error(), "WithPTY is not supported") {
t.Fatalf("expected WithPTY pipeline error, got %v", err)
}
}
// TestWithPTYOpenError ensures terminal allocation failures abort execution with their cause intact.
func TestWithPTYOpenError(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
return nil, nil, errors.New("pty open failed")
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
_, err := Command("printf", "hi").WithPTY().Run()
if err == nil || !strings.Contains(err.Error(), "pty open failed") {
t.Fatalf("expected openpty error, got %v", err)
}
}
// TestWithPTYCombinedStream ensures PTY output is captured once while notifying both logical stream callbacks.
func TestWithPTYCombinedStream(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
stdoutLines := []string{}
stderrLines := []string{}
res, err := Command("printf", "a\nb\n").
WithPTY().
OnStdout(func(line string) { stdoutLines = append(stdoutLines, line) }).
OnStderr(func(line string) { stderrLines = append(stderrLines, line) }).
Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if res.Stdout != "a\nb\n" {
t.Fatalf("expected stdout to contain output, got %q", res.Stdout)
}
if res.Stderr != "" {
t.Fatalf("expected stderr to be empty, got %q", res.Stderr)
}
if strings.Join(stdoutLines, ",") != "a,b" {
t.Fatalf("unexpected stdout lines: %v", stdoutLines)
}
if strings.Join(stderrLines, ",") != "a,b" {
t.Fatalf("unexpected stderr lines: %v", stderrLines)
}
}
// TestWithPTYCombinedOutput ensures the combined-output convenience API works with a single PTY stream.
func TestWithPTYCombinedOutput(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
out, err := Command("printf", "hi").WithPTY().CombinedOutput()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if out != "hi" {
t.Fatalf("expected combined output, got %q", out)
}
}
// TestWithPTYPipelineResults ensures a one-stage PTY command retains the pipeline-results API contract.
func TestWithPTYPipelineResults(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
results, err := Command("printf", "ok").WithPTY().PipelineResults()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if len(results) != 1 || results[0].Stdout != "ok" {
t.Fatalf("unexpected pipeline results: %+v", results)
}
}
// TestWithPTYStart ensures asynchronous PTY capture is complete before Wait returns.
func TestWithPTYStart(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
proc := Command("printf", "hi").WithPTY().Start()
res, err := proc.Wait()
if err != nil || res.Stdout != "hi" {
t.Fatalf("expected stdout from Start, got %q err=%v", res.Stdout, err)
}
}
// TestWithPTYCheckError ensures unsupported terminals fail before process startup.
func TestWithPTYCheckError(t *testing.T) {
prevCheck := ptyCheckFunc
ptyCheckFunc = func() error { return errors.New("pty unsupported") }
t.Cleanup(func() {
ptyCheckFunc = prevCheck
})
_, err := Command("printf", "hi").WithPTY().CombinedOutput()
if err == nil || !strings.Contains(err.Error(), "pty unsupported") {
t.Fatalf("expected pty check error, got %v", err)
}
}
// TestWithPTYStartCheckError ensures asynchronous PTY validation failures surface through Wait.
func TestWithPTYStartCheckError(t *testing.T) {
prevCheck := ptyCheckFunc
ptyCheckFunc = func() error { return errors.New("pty unsupported") }
t.Cleanup(func() {
ptyCheckFunc = prevCheck
})
proc := Command("printf", "hi").WithPTY().Start()
res, err := proc.Wait()
if err == nil || !strings.Contains(err.Error(), "pty unsupported") {
t.Fatalf("expected pty check error, got %v", err)
}
if res.ExitCode != -1 {
t.Fatalf("expected exit code -1, got %d", res.ExitCode)
}
}
// TestWithPTYPipelineResultsCheckError ensures PTY validation also protects the pipeline-results entry point.
func TestWithPTYPipelineResultsCheckError(t *testing.T) {
prevCheck := ptyCheckFunc
ptyCheckFunc = func() error { return errors.New("pty unsupported") }
t.Cleanup(func() {
ptyCheckFunc = prevCheck
})
_, err := Command("printf", "hi").WithPTY().PipelineResults()
if err == nil || !strings.Contains(err.Error(), "pty unsupported") {
t.Fatalf("expected pty check error, got %v", err)
}
}
type errWriter struct {
called bool
}
// Write records the attempt before returning a deterministic output failure.
func (w *errWriter) Write(p []byte) (int, error) {
w.called = true
return 0, errors.New("write failed")
}
type errReader struct{}
// Read returns a deterministic stdin-copy failure.
func (errReader) Read([]byte) (int, error) {
return 0, errors.New("read failed")
}
type sliceWriter []byte
// Write accepts bytes without mutating its non-comparable value receiver.
func (sliceWriter) Write(p []byte) (int, error) {
return len(p), nil
}
// TestWithPTYWriterError ensures forwarding failures become ErrExec without discarding captured output.
func TestWithPTYWriterError(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
writer := &errWriter{}
res, err := Command("printf", "hi").WithPTY().StdoutWriter(writer).Run()
if err == nil {
t.Fatal("expected writer error")
}
var execErr ErrExec
if !errors.As(err, &execErr) {
t.Fatalf("expected ErrExec, got %T", err)
}
if !writer.called {
t.Fatalf("expected writer to be called")
}
if res.Stdout != "hi" {
t.Fatalf("expected captured stdout before writer failure, got %q", res.Stdout)
}
}
// TestWriterErrorIsExecutionError ensures ordinary stream-writer failures use the same ErrExec boundary as process failures.
func TestWriterErrorIsExecutionError(t *testing.T) {
writer := &errWriter{}
res, err := helperCommand("echo", "hi").StdoutWriter(writer).Run()
if err == nil {
t.Fatal("expected writer error")
}
var execErr ErrExec
if !errors.As(err, &execErr) {
t.Fatalf("expected ErrExec, got %T", err)
}
if res.Stdout != "hi" {
t.Fatalf("expected result capture before writer failure, got %q", res.Stdout)
}
}
// TestReaderErrorIsExecutionError ensures stdin-copy failures cannot be mistaken for successful execution.
func TestReaderErrorIsExecutionError(t *testing.T) {
_, err := helperCommand("cat").StdinReader(errReader{}).Run()
if err == nil {
t.Fatal("expected reader error")
}
var execErr ErrExec
if !errors.As(err, &execErr) {
t.Fatalf("expected ErrExec, got %T", err)
}
}
// TestWithPTYStartError ensures process startup failures remain visible after successful terminal allocation.
func TestWithPTYStartError(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
_, err := Command("execx-does-not-exist").WithPTY().Run()
if err == nil {
t.Fatalf("expected start error")
}
}
// TestWithPTYWritersNoCallbacks ensures both configured writers receive the merged PTY stream without callbacks.
func TestWithPTYWritersNoCallbacks(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
var stdoutBuf bytes.Buffer
var stderrBuf bytes.Buffer
res, err := Command("printf", "hi").
WithPTY().
StdoutWriter(&stdoutBuf).
StderrWriter(&stderrBuf).
Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if res.Stdout != "hi" {
t.Fatalf("expected stdout buffer to capture output, got %q", res.Stdout)
}
if stdoutBuf.String() != "hi" || stderrBuf.String() != "hi" {
t.Fatalf("unexpected writers: stdout=%q stderr=%q", stdoutBuf.String(), stderrBuf.String())
}
}
// TestWithPTYSharedWriterAndCallback ensures a shared writer receives merged bytes once while callbacks remain serialized.
func TestWithPTYSharedWriterAndCallback(t *testing.T) {
prevOpen := openPTYFunc
prevCheck := ptyCheckFunc
openPTYFunc = func() (*os.File, *os.File, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, nil, err
}
return r, w, nil
}
ptyCheckFunc = func() error { return nil }
t.Cleanup(func() {
openPTYFunc = prevOpen
ptyCheckFunc = prevCheck
})
var output bytes.Buffer
var lines []string
callback := func(line string) { lines = append(lines, line) }
_, err := Command("printf", "a\nb").
WithPTY().
StdoutWriter(&output).
StderrWriter(&output).
OnStdout(callback).
OnStderr(callback).
Run()
if err != nil {
t.Fatalf("expected no error, got %v", err)
}