-
Notifications
You must be signed in to change notification settings - Fork 5.1k
test: Fix TestMiniPath unit test on windows #21739
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
base: master
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: bobsira The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @bobsira. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the 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-sigs/prow repository. |
|
Can one of the admins verify this patch? |
| if filepath.Base(minikubeHomeEnv) == ".minikube" { | ||
| return minikubeHomeEnv | ||
| // Normalize to platform-specific separators for consistency on Windows. | ||
| return filepath.Clean(filepath.FromSlash(minikubeHomeEnv)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is value from the MINIKUBE_HOME environment variable. Why do we need to fix value set by the user? they should set the right value, and it the path is invalid the minikube command should fail.
If the issue comes from a test using wrong path, we should fix the test, not the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We’re not correcting a bad user value; we’re standardizing a valid path so it has one canonical string form. Windows accepts forward slashes, but raw string comparisons (tests, map keys, logs) treat “C:/Users/Alice/.minikube” and “C:\Users\Alice.minikube” as different. Without normalization this causes flaky tests, cache/key mismatches, and forces every caller to remember to clean paths. Centralizing normalization in MiniPath() creates a consistent invariant (clean, native separators, no trailing slash), reduces maintenance, and doesn’t hide truly invalid paths (bad paths still fail later). So the change solves a real cross‑platform consistency problem, not just a test artifact.
| // Normalize to platform-specific separators for consistency on Windows. | ||
| return filepath.Clean(filepath.FromSlash(minikubeHomeEnv)) | ||
| } | ||
| return filepath.Join(minikubeHomeEnv, ".minikube") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However if we need to fix the value for the user, why we don't need to fix it in this case?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point—the most consistent approach is to canonicalize the final result unconditionally, not just one branch. The branch-specific change was a minimal surgical patch targeting the exact failing scenario (raw env already points at .minikube). A cleaner follow-up is:
func MiniPath() string {
minikubeHomeEnv := os.Getenv(MinikubeHome)
var p string
switch {
case minikubeHomeEnv == "":
p = filepath.Join(homedir.HomeDir(), ".minikube")
case filepath.Base(minikubeHomeEnv) == ".minikube":
p = minikubeHomeEnv
default:
p = filepath.Join(minikubeHomeEnv, ".minikube")
}
return filepath.Clean(filepath.FromSlash(p))
}
Looking at TestMiniPath it fails on Windows because users often set MINIKUBE_HOME with forward slashes (e.g. C:/Users/Alice/.minikube), and the current implementation of MiniPath() returned that raw value unchanged when it already ended in .minikube, while other branches build the path using filepath.Join, which on Windows emits backslashes; the filesystem accepts both, but our test performs a strict string equality, so the expected path (backslashes) and actual path (forward slashes) diverge despite referring to the same directory. By normalizing the chosen path with filepath.Clean(filepath.FromSlash(...)), we enforce one canonical, native-separator, no-trailing-slash representation, eliminating flaky equality failures, preventing subtle cache/map key mismatches, and centralizing path cleanup so every caller gets a consistent result without masking truly invalid paths (bad values still fail later during actual file operations). |
No description provided.