OILS / spec / ysh-proc.test.sh View on Github | oilshell.org

457 lines, 249 significant
1## oils_failures_allowed: 0
2
3#### Open proc (any number of args)
4shopt --set parse_proc
5
6proc f {
7 var x = 42
8 return $x
9}
10# this gets called with 3 args then?
11f a b c
12echo status=$?
13## STDOUT:
14status=42
15## END
16
17#### Closed proc with no args, passed too many
18shopt --set parse_proc
19
20proc f() {
21 return 42
22}
23f
24echo status=$?
25
26f a b # status 2
27
28## status: 3
29## STDOUT:
30status=42
31## END
32
33#### Open proc has ARGV
34shopt -s ysh:all
35proc foo {
36 echo ARGV @ARGV
37 # do we care about this? I think we want to syntactically remove it from YSH
38 # but it can still be used for legacy
39 echo dollar-at "$@"
40}
41builtin set -- a b c
42foo x y z
43## STDOUT:
44ARGV x y z
45dollar-at a b c
46## END
47
48#### Closed proc has empty "$@" or ARGV
49shopt -s ysh:all
50
51proc foo(d, e, f) {
52 write params $d $e $f
53 argv.py dollar-at "$@"
54 argv.py ARGV @ARGV
55}
56builtin set -- a b c
57foo x y z
58## STDOUT:
59params
60x
61y
62z
63['dollar-at', 'a', 'b', 'c']
64['ARGV']
65## END
66
67#### Proc with default args
68shopt --set parse_proc
69
70proc f(x='foo') {
71 echo x=$x
72}
73f
74## STDOUT:
75x=foo
76## END
77
78#### Proc with word params
79shopt --set parse_proc
80
81# doesn't require ysh:all
82proc f(x, y, z) {
83 echo $x $y $z
84 var ret = 42
85 return $ret
86}
87# this gets called with 3 args then?
88f a b c
89echo status=$?
90## STDOUT:
91a b c
92status=42
93## END
94
95#### Proc with ... "rest" word params
96
97# TODO: opts goes with this
98# var opt = grep_opts.parse(ARGV)
99#
100# func(**opt) # Assumes keyword args match?
101# parse :grep_opts :opt @ARGV
102
103shopt -s ysh:all
104
105proc f(...names) {
106 write names: @names
107}
108# this gets called with 3 args then?
109f a b c
110echo status=$?
111## STDOUT:
112names:
113a
114b
115c
116status=0
117## END
118
119#### word rest params 2
120shopt --set ysh:all
121
122proc f(first, ...rest) { # @ means "the rest of the arguments"
123 write --sep ' ' -- $first
124 write --sep ' ' -- @rest # @ means "splice this array"
125}
126f a b c
127## STDOUT:
128a
129b c
130## END
131
132#### proc with typed args
133shopt --set ysh:upgrade
134
135# TODO: duplicate param names aren't allowed
136proc p (a; mylist, mydict; opt Int = 42) {
137 pp line (a)
138 pp line (mylist)
139 pp line (mydict)
140 #pp line (opt)
141}
142
143p WORD ([1,2,3], {name: 'bob'})
144
145echo ---
146
147p x (:| a b |, {bob: 42}, a = 5)
148
149## STDOUT:
150(Str) "WORD"
151(List) [1,2,3]
152(Dict) {"name":"bob"}
153---
154(Str) "x"
155(List) ["a","b"]
156(Dict) {"bob":42}
157## END
158
159#### Proc name-with-hyphen
160shopt --set parse_proc parse_at
161
162proc name-with-hyphen {
163 echo @ARGV
164}
165name-with-hyphen x y z
166## STDOUT:
167x y z
168## END
169
170#### Proc with block arg
171shopt --set ysh:upgrade
172
173# TODO: Test more of this
174proc f(x, y ; ; ; block) {
175 echo f word $x $y
176
177 if (block) {
178 eval (block)
179 }
180}
181f a b { echo FFF }
182
183# With varargs and block
184shopt --set parse_proc
185
186proc g(x, y, ...rest ; ; ; block) {
187 echo g word $x $y
188 echo g rest @rest
189
190 if (block) {
191 eval (block)
192 }
193}
194g a b c d {
195 echo GGG
196}
197
198## STDOUT:
199f word a b
200FFF
201g word a b
202g rest c d
203GGG
204## END
205
206#### proc returning wrong type
207shopt --set parse_proc
208
209# this should print an error message
210proc f {
211 var a = %(one two)
212 return $a
213}
214f
215## status: 3
216## STDOUT:
217## END
218
219#### proc returning invalid string
220shopt --set parse_proc
221
222# this should print an error message
223proc f {
224 var s = 'not an integer status'
225 return $s
226}
227f
228## status: 1
229## STDOUT:
230## END
231
232#### 'return' doesn't accept expressions
233proc p {
234 return 1 + 2
235}
236p
237## status: 2
238## STDOUT:
239## END
240
241#### procs are in same namespace as shell functions
242shopt --set parse_proc
243
244myfunc() {
245 echo hi
246}
247
248proc myproc {
249 echo hi
250}
251
252declare -F
253
254# this doesn't really test that anymore...
255exit 1 # force a failure
256
257## STDOUT:
258declare -f myfunc
259declare -f myproc
260## END
261
262
263#### Nested proc is disallowed at parse time
264shopt --set parse_proc
265
266# NOTE: we can disallow this in Oil statically ...
267proc f {
268 proc g {
269 echo 'G'
270 }
271 g
272}
273f
274g
275## status: 2
276## stdout-json: ""
277
278#### Procs defined inside compound statements (with redefine_proc)
279
280shopt --set ysh:upgrade
281shopt --set redefine_proc_func
282
283for x in 1 2 {
284 proc p {
285 echo 'loop'
286 }
287}
288p
289
290{
291 proc p {
292 echo 'brace'
293 }
294}
295p
296
297## STDOUT:
298loop
299brace
300## END
301
302#### Block can be passed literally, or as expression in third arg group
303shopt --set ysh:upgrade
304
305proc p ( ; ; ; block) {
306 eval (block)
307}
308
309p { echo literal }
310
311var block = ^(echo expression)
312p (; ; block)
313
314## STDOUT:
315literal
316expression
317## END
318
319#### Pass through all 4 kinds of args
320
321shopt --set ysh:upgrade
322
323proc p2 (...words; ...typed; ...named; block) {
324 pp line (words)
325 pp line (typed)
326 pp line (named)
327 #pp line (block)
328 # To avoid <Block 0x??> - could change pp line
329 echo $[type(block)]
330}
331
332proc p1 (...words; ...typed; ...named; block) {
333 p2 @words (...typed; ...named; block)
334}
335
336p2 a b ('c', 'd', n=99) {
337 echo literal
338}
339echo
340
341# Same thing
342var block = ^(echo expression)
343
344# Note: you need the second explicit ;
345
346p2 a b ('c', 'd'; n=99; block)
347echo
348
349# what happens when you do this?
350p2 a b ('c', 'd'; n=99; block) {
351 echo duplicate
352}
353
354## status: 1
355## STDOUT:
356(List) ["a","b"]
357(List) ["c","d"]
358(Dict) {"n":99}
359Block
360
361(List) ["a","b"]
362(List) ["c","d"]
363(Dict) {"n":99}
364Command
365
366## END
367
368#### Global and local ARGV, like "$@"
369shopt -s parse_at
370argv.py "$@"
371argv.py @ARGV
372#argv.py "${ARGV[@]}" # not useful, but it works!
373
374set -- 'a b' c
375argv.py "$@"
376argv.py @ARGV # separate from the argv stack
377
378f() {
379 argv.py "$@"
380 argv.py @ARGV # separate from the argv stack
381}
382f 1 '2 3'
383## STDOUT:
384[]
385[]
386['a b', 'c']
387[]
388['1', '2 3']
389[]
390## END
391
392
393#### Mutating global ARGV
394
395$SH -c '
396shopt -s ysh:upgrade
397
398argv.py global @ARGV
399
400# should not be ignored
401call ARGV->append("GG")
402
403argv.py global @ARGV
404'
405## STDOUT:
406['global']
407['global', 'GG']
408## END
409
410#### Mutating local ARGV
411
412$SH -c '
413shopt -s ysh:upgrade
414
415argv.py global @ARGV
416
417proc p {
418 argv.py @ARGV
419 call ARGV->append("LL")
420 argv.py @ARGV
421}
422
423p local @ARGV
424
425argv.py global @ARGV
426
427' dummy0 'a b' c
428
429## STDOUT:
430['global', 'a b', 'c']
431['local', 'a b', 'c']
432['local', 'a b', 'c', 'LL']
433['global', 'a b', 'c']
434## END
435
436
437#### typed proc allows all kinds of args
438shopt -s ysh:upgrade
439
440typed proc p (w; t; n; block) {
441 pp line (w)
442 pp line (t)
443 pp line (n)
444 echo $[type(block)]
445}
446
447p word (42, n=99) {
448 echo block
449}
450
451
452## STDOUT:
453(Str) "word"
454(Int) 42
455(Int) 99
456Block
457## END