@matheusbsbs / matheus-bagliano / commits / 2b61c8dc88

tests: diagnose unclosed here-doc in chainlint.pl

An unclosed here-doc in a test is a problem, because it silently gobbles up any remaining commands. Since 99a64e4b73c (tests: lint for run-away here-doc, 2017-03-22) we detect this by piggy-backing on the internal chainlint checker in test-lib.sh. However, it would be nice to detect it in chainlint.pl, for a few reasons: - the output from chainlint.pl is much nicer; it can show the exact spot of the error, rather than a vague "somewhere in this test you broke the &&-chain or had a bad here-doc" message. - the implementation in test-lib.sh runs for each test snippet. And since it requires a subshell, the extra cost is small but not zero. If chainlint.pl can reliably find the problem, we can optimize the test-lib.sh code. The chainlint.pl code never intended to find here-doc problems. But since it has to parse them anyway (to avoid reporting problems inside here-docs), most of what we need is already there. We can detect the problem when we fail to find the missing end-tag in swallow_heredocs(). The extra change in scan_heredoc_tag() stores the location of the start of the here-doc, which lets us mark it as the source of the error in the output (see the new tests for examples). [jk: added commit message and tests] Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Eric Sunshine committed Mar 30, 2023 at 15:30 UTC 2b61c8dc8843319d09f1485fbcb3b1dc4aecb36d
5 files changed +34 -3
t/chainlint.pl
+12 -3
@@ -80,7 +80,8 @@ sub scan_heredoc_tag {
80 return "<<$indented" unless $token;
81 my $tag = $token->[0];
82 $tag =~ s/['"\\]//g;
83 - push(@{$self->{heretags}}, $indented ? "\t$tag" : "$tag");
83 + $$token[0] = $indented ? "\t$tag" : "$tag";
84 + push(@{$self->{heretags}}, $token);
85 return "<<$indented$tag";
86 }
87
@@ -169,10 +170,18 @@ sub swallow_heredocs {
170 my $tags = $self->{heretags};
171 while (my $tag = shift @$tags) {
172 my $start = pos($$b);
172 - my $indent = $tag =~ s/^\t// ? '\\s*' : '';
173 - $$b =~ /(?:\G|\n)$indent\Q$tag\E(?:\n|\z)/gc;
173 + my $indent = $$tag[0] =~ s/^\t// ? '\\s*' : '';
174 + $$b =~ /(?:\G|\n)$indent\Q$$tag[0]\E(?:\n|\z)/gc;
175 + if (pos($$b) > $start) {
176 + my $body = substr($$b, $start, pos($$b) - $start);
177 + $self->{lineno} += () = $body =~ /\n/sg;
178 + next;
179 + }
180 + push(@{$self->{parser}->{problems}}, ['UNCLOSED-HEREDOC', $tag]);
181 + $$b =~ /(?:\G|\n).*\z/gc; # consume rest of input
182 my $body = substr($$b, $start, pos($$b) - $start);
183 $self->{lineno} += () = $body =~ /\n/sg;
184 + last;
185 }
186 }
187
t/chainlint/unclosed-here-doc-indent.expect new
+4
@@ -0,0 +1,4 @@
1 +command_which_is_run &&
2 +cat >expect <<-\EOF ?!UNCLOSED-HEREDOC?! &&
3 +we forget to end the here-doc
4 +command_which_is_gobbled
t/chainlint/unclosed-here-doc-indent.test new
+4
@@ -0,0 +1,4 @@
1 +command_which_is_run &&
2 +cat >expect <<-\EOF &&
3 +we forget to end the here-doc
4 +command_which_is_gobbled
t/chainlint/unclosed-here-doc.expect new
+7
@@ -0,0 +1,7 @@
1 +command_which_is_run &&
2 +cat >expect <<\EOF ?!UNCLOSED-HEREDOC?! &&
3 + we try to end the here-doc below,
4 + but the indentation throws us off
5 + since the operator is not "<<-".
6 + EOF
7 +command_which_is_gobbled
t/chainlint/unclosed-here-doc.test new
+7
@@ -0,0 +1,7 @@
1 +command_which_is_run &&
2 +cat >expect <<\EOF &&
3 + we try to end the here-doc below,
4 + but the indentation throws us off
5 + since the operator is not "<<-".
6 + EOF
7 +command_which_is_gobbled