add alternate azure git repo urls to credentials for submodules #372
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
brettfo
commented
Oct 21, 2024
| input.Credentials = append(input.Credentials, model.Credential{ | ||
| "type": "git_source", | ||
| "host": "dev.azure.com", | ||
| "username": "x-access-token", | ||
| "password": "$LOCAL_AZURE_ACCESS_TOKEN", | ||
| }) | ||
| if len(input.Job.CredentialsMetadata) > 0 { | ||
| // Add the metadata since the next section will be skipped. |
There was a problem hiding this comment.
This comment is incorrect; the next section is not skipped and the CredentialsMetadata is correctly updated. The test has been modified to verify this.
brettfo
commented
Oct 21, 2024
| for _, cred := range input.Credentials { | ||
| if cred["type"] != "git_source" && cred["type"] != "nuget_feed" { | ||
| t.Errorf("expected credentials to be either git_source or nuget_feed, got %s", cred["type"]) | ||
| } | ||
| } | ||
|
|
||
| // Validate NuGet feeds |
There was a problem hiding this comment.
This behavior is unchanged, but was not explicitly tested.
brettfo
commented
Oct 21, 2024
| expectedGitCredentials := []string{ | ||
| "dev.azure.com|org|$LOCAL_AZURE_ACCESS_TOKEN", | ||
| "dev.azure.com|x-access-token|$LOCAL_AZURE_ACCESS_TOKEN", | ||
| "org.visualstudio.com|x-access-token|$LOCAL_AZURE_ACCESS_TOKEN", |
There was a problem hiding this comment.
This is the new URL that's added to the credentials.
brettfo
commented
Oct 21, 2024
| actualCredentialsMetadataHosts = append(actualCredentialsMetadataHosts, host) | ||
| } | ||
|
|
||
| expectedGitCredentalsMetadataHosts := []string{ |
There was a problem hiding this comment.
This is what the unnecessary deleted code did, just adding explicit verification here.
JamieMagee
approved these changes
Oct 21, 2024
ByAgenT
approved these changes
Oct 21, 2024
jakecoffman
approved these changes
Oct 22, 2024
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 a job is started with the
azureprovider,git_sourcecredentials are provided for thedev.azure.comdomain and that URL is ultimately used to clone the repo.If a repo has a submodule and specifies the URL with the
dev.azure.comformat, everything is OK because the credentials are properly injected by the proxy, but there is an alternate format that's not handled:org.visualstudio.com/DefaultCollection/project/_git/repoand if a submodule clone is attempted with that URL, it's not detected as being functionally the same as the other URL and a401is returned, possibly making the job fail due to missing sources.This PR adds the alternate
org.visualstudio.comcredentials.A manual test was performed, first with the old behavior ensuring the
401and again with the new behavior ensuring a correct200when cloning the submodule.