1 #!/usr/bin/env bash
2
3 #### -A function prints functions
4 add () { expr 4 + 4; }
5 div () { expr 6 / 2; }
6 ek () { echo hello; }
7 __ec () { echo hi; }
8 _ab () { expr 10 % 3; }
9 compgen -A function
10 echo --
11 compgen -A function _
12 ## status: 0
13 ## STDOUT:
14 __ec
15 _ab
16 add
17 div
18 ek
19 --
20 __ec
21 _ab
22 ## END
23
24 #### Invalid syntax
25 compgen -A foo
26 echo status=$?
27 ## stdout: status=2
28
29 #### how compgen calls completion functions
30 foo_complete() {
31 # first, cur, prev
32 argv.py argv "$@"
33 argv.py COMP_WORDS "${COMP_WORDS[@]}"
34 argv.py COMP_CWORD "${COMP_CWORD}"
35 argv.py COMP_LINE "${COMP_LINE}"
36 argv.py COMP_POINT "${COMP_POINT}"
37 #return 124
38 COMPREPLY=(one two three)
39 }
40 compgen -F foo_complete foo a b c
41 ## STDOUT:
42 ['argv', 'compgen', 'foo', '']
43 ['COMP_WORDS']
44 ['COMP_CWORD', '-1']
45 ['COMP_LINE', '']
46 ['COMP_POINT', '0']
47 one
48 two
49 three
50 ## END
51
52 #### complete -o -F (git)
53 foo() { echo foo; }
54 wrapper=foo
55 complete -o default -o nospace -F $wrapper git
56 ## status: 0
57
58 #### compopt with invalid syntax
59 compopt -o invalid
60 echo status=$?
61 ## stdout: status=2
62
63 #### compopt fails when not in completion function
64 # NOTE: Have to be executing a completion function
65 compopt -o filenames +o nospace
66 ## status: 1
67
68 #### compgen -f on invalid dir
69 compgen -f /non-existing-dir/
70 ## status: 1
71 ## stdout-json: ""
72
73 #### compgen -f
74 mkdir -p $TMP/compgen
75 touch $TMP/compgen/{one,two,three}
76 cd $TMP/compgen
77 compgen -f | sort
78 echo --
79 compgen -f t | sort
80 ## STDOUT:
81 one
82 three
83 two
84 --
85 three
86 two
87 ## END
88
89 #### compgen -v with local vars
90 v1_global=0
91 f() {
92 local v2_local=0
93 compgen -v v
94 }
95 f
96 ## STDOUT:
97 v1_global
98 v2_local
99 ## END
100
101 #### compgen -v on unknown var
102 compgen -v __nonexistent__
103 ## status: 1
104 ## stdout-json: ""
105
106 #### compgen -v P
107 cd > /dev/null # for some reason in bash, this makes PIPESTATUS appear!
108 compgen -v P | grep -E '^PATH|PWD' | sort
109 ## STDOUT:
110 PATH
111 PWD
112 ## END
113
114 #### compgen with actions: function / variable / file
115 mkdir -p $TMP/compgen2
116 touch $TMP/compgen2/PA_FILE_{1,2}
117 cd $TMP/compgen2 # depends on previous test above!
118 PA_FUNC() { echo P; }
119 Q_FUNC() { echo Q; }
120 compgen -A function -A variable -A file PA
121 ## STDOUT:
122 PA_FUNC
123 PATH
124 PA_FILE_1
125 PA_FILE_2
126 ## END
127
128 #### compgen with actions: alias, setopt
129 alias v_alias='ls'
130 alias v_alias2='ls'
131 alias a1='ls'
132 compgen -A alias -A setopt v
133 ## STDOUT:
134 v_alias
135 v_alias2
136 verbose
137 vi
138 ## END
139
140 #### compgen with actions: shopt
141 compgen -A shopt -P [ -S ] nu
142 ## STDOUT:
143 [nullglob]
144 ## END
145
146 #### compgen with action and suffix: helptopic
147 compgen -A helptopic -S ___ fa
148 ## STDOUT:
149 false___
150 ## END
151
152 #### compgen -A directory
153 # omit portable-files.mk
154 compgen -A directory p
155 ## STDOUT:
156 pgen2
157 pylib
158 ## END
159
160 #### compgen -A file
161 compgen -A file b
162 ## STDOUT:
163 bin
164 benchmarks
165 build
166 ## END
167
168 #### compgen -A user
169 # no assertion because this isn't hermetic
170 compgen -A user
171 ## status: 0
172
173 #### compgen -A command completes external commands
174 # NOTE: this test isn't hermetic
175 compgen -A command xarg
176 echo status=$?
177 ## STDOUT:
178 xargs
179 status=0
180 ## END
181
182 #### compgen -A command completes functions and aliases
183 my_func() { echo ; }
184 my_func2() { echo ; }
185 alias my_alias=foo
186 compgen -A command my_
187 echo status=$?
188 ## STDOUT:
189 my_alias
190 my_func
191 my_func2
192 status=0
193 ## END
194
195 #### compgen -A command completes builtins and keywords
196 compgen -A command eva
197 echo status=$?
198 compgen -A command whil
199 echo status=$?
200 ## STDOUT:
201 eval
202 status=0
203 while
204 status=0
205 ## END
206
207 #### complete with nonexistent function
208 complete -F invalidZZ -D
209 echo status=$?
210 ## stdout: status=2
211 ## BUG bash stdout: status=0
212
213 #### complete with no action
214 complete foo
215 echo status=$?
216 ## stdout: status=2
217 ## BUG bash stdout: status=0
218
219 #### -o filenames and -o nospace have no effect with compgen
220 # they are POSTPROCESSING.
221 compgen -o filenames -o nospace -W 'bin build'
222 ## STDOUT:
223 bin
224 build
225 ## END
226
227 #### -o plusdirs and -o dirnames with compgen
228 compgen -o plusdirs -W 'a b1 b2' b | sort
229 echo ---
230 compgen -o dirnames b | sort
231 ## STDOUT:
232 b1
233 b2
234 benchmarks
235 bin
236 build
237 ---
238 benchmarks
239 bin
240 build
241 ## END
242
243 #### compgen -o default completes files and dirs
244 compgen -o default spec/t
245 ## STDOUT:
246 spec/tilde.test.sh
247 spec/type-compat.test.sh
248 spec/testdata
249 ## END
250
251 #### compgen doesn't respect -X for user-defined functions
252 # WORKAROUND: wrap in bash -i -c because non-interactive bash behaves
253 # differently!
254 $SH -i -c '
255 func() {
256 COMPREPLY=(one two three bin)
257 }
258 compgen -X "@(two|bin)" -F func
259 echo --
260 compgen -X "!@(two|bin)" -F func
261 '
262 ## STDOUT:
263 one
264 three
265 --
266 two
267 bin
268 ## END
269
270 #### compgen -W words -X filter
271 # WORKAROUND: wrap in bash -i -c because non-interactive bash behaves
272 # differently!
273 $SH -i -c 'compgen -X "@(two|bin)" -W "one two three bin"'
274 ## STDOUT:
275 one
276 three
277 ## END
278
279 #### compgen -f -X filter -- $cur
280 cd $TMP
281 touch spam.py spam.sh
282 compgen -f -- sp
283 echo --
284 # WORKAROUND: wrap in bash -i -c because non-interactive bash behaves
285 # differently!
286 $SH -i -c 'compgen -f -X "!*.@(py)" -- sp'
287 ## STDOUT:
288 spam.py
289 spam.sh
290 --
291 spam.py
292 ## END
293
294 #### compgen doesn't need shell quoting
295 # There is an obsolete comment in bash_completion that claims the opposite.
296 cd $TMP
297 touch 'foo bar'
298 touch "foo'bar"
299 compgen -f "foo b"
300 compgen -f "foo'"
301 ## STDOUT:
302 foo bar
303 foo'bar
304 ## END
305
306 #### compgen -W 'one two three'
307 compgen -W 'one two three'
308 echo --
309 compgen -W 'w1 w2 three' -A directory w
310 echo --
311 compgen -A directory -W 'w1 w2 three' w # order doesn't matter
312 ## STDOUT:
313 one
314 two
315 three
316 --
317 web
318 w1
319 w2
320 --
321 web
322 w1
323 w2
324 ## END
325
326 #### compgen -W evaluates code in $()
327 IFS=':%'
328 compgen -W '$(echo "spam:eggs%ham cheese")'
329 ## STDOUT:
330 spam
331 eggs
332 ham cheese
333 ## END
334
335 #### compgen -W uses IFS, and delimiters are escaped with \
336 IFS=':%'
337 compgen -W 'spam:eggs%ham cheese\:colon'
338 ## STDOUT:
339 spam
340 eggs
341 ham cheese:colon
342 ## END
343
344 #### Parse errors for compgen -W and complete -W
345 # bash doesn't detect as many errors because it lacks static parsing.
346 compgen -W '${'
347 echo status=$?
348 complete -W '${' foo
349 echo status=$?
350 ## STDOUT:
351 status=2
352 status=2
353 ## END
354 ## BUG bash STDOUT:
355 status=1
356 status=0
357 ## END
358
359 #### Runtime errors for compgen -W
360 compgen -W 'foo $(( 1 / 0 )) bar'
361 echo status=$?
362 ## STDOUT:
363 status=1
364 ## END
365
366 #### Runtime errors for compgen -F func
367 _foo() {
368 COMPREPLY=( foo bar )
369 COMPREPLY+=( $(( 1 / 0 )) ) # FATAL, but we still have candidates
370 }
371 compgen -F _foo foo
372 echo status=$?
373 ## STDOUT:
374 status=1
375 ## END
376
377 #### compgen -W '' cmd is not a usage error
378 # Bug fix due to '' being falsey in Python
379 compgen -W '' -- foo
380 echo status=$?
381 ## stdout: status=1