https://github.com/rogozhka/go-generate-mockgen
Small wrapper to simplify gomock generation. Automatically infers interface names and file paths after you place the same (!) go:generate expression for all the occurences. Eliminates the need to manually specify 5 generation parameters. ⌨️ Reduces boilerplate code and minimizes errors. 🎸 Charged for good test coverage :)
https://github.com/rogozhka/go-generate-mockgen
bash-script go-generate gomock unit-testing
Last synced: 3 months ago
JSON representation
Small wrapper to simplify gomock generation. Automatically infers interface names and file paths after you place the same (!) go:generate expression for all the occurences. Eliminates the need to manually specify 5 generation parameters. ⌨️ Reduces boilerplate code and minimizes errors. 🎸 Charged for good test coverage :)
- Host: GitHub
- URL: https://github.com/rogozhka/go-generate-mockgen
- Owner: rogozhka
- License: mit
- Created: 2024-12-14T18:33:41.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-02-12T13:30:15.000Z (4 months ago)
- Last Synced: 2025-02-12T14:47:42.236Z (4 months ago)
- Topics: bash-script, go-generate, gomock, unit-testing
- Language: Go
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**[wrap-mockgen.sh](scripts/wrap-mockgen.sh)** is a helper-script for more convenient use of //go:generate with gomock.
### What is the problem with direct gomock call
For example
```go
//go:generate mockgen -source=my_interface.go -destination=mocks/my_interface_generated.go -mock_names myInterface=MockMyInterface -typed -package=mocks myInterface
type myInterface interface {
Method()
}
```
Imagine for each new interface you have to copy the line and then change 5(!) parameters. It is too easy to make a mistake by pasting something incorrectly.
### Compare with the alternative I suggest
```go
//go:generate wrap-mockgen.sh -line=$GOLINE -source=$GOFILE -package=$GOPACKAGE
type myInterface interface {
Method()
}
```
The same code for all the interfaces.
See the [example](example/) folder for simple and table test cases. Notice the naming and general test layout.
### Installation and usage
#### Local wrap-mockgen.sh (useful with lots of private repo)
1. Place the file [scripts/wrap-mockgen.sh](scripts/wrap-mockgen.sh) in a directory that is included in your $PATH.
2. Set executable permissions ```chmod +x path/to/wrap-mockgen.sh ```
3. Install mockgen if not already installed ```go install go.uber.org/mock/mockgen@latest```
4. Place //go:generate instruction in front of mocked interface, follow the exact format below:
```go
//go:generate wrap-mockgen.sh -line=$GOLINE -source=$GOFILE -package=$GOPACKAGE
type myInterface interface {
Method()
}
```
5. Run ```go generate ./... ``` in project root.
#### Prebuilt Docker image
1. You should have docker installed. Refer to [docs.docker.com/engine/install](https://docs.docker.com/engine/install/)
2. Place //go:generate instruction in front of mocked interface, follow the exact format below:
```go
//go:generate docker run --rm -v ${PWD}:/w rogozhka/go-generate-mockgen -line=$GOLINE -source=$GOFILE -package=$GOPACKAGE
type myInterface interface {
Method()
}
```
3. Run ```go generate ./... ``` in project root.
Happy mocking! :)