mirror of
https://github.com/fleetdm/fleet
synced 2026-05-03 21:38:24 +00:00
eeb9931f40
#15560 Probably best to review commit by commit. First commit adds the mockimpl files, second commit amends README.md and third commit fixes golangci-lint issues. - [X] Manual QA for all new/changed functionality Tested by adding a dummy method to service.go and running `make generate-mock`. --------- Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
66 lines
1.6 KiB
Markdown
66 lines
1.6 KiB
Markdown
# mockimpl
|
|
|
|
> The contents of this directory were copied (on December 2023) from https://github.com/fleetdm/mockimpl which was forked from https://github.com/groob/mockimpl.
|
|
|
|
`mockimpl` generates mock method stubs for implementing an interface.
|
|
mockimpl is based on [impl](https://github.com/josharian/impl)
|
|
|
|
|
|
```bash
|
|
go get -u github.com/groob/mockimpl
|
|
```
|
|
|
|
Sample usage:
|
|
|
|
```bash
|
|
$ impl 'f *File' io.ReadWriteCloser
|
|
// Automatically generated by mockimpl. DO NOT EDIT!
|
|
|
|
package mock
|
|
|
|
import "io"
|
|
|
|
var _ io.ReadWriteCloser = (*File)(nil)
|
|
|
|
type ReadFunc func(p []byte) (n int, err error)
|
|
|
|
type WriteFunc func(p []byte) (n int, err error)
|
|
|
|
type CloseFunc func() error
|
|
|
|
type File struct {
|
|
ReadFunc ReadFunc
|
|
ReadFuncInvoked bool
|
|
|
|
WriteFunc WriteFunc
|
|
WriteFuncInvoked bool
|
|
|
|
CloseFunc CloseFunc
|
|
CloseFuncInvoked bool
|
|
}
|
|
|
|
func (f *File) Read(p []byte) (n int, err error) {
|
|
f.ReadFuncInvoked = true
|
|
return f.ReadFunc(p)
|
|
}
|
|
|
|
func (f *File) Write(p []byte) (n int, err error) {
|
|
f.WriteFuncInvoked = true
|
|
return f.WriteFunc(p)
|
|
}
|
|
|
|
func (f *File) Close() error {
|
|
f.CloseFuncInvoked = true
|
|
return f.CloseFunc()
|
|
}
|
|
|
|
# You can also provide a full name by specifying the package path.
|
|
# This helps in cases where the interface can't be guessed
|
|
# just from the package name and interface name.
|
|
$ impl 's *Source' golang.org/x/oauth2.TokenSource
|
|
func (s *Source) Token() (*oauth2.Token, error) {
|
|
panic("not implemented")
|
|
}
|
|
```
|
|
|
|
You can use `impl` from Vim with [vim-go-impl](https://github.com/rhysd/vim-go-impl)
|