/
exec.test.ts
1030 lines (920 loc) · 31 KB
/
exec.test.ts
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
import * as exec from '../src/exec'
import * as im from '../src/interfaces'
import * as childProcess from 'child_process'
import * as fs from 'fs'
import * as os from 'os'
import * as path from 'path'
import * as stream from 'stream'
import * as io from '@actions/io'
/* eslint-disable @typescript-eslint/unbound-method */
const IS_WINDOWS = process.platform === 'win32'
let outstream: stream.Writable
let errstream: stream.Writable
describe('@actions/exec', () => {
beforeAll(() => {
io.mkdirP(getTestTemp())
outstream = fs.createWriteStream(path.join(getTestTemp(), 'my.log'))
errstream = fs.createWriteStream(path.join(getTestTemp(), 'myerr.log'))
})
beforeEach(() => {
outstream.write = jest.fn()
errstream.write = jest.fn()
})
it('Runs exec successfully with arguments split out', async () => {
const _testExecOptions = getExecOptions()
let exitCode = 1
let toolpath = ''
if (IS_WINDOWS) {
toolpath = await io.which('cmd', true)
exitCode = await exec.exec(
`"${toolpath}"`,
['/c', 'echo', 'hello'],
_testExecOptions
)
} else {
toolpath = await io.which('ls', true)
exitCode = await exec.exec(
`"${toolpath}"`,
['-l', '-a'],
_testExecOptions
)
}
expect(exitCode).toBe(0)
if (IS_WINDOWS) {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} /c echo hello${os.EOL}`
)
expect(outstream.write).toBeCalledWith(Buffer.from(`hello${os.EOL}`))
} else {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} -l -a${os.EOL}`
)
}
})
it('Runs exec successfully with arguments partially split out', async () => {
const _testExecOptions = getExecOptions()
let exitCode = 1
let toolpath = ''
if (IS_WINDOWS) {
toolpath = await io.which('cmd', true)
exitCode = await exec.exec(
`"${toolpath}" /c`,
['echo', 'hello'],
_testExecOptions
)
} else {
toolpath = await io.which('ls', true)
exitCode = await exec.exec(`"${toolpath}" -l`, ['-a'], _testExecOptions)
}
expect(exitCode).toBe(0)
if (IS_WINDOWS) {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} /c echo hello${os.EOL}`
)
expect(outstream.write).toBeCalledWith(Buffer.from(`hello${os.EOL}`))
} else {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} -l -a${os.EOL}`
)
}
})
it('Runs exec successfully with arguments as part of command line', async () => {
const _testExecOptions = getExecOptions()
let exitCode = 1
let toolpath = ''
if (IS_WINDOWS) {
toolpath = await io.which('cmd', true)
exitCode = await exec.exec(
`"${toolpath}" /c echo hello`,
[],
_testExecOptions
)
} else {
toolpath = await io.which('ls', true)
exitCode = await exec.exec(`"${toolpath}" -l -a`, [], _testExecOptions)
}
expect(exitCode).toBe(0)
if (IS_WINDOWS) {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} /c echo hello${os.EOL}`
)
expect(outstream.write).toBeCalledWith(Buffer.from(`hello${os.EOL}`))
} else {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} -l -a${os.EOL}`
)
}
})
it('Runs exec successfully with command from PATH', async () => {
const execOptions = getExecOptions()
const outStream = new StringStream()
execOptions.outStream = outStream
let output = ''
execOptions.listeners = {
stdout: (data: Buffer) => {
output += data.toString()
}
}
let exitCode = 1
let tool: string
let args: string[]
if (IS_WINDOWS) {
tool = 'cmd'
args = ['/c', 'echo', 'hello']
} else {
tool = 'sh'
args = ['-c', 'echo hello']
}
exitCode = await exec.exec(tool, args, execOptions)
expect(exitCode).toBe(0)
const rootedTool = await io.which(tool, true)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${rootedTool} ${args.join(' ')}`
)
expect(output.trim()).toBe(`hello`)
})
it('Exec fails with error on bad call', async () => {
const _testExecOptions = getExecOptions()
let toolpath = ''
let args: string[] = []
if (IS_WINDOWS) {
toolpath = await io.which('cmd', true)
args = ['/c', 'non-existent']
} else {
toolpath = await io.which('ls', true)
args = ['-l', 'non-existent']
}
let failed = false
await exec.exec(`"${toolpath}"`, args, _testExecOptions).catch(err => {
failed = true
expect(err.message).toContain(
`The process '${toolpath}' failed with exit code `
)
})
expect(failed).toBe(true)
if (IS_WINDOWS) {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} /c non-existent${os.EOL}`
)
} else {
expect(outstream.write).toBeCalledWith(
`[command]${toolpath} -l non-existent${os.EOL}`
)
}
})
it('Succeeds on stderr by default', async () => {
const scriptPath: string = path.join(
__dirname,
'scripts',
'stderroutput.js'
)
const nodePath: string = await io.which('node', true)
const _testExecOptions = getExecOptions()
const exitCode = await exec.exec(
`"${nodePath}"`,
[scriptPath],
_testExecOptions
)
expect(exitCode).toBe(0)
expect(outstream.write).toBeCalledWith(
Buffer.from('this is output to stderr')
)
})
it('Fails on stderr if specified', async () => {
const scriptPath: string = path.join(
__dirname,
'scripts',
'stderroutput.js'
)
const nodePath: string = await io.which('node', true)
const _testExecOptions = getExecOptions()
_testExecOptions.failOnStdErr = true
let failed = false
await exec
.exec(`"${nodePath}"`, [scriptPath], _testExecOptions)
.catch(() => {
failed = true
})
expect(failed).toBe(true)
expect(errstream.write).toBeCalledWith(
Buffer.from('this is output to stderr')
)
})
it('Fails when process fails to launch', async () => {
const nodePath: string = await io.which('node', true)
const _testExecOptions = getExecOptions()
_testExecOptions.cwd = path.join(__dirname, 'nosuchdir')
let failed = false
await exec.exec(`"${nodePath}"`, [], _testExecOptions).catch(() => {
failed = true
})
expect(failed).toBe(true)
})
it('Handles output callbacks', async () => {
const stdErrPath: string = path.join(
__dirname,
'scripts',
'stderroutput.js'
)
const stdOutPath: string = path.join(
__dirname,
'scripts',
'stdoutoutput.js'
)
const nodePath: string = await io.which('node', true)
let stdoutCalled = false
let stderrCalled = false
const _testExecOptions = getExecOptions()
_testExecOptions.listeners = {
stdout: (data: Buffer) => {
expect(data).toEqual(Buffer.from('this is output to stdout'))
stdoutCalled = true
},
stderr: (data: Buffer) => {
expect(data).toEqual(Buffer.from('this is output to stderr'))
stderrCalled = true
}
}
let exitCode = await exec.exec(
`"${nodePath}"`,
[stdOutPath],
_testExecOptions
)
expect(exitCode).toBe(0)
exitCode = await exec.exec(`"${nodePath}"`, [stdErrPath], _testExecOptions)
expect(exitCode).toBe(0)
expect(stdoutCalled).toBeTruthy()
expect(stderrCalled).toBeTruthy()
})
it('Handles stdin shell', async () => {
let command: string
if (IS_WINDOWS) {
command = 'wait-for-input.cmd'
} else {
command = 'wait-for-input.sh'
}
const waitForInput: string = path.join(__dirname, 'scripts', command)
const _testExecOptions = getExecOptions()
_testExecOptions.listeners = {
stdout: (data: Buffer) => {
expect(data).toEqual(Buffer.from(`this is my input${os.EOL}`))
}
}
_testExecOptions.input = Buffer.from('this is my input')
const exitCode = await exec.exec(`"${waitForInput}"`, [], _testExecOptions)
expect(exitCode).toBe(0)
})
it('Handles stdin js', async () => {
const waitForInput: string = path.join(
__dirname,
'scripts',
'wait-for-input.js'
)
const _testExecOptions = getExecOptions()
_testExecOptions.listeners = {
stdout: (data: Buffer) => {
expect(data).toEqual(Buffer.from(`this is my input`))
}
}
_testExecOptions.input = Buffer.from('this is my input')
const nodePath = await io.which('node', true)
const exitCode = await exec.exec(nodePath, [waitForInput], _testExecOptions)
expect(exitCode).toBe(0)
})
it('Handles child process holding streams open', async function() {
const semaphorePath = path.join(
getTestTemp(),
'child-process-semaphore.txt'
)
fs.writeFileSync(semaphorePath, '')
const nodePath = await io.which('node', true)
const scriptPath = path.join(__dirname, 'scripts', 'wait-for-file.js')
const debugList: string[] = []
const _testExecOptions = getExecOptions()
_testExecOptions.delay = 500
_testExecOptions.windowsVerbatimArguments = true
_testExecOptions.listeners = {
debug: (data: string) => {
debugList.push(data)
}
}
let exitCode: number
if (IS_WINDOWS) {
const toolName: string = await io.which('cmd.exe', true)
const args = [
'/D', // Disable execution of AutoRun commands from registry.
'/E:ON', // Enable command extensions. Note, command extensions are enabled by default, unless disabled via registry.
'/V:OFF', // Disable delayed environment expansion. Note, delayed environment expansion is disabled by default, unless enabled via registry.
'/S', // Will cause first and last quote after /C to be stripped.
'/C',
`"start "" /B "${nodePath}" "${scriptPath}" "file=${semaphorePath}""`
]
exitCode = await exec.exec(`"${toolName}"`, args, _testExecOptions)
} else {
const toolName: string = await io.which('bash', true)
const args = ['-c', `node '${scriptPath}' 'file=${semaphorePath}' &`]
exitCode = await exec.exec(`"${toolName}"`, args, _testExecOptions)
}
expect(exitCode).toBe(0)
expect(
debugList.filter(x => x.includes('STDIO streams did not close')).length
).toBe(1)
fs.unlinkSync(semaphorePath)
}, 10000) // this was timing out on some slower hosted macOS runs at default 5s
it('Handles child process holding streams open and non-zero exit code', async function() {
const semaphorePath = path.join(
getTestTemp(),
'child-process-semaphore.txt'
)
fs.writeFileSync(semaphorePath, '')
const nodePath = await io.which('node', true)
const scriptPath = path.join(__dirname, 'scripts', 'wait-for-file.js')
const debugList: string[] = []
const _testExecOptions = getExecOptions()
_testExecOptions.delay = 500
_testExecOptions.windowsVerbatimArguments = true
_testExecOptions.listeners = {
debug: (data: string) => {
debugList.push(data)
}
}
let toolName: string
let args: string[]
if (IS_WINDOWS) {
toolName = await io.which('cmd.exe', true)
args = [
'/D', // Disable execution of AutoRun commands from registry.
'/E:ON', // Enable command extensions. Note, command extensions are enabled by default, unless disabled via registry.
'/V:OFF', // Disable delayed environment expansion. Note, delayed environment expansion is disabled by default, unless enabled via registry.
'/S', // Will cause first and last quote after /C to be stripped.
'/C',
`"start "" /B "${nodePath}" "${scriptPath}" "file=${semaphorePath}"" & exit /b 123`
]
} else {
toolName = await io.which('bash', true)
args = ['-c', `node '${scriptPath}' 'file=${semaphorePath}' & exit 123`]
}
await exec
.exec(`"${toolName}"`, args, _testExecOptions)
.then(() => {
throw new Error('Should not have succeeded')
})
.catch(err => {
expect(
err.message.indexOf('failed with exit code 123')
).toBeGreaterThanOrEqual(0)
})
expect(
debugList.filter(x => x.includes('STDIO streams did not close')).length
).toBe(1)
fs.unlinkSync(semaphorePath)
}, 10000) // this was timing out on some slower hosted macOS runs at default 5s
it('Handles child process holding streams open and stderr', async function() {
const semaphorePath = path.join(
getTestTemp(),
'child-process-semaphore.txt'
)
fs.writeFileSync(semaphorePath, '')
const nodePath = await io.which('node', true)
const scriptPath = path.join(__dirname, 'scripts', 'wait-for-file.js')
const debugList: string[] = []
const _testExecOptions = getExecOptions()
_testExecOptions.delay = 500
_testExecOptions.failOnStdErr = true
_testExecOptions.windowsVerbatimArguments = true
_testExecOptions.listeners = {
debug: (data: string) => {
debugList.push(data)
}
}
let toolName: string
let args: string[]
if (IS_WINDOWS) {
toolName = await io.which('cmd.exe', true)
args = [
'/D', // Disable execution of AutoRun commands from registry.
'/E:ON', // Enable command extensions. Note, command extensions are enabled by default, unless disabled via registry.
'/V:OFF', // Disable delayed environment expansion. Note, delayed environment expansion is disabled by default, unless enabled via registry.
'/S', // Will cause first and last quote after /C to be stripped.
'/C',
`"start "" /B "${nodePath}" "${scriptPath}" "file=${semaphorePath}"" & echo hi 1>&2`
]
} else {
toolName = await io.which('bash', true)
args = [
'-c',
`node '${scriptPath}' 'file=${semaphorePath}' & echo hi 1>&2`
]
}
await exec
.exec(`"${toolName}"`, args, _testExecOptions)
.then(() => {
throw new Error('Should not have succeeded')
})
.catch(err => {
expect(
err.message.indexOf(
'failed because one or more lines were written to the STDERR stream'
)
).toBeGreaterThanOrEqual(0)
})
expect(
debugList.filter(x => x.includes('STDIO streams did not close')).length
).toBe(1)
fs.unlinkSync(semaphorePath)
})
it('Exec roots relative tool path using unrooted options.cwd', async () => {
let exitCode: number
let command: string
if (IS_WINDOWS) {
command = './print-args-cmd' // let ToolRunner resolve the extension
} else {
command = './print-args-sh.sh'
}
const execOptions = getExecOptions()
execOptions.cwd = 'scripts'
const outStream = new StringStream()
execOptions.outStream = outStream
let output = ''
execOptions.listeners = {
stdout: (data: Buffer) => {
output += data.toString()
}
}
const originalCwd = process.cwd()
try {
process.chdir(__dirname)
exitCode = await exec.exec(`${command} hello world`, [], execOptions)
} catch (err) {
process.chdir(originalCwd)
throw err
}
expect(exitCode).toBe(0)
const toolPath = path.resolve(
__dirname,
execOptions.cwd,
`${command}${IS_WINDOWS ? '.cmd' : ''}`
)
if (IS_WINDOWS) {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C "${toolPath} hello world"`
)
} else {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${toolPath} hello world`
)
}
expect(output.trim()).toBe(`args[0]: "hello"${os.EOL}args[1]: "world"`)
})
it('Exec roots throws friendly error when bad cwd is specified', async () => {
const execOptions = getExecOptions()
execOptions.cwd = 'nonexistent/path'
await expect(exec.exec('ls', ['-all'], execOptions)).rejects.toThrowError(
`The cwd: ${execOptions.cwd} does not exist!`
)
})
it('Exec roots does not throw when valid cwd is provided', async () => {
const execOptions = getExecOptions()
execOptions.cwd = './'
await expect(exec.exec('ls', ['-all'], execOptions)).resolves.toBe(0)
})
it('Exec roots relative tool path using rooted options.cwd', async () => {
let command: string
if (IS_WINDOWS) {
command = './print-args-cmd' // let ToolRunner resolve the extension
} else {
command = './print-args-sh.sh'
}
const execOptions = getExecOptions()
execOptions.cwd = path.join(__dirname, 'scripts')
const outStream = new StringStream()
execOptions.outStream = outStream
let output = ''
execOptions.listeners = {
stdout: (data: Buffer) => {
output += data.toString()
}
}
const exitCode = await exec.exec(`${command} hello world`, [], execOptions)
expect(exitCode).toBe(0)
const toolPath = path.resolve(
__dirname,
execOptions.cwd,
`${command}${IS_WINDOWS ? '.cmd' : ''}`
)
if (IS_WINDOWS) {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C "${toolPath} hello world"`
)
} else {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${toolPath} hello world`
)
}
expect(output.trim()).toBe(`args[0]: "hello"${os.EOL}args[1]: "world"`)
})
it('Exec roots relative tool path using process.cwd', async () => {
let exitCode: number
let command: string
if (IS_WINDOWS) {
command = 'scripts/print-args-cmd' // let ToolRunner resolve the extension
} else {
command = 'scripts/print-args-sh.sh'
}
const execOptions = getExecOptions()
const outStream = new StringStream()
execOptions.outStream = outStream
let output = ''
execOptions.listeners = {
stdout: (data: Buffer) => {
output += data.toString()
}
}
const originalCwd = process.cwd()
try {
process.chdir(__dirname)
exitCode = await exec.exec(`${command} hello world`, [], execOptions)
} catch (err) {
process.chdir(originalCwd)
throw err
}
expect(exitCode).toBe(0)
const toolPath = path.resolve(
__dirname,
`${command}${IS_WINDOWS ? '.cmd' : ''}`
)
if (IS_WINDOWS) {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C "${toolPath} hello world"`
)
} else {
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${toolPath} hello world`
)
}
expect(output.trim()).toBe(`args[0]: "hello"${os.EOL}args[1]: "world"`)
})
if (IS_WINDOWS) {
it('Exec roots relative tool path using process.cwd (Windows path separator)', async () => {
let exitCode: number
const command = 'scripts\\print-args-cmd' // let ToolRunner resolve the extension
const execOptions = getExecOptions()
const outStream = new StringStream()
execOptions.outStream = outStream
let output = ''
execOptions.listeners = {
stdout: (data: Buffer) => {
output += data.toString()
}
}
const originalCwd = process.cwd()
try {
process.chdir(__dirname)
exitCode = await exec.exec(`${command} hello world`, [], execOptions)
} catch (err) {
process.chdir(originalCwd)
throw err
}
expect(exitCode).toBe(0)
const toolPath = path.resolve(__dirname, `${command}.cmd`)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C "${toolPath} hello world"`
)
expect(output.trim()).toBe(`args[0]: "hello"${os.EOL}args[1]: "world"`)
})
// Win specific quoting tests
it('execs .exe with verbatim args (Windows)', async () => {
const exePath = process.env.ComSpec
const args: string[] = ['/c', 'echo', 'helloworld', 'hello:"world again"']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
windowsVerbatimArguments: true,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${exePath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]"${exePath}" /c echo helloworld hello:"world again"`
)
expect(output.trim()).toBe('helloworld hello:"world again"')
})
it('execs .exe with arg quoting (Windows)', async () => {
const exePath = process.env.ComSpec
const args: string[] = [
'/c',
'echo',
'helloworld',
'hello world',
'hello:"world again"',
'hello,world'
]
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${exePath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${exePath} /c echo` +
` helloworld` +
` "hello world"` +
` "hello:\\"world again\\""` +
` hello,world`
)
expect(output.trim()).toBe(
'helloworld' +
' "hello world"' +
' "hello:\\"world again\\""' +
' hello,world'
)
})
it('execs .exe with a space and with verbatim args (Windows)', async () => {
// this test validates the quoting that tool runner adds around the tool path
// when using the windowsVerbatimArguments option. otherwise the target process
// interprets the args as starting after the first space in the tool path.
const exePath = compileArgsExe('print args exe with spaces.exe')
const args: string[] = ['myarg1 myarg2']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
windowsVerbatimArguments: true,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${exePath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]"${exePath}" myarg1 myarg2`
)
expect(output.trim()).toBe("args[0]: 'myarg1'\r\nargs[1]: 'myarg2'")
}, 20000) // slower windows runs timeout, so upping timeout to 20s (from default of 5s)
it('execs .cmd with a space and with verbatim args (Windows)', async () => {
// this test validates the quoting that tool runner adds around the script path.
// otherwise cmd.exe will not be able to resolve the path to the script.
const cmdPath = path.join(
__dirname,
'scripts',
'print args cmd with spaces.cmd'
)
const args: string[] = ['arg1 arg2', 'arg3']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
windowsVerbatimArguments: true,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${cmdPath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C ""${cmdPath}" arg1 arg2 arg3"`
)
expect(output.trim()).toBe(
'args[0]: "arg1"\r\nargs[1]: "arg2"\r\nargs[2]: "arg3"'
)
})
it('execs .cmd with a space and with arg with space (Windows)', async () => {
// this test validates the command is wrapped in quotes (i.e. cmd.exe /S /C "<COMMAND>").
// otherwise the leading quote (around the script with space path) would be stripped
// and cmd.exe would not be able to resolve the script path.
const cmdPath = path.join(
__dirname,
'scripts',
'print args cmd with spaces.cmd'
)
const args: string[] = ['my arg 1', 'my arg 2']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${cmdPath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C ""${cmdPath}" "my arg 1" "my arg 2""`
)
expect(output.trim()).toBe(
'args[0]: "<quote>my arg 1<quote>"\r\n' +
'args[1]: "<quote>my arg 2<quote>"'
)
})
it('execs .cmd from path (Windows)', async () => {
// this test validates whether a .cmd is resolved from the PATH when the extension is not specified
const cmd = 'print-args-cmd' // note, not print-args-cmd.cmd
const cmdPath = path.join(__dirname, 'scripts', `${cmd}.cmd`)
const args: string[] = ['my arg 1', 'my arg 2']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const originalPath = process.env['Path']
try {
process.env['Path'] = `${originalPath};${path.dirname(cmdPath)}`
const exitCode = await exec.exec(`${cmd}`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C "${cmdPath} "my arg 1" "my arg 2""`
)
expect(output.trim()).toBe(
'args[0]: "<quote>my arg 1<quote>"\r\n' +
'args[1]: "<quote>my arg 2<quote>"'
)
} catch (err) {
process.env['Path'] = originalPath
throw err
}
})
it('execs .cmd with arg quoting (Windows)', async () => {
// this test validates .cmd quoting rules are applied, not the default libuv rules
const cmdPath = path.join(
__dirname,
'scripts',
'print args cmd with spaces.cmd'
)
const args: string[] = [
'helloworld',
'hello world',
'hello\tworld',
'hello&world',
'hello(world',
'hello)world',
'hello[world',
'hello]world',
'hello{world',
'hello}world',
'hello^world',
'hello=world',
'hello;world',
'hello!world',
"hello'world",
'hello+world',
'hello,world',
'hello`world',
'hello~world',
'hello|world',
'hello<world',
'hello>world',
'hello:"world again"',
'hello world\\'
]
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}
const exitCode = await exec.exec(`"${cmdPath}"`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${process.env.ComSpec} /D /S /C ""${cmdPath}"` +
` helloworld` +
` "hello world"` +
` "hello\tworld"` +
` "hello&world"` +
` "hello(world"` +
` "hello)world"` +
` "hello[world"` +
` "hello]world"` +
` "hello{world"` +
` "hello}world"` +
` "hello^world"` +
` "hello=world"` +
` "hello;world"` +
` "hello!world"` +
` "hello'world"` +
` "hello+world"` +
` "hello,world"` +
` "hello\`world"` +
` "hello~world"` +
` "hello|world"` +
` "hello<world"` +
` "hello>world"` +
` "hello:""world again"""` +
` "hello world\\\\"` +
`"`
)
expect(output.trim()).toBe(
'args[0]: "helloworld"\r\n' +
'args[1]: "<quote>hello world<quote>"\r\n' +
'args[2]: "<quote>hello\tworld<quote>"\r\n' +
'args[3]: "<quote>hello&world<quote>"\r\n' +
'args[4]: "<quote>hello(world<quote>"\r\n' +
'args[5]: "<quote>hello)world<quote>"\r\n' +
'args[6]: "<quote>hello[world<quote>"\r\n' +
'args[7]: "<quote>hello]world<quote>"\r\n' +
'args[8]: "<quote>hello{world<quote>"\r\n' +
'args[9]: "<quote>hello}world<quote>"\r\n' +
'args[10]: "<quote>hello^world<quote>"\r\n' +
'args[11]: "<quote>hello=world<quote>"\r\n' +
'args[12]: "<quote>hello;world<quote>"\r\n' +
'args[13]: "<quote>hello!world<quote>"\r\n' +
'args[14]: "<quote>hello\'world<quote>"\r\n' +
'args[15]: "<quote>hello+world<quote>"\r\n' +
'args[16]: "<quote>hello,world<quote>"\r\n' +
'args[17]: "<quote>hello`world<quote>"\r\n' +
'args[18]: "<quote>hello~world<quote>"\r\n' +
'args[19]: "<quote>hello|world<quote>"\r\n' +
'args[20]: "<quote>hello<world<quote>"\r\n' +
'args[21]: "<quote>hello>world<quote>"\r\n' +
'args[22]: "<quote>hello:<quote><quote>world again<quote><quote><quote>"\r\n' +
'args[23]: "<quote>hello world\\\\<quote>"'
)
})
}
})
function getTestTemp(): string {
return path.join(__dirname, '_temp')
}
function getExecOptions(): im.ExecOptions {
return {
cwd: __dirname,
env: {},
silent: false,
failOnStdErr: false,
ignoreReturnCode: false,
outStream: outstream,
errStream: errstream
}
}
export class StringStream extends stream.Writable {
constructor() {
super()
stream.Writable.call(this)
}
private contents = ''
_write(
data: string | Buffer | Uint8Array,
encoding: string,
next: Function
): void {
this.contents += data
next()
}
getContents(): string {
return this.contents
}
}
// function to compile a .NET program on Windows.
const compileExe = (sourceFileName: string, targetFileName: string): string => {
const directory = path.join(getTestTemp(), sourceFileName)
io.mkdirP(directory)