Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GuilhermeCaruso/mooncake
:moon_cake: A simple way to generate mocks for multiple purposes
https://github.com/GuilhermeCaruso/mooncake
Last synced: about 2 months ago
JSON representation
:moon_cake: A simple way to generate mocks for multiple purposes
- Host: GitHub
- URL: https://github.com/GuilhermeCaruso/mooncake
- Owner: GuilhermeCaruso
- License: mit
- Created: 2022-08-18T02:33:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-18T06:44:04.000Z (about 2 years ago)
- Last Synced: 2024-06-21T09:25:01.746Z (3 months ago)
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-go - mooncake - A simple way to generate mocks for multiple purposes. (Testing / Mock)
README
Mooncake
A simple way to generate mocks for multiple purposes
[](https://github.com/avelino/awesome-go)
[](https://goreportcard.com/report/github.com/GuilhermeCaruso/mooncake) [](https://app.travis-ci.com/GuilhermeCaruso/mooncake) [](https://codecov.io/gh/GuilhermeCaruso/mooncake)  [](https://godoc.org/github.com/GuilhermeCaruso/mooncake) [](https://opensource.org/licenses/MIT)
**Table of Contents**
- [What is Mooncake](#what-is-mooncake)
- [Development Status](#development-status)
- [Getting Started](#getting-start)
- [Installation](#installation)
- [Mooncake Configuration File](#mooncake-configuration-file)
- [How to generate](#how-to-generate)
- [How to use](#how-to-use)
- [License](#license)
## What is Mooncake
Mooncake is a simple way to generate mocks for multiple purposes.
It was designed to be uncomplicated and simples, focused on development agility while reducing bureaucracy.
Compatible with different types of interfaces such as:
- Default interfaces
```go
type Simple interface{
MyMethod()
}
```
- Nested interfaces
```go
type Nested interface{
Simple
}
```
- Generic Interfaces
```go
type Generic[T,Z any] interface{
MyCustomMethod(T) (T,Z)
}
```
- Generic Nested Interfaces
```go
type NestGeneric[T,Z any] interface{
Generic[T,Z]
}
```
## Development Status
This project is under development. Therefore, some features may contain minor instabilities, in addition to the possibility of new features being added periodically.
## Getting Start
To start using `mooncake` you need to follow the steps below
### Installation
To add mooncake to your project run:
```
go get github.com/GuilhermeCaruso/mooncake
```
To install the mooncake generator (`moongen`) run:
```sh
go install github.com/GuilhermeCaruso/mooncake/[email protected]
```
### Mooncake Configuration File
Once you have decided to use mooncake in your project you will need to create a configuration file
The file must be in the yaml extension. His name doesn't matter, however we recommend it to be mooncake
- Create `mooncake.yaml` file
Once created the following template must be used
```yaml
mocks:
package: #package
path: #path
files:
- #files
output: #output
prefix: #prefix
```
| Field | Definition | Example |
|-|-|-|
| package | package name of files created | mocks |
| path | path for the interfaces directory | interfaces/ |
| files | list of interface files to be mocked | - |
| output | path to the directory of the generated files| mocks/ |
| prefix | optional value to be added as prefix on generated files | generated |
### How to generate
Once the configuration file is done, to generate the files, run:
```
moongen --file
```
### How to use
After you have generated the mocks, to use the resources you can go like this:
```go
package example
import (
"testing"
"github.com/GuilhermeCaruso/mooncake"
)
func checkValue(t *testing.T, es SimpleInterface, expectedResult string) {
v, err := es.Get()
if v != expectedResult {
t.Errorf("unexpected result. expected=%v got=%v", expectedResult, v)
}
if err != nil {
t.Errorf("unexpected error. expected= got=%v", err.Error())
}
}
func TestWithMock(t *testing.T) {
// Prepare new Mooncake Agent
a := mooncake.NewAgent()
// Start Implementation using created agent
ac := NewMockSimpleInterface(a)
// Define the implementation and responses
ac.Prepare().Get().SetReturn("mocked_value", nil)
checkValue(t, ac, "mocked_value")
}
```
## License
MIT licensed. See the LICENSE file for details.