Skip to content

Commit ace1f99

Browse files
gitstergitster
committed
Merge branch 'es/chain-lint-more'
Improve built-in facility to catch broken &&-chain in the tests. * es/chain-lint-more: chainlint: add test of pathological case which triggered false positive chainlint: recognize multi-line quoted strings more robustly chainlint: let here-doc and multi-line string commence on same line chainlint: recognize multi-line $(...) when command cuddled with "$(" chainlint: match 'quoted' here-doc tags chainlint: match arbitrary here-docs tags rather than hard-coded names
2 parents a15bfa5 + 4f69176 commit ace1f99

19 files changed

+213
-41
lines changed

‎t/chainlint.sed

Lines changed: 61 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,22 @@
6161
# "else", and "fi" in if-then-else likewise must not end with "&&", thus
6262
# receives similar treatment.
6363
#
64+
# Swallowing here-docs with arbitrary tags requires a bit of finesse. When a
65+
# line such as "cat <<EOF >out" is seen, the here-doc tag is moved to the front
66+
# of the line enclosed in angle brackets as a sentinel, giving "<EOF>cat >out".
67+
# As each subsequent line is read, it is appended to the target line and a
68+
# (whitespace-loose) back-reference match /^<(.*)>\n\1$/ is attempted to see if
69+
# the content inside "<...>" matches the entirety of the newly-read line. For
70+
# instance, if the next line read is "some data", when concatenated with the
71+
# target line, it becomes "<EOF>cat >out\nsome data", and a match is attempted
72+
# to see if "EOF" matches "some data". Since it doesn't, the next line is
73+
# attempted. When a line consisting of only "EOF" (and possible whitespace) is
74+
# encountered, it is appended to the target line giving "<EOF>cat >out\nEOF",
75+
# in which case the "EOF" inside "<...>" does match the text following the
76+
# newline, thus the closing here-doc tag has been found. The closing tag line
77+
# and the "<...>" prefix on the target line are then discarded, leaving just
78+
# the target line "cat >out".
79+
#
6480
# To facilitate regression testing (and manual debugging), a ">" annotation is
6581
# applied to the line containing ")" which closes a subshell, ">>" to a line
6682
# closing a nested subshell, and ">>>" to a line closing both at once. This
@@ -78,14 +94,17 @@
7894

7995
# here-doc -- swallow it to avoid false hits within its body (but keep the
8096
# command to which it was attached)
81-
/<<[ ]*[-\\]*EOF[ ]*/ {
82-
s/[ ]*<<[ ]*[-\\]*EOF//
83-
h
97+
/<<[ ]*[-\\']*[A-Za-z0-9_]/ {
98+
s/^\(.*\)<<[ ]*[-\\']*\([A-Za-z0-9_][A-Za-z0-9_]*\)'*/<\2>\1<</
99+
s/[ ]*<<//
84100
:hereslurp
85101
N
86-
s/.*\n//
87-
/^[ ]*EOF[ ]*$/!bhereslurp
88-
x
102+
/^<\([^>]*\)>.*\n[ ]*\1[ ]*$/!{
103+
s/\n.*$//
104+
bhereslurp
105+
}
106+
s/^<[^>]*>//
107+
s/\n.*$//
89108
}
90109

91110
# one-liner "(...) &&"
@@ -132,16 +151,15 @@ s/.*\n//
132151
:slurp
133152
# incomplete line "...\"
134153
/\\$/bincomplete
135-
# multi-line quoted string "...\n..."
136-
/^[^"]*"[^"]*$/bdqstring
137-
# multi-line quoted string '...\n...' (but not contraction in string "it's so")
138-
/^[^']*'[^']*$/{
154+
# multi-line quoted string "...\n..."?
155+
/"/bdqstring
156+
# multi-line quoted string '...\n...'? (but not contraction in string "it's")
157+
/'/{
139158
/"[^'"]*'[^'"]*"/!bsqstring
140159
}
160+
:folded
141161
# here-doc -- swallow it
142-
/<<[ ]*[-\\]*EOF/bheredoc
143-
/<<[ ]*[-\\]*EOT/bheredoc
144-
/<<[ ]*[-\\]*INPUT_END/bheredoc
162+
/<<[ ]*[-\\']*[A-Za-z0-9_]/bheredoc
145163
# comment or empty line -- discard since final non-comment, non-empty line
146164
# before closing ")", "done", "elsif", "else", or "fi" will need to be
147165
# re-visited to drop "suspect" marking since final line of those constructs
@@ -199,7 +217,7 @@ s/.*\n//
199217
# "$(...)" -- command substitution; not closing ")"
200218
/\$([^)][^)]*)[^)]*$/bcheckchain
201219
# multi-line "$(...\n...)" -- command substitution; treat as nested subshell
202-
/\$([ ]*$/bnest
220+
/\$([^)]*$/bnest
203221
# "=(...)" -- Bash array assignment; not closing ")"
204222
/=(/bcheckchain
205223
# closing "...) &&"
@@ -232,42 +250,48 @@ N
232250
s/\\\n//
233251
bslurp
234252

235-
# found multi-line double-quoted string "...\n..." -- slurp until end of string
253+
# check for multi-line double-quoted string "...\n..." -- fold to one line
236254
:dqstring
237-
s/"//g
255+
# remove all quote pairs
256+
s/"\([^"]*\)"/@!\1@!/g
257+
# done if no dangling quote
258+
/"/!bdqdone
259+
# otherwise, slurp next line and try again
238260
N
239261
s/\n//
240-
/"/!bdqstring
241-
bcheckchain
262+
bdqstring
263+
:dqdone
264+
s/@!/"/g
265+
bfolded
242266

243-
# found multi-line single-quoted string '...\n...' -- slurp until end of string
267+
# check for multi-line single-quoted string '...\n...' -- fold to one line
244268
:sqstring
245-
s/'//g
269+
# remove all quote pairs
270+
s/'\([^']*\)'/@!\1@!/g
271+
# done if no dangling quote
272+
/'/!bsqdone
273+
# otherwise, slurp next line and try again
246274
N
247275
s/\n//
248-
/'/!bsqstring
249-
bcheckchain
276+
bsqstring
277+
:sqdone
278+
s/@!/'/g
279+
bfolded
250280

251281
# found here-doc -- swallow it to avoid false hits within its body (but keep
252-
# the command to which it was attached); take care to handle here-docs nested
253-
# within here-docs by only recognizing closing tag matching outer here-doc
254-
# opening tag
282+
# the command to which it was attached)
255283
:heredoc
256-
/EOF/{ s/[ ]*<<[ ]*[-\\]*EOF//; s/^/EOF/; }
257-
/EOT/{ s/[ ]*<<[ ]*[-\\]*EOT//; s/^/EOT/; }
258-
/INPUT_END/{ s/[ ]*<<[ ]*[-\\]*INPUT_END//; s/^/INPUT_END/; }
284+
s/^\(.*\)<<[ ]*[-\\']*\([A-Za-z0-9_][A-Za-z0-9_]*\)'*/<\2>\1<</
285+
s/[ ]*<<//
259286
:hereslurpsub
260287
N
261-
/^EOF.*\n[ ]*EOF[ ]*$/bhereclose
262-
/^EOT.*\n[ ]*EOT[ ]*$/bhereclose
263-
/^INPUT_END.*\n[ ]*INPUT_END[ ]*$/bhereclose
264-
bhereslurpsub
265-
:hereclose
266-
s/^EOF//
267-
s/^EOT//
268-
s/^INPUT_END//
288+
/^<\([^>]*\)>.*\n[ ]*\1[ ]*$/!{
289+
s/\n.*$//
290+
bhereslurpsub
291+
}
292+
s/^<[^>]*>//
269293
s/\n.*$//
270-
bcheckchain
294+
bfolded
271295

272296
# found "case ... in" -- pass through untouched
273297
:case

‎t/chainlint/here-doc-close-subshell.expect

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
(
2+
> cat)

‎t/chainlint/here-doc-close-subshell.test

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(
2+
# LINT: line contains here-doc and closes nested subshell
3+
cat <<-\INPUT)
4+
fizz
5+
INPUT

‎t/chainlint/here-doc-multi-line-command-subst.expect

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(
2+
x=$(bobble &&
3+
?!AMP?!>> wiffle)
4+
echo $x
5+
>)

‎t/chainlint/here-doc-multi-line-command-subst.test

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
(
2+
# LINT: line contains here-doc and opens multi-line $(...)
3+
x=$(bobble <<-\END &&
4+
fossil
5+
vegetable
6+
END
7+
wiffle)
8+
echo $x
9+
)

‎t/chainlint/here-doc-multi-line-string.expect

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
(
2+
?!AMP?! cat && echo "multi-line string"
3+
bap
4+
>)

‎t/chainlint/here-doc-multi-line-string.test

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
(
2+
# LINT: line contains here-doc and opens multi-line string
3+
cat <<-\TXT && echo "multi-line
4+
string"
5+
fizzle
6+
TXT
7+
bap
8+
)

‎t/chainlint/here-doc.expect

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
boodle wobba gorgo snoot wafta snurb &&
22

3+
cat >foo &&
4+
5+
cat >bar &&
6+
37
horticulture

‎t/chainlint/here-doc.test

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ quoth the raven,
77
nevermore...
88
EOF
99

10+
# LINT: swallow here-doc with arbitrary tag
11+
cat <<-Arbitrary_Tag_42 >foo &&
12+
snoz
13+
boz
14+
woz
15+
Arbitrary_Tag_42
16+
17+
# LINT: swallow 'quoted' here-doc
18+
cat <<'FUMP' >bar &&
19+
snoz
20+
boz
21+
woz
22+
FUMP
23+
1024
# LINT: swallow here-doc (EOF is last line of test)
1125
horticulture <<\EOF
1226
gomez

‎t/chainlint/multi-line-nested-command-substitution.expect

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,13 @@
66
>> ) &&
77
echo ok
88
>) |
9-
sort
9+
sort &&
10+
(
11+
bar &&
12+
x=$(echo bar |
13+
cat
14+
>> ) &&
15+
y=$(echo baz |
16+
>> fip) &&
17+
echo fail
18+
>)

0 commit comments

Comments
 (0)