Factor out a high-level githubClient interface for all operations. #26
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
Codecov Report
@@ Coverage Diff @@
## master #26 +/- ##
==========================================
- Coverage 54.86% 53.62% -1.25%
==========================================
Files 22 23 +1
Lines 1068 1130 +62
==========================================
+ Hits 586 606 +20
- Misses 447 484 +37
- Partials 35 40 +5
Continue to review full report at Codecov.
|
twelho
approved these changes
Aug 18, 2020
| return nil, err | ||
| } | ||
| keys = append(keys, k) | ||
| keys = append(keys, newDeployKey(c, apiObj)) |
There was a problem hiding this comment.
Add comment for consistency with other similar cases: // apiObj is already validated at ListKeys
| @@ -17,6 +17,8 @@ limitations under the License. | |||
| package github | |||
|
|
|||
| import ( | |||
| "fmt" | |||
|
|
|||
| "github.com/google/go-github/v32/github" | |||
|
|
|||
There was a problem hiding this comment.
Stefan wanted our internal imports to be separate from external, so I'll hold this for now
github/resource_organization.go
Outdated
| // validateOrganizationAPI validates the apiObj received from the server, to make sure that it is | ||
| // valid for our use. | ||
| func validateOrganizationAPI(apiObj *github.Organization) error { | ||
| if apiObj.Login == nil { |
There was a problem hiding this comment.
This could probably use validateAPIObject like validateDeployKeyAPI does, wdyt?
luxas
changed the title
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.
This allows us to
a) see, in a consistent way, how all API operations using
*github.Clientare done, to make sure that- pagination works
- all returned values are validated first
- HTTP errors are handled consistently
b) later, create mock implementations of the
githubClientinterface for unit testing of the clientc) focus on high-level operations in the main clients, not Github API details or pagination/validation/error handling.
cc @twelho @dinosk please review