Fix glob expansion that includes broken symlinks #1567
Conversation
krader1961
force-pushed
the
issue-1240-wildcard-expansion-bad-symlink
branch
from
3ca727a
to
1433fd1
Compare
Glob expansion should use os.Lstat rather than os.Stat so that broken symlinks don't stop glob expansion. It's not the place of glob expansion to decide if a particular path is good. The symlink test cases and logic were borrowed from pkg/mods/path/path_test.go. Fixes elves#1240
krader1961
force-pushed
the
issue-1240-wildcard-expansion-bad-symlink
branch
from
1433fd1
to
c0ab3ca
Compare
| // Creating symlinks requires a special permission on Windows. If | ||
| // the user doesn't have that permission, just skip the whole test. | ||
| t.Skip(err) |
There was a problem hiding this comment.
Skipping the entire test makes sense in the TestPath_Symlink function this is borrowed from, because that entire test is about symlinks. It makes much less sense here, it makes a large part of the globbing code untested on Windows. A better strategy is to just create the symlinks as ordinary files on Windows.
There was a problem hiding this comment.
Good point. I would argue that both sets of tests should fail if unable to create a symlink on Windows. The CI environment should always have that capability enabled. And anyone running these tests on their local system should also have the capability enabled. The question is whether, and how, to test the behavior on Windows when the symlink capability isn't enabled.
| - Glob expansion that includes broken symlinks no longer short-circuits the | ||
| expansion ([#1240](https://b.elv.sh/1240)). |
There was a problem hiding this comment.
This is a fix but it's also a breaking change - symlinks to directories will now be treated as files, not directories. This breaking change is fine for me - among other things it avoids infinite recursions when expanding ** symlinks introduce loops in the FS tree. But it should be documented as such.
There was a problem hiding this comment.
Another good point but the existing behavior is flat out wrong and it's unclear how to document the change in behavior.
Glob expansion should use os.Lstat rather than os.Stat so that broken
symlinks don't stop glob expansion. It's not the place of glob expansion
to decide if a particular path is good.
The symlink test cases and logic were borrowed from
pkg/mods/path/path_test.go.
Fixes #1240