(SDK-268) Create directory junctions instead of symlinks on windows #192
Conversation
This file contains 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
|
CLA signed by all contributors. |
|
it looks like the symlink code does error on Windows: this is running this code against a repo with no .fixtures.yml. Maybe that's a 2.1 vs 2.3 distinction, but that won't save us long-term. |
|
Hmm, it doesn't error for me on Ruby 2.3, but I am using Puppet 4.10.1 for testing. Will investigate further (it's an easy enough fix to catch the exception above, but i'm curious why it doesn't get raised on my VM) |
rodjek
added a commit
to rodjek/puppet
that referenced
this pull request
Jun 7, 2017
I was tracking down why CreateSymbolicLinkW was returning non-zero when failing on one test VM and not a different one (puppetlabs/puppetlabs_spec_helper#192). Turns out CreateSymbolicLinkW returns a `BOOLEAN` (1 byte) rather than a `BOOL` (4 bytes), so I was getting random garbage in the upper 3 bytes and therefore a non-zero result.
|
Found the cause and it looks like a valid bug in Puppet, so time well spent. |
rodjek
added a commit
to rodjek/puppet
that referenced
this pull request
Jun 7, 2017
I was tracking down why CreateSymbolicLinkW was returning non-zero when failing on one test VM and not a different one (puppetlabs/puppetlabs_spec_helper#192). Turns out CreateSymbolicLinkW returns a `BOOLEAN` (1 byte) rather than a `BOOL` (4 bytes), so I was getting random garbage in the upper 3 bytes and therefore a non-zero result.
Iristyle
reviewed
Jun 7, 2017
| if is_windows | ||
| fail "Cannot symlink on Windows unless using at least Puppet 3.5" if !puppet_symlink_available | ||
| Puppet::FileSystem::exist?(target) || Puppet::FileSystem::symlink(source, target) | ||
| unless File.symlink(target) |
There was a problem hiding this comment.
Did you mean File.symlink? here?
This may have been fixed in later Ruby versions, but IIRC, symlink support was pretty broken in Ruby on Windows in earlier versions.
Iristyle
pushed a commit
to Iristyle/puppet
that referenced
this pull request
Jun 7, 2017
- CreateSymbolicLinkW was intermittently returning non-zero on different tests hosts, under similar circumstances. Some discussion in: puppetlabs/puppetlabs_spec_helper#192 - The signature for CreateSymbolicLinkW should return a BOOLEAN (BYTE - aka unsigned char) value not a BOOL (4 byte / 32-bit signed int). Based on the presence of random data in the incorrectly sized return value, the code may behave incorrectly. - Fix the problem by sizing the return value correctly
Iristyle
pushed a commit
to Iristyle/puppet
that referenced
this pull request
Jun 7, 2017
- CreateSymbolicLinkW was intermittently returning non-zero on different tests hosts, under similar circumstances. Some discussion in: puppetlabs/puppetlabs_spec_helper#192 Note the original PR was wrong and updated in: puppetlabs/puppetlabs_spec_helper@bb46874 - The signature for CreateSymbolicLinkW should return a BOOLEAN (BYTE - aka unsigned char) value not a BOOL (4 byte / 32-bit signed int). Based on the presence of random data in the incorrectly sized return value, the code may behave incorrectly. - Fix the problem by sizing the return value correctly
eputnam
pushed a commit
to eputnam/puppet
that referenced
this pull request
Jul 12, 2017
- CreateSymbolicLinkW was intermittently returning non-zero on different tests hosts, under similar circumstances. Some discussion in: puppetlabs/puppetlabs_spec_helper#192 Note the original PR was wrong and updated in: puppetlabs/puppetlabs_spec_helper@bb46874 - The signature for CreateSymbolicLinkW should return a BOOLEAN (BYTE - aka unsigned char) value not a BOOL (4 byte / 32-bit signed int). Based on the presence of random data in the incorrectly sized return value, the code may behave incorrectly. - Fix the problem by sizing the return value correctly
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.
Expands on the windows symlink functionality by falling back to using directory junctions if
Puppet::FileSystem.symlinkfails to create the symlink (or isn't available). Unlike symlinks, NTFS junctions don't require administrator access 🎉 and provide identical behaviour for our purposes.As
Puppet::FileSystem.symlinkdoesn't raise an exception when run as non-administrator, we can just check for the existence of the link target after it (File.symlink?conveniently returnstruefor junctions) in order to fall back to using junctions.The win32-dir gem extends
Dirwith acreate_junctionmethod that we try to use first. If that gem isn't available then we fall back to shelling out tomklinkto create the junction.