Skip to content

fix(rsync,ssh,sshfs): do not generate regular files *'\' as dirs #1397

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions completions/ssh
Original file line number Diff line number Diff line change
Expand Up @@ -512,15 +512,15 @@ _comp_xfunc_scp_compgen_remote_files()
# shellcheck disable=SC2090
_files=$(ssh -o 'Batchmode yes' "$_userhost" \
command ls -aF1dL "$_path*" 2>/dev/null |
command sed -e 's/'"$_comp_cmd_scp__path_esc"'/'"$_escape_replacement"'/g' -e '/[^\/]$/d')
command sed -e 's/'"$_comp_cmd_scp__path_esc"'/'"$_escape_replacement"'/g' -e '/[^/]$/d')
else
# escape problematic characters; remove executables, aliases, pipes
# and sockets; add space at end of file names
# shellcheck disable=SC2090
_files=$(ssh -o 'Batchmode yes' "$_userhost" \
command ls -aF1dL "$_path*" 2>/dev/null |
command sed -e 's/'"$_comp_cmd_scp__path_esc"'/'"$_escape_replacement"'/g' -e 's/[*@|=]$//g' \
-e 's/[^\/]$/& /g')
-e 's/[^/]$/& /g')
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried to add a test for this if-branch, but it seems difficult to test it within the current test framework. This branch tries to append a space when it is not a directory, but bash-completion's test framework removes the trailing whitespace when it extracts the generated completions. As a result, we cannot detect whether a suffix space is added by the completion function or not.

fi
_comp_compgen -R split -l -- "$_files"
}
Expand Down Expand Up @@ -550,13 +550,13 @@ _comp_xfunc_scp_compgen_local_files()
_comp_compgen -RU files split -l -- "$(
command ls -aF1dL "${files[@]}" 2>/dev/null |
command sed -e "s/$_comp_cmd_scp__path_esc/\\\\&/g" \
-e '/[^\/]$/d' -e "s/^/${1-}/"
-e '/[^/]$/d' -e "s/^/${1-}/"
)"
else
_comp_compgen -RU files split -l -- "$(
command ls -aF1dL "${files[@]}" 2>/dev/null |
command sed -e "s/$_comp_cmd_scp__path_esc/\\\\&/g" \
-e 's/[*@|=]$//g' -e 's/[^\/]$/& /g' -e "s/^/${1-}/"
-e 's/[*@|=]$//g' -e 's/[^/]$/& /g' -e "s/^/${1-}/"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

A test for the local-path generation without -d has the same issue. We cannot check the trailing space within the current test framework.

)"
fi
}
Expand Down
7 changes: 4 additions & 3 deletions completions/sshfs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ _comp_cmd_sshfs()
_comp_expand || return

if [[ $cur == *:* ]]; then
_comp_compgen -x scp remote_files -d
# unlike scp and rsync, sshfs works with 1 backslash instead of 3
COMPREPLY=("${COMPREPLY[@]//\\\\\\/\\}")
if _comp_compgen -x scp remote_files -d; then
# unlike scp and rsync, sshfs works with 1 backslash instead of 3
COMPREPLY=("${COMPREPLY[@]//\\\\\\/\\}")
fi
return
fi

Expand Down
Empty file.
Empty file.
12 changes: 12 additions & 0 deletions test/t/test_sshfs.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
import pytest

from conftest import assert_bash_exec, assert_complete


@pytest.mark.bashcomp(ignore_env=r"^[+-]_comp_cmd_scp__path_esc=")
class TestSshfs:
@pytest.mark.complete("sshfs ./")
def test_1(self, completion):
assert completion

@pytest.mark.complete("sshfs local_path", cwd="sshfs")
def test_local_path_suffix_1(self, completion):
assert completion == "-dir/"

def test_remote_path_ending_with_backslash(self, bash):
assert_bash_exec(bash, "ssh() { echo 'hypothetical\\'; }")
completion = assert_complete(bash, "sshfs remote_host:hypo")
assert_bash_exec(bash, "unset -f ssh")
assert not completion
Loading