Double quote variables to prevent globbing and word splitting #17235
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
Status: Work in Progress
jwk404
approved these changes
Apr 11, 2025
github-actions
bot
added
Status: Code Review Needed
tonynguien
approved these changes
Apr 16, 2025
This change goes through and quotes variables where appropriate to avoid issues with incorrect splitting. The performance tests ran into an issue with $SUDO_COMMAND splitting incorrectly because it was not quoted. This change fixes that issue and hopefully gets ahead of any other similar problems. Signed-off-by: Aleksandr Liber <[email protected]> Requires-builders: test perf
amotin
reviewed
Apr 24, 2025
| @@ -105,7 +105,7 @@ function do_fio_run_impl | |||
| # the default filesystem (e.g. against a clone). | |||
| # | |||
| export DIRECTORY=$(get_directory) | |||
| log_note "DIRECTORY: " $DIRECTORY | |||
| log_note "DIRECTORY: " "$DIRECTORY" | |||
There was a problem hiding this comment.
I don't think log_note cares about number of arguments, but if we want to wrap the variable into quotes, I don't think we need to close and reopen them before it.
|
|
||
| # Define output file | ||
| typeset logbase="$(get_perf_output_dir)/$(basename \ | ||
| $SUDO_COMMAND)" | ||
| "$SUDO_COMMAND")" |
There was a problem hiding this comment.
It seems you are adding quotes inside quotes. Doesn't it need escaping, or something?
| typeset outfile="$logbase.fio.$suffix" | ||
|
|
||
| # Start the load | ||
| if [[ $NFS -eq 1 ]]; then | ||
| log_must ssh -t $NFS_USER@$NFS_CLIENT " | ||
| log_must ssh -t "$NFS_USER"@"$NFS_CLIENT" " |
There was a problem hiding this comment.
Here and below, do we need to close quotes around @?
| log_must fio --output-format=${PERF_FIO_FORMAT} \ | ||
| --output $outfile $FIO_SCRIPTS/$script | ||
| log_must fio --output-format="${PERF_FIO_FORMAT}" \ | ||
| --output "$outfile" "$FIO_SCRIPTS"/"$script" |
There was a problem hiding this comment.
Here and below, wo we need to close/reopen quotes around /?
| done | ||
| IFS=$oIFS | ||
|
|
||
| typeset idx=0 | ||
| while [[ $idx -lt "${#collect_scripts[@]}" ]]; do | ||
| typeset logbase="$(get_perf_output_dir)/$(basename \ | ||
| $SUDO_COMMAND)" | ||
| "$SUDO_COMMAND")" |
| @@ -354,13 +354,13 @@ function populate_perf_filesystems | |||
|
|
|||
| function get_nfilesystems | |||
| { | |||
| typeset filesystems=( $TESTFS ) | |||
| typeset filesystems=("$TESTFS") | |||
There was a problem hiding this comment.
This seems to be an array initialization. Do we really want to convert empty variable into one element array of empty string?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
It has been quite some time since shellcheck has been run against the performance test library. Recently there was an issue where $SUDO_COMMAND splitting incorrectly causes the result file paths to be generated incorrectly. We want to fix this issue and get ahead of any other potential issues.
Description
This change goes through and quotes variables where appropriate to avoid issues with incorrect splitting.
How Has This Been Tested?
Ran the perf suite to ensure still working as expected
Types of changes
Checklist:
Signed-off-by.