Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bxcodec/faker

Go (Golang) Fake Data Generator for Struct. [Notes]This repository is archived, moved to the new repository https://github.com/go-faker/faker
https://github.com/bxcodec/faker

dummy-data dummy-data-generator fake-data faker generator go golang hactoberfest mock-data struct testing-tools

Last synced: 3 months ago
JSON representation

Go (Golang) Fake Data Generator for Struct. [Notes]This repository is archived, moved to the new repository https://github.com/go-faker/faker

Host: GitHub
URL: https://github.com/bxcodec/faker
Owner: bxcodec
License: mit
Archived: true
Created: 2017-06-22T09:08:40.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-12-08T09:23:48.000Z (about 2 years ago)
Last Synced: 2024-09-21T16:20:19.631Z (3 months ago)
Topics: dummy-data, dummy-data-generator, fake-data, faker, generator, go, golang, hactoberfest, mock-data, struct, testing-tools
Language: Go
Homepage: https://pkg.go.dev/github.com/bxcodec/faker/v4
Size: 342 KB
Stars: 2,085
Watchers: 19
Forks: 148
Open Issues: 25
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-starts - bxcodec/faker - Go (Golang) Fake Data Generator for Struct (Go)

README

        
# Important Notes

This repository has been archived, and **moved to the new repository** here https://github.com/go-faker/faker

Further development and fixing will be happening in the new repository.

---

# Docs

## [faker](#)

Struct Data Fake Generator

Faker will generate you a fake data based on your Struct.

[![Build Status](https://travis-ci.org/bxcodec/faker.svg?branch=master)](https://travis-ci.org/bxcodec/faker)

[![codecov](https://codecov.io/gh/bxcodec/faker/branch/master/graph/badge.svg)](https://codecov.io/gh/bxcodec/faker)

[![Go Report Card](https://goreportcard.com/badge/github.com/bxcodec/faker)](https://goreportcard.com/report/github.com/bxcodec/faker)

[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/bxcodec/faker/blob/master/LICENSE)

[![Go.Dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/bxcodec/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/bxcodec/faker/issues/new).

See documentation in [Go.Dev](https://pkg.go.dev/github.com/bxcodec/faker/v4?tab=doc)

## Getting Started

#### Download

```shell

go get -u github.com/bxcodec/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

---

![Example to use Faker](https://cdn-images-1.medium.com/max/800/1*AkMbxngg7zfvtWiuvFb4Mg.gif)

## 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/bxcodec/faker/blob/9169c33ae9926e5b8f8732909790ee20b10b736a/faker.go#L320) 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.