Skip to content

fix: SC2086 quote $BEHAT_TAGS in mu-migration/bin/test.sh #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
superdav42 merged 1 commit into from
Mar 25, 2026
Merged

fix: SC2086 quote $BEHAT_TAGS in mu-migration/bin/test.sh #444

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions inc/site-exporter/mu-migration/bin/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
set -ex

# Run the unit tests, if they exist
if [ -f "phpunit.xml" ] || [ -f "phpunit.xml.dist" ]
then
if [ -f "phpunit.xml" ] || [ -f "phpunit.xml.dist" ]; then
phpunit
fi

# Run the functional tests
BEHAT_TAGS=$(php utils/behat-tags.php)

vendor/bin/behat --format progress $BEHAT_TAGS --strict
vendor/bin/behat --format progress "$BEHAT_TAGS" --strict

@coderabbitai coderabbitai Bot Mar 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Quoting breaks behavior when BEHAT_TAGS is empty.

The behat-tags.php script outputs nothing when there are no tags to skip (see lines 72-74: it only echoes when $skip_tags is non-empty). With this change:

  • Before (unquoted): Empty variable disappears → behat --format progress --strict ✓
  • After (quoted): Empty variable becomes "" → behat --format progress "" --strict ✗

Passing an empty string argument to behat will likely cause it to fail or behave unexpectedly. Use parameter expansion to conditionally include the argument only when non-empty:

🐛 Proposed fix using conditional expansion 
-vendor/bin/behat --format progress "$BEHAT_TAGS" --strict
+vendor/bin/behat --format progress ${BEHAT_TAGS:+"$BEHAT_TAGS"} --strict

${BEHAT_TAGS:+"$BEHAT_TAGS"} expands to nothing if the variable is empty/unset, or to the properly quoted value otherwise. This satisfies ShellCheck SC2086 while preserving the original behavior.

Alternatively, if you prefer to keep it unquoted (since the output contains no spaces or glob characters), disable the warning explicitly:

# shellcheck disable=SC2086
vendor/bin/behat --format progress $BEHAT_TAGS --strict
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@inc/site-exporter/mu-migration/bin/test.sh` at line 13, The quoted BEHAT_TAGS
breaks behavior when empty; update the vendor/bin/behat invocation in test.sh to
only pass the tag argument when non-empty by using conditional parameter
expansion for BEHAT_TAGS (e.g., replace the current quoted "$BEHAT_TAGS" with
the ${BEHAT_TAGS:+"$BEHAT_TAGS"} expansion) or explicitly disable ShellCheck
SC2086 if you intentionally want unquoted expansion; ensure the change is
applied where the behat command is invoked so an empty BEHAT_TAGS produces no
extra empty argument.

Loading