Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-faker/faker
Go (Golang) Fake Data Generator for Struct, previously https://github.com/bxcodec/faker
https://github.com/go-faker/faker
fake-data faker golang golang-library testing-library testing-tools
Last synced: about 1 month ago
JSON representation
Go (Golang) Fake Data Generator for Struct, previously https://github.com/bxcodec/faker
- Host: GitHub
- URL: https://github.com/go-faker/faker
- Owner: go-faker
- License: mit
- Created: 2022-06-09T02:50:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T05:17:19.000Z (3 months ago)
- Last Synced: 2024-09-14T17:25:10.328Z (3 months ago)
- Topics: fake-data, faker, golang, golang-library, testing-library, testing-tools
- Language: Go
- Homepage: https://pkg.go.dev/github.com/go-faker/faker/v4
- Size: 181 KB
- Stars: 652
- Watchers: 4
- Forks: 30
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- go-awesome - go-faker/faker - Struct Data Fake Generator (Open source library / Test)
README
# Docs
## [faker](#)
Struct Data Fake Generator
Faker will generate you a fake data based on your Struct.
[](https://github.com/go-faker/faker/actions/workflows/go.yml)
[](https://codecov.io/gh/go-faker/faker)
[](https://goreportcard.com/report/github.com/go-faker/faker/v4)
[](https://github.com/go-faker/faker/blob/master/LICENSE)
[](https://pkg.go.dev/github.com/go-faker/faker/v4?tab=doc)
## Index
- [Support](#support)
- [Getting Started](#getting-started)
- [Example](#example)
- [Limitation](#limitation)
- [Contribution](#contribution)
## Support
You can file an [Issue](https://github.com/go-faker/faker/issues/new).
See documentation in [Go.Dev](https://pkg.go.dev/github.com/go-faker/faker/v4?tab=doc)
## Getting Started
#### Download
```shell
go get -u github.com/go-faker/faker/v4
```
# Example
---
- Using Struct's tag:
- [basic tags: example_with_tags_test.go](/example_with_tags_test.go)
- [length and bounds: example_with_tags_lenbounds_test.go](/example_with_tags_lenbounds_test.go)
- [language: example_with_tags_lang_test.go](/example_with_tags_lang_test.go)
- [unique: example_with_tags_unique_test.go](example_with_tags_unique_test.go)
- [slice length: example_with_tags_slicelength_test.go](example_with_tags_slicelength_test.go)
- Custom Struct's tag (define your own faker data): [example_custom_faker_test.go](/example_custom_faker_test.go)
- Without struct's tag: [example_without_tag_test.go](/example_without_tag_test.go)
- Single Fake Data Function: [example_single_fake_data_test.go](/example_single_fake_data_test.go)
## DEMO
---
## Benchmark
---
Bench To Generate Fake Data
#### Without Tag
```bash
BenchmarkFakerDataNOTTagged-4 500000 3049 ns/op 488 B/op 20 allocs/op
```
#### Using Tag
```bash
BenchmarkFakerDataTagged-4 100000 17470 ns/op 380 B/op 26 allocs/op
```
### MUST KNOW
---
The Struct Field must be PUBLIC.
Support Only For :
- `int`, `int8`, `int16`, `int32` & `int64`
- `[]int`, `[]int8`, `[]int16`, `[]int32` & `[]int64`
- `bool` & `[]bool`
- `string` & `[]string`
- `float32`, `float64`, `[]float32` &`[]float64`
- `time.Time` & `[]time.Time`
- Nested Struct Field
## Limitation
---
Unfortunately this library has some limitation
- It does not support private fields. Make sure your structs fields you intend to generate fake data for are public, it would otherwise trigger a panic. You can however omit fields using a tag skip `faker:"-"` on your private fields.
- It does not support the `interface{}` data type. How could we generate anything without knowing its data type?
- It does not support the `map[interface{}]interface{}`, `map[any_type]interface{}` & `map[interface{}]any_type` data types. Once again, we cannot generate values for an unknown data type.
- Custom types are not fully supported. However some custom types are already supported: we are still investigating how to do this the correct way. For now, if you use `faker`, it's safer not to use any custom types in order to avoid panics.
- Some extra custom types can be supported IF AND ONLY IF extended with [AddProvider()](https://github.com/go-faker/faker/blob/7473ac7d8d0440d24addac302c73e13c08895764/faker.go#L303) please see [example](example_custom_faker_test.go#L46)
- The `oneof` tag currently only supports `string`, the `int` types, and both `float32` & `float64`. Further support is coming soon (i.e. hex numbers, etc). See [example](example_with_tags_test.go#L53) for usage.
## Contribution
---
To contrib to this project, you can open a PR or an issue.