Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/connormckelvey/go-github-mockable
Mockable, interface-based wrapper for the github.com/google/go-github *Client
https://github.com/connormckelvey/go-github-mockable
github go-github golang gomock mocking
Last synced: about 20 hours ago
JSON representation
Mockable, interface-based wrapper for the github.com/google/go-github *Client
- Host: GitHub
- URL: https://github.com/connormckelvey/go-github-mockable
- Owner: connormckelvey
- License: mit
- Created: 2022-11-13T20:29:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-15T22:23:05.000Z (about 2 years ago)
- Last Synced: 2024-10-12T16:40:50.673Z (about 1 month ago)
- Topics: github, go-github, golang, gomock, mocking
- Language: Go
- Homepage:
- Size: 193 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Github Mockable
[](https://pkg.go.dev/github.com/connormckelvey/go-github-mockable) [](https://goreportcard.com/report/github.com/connormckelvey/go-github-mockable)
Go Github Mockable provides an interface-based wrapper for the [Go Github](https://github.com/google/go-github) client, making it possible to generate mocks (also included) for the client using [GoMock](https://github.com/golang/mock).
## Installation
```bash
$ go get github.com/connormckelvey/go-github-mockable
```
## Features
### [ClientAPI interface type](https://pkg.go.dev/github.com/connormckelvey/go-github-mockable#ClientAPI)
Interface type to be used in place of `*github.Client`. Allows dependency injection of a mocked `ClientAPI`.
For example
```go
type MyService struct {
github *github.Client
}
func NewMyService(client *github.Client) *Service {
return &MyService{
github: client,
}
}
//becomes:
type MyService struct {
github gogithubmockable.ClientAPI
}
func NewMyService(client gogithubmockable.ClientAPI) *Service {
return &MyService{
github: client,
}
}
```
### [ClientAPI implementation](https://pkg.go.dev/github.com/connormckelvey/go-github-mockable#Client)
`gogithubmockable.Client` provides a default implementation of `gogithubmockable.ClientAPI` by dispatching calls to a provided `*github.Client`
For example:
```go
func main() {
gh := github.NewClient(nil)
client := gogithubmockable.NewClient(gh)
service := NewMyService(client)
...
}
func TestMyService(t *testing.T) {
ctrl := gomock.NewController(t)
mockClient := mocks.NewMockClientAPI(ctrl)
service := NewMYService(mockClient)
}
```
### [Services Getter Methods](https://pkg.go.dev/github.com/connormckelvey/go-github-mockable#Client.Actions)
The `ClientAPI` interface include getter methods for every service normally available on the `*github.Client` struct. The return types for the getter methods are themselves interfaces allowing services to be independently mocked.
For example
```go
func (s *MyService) Foo() {
repo, _, err := s.github.Repositories.Get(context.Background(), "owner", "repo")
...
}
// becomes
func (s *MyService) Foo() {
repo, _, err := s.github.Repositories().Get(context.Background(), "owner", "repo")
...
}
```
### [Service interfaces](https://pkg.go.dev/github.com/connormckelvey/go-github-mockable#ActionsService)
The service getter methods included on the `ClientAPI` interface return interface types defined with all public methods included on the original concrete service types.
## Usage
```go
package main
import (
"github.com/google/go-github/v48/github"
"github.com/connormckelvey/go-github-mockable"
)
func main() {
gh := github.NewClient(nil)
client := gogithubmockable.NewClient(gh)
// Instead of client.Repositories, use client.Repositories()
c.Repositories().Get(context.TODO(), "owner", "repo")
...
}
```
### Mocking
```go
func TestMockClientAPI(t *testing.T) {
ctrl := gomock.NewController(t)
owner := "connormckelvey"
repo := "go-github-mockable"
expected := fmt.Sprintf("%s/%s", owner, repo)
rm := mocks.NewMockRepositoriesService(ctrl)
rm.EXPECT().Get(gomock.Any(), gomock.Eq(owner), gomock.Eq(repo)).Return(
&github.Repository{
FullName: &expected,
},
&github.Response{},
nil,
)
cm := mocks.NewMockClientAPI(ctrl)
cm.EXPECT().Repositories().Return(rm)
service := NewMyService(cm)
fullName, err := service.FullName()
require.NoError(t, err)
assert.Equal(t, expected, fullName)
}
```