diff options
| author | Paul Buetow <paul@buetow.org> | 2026-06-17 21:00:43 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-06-17 21:00:43 +0300 |
| commit | 5ebee8ef2a54b8578daf47b17fa82fc85b2cd1cd (patch) | |
| tree | 90ae7da157de5936b8753f88da80ffa1ac5527fc /tests | |
| parent | 50d951ab3bb28861b34bc190911dd76bfb93e71c (diff) | |
an0 reject scalar SYNC_DESTINATIONS instead of word-splitting it
A scalar SYNC_DESTINATIONS containing spaces was word-split by the shared
resolve_config_array helper, breaking a single destination into multiple
broken arguments passed to rsync.
A list of rsync destinations is inherently a list, and array syntax is the
only spelling that preserves embedded spaces. resolve_sync_destinations now
detects a scalar declaration via declare -p and fails with a clear
config_error telling the user to use array syntax. The array path is
unchanged, and resolve_config_array's scalar word-splitting is left intact
for TAR_OPTS (where turning "-c -v" into separate options is desired).
Adds focused tests proving the scalar case errors without invoking rsync and
the array case preserves a space-containing destination as one argument.
Updates src/shuriken.default.conf and README.md to document the requirement.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'tests')
| -rwxr-xr-x | tests/cli.sh | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/tests/cli.sh b/tests/cli.sh index a16cbea..a28c1f1 100755 --- a/tests/cli.sh +++ b/tests/cli.sh @@ -5494,6 +5494,84 @@ test_sync_rejects_missing_dist() { test::teardown } +test_sync_rejects_scalar_destinations() { + # Regression for an0: a scalar SYNC_DESTINATIONS with spaces used to be + # word-split into multiple broken rsync destinations. We now reject scalar + # declarations outright so the only spelling is an array, where embedded + # spaces are preserved naturally. + local config_file + local dist_dir + local fake_bin + local output + local rsync_log + + test::setup + fake_bin="$TEST_TMPDIR/bin" + config_file="$TEST_TMPDIR/shuriken.conf" + dist_dir="$TEST_TMPDIR/dist" + rsync_log="$TEST_TMPDIR/rsync.log" + + test::install_rsync_spy "$fake_bin" + mkdir -p "$dist_dir" + printf 'generated\n' > "$dist_dir/index.html" + { + printf 'DIST_DIR=%q\n' "$dist_dir" + printf 'SYNC_DESTINATIONS=%q\n' '/path/with spaces/' + } > "$config_file" + + output=$( + cd "$TEST_TMPDIR" + PATH="$fake_bin:$PATH" TEST_RSYNC_LOG="$rsync_log" \ + test::capture_failure_output "$TEST_SHURIKEN" --sync + ) + + test::assert_contains \ + 'ERROR: SYNC_DESTINATIONS must be an array' \ + "$output" + # rsync must never run: the scalar was rejected, not word-split. + test::assert_path_absent "$rsync_log" + test::teardown +} + +test_sync_array_destination_preserves_spaces() { + # A single array destination containing spaces must reach rsync intact as + # one argument, proving the array path is unaffected by the an0 fix. + local config_file + local dist_dir + local fake_bin + local rsync_log + local rsync_output + + test::setup + fake_bin="$TEST_TMPDIR/bin" + config_file="$TEST_TMPDIR/shuriken.conf" + dist_dir="$TEST_TMPDIR/dist" + rsync_log="$TEST_TMPDIR/rsync.log" + + test::install_rsync_spy "$fake_bin" + mkdir -p "$dist_dir" + printf 'generated\n' > "$dist_dir/index.html" + { + printf 'DIST_DIR=%q\n' "$dist_dir" + printf 'SYNC_DESTINATIONS=(%q)\n' '/path/with spaces/' + } > "$config_file" + + ( + cd "$TEST_TMPDIR" + PATH="$fake_bin:$PATH" TEST_RSYNC_LOG="$rsync_log" \ + "$TEST_SHURIKEN" --sync + ) + + rsync_output=$(<"$rsync_log") + # argc=4 (-av, --delete, source, single destination): the destination is + # NOT split into two arguments despite the embedded space. + # The rsync spy logs each argument with %q quoting, so a single argument + # with a space appears as one escaped arg3 (not two split args). + test::assert_contains 'argc=4' "$rsync_output" + test::assert_contains 'arg3=/path/with\ spaces/' "$rsync_output" + test::teardown +} + test_positional_commands_fail_without_deprecation() { local output local old_command @@ -6125,6 +6203,12 @@ main() { '--sync rejects missing dist' \ test_sync_rejects_missing_dist test::run_case \ + '--sync rejects scalar destinations' \ + test_sync_rejects_scalar_destinations + test::run_case \ + '--sync array destination preserves spaces' \ + test_sync_array_destination_preserves_spaces + test::run_case \ 'positional commands fail without deprecation output' \ test_positional_commands_fail_without_deprecation test::run_case \ |
