git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] check-non-portable-shell: support Perl versions older than 5.10

From
Eric Sunshine <sunshine@sunshineco.com>
Date
May 9, 2019, 10:20 UTC
Message-ID
<20190509102037.27044-1-sunshine@sunshineco.com>
In-Reply-To
<CAH8yC8nTyq5Fjc-6fUNn1iwkCO9i1Vrc0vFqxEVg4Eor3h-0Lw@mail.gmail.com>

For thoroughness when checking for one-shot environment variable assignments at shell function call sites, check-non-portable-shell stitches together incomplete lines (those ending with backslash). This allows it to correctly flag such undesirable usage even when the variable assignment and function call are split across lines, for example:

    FOO=bar \
    func
where 'func' is a shell function.
The stitching is accomplished like this:
    while (<>) {
        chomp;
        # stitch together incomplete lines (those ending with "\")
        while (s/\\$//) {
            $_ .= readline;
            chomp;
        }
        # detect unportable/undesirable shell constructs
        ...
    }

Although this implementation is well supported in reasonably modern Perl versions (5.10 and later), it fails in a couple ways with older versions (such as Perl 5.8 shipped with ancient Mac OS 10.5).

In particular, in older Perl versions, 'readline' is not connected to the file handle associated with the "magic" while (<>) {...} construct, so 'readline' throws a "readline() on unopened filehandle" error. Furthermore, $_ assigned by the outer while-loop is read-only, so the attempt to modify it via "$_ .= readline" in the inner while-loop fails with a "Modification of a read-only value" error.

Avoid both problems by collecting the stitched-together line in a variable other than $_ and dropping the inner loop entirely.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 t/check-non-portable-shell.pl | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/t/check-non-portable-shell.pl b/t/check-non-portable-shell.pl
index 166d64d4a2..60e607ba42 100755
--- a/t/check-non-portable-shell.pl
+++ b/t/check-non-portable-shell.pl
@@ -27,14 +27,14 @@ sub err {
 	close $f;
 }
 
+my $line = '';
 while (<>) {
 	chomp;
+	$line .= $_;
 	# stitch together incomplete lines (those ending with "\")
-	while (s/\\$//) {
-		$_ .= readline;
-		chomp;
-	}
+	next if $line =~ s/\\$//;
 
+	local $_ = $line;
 	/\bcp\s+-a/ and err 'cp -a is not portable';
 	/\bsed\s+-[^efn]\s+/ and err 'sed option not portable (use only -n, -e, -f)';
 	/\becho\s+-[neE]/ and err 'echo with option is not portable (use printf)';
@@ -48,6 +48,7 @@ sub err {
 	/\bexport\s+[A-Za-z0-9_]*=/ and err '"export FOO=bar" is not portable (use FOO=bar && export FOO)';
 	/^\s*([A-Z0-9_]+=(\w+|(["']).*?\3)\s+)+(\w+)/ and exists($func{$4}) and
 		err '"FOO=bar shell_func" assignment extends beyond "shell_func"';
+	$line = '';
 	# this resets our $. for each file
 	close ARGV if eof;
 }
-- 
2.21.0.1084.g81c186ecd2
Previous: Eric SunshineNext: Ævar Arnfjörð Bjarmason
Message 6 of 9 in “Git build on antique PowerMac”
  1. Jeffrey WaltonMay 5, 2019
  2. SZEDER GáborMay 5, 2019
  3. Eric SunshineMay 5, 2019
  4. Ævar Arnfjörð BjarmasonMay 8, 2019
  5. Eric SunshineMay 9, 2019
  6. check-non-portable-shell: support Perl versions older than 5.10Eric Sunshine, May 9, 2019
  7. Ævar Arnfjörð BjarmasonMay 9, 2019
  8. Eric SunshineMay 10, 2019
  9. check-non-portable-shell: support Perl versions older than 5.10Eric Sunshine, May 11, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.