🐛 Fixes issue with Windows, paths can't be escaped #3501

genehynson · 2020-08-18T21:23:23Z

Authored-by: Gene Hynson ghynson@vmware.com

What this PR does / why we need it:

This PR removes the url.EscapedPath() step from Windows local repositories. On Windows 10 versions >= 1803, Windows will no longer decode file paths. This causes a failure when clusterctl tries to read the providers if your Windows username has a space in it (e.g. C:\Users\Gene Hynson\...):

Which issue(s) this PR fixes:

Testing

I'm not exactly sure what's the best way to add automated tests for this change, since it would require setting runtime.GOOS. If anyone has suggestions, I'm all ears!

In terms of manual tests, I tested this on the latest version of Windows and on Mac - it works fine.

k8s-ci-robot · 2020-08-18T21:23:26Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot · 2020-08-18T21:23:30Z

Welcome @genehynson!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2020-08-18T21:23:31Z

Hi @genehynson. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

neolit123 · 2020-08-18T21:55:02Z

cmd/clusterctl/client/repository/repository_local.go

 	if runtime.GOOS == "windows" {
 		path = strings.TrimPrefix(path, "/")
 		path = filepath.FromSlash(path)
+	} else {
+		// Windows 10 update 1803 stops decoding file paths
+		// https://support.microsoft.com/en-us/help/4467268/url-encoded-unc-paths-not-url-decoded-in-windows-10-version-1803-later


ideally, the note about Windows should be in the Windows branch above, indicating that escaping is not required for older versions and not supported in 1803 and later, linking to the page about the UNC change.

the "in case of windows..." note should be moved in the Windows branch as well.

Moved both comments within if block

neolit123 · 2020-08-18T21:57:48Z

cmd/clusterctl/client/repository/repository_local.go

+	} else {
+		// Windows 10 update 1803 stops decoding file paths
+		// https://support.microsoft.com/en-us/help/4467268/url-encoded-unc-paths-not-url-decoded-in-windows-10-version-1803-later
+		path = url.EscapedPath()


there could be a comment here on why the path is escaped for other OSes.

Honestly...we could probably remove url.EscapedPath() altogether. Looking at the blame, it was introduced in this commit for adding Windows support: 737e369

I don't believe escaping file paths is a requirement for other OSes. Thoughts?

it was already present here before that commit:
737e369#diff-88fbf51cc189eba2daf622ffc4a215d0L134

/cc @fabriziopandini
do you recall why EscapedPath() was required when preparing "basepath"?

Ah, yup. Introduced here: b5b9f79#diff-88bc45b90b0324f78a6bea9e5c59aa26R138

TBH I don't recall.
I'm fine in removing it if tests report green signal on both OSes (unfortunately there is no CI signal for windows :-))

Ok, I removed it. Manually tested on Windows and it works.

neolit123

thanks for the PR
/ok-to-test

neolit123 · 2020-08-18T22:02:05Z

given the OS is detected on runtime the IsAbs logic could be extracted to a helper function that accepts the OS as a parameter and this could be unit tested. currently the unit tests don't seem to handle Windows paths.

potentially a separate PR, though.

Authored-by: Gene Hynson <ghynson@vmware.com>

neolit123 · 2020-08-19T17:48:07Z

thanks for the update.
leaving the LGTM to another set of eyes as i have no context on the original idea behind the EscapedPath()

/kind cleanup bug
/approve
/priority important-longterm

k8s-ci-robot · 2020-08-19T17:48:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: neolit123

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~cmd/clusterctl/OWNERS~~ [neolit123]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

vincepri

/lgtm

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 18, 2020

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 18, 2020

k8s-ci-robot requested review from CecileRobertMichon and vincepri August 18, 2020 21:23

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 18, 2020

genehynson changed the title ~~🐛 fixes issue with Windows, paths can't be escaped~~ 🐛 Fixes issue with Windows, paths can't be escaped Aug 18, 2020

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 18, 2020

neolit123 reviewed Aug 18, 2020

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 18, 2020

k8s-ci-robot requested a review from fabriziopandini August 18, 2020 22:07

fixes issue with Windows, paths can't be escaped

ca50ea9

Authored-by: Gene Hynson <ghynson@vmware.com>

genehynson force-pushed the fork/fix-windows-path-encoding branch from a1c2488 to ca50ea9 Compare August 19, 2020 16:29

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2020

vincepri approved these changes Aug 19, 2020

View reviewed changes

k8s-ci-robot assigned vincepri Aug 19, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2020

k8s-ci-robot merged commit 101d2bf into kubernetes-sigs:master Aug 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 Fixes issue with Windows, paths can't be escaped #3501

🐛 Fixes issue with Windows, paths can't be escaped #3501

genehynson commented Aug 18, 2020 •

edited

Loading

k8s-ci-robot commented Aug 18, 2020

k8s-ci-robot commented Aug 18, 2020

k8s-ci-robot commented Aug 18, 2020

neolit123 Aug 18, 2020

genehynson Aug 19, 2020

neolit123 Aug 18, 2020

genehynson Aug 18, 2020

neolit123 Aug 18, 2020

neolit123 Aug 18, 2020 •

edited

Loading

genehynson Aug 18, 2020

fabriziopandini Aug 19, 2020

genehynson Aug 19, 2020

neolit123 left a comment

neolit123 commented Aug 18, 2020 •

edited

Loading

neolit123 commented Aug 19, 2020

k8s-ci-robot commented Aug 19, 2020

vincepri left a comment

🐛 Fixes issue with Windows, paths can't be escaped #3501

🐛 Fixes issue with Windows, paths can't be escaped #3501

Conversation

genehynson commented Aug 18, 2020 • edited Loading

k8s-ci-robot commented Aug 18, 2020

k8s-ci-robot commented Aug 18, 2020

k8s-ci-robot commented Aug 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 Aug 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 left a comment

Choose a reason for hiding this comment

neolit123 commented Aug 18, 2020 • edited Loading

neolit123 commented Aug 19, 2020

k8s-ci-robot commented Aug 19, 2020

vincepri left a comment

Choose a reason for hiding this comment

genehynson commented Aug 18, 2020 •

edited

Loading

neolit123 Aug 18, 2020 •

edited

Loading

neolit123 commented Aug 18, 2020 •

edited

Loading