test-lib: check Bash version for '-x' without using shell arrays
PATCH 1/1 test-lib: check Bash version for '-x' without using shell arrays
One of our test scripts, 't1510-repo-setup.sh' [1], still can't be reliably run with '-x' tracing enabled, unless it's executed with a Bash version supporting BASH_XTRACEFD (since v4.1). We have a lengthy condition to check the version of the shell running the test script, and disable tracing if it's not executed with a suitable Bash version [2].
This condition uses non-portable shell array accesses to easily get Bash's major and minor version number. This didn't seem to be problematic, because the simple commands expanding those array accesses are only executed when the test script is actually run with Bash. When run with Dash, the only shell I have at hand that doesn't support shell arrays, there are no issues, as it apparently skips right over the non-executed simple commands without noticing the non-supported constructs.
Alas, it has been reported that NetBSD's /bin/sh does complain about them:
./test-lib.sh: 327: Syntax error: Bad substitution
where line 327 contains the first ${BASH_VERSINFO[0]} array access.
To my understanding both shells are right and conform to POSIX, because the standard allows both behavior by stating the following under '2.8.1 Consequences of Shell Errors':
"An expansion error is one that occurs when the shell expansions define in wordexp are carried out (for example, "${x!y}", because '!' is not a valid operator); an implementation may treat these as syntax errors if it is able to detect them during tokenization, rather than during expansion."
Avoid this issue with NetBSD's /bin/sh (and potentially with other, less common shells) by using a couple of parameter expansions to extract the major and minor version numbers from $BASH_VERSION.
[1] 5827506928 (t1510-repo-setup: mark as untraceable with '-x',
2018-02-24)
[2] 5fc98e79fc (t: add means to disable '-x' tracing for individual
test scripts, 2018-02-24)---
This will certainly conflict with patches 3 and 6 in my stress testing patch series at
https://public-inbox.org/git/[email protected]/T/#u
t/test-lib.sh | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
t/test-lib.sh +6 -3
@@ -324,9 +324,12 @@ do # isn't executed with a suitable Bash version. if test -z "$test_untraceable" || { test -n "$BASH_VERSION" && { - test ${BASH_VERSINFO[0]} -gt 4 || { - test ${BASH_VERSINFO[0]} -eq 4 && - test ${BASH_VERSINFO[1]} -ge 1 + bash_major=${BASH_VERSION%%.*} + bash_minor=${BASH_VERSION#*.} + bash_minor=${bash_minor%%.*} + test $bash_major -gt 4 || { + test $bash_major -eq 4 && + test $bash_minor -ge 1 } } }
Signature · 1 line
2.20.1.151.gec613c4b75
Am 02.01.19 um 00:19 schrieb SZEDER Gábor:
Quoted 18 lines
Alas, it has been reported that NetBSD's
/bin/shdoes complain about them:./test-lib.sh: 327: Syntax error: Bad substitution
where line 327 contains the first ${BASH_VERSINFO[0]} array access.
t/test-lib.sh +0
-2@@ -324,9 +324,12 @@ do # isn't executed with a suitable Bash version. if test -z "$test_untraceable" || { test -n "$BASH_VERSION" && { - test ${BASH_VERSINFO[0]} -gt 4 || { - test ${BASH_VERSINFO[0]} -eq 4 &&
t/test-lib.sh do · line 335
Quoted 10 lines
t/test-lib.sh +6
-1- test ${BASH_VERSINFO[1]} -ge 1 + bash_major=${BASH_VERSION%%.*} + bash_minor=${BASH_VERSION#*.} + bash_minor=${bash_minor%%.*} + test $bash_major -gt 4 || { + test $bash_major -eq 4 && + test $bash_minor -ge 1 } } }
Would it perhaps be simpler to just hide the syntax behind eval? Like
if test -z "$test_untraceable" || {
test -n "$BASH_VERSION" && eval '
test ${BASH_VERSINFO[0]} -gt 4 || {
test ${BASH_VERSINFO[0]} -eq 4 &&
test ${BASH_VERSINFO[1]} -ge 1
}'
-- Hannes
Quoted 9 lines · Johannes Sixt
Would it perhaps be simpler to just hide the syntax behind eval? Like
(quoted diff) +0
-0if test -z "$test_untraceable" || { test -n "$BASH_VERSION" && eval 'test ${BASH_VERSINFO[0]} -gt 4 || { test ${BASH_VERSINFO[0]} -eq 4 && test ${BASH_VERSINFO[1]} -ge 1 }'
It indeed is somewhat easier to see that your version does exactly the same as the original than the posted patch, but the pattern substitutions are not all that bad, either.
PATCH v2 1/1 test-lib: check Bash version for '-x' without using shell arrays
One of our test scripts, 't1510-repo-setup.sh' [1], still can't be reliably run with '-x' tracing enabled, unless it's executed with a Bash version supporting BASH_XTRACEFD (since v4.1). We have a lengthy condition to check the version of the shell running the test script, and disable tracing if it's not executed with a suitable Bash version [2].
This condition uses non-portable shell array accesses to easily get Bash's major and minor version number. This didn't seem to be problematic, because the simple commands expanding those array accesses are only executed when the test script is actually run with Bash. When run with Dash, the only shell I have at hand that doesn't support shell arrays, there are no issues, as it apparently skips right over the non-executed simple commands without noticing the non-supported constructs.
Alas, it has been reported that NetBSD's /bin/sh does complain about them:
./test-lib.sh: 327: Syntax error: Bad substitution
where line 327 contains the first ${BASH_VERSINFO[0]} array access.
To my understanding both shells are right and conform to POSIX, because the standard allows both behaviors by stating the following under '2.8.1 Consequences of Shell Errors' [3]:
"An expansion error is one that occurs when the shell expansions define in wordexp are carried out (for example, "${x!y}", because '!' is not a valid operator); an implementation may treat these as syntax errors if it is able to detect them during tokenization, rather than during expansion."
Avoid this issue with NetBSD's /bin/sh (and potentially with other, less common shells) by hiding the shell array syntax behind 'eval' that is only executed with Bash.
[1] 5827506928 (t1510-repo-setup: mark as untraceable with '-x',
2018-02-24)
[2] 5fc98e79fc (t: add means to disable '-x' tracing for individual
test scripts, 2018-02-24)[3] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_08_01
---
Changes since v1:
- Hide the shell array syntax behind 'eval'. (I'm fine with both versions, take your pick.)
- Corrected typo in commit message that Eric pointed out.
- Added a link to the relevant section in POSIX.
t/test-lib.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
t/test-lib.sh +2 -2
@@ -323,12 +323,12 @@ do # this test is marked as such, and ignore '-x' if it # isn't executed with a suitable Bash version. if test -z "$test_untraceable" || { - test -n "$BASH_VERSION" && { + test -n "$BASH_VERSION" && eval ' test ${BASH_VERSINFO[0]} -gt 4 || { test ${BASH_VERSINFO[0]} -eq 4 && test ${BASH_VERSINFO[1]} -ge 1 } - } + ' } then trace=t
Signature · 1 line
2.20.1.151.gec613c4b75
Quoted 46 lines · SZEDER Gábor
One of our test scripts, '
t1510-repo-setup.sh' [1], still can't be reliably run with '-x' tracing enabled, unless it's executed with a Bash version supportingBASH_XTRACEFD(since v4.1). We have a lengthy condition to check the version of the shell running the test script, and disable tracing if it's not executed with a suitable Bash version [2].This condition uses non-portable shell array accesses to easily get Bash's major and minor version number. This didn't seem to be problematic, because the simple commands expanding those array accesses are only executed when the test script is actually run with Bash. When run with Dash, the only shell I have at hand that doesn't support shell arrays, there are no issues, as it apparently skips right over the non-executed simple commands without noticing the non-supported constructs.
Alas, it has been reported that NetBSD's
/bin/shdoes complain about them:./test-lib.sh: 327: Syntax error: Bad substitution
where line 327 contains the first ${BASH_VERSINFO[0]} array access.
To my understanding both shells are right and conform to POSIX, because the standard allows both behaviors by stating the following under '2.8.1 Consequences of Shell Errors' [3]:
"An expansion error is one that occurs when the shell expansions define in wordexp are carried out (for example, "${x!y}", because '!' is not a valid operator); an implementation may treat these as syntax errors if it is able to detect them during tokenization, rather than during expansion."
Avoid this issue with NetBSD's
/bin/sh(and potentially with other, less common shells) by hiding the shell array syntax behind 'eval' that is only executed with Bash.[1] 5827506928 (t1510-repo-setup: mark as untraceable with '-x',
2018-02-24) [2] 5fc98e79fc (t: add means to disable '-x' tracing for individual test scripts, 2018-02-24)[3] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_08_01
Reported-by Max Kirillov <[email protected]>Helped-by Johannes Sixt <[email protected]>Signed-off-by SZEDER Gábor <[email protected]>
Quoted 8 lines
---
Changes since v1:
- Hide the shell array syntax behind 'eval'. (I'm fine with both versions, take your pick.)
- Corrected typo in commit message that Eric pointed out.
- Added a link to the relevant section in POSIX.
Let's treat this as an independent and more urgent fix-up. I think it is sufficient to apply it to 2.20.x track, even though we could go back to 2.17.x and above.
And then let's tentatively kick the "stress test" series out of 'pu', and have that series rebuilt on top of 'master' and this patch.
Thanks.
Quoted 23 lines
t/test-lib.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)t/test-lib.sh +2
-2@@ -323,12 +323,12 @@ do # this test is marked as such, and ignore '-x' if it # isn't executed with a suitable Bash version. if test -z "$test_untraceable" || { - test -n "$BASH_VERSION" && { + test -n "$BASH_VERSION" && eval ' test ${BASH_VERSINFO[0]} -gt 4 || { test ${BASH_VERSINFO[0]} -eq 4 && test ${BASH_VERSINFO[1]} -ge 1 } - } + ' } then trace=t
Quoted 7 lines · Junio C Hamano
Let's treat this as an independent and more urgent fix-up. I think it is sufficient to apply it to 2.20.x track, even though we could go back to 2.17.x and above.
And then let's tentatively kick the "stress test" series out of 'pu', and have that series rebuilt on top of 'master' and this patch.
I rebased my '--stress' patch series on top of 'sg/test-bash-version-fix', and the result is the same as what's at the tip of 'sg/stress-test' at 1d1416a34b.
Quoted 5 lines · SZEDER Gábor
Quoted 4 lines · Junio C Hamano
Let's treat this as an independent and more urgent fix-up. I think it is sufficient to apply it to 2.20.x track, even though we could go back to 2.17.x and above.
Quoted 7 lines
Quoted 3 lines
And then let's tentatively kick the "stress test" series out of 'pu', and have that series rebuilt on top of 'master' and this patch.
I rebased my '--stress' patch series on top of 'sg/test-bash-version-fix', and the result is the same as what's at the tip of 'sg/stress-test' at
1d1416a34b.
Yeah, sorry for not reporting what I did after pushing the integration result out. I ended up rebasing the stress series on top of the updated fix with eval myself.
Thanks.
Quoted 11 lines · Junio C Hamano
Quoted 9 lines · SZEDER Gábor
Quoted 7 lines · Junio C Hamano
Let's treat this as an independent and more urgent fix-up. I think it is sufficient to apply it to 2.20.x track, even though we could go back to 2.17.x and above.
And then let's tentatively kick the "stress test" series out of 'pu', and have that series rebuilt on top of 'master' and this patch.
Quoted 7 lines
Quoted 3 lines
I rebased my '--stress' patch series on top of 'sg/test-bash-version-fix', and the result is the same as what's at the tip of 'sg/stress-test' at
1d1416a34b.Yeah, sorry for not reporting what I did after pushing the integration result out. I ended up rebasing the stress series on top of the updated fix with eval myself.
No problem, it still saved me from writing a cover letter :)
Note that I didn't actually test either of these patches on NetBSD, though both "Should Work". Carlo sent a Tested-by for v1; I hope he'll be able to get around and test v2 as well.
v2 works fine, as expected
Carlo
Quoted 1 line · Carlo Arenas
v2 works fine, as expected
Thanks.
Quoted 30 lines · Johannes Sixt
Quoted 11 lines
t/test-lib.sh +0
-2@@ -324,9 +324,12 @@ do # isn't executed with a suitable Bash version. if test -z "$test_untraceable" || { test -n "$BASH_VERSION" && { - test ${BASH_VERSINFO[0]} -gt 4 || { - test ${BASH_VERSINFO[0]} -eq 4 &&t/test-lib.sh do · line 335
Quoted 10 lines
t/test-lib.sh +6
-1- test ${BASH_VERSINFO[1]} -ge 1 + bash_major=${BASH_VERSION%%.*} + bash_minor=${BASH_VERSION#*.} + bash_minor=${bash_minor%%.*} + test $bash_major -gt 4 || { + test $bash_major -eq 4 && + test $bash_minor -ge 1 } } }Would it perhaps be simpler to just hide the syntax behind eval? Like
(quoted diff) +0
-0if test -z "$test_untraceable" || { test -n "$BASH_VERSION" && eval 'test ${BASH_VERSINFO[0]} -gt 4 || { test ${BASH_VERSINFO[0]} -eq 4 && test ${BASH_VERSINFO[1]} -ge 1 }
Quoted 1 line
'
That was my first thought, too. :)
The parsing here is simple enough that I'd be fine either with the original patch, or an eval-based version (and otherwise, the goal and description seem quite good to me).
-Peff
Quoted 3 lines · SZEDER Gábor
[...]
To my understanding both shells are right and conform to POSIX, because the standard allows both behavior by stating the following
s/behavior/behaviors/
Quoted 4 lines
under '2.8.1 Consequences of Shell Errors':
Reported-by Max Kirillov <[email protected]>Signed-off-by SZEDER Gábor <[email protected]>
Carlo Arenas
Tested-byQuoted 6 lines · SZEDER Gábor
To my understanding both shells are right and conform to POSIX, because the standard allows both behavior by stating the following under '2.8.1 Consequences of Shell Errors':
"An expansion error is one that occurs when the shell expansions define in wordexp are carried out (for example, "${x!y}", because
That "define" above always stops my (non-native) English parser for a moment or two... shouldn't it be s/define/defined/ ?
It's not a copy-paste error, POSIX does indeed write "define" there, see:
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_08_01
(First paragraph below the table and the Notes.)
Quoted 4 lines
'!' is not a valid operator); an implementation may treat these as syntax errors if it is able to detect them during tokenization, rather than during expansion."