Updated error message when hit "not found error" in gitprovider #1048
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
…nction between not finding a key, not having permissions or the repository doesn't exist.
…ror when creating deploy key
josecordaz
requested review from
luizbafilho,
jpellizzari and
jrryjcksn
and removed request for
jpellizzari
jpellizzari
approved these changes
Nov 9, 2021
| @@ -137,6 +137,13 @@ var _ = Describe("Org Provider", func() { | |||
| Expect(err.Error()).Should(ContainSubstring("error uploading deploy key")) | |||
| }) | |||
|
|
|||
| It("return error when it fails to upload a deploy key", func() { | |||
luizbafilho
suggested changes
Nov 10, 2021
| @@ -89,7 +91,11 @@ func deployKeyExists(ctx context.Context, repo gitprovider.UserRepository) (bool | |||
| func uploadDeployKey(ctx context.Context, repo gitprovider.UserRepository, deployKeyInfo gitprovider.DeployKeyInfo) error { | |||
| _, err := repo.DeployKeys().Create(ctx, deployKeyInfo) | |||
| if err != nil { | |||
| return fmt.Errorf("error uploading deploy key %s", err) | |||
| if errors.Is(err, gitprovider.ErrNotFound) { | |||
There was a problem hiding this comment.
in general in Go we should use else clauses unless strictly necessary, which is not the case here since we call return in the if, so a suggestion would be changing to:
if errors.Is(err, gitprovider.ErrNotFound) {
return RepositoryNoPermissionsOrDoesNotExistError
}
return fmt.Errorf("error uploading deploy key %s", err)
pkg/gitproviders/provider.go
Outdated
| @@ -25,6 +25,8 @@ const ( | |||
| defaultTimeout = time.Second * 30 | |||
| ) | |||
|
|
|||
| var RepositoryNoPermissionsOrDoesNotExistError = errors.New("no permissions to access this repository or repository doesn't exists") | |||
There was a problem hiding this comment.
major: errors are prefixed with the Err like in gitprovider.ErrNotFound and the error types are suffixed with the Error
luizbafilho
approved these changes
Nov 10, 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.
Closes: #1001
What changed?
Updated error message.
From:
To:
Why?
There was confusion when distinguishing between if there were not enough permissions and if the repository does not exist.
How did you test it?
Added unit tests
Release notes
Documentation Changes