Add method to GitServer to switch auth on #83
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
hiddeco
reviewed
Feb 11, 2021
Comment on lines
+190
to
+212
| u, err := url.Parse(s.httpServer.URL) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| if s.password != "" { | ||
| u.User = url.UserPassword(s.username, s.password) | ||
| } else if s.username != "" { | ||
| u.User = url.User(s.username) | ||
| } | ||
| return u.String() |
There was a problem hiding this comment.
Doesn't this complicate situations where you want to e.g. mock a GitRepository resource including the Secret required to authenticate, where you do not want to include the credential part of the URL in the mock (as those are defined in the secret)?
If so, maybe it would be wise to add a RepositoryHTTPAddress(repository string) (and maybe also the SSH version) that does not include any credentials for HTTP and only the user for SSH?
There was a problem hiding this comment.
Yeahp, that's the other branch of that decision. Good suggestion -- in fact perhaps I should have HTTPAddressWithCredentials() and adjust my tests to use that.
There was a problem hiding this comment.
Let me rework this a little.
When testing using gittestserver, it's useful to be able to use authentication. This is especially true when testing against libgit2, because it expects to use authentication over SSH, and will balk if it's not requested. This commit adds a method to *GitServer for switching auth on. There's no way to switch auth on for just SSH -- it will also be required for HTTP. For that reason, a username and password are needed. The credentials are included in the URL returned by HTTPAddressWithCredentials(), so anything using that will transparently work whether auth is on or not. If you need to test authentication with HTTP, use `s.HTTPAddress()` and the credentials you handed to `s.Auth()`. Signed-off-by: Michael Bridgen <michael@weave.works>
hiddeco
approved these changes
Feb 11, 2021
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.
When testing using gittestserver, it's useful to be able to use
authentication. This is especially true when testing against libgit2,
because it expects authentication over SSH, and will balk if it's not
requested.
This commit adds a method to *GitServer for switching auth on. There's
no way to switch auth on for just SSH -- it will also be required for
HTTP. For that reason, a username and password are needed.
The credentials are included in the URL returned by HTTPAddressWithCredentials(), so
anything using that will transparently work whether auth is on or
not.
EDIT: we changed our idea of whether credentials should go in the URL returned by HTTPAddress().