kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix: ban grep long flags (#1117)

Browse Source 
Co-authored-by: James Hegedus <jthegedus@hey.com>
This commit is contained in:
Trevor Brown 2021-12-08 21:17:49 -05:00 committed by GitHub
parent 8e6f0cc370
commit 6e4c39c244
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
test/banned_commands.bats
View File

@ -14,22 +14,27 @@ banned_commands=(
# It's best to avoid eval as it makes it easier to accidentally execute
# arbitrary strings
eval
# grep -y does not work on alpine and should be "grep -i" either way
"grep.* -y"
# grep -P is not a valid option in OSX.
"grep.* -P"
# realpath not available by default on OSX.
realpath
# readlink on OSX behaves differently from readlink on other Unix systems
readlink
# sort --sort-version isn't supported everywhere
"sort.*-V"
"sort.*--sort-versions"
# source isn't POSIX compliant. . behaves the same and is POSIX compliant
# Except in fish, where . is deprecated, and will be removed in the future.
source
)
banned_commands_regex=(
# grep -y does not work on alpine and should be "grep -i" either way
"grep.* -y"
# grep -P is not a valid option in OSX.
"grep.* -P"
# Ban grep long commands as they do not work on alpine
"grep[^|]+--\w{2,}"
# sort --sort-version isn't supported everywhere
"sort.*-V"
"sort.*--sort-versions"
)
setup() {
setup_asdf_dir
}
@ -39,12 +44,12 @@ teardown() {
}
@test "banned commands are not found in source code" {
# Assert command is not used in the lib and bin dirs
# or expect an explicit comment at end of line, allowing it.
# Also ignore matches that are contained in comments or a string or
# followed by an underscore (indicating it's a variable and not a
# command).
for cmd in "${banned_commands[@]}"; do
# Assert command is not used in the lib and bin dirs
# or expect an explicit comment at end of line, allowing it.
# Also ignore matches that are contained in comments or a string or
# followed by an underscore (indicating it's a variable and not a
# command).
run bash -c "grep -nHR '$cmd' asdf.* lib bin\
| grep -v '#.*$cmd'\
| grep -v '\".*$cmd.*\"' \
@ -52,7 +57,25 @@ teardown() {
| grep -v '# asdf_allow: $cmd'"
# Only print output if we've found a banned command
if [ "$status" -ne 1 ]; then
#if [ "$status" -ne 1 ]; then
if [ "" != "$output" ]; then
echo "banned command $cmd: $output"
fi
[ "$status" -eq 1 ]
[ "" == "$output" ]
done
for cmd in "${banned_commands_regex[@]}"; do
run bash -c "grep -nHRE '$cmd' asdf.* lib bin\
| grep -v '#.*$cmd'\
| grep -v '\".*$cmd.*\"' \
| grep -v '${cmd}_'\
| grep -v '# asdf_allow: $cmd'"
# Only print output if we've found a banned command
#if [ "$status" -ne 1 ]; then
if [ "" != "$output" ]; then
echo "banned command $cmd: $output"
fi