- Notifications
You must be signed in to change notification settings - Fork261
fix: path traversal prevention auto-failure on windows#1016
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or 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
This is more just for standardization. Ruff also recommends all capital variablenames for Windows even though Windows is case-insensitive.
…use all capital vars
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
Purpose
Rationale
See#1014, and I did have to adjust the testing to accomidate windows for some weird compatibility bugs that caused tests to fail. (1) GitPython under the hood uses
getpass.getuser()which will fail on windows unless theUSERNAMEvariable is set in the environment. (2) The use ofNamedTemporaryFile()for testingnetrcwas not compatible with Windows because it restricts the file to one reader at a time and we were leaving the file open (a second read is allowed on linux). (3) Some expected filepaths were hardcoded strings that represented linux only which were passed throughPath()to auto-convert path separators.Lastly, since the testing on windows takes around 10-15 minutes to complete, it was infeasible to integrate windows testing directly into the matrix testing as part of the PR. Instead, I have it testing the oldest version of python on windows and then matrix testing across all the versions before release. Trying to get the best of both worlds with a little bit of increased rigor.
How did you test?
I ran a bunch of pipelines on the windows platform. Then went through each error of the tests to evaluate why it was failing. Ultimately, I did not add any new tests but I did ensure that all test cases run on both windows and maintained compatibility on linux. This is demonstrated by the pipeline below.
How to Verify
Review the pipeline results below since we test both windows and linux now in the PR pipeline. This can still be replicated if you check out this pr and then run
pytestlocally.