dev-doctor: add check for the root directory #16205
Merged
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
twpayne
added
area/misc
glibsm
reviewed
May 18, 2021
| return checkError, fmt.Sprintf("cannot get working directory: %s", err) | ||
| } | ||
|
|
||
| // Search upward through through parent directories to find the .git directory. |
There was a problem hiding this comment.
It's not immediately clear to me why we search upward. Is doctor run from any subdir in cilium rather than root, ro what's the main reason?
There was a problem hiding this comment.
Although running make dev-doctor will run from the root, folks might also run cd tools/dev-doctor && go run ..
glibsm
approved these changes
May 18, 2021
tools/dev-doctor/rootdircheck.go
Outdated
| info, err := os.Stat(path.Join(dir, ".git")) | ||
| switch { | ||
| case err == nil && info.Mode().IsDir(): | ||
| if dir != path.Join(os.Getenv("GOPATH"), "src", "github.com", "cilium", "cilium") { |
There was a problem hiding this comment.
if GOPATH=="" this could succeed even though in reality wouldn't work, right? Perhaps we could check for !!GOPATH first
aditighag
requested changes
May 18, 2021
tools/dev-doctor/rootdircheck.go
Outdated
|
|
||
| // A rootDirCheck checks that Cilium is checked out in | ||
| // ${GOPATH}/src/github.com/cilium/cilium. | ||
| type rootDirCheck struct{} |
There was a problem hiding this comment.
Why don't you extract ${GOPATH}/src/github.com/cilium/cilium to a default variable?
tools/dev-doctor/rootdircheck.go
Outdated
| info, err := os.Stat(path.Join(dir, ".git")) | ||
| switch { | ||
| case err == nil && info.Mode().IsDir(): | ||
| if dir != path.Join(os.Getenv("GOPATH"), "src", "github.com", "cilium", "cilium") { |
There was a problem hiding this comment.
Check above comment at L27. This is can then be os.State(rootDirCheck.path)?
Currently Cilium's build infrastructure assumes that Cilium is checked
out in ${GOPATH}/src/github.com/cilium/cilium, and will fail in
unpredictable ways if it is not.
This PR adds a check to the dev-doctor target to alert developers when
this is the case.
Signed-off-by: Tom Payne <tom@isovalent.com>
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.
Currently Cilium's build infrastructure assumes that Cilium is checked
out in ${GOPATH}/src/github.com/cilium/cilium, and will fail in
unpredictable ways if it is not.
This PR adds a check to the dev-doctor target to alert developers when
this is the case.
Signed-off-by: Tom Payne tom@isovalent.com
Refs #11341