Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/serpro69/kotlin-faker

Port of a popular ruby faker gem written in kotlin. Generate realistically looking fake data such as names, addresses, banking details, and many more, that can be used for testing and data anonymization purposes.
https://github.com/serpro69/kotlin-faker

android android-development android-testing anonymisation anonymization anonymizer data faker faker-gem faker-generator faker-library faker-libs java jvm kotlin kotlin-faker kotlin-library test-automation testing testing-tools

Last synced: about 20 hours ago
JSON representation

Host: GitHub
URL: https://github.com/serpro69/kotlin-faker
Owner: serpro69
License: mit
Created: 2019-03-11T09:41:12.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-11-17T14:23:24.000Z (about 1 month ago)
Last Synced: 2024-12-13T22:03:26.233Z (8 days ago)
Topics: android, android-development, android-testing, anonymisation, anonymization, anonymizer, data, faker, faker-gem, faker-generator, faker-library, faker-libs, java, jvm, kotlin, kotlin-faker, kotlin-library, test-automation, testing, testing-tools
Language: Kotlin
Homepage: https://serpro69.github.io/kotlin-faker/
Size: 36.8 MB
Stars: 474
Watchers: 4
Forks: 45
Open Issues: 22
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- Contributing: CONTRIBUTING.adoc
- Funding: .github/FUNDING.yml
- License: LICENSE.adoc

Awesome Lists containing this project

fucking-awesome-readme - serpro69/kotlin-faker - Project logo. Badges. Concise description and clear getting-started instructions with a link to the full documentation website. Test, build and contributing guidelines. Licence info. (Examples)
awesome-list - serpro69/kotlin-faker - Port of a popular ruby faker gem written in kotlin. Generate realistically looking fake data such as names, addresses, banking details, and many more, that can be used for testing and data anonymization purposes. (Kotlin)
awesome-readme - serpro69/kotlin-faker - Project logo. Badges. Concise description and clear getting-started instructions with a link to the full documentation website. Test, build and contributing guidelines. Licence info. (Examples)

README

        [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)

> [!IMPORTANT]

> **Are you considering supporting the project by donating to me? Please DO NOT!!!**

>

> **Please visit the above banner link and make a small donation to help the people in Ukraine. A small donation goes a long way.** 💙💛

  

> **Generate realistically-looking fake data for Kotlin, Android, Java and JVM**  

> Use kotlin-faker during development and testing to ensure your application data looks as if it was real, just like this *really* fake logo, but not quite so.

>

> 

>

> *Kotlin-faker is a kotlin port of a popular [ruby faker](https://github.com/stympy/faker) gem.*

[![Build Status](https://img.shields.io/github/actions/workflow/status/serpro69/kotlin-faker/build.yml?branch=master&logo=github&style=for-the-badge)](https://github.com/serpro69/kotlin-faker/actions/workflows/build.yml)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.serpro69/kotlin-faker?style=for-the-badge)](https://search.maven.org/artifact/io.github.serpro69/kotlin-faker)

[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.serpro69/kotlin-faker?label=snapshot-version&server=https%3A%2F%2Foss.sonatype.org&style=for-the-badge&color=yellow)](#downloading)

[![Issues](https://img.shields.io/github/issues/serpro69/kotlin-faker.svg?logo=GitHub&style=for-the-badge&color=lightblue)](https://github.com/serpro69/kotlin-faker/issues)

![GitHub Top Lang](https://img.shields.io/github/languages/top/serpro69/kotlin-faker.svg?logo=Kotlin&logoColor=white&color=A97BFF&style=for-the-badge)

[![Awesome Kotlin](https://img.shields.io/badge/awesome-kotlin-orange?logo=Awesome-Lists&style=for-the-badge)](https://kotlin.link/resources?q=kotlin-faker)

[![Licence](https://img.shields.io/github/license/serpro69/kotlin-faker.svg?style=for-the-badge)](LICENSE.adoc)

## ToC

- [ToC](#toc)

- [About](#about)

- [Prerequisites](#prerequisites)

- [Installation](#installation)

  - [Install with Gradle](#install-with-gradle)

  - [Install with Maven](#install-with-maven)

  - [BOM](#bom)

  - [Additional Fakers](#additional-fakers)

  - [Third-Party Extensions](#third-party-extensions)

- [Usage](#usage)

  - [Generating data](#generating-data)

- [CLI](#cli)

- [Test](#test)

- [Build and Deploy](#build-and-deploy)

  - [Bumping versions](#bumping-versions)

    - [Pre-releases](#pre-releases)

    - [Releases](#releases)

    - [Make targets](#make-targets)

- [Contributing](#contributing)

- [Thanks](#thanks)

- [License](#license)

## About

**kotlin-faker: the ultimate fake data generation library for development and testing**

Kotlin-faker is a comprehensive data-generation library for the JVM. It is most suitable for development, testing, and data anonymization purposes, and can be used with Kotlin, Java, Android, Scala, and other JVM-based projects. Kotlin-faker provides realistic-looking, fake data generation capabilities in various domains like *names* 📇, *addresses* 🏡, *internet* 🌐, *banking* 💸, *books* 📖, *games* 🎮, and [many more](https://serpro69.github.io/kotlin-faker/wiki/data-providers/).

In fact, kotlin-faker is so good at generating fake data, it almost fooled us into thinking it was real! 😱 From names that sound like they belong to secret agents 🕴️, to addresses where superheroes 🦸 might live.

---

⚠️  P.S. *All names, addresses, bank accounts, and other data generated by this library - even those based on real strings - are entirely fictional.* 🦹 *All produced data is fake and generated... poorly* 💩 *The data is completely made up, but the problems that it tries to solve are real* 👽 *We take no responsibility for any existential crises caused by the eerily convincing fake data. Use with caution!* ⚠️

## Prerequisites

- Faker libraries depend on java 8 and kotlin 1.9.x for runtime

- Building faker from source requires 3 jdk distributions: jdk 8 (temurin is recommended, but any vendor should work), jdk 11 (for [`docs`](docs) module) and jdk 17 (graalvm-ce distribution, for [`cli-bot`](cli-bot) module). See [CONTRIBUTING](CONTRIBUTING.adoc) for more details.

## Installation

Latest releases are always available on maven central.

### Install with Gradle

```groovy

dependencies {

    implementation 'io.github.serpro69:kotlin-faker:$version'

}

```  

### Install with Maven

```xml

    

        io.github.serpro69

        kotlin-faker

        ${version}

    

```  

***Snapshots are also available using the following repository: `https://oss.sonatype.org/content/repositories/snapshots/`***

**With gradle**

```groovy

repositories {

    maven {

        url = 'https://oss.sonatype.org/content/repositories/snapshots/'

    }

}

```

**With maven**

```xml

    

        sonatype-snapshot

        Sonatype Snapshot

        https://oss.sonatype.org/content/repositories/snapshots/

    

```

### BOM

Kotlin-faker provides a [Bill-of-Materials](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms) that simplifies dependency management.

See [bom/README.md](bom/README.md) for more details.

### Additional Fakers

Extra fakers covering a wide range of domains are available as separate dependencies. See [faker](faker) submodules in this repo for more details about each faker.

### Third-Party Extensions

Faker provides extensions for some third-party testing libraries. See [extension](extension) submodules in this repo for more details about each extension.

## Usage

Full usage documentation for kotlin-faker is available at [serpro69.github.io/kotlin-faker/](https://serpro69.github.io/kotlin-faker/).

_NB! The documentation website is currently not versioned and always reflects `master` rather than the last stable version._

> [!WARNING]

> **kotlin-faker 2.0** is coming, which, apart from new features, also means breaking changes.

>

> More details on currently added breaking changes and migration can be found in [#220](https://github.com/serpro69/kotlin-faker/issues/220)

### Generating data

```kotlin

val faker = faker { }

faker.name.firstName() // => Ana

faker.address.city() // => New York

```

## CLI

Command line application can be used for a quick lookup of faker functions. See [faker-bot README](cli-bot/README.md)

for installation and usage details.

## Test

To run unit tests: `./gradlew clean test`

To run integration tests: `./gradlew clean integrationTest`

## Build and Deploy

To deploy to OSS Sonatype repo:

- set the following properties in `~/.gradle/gradle.properties`

    - `signing.keyId=`

    - `signing.password=`

    - `signing.secretKeyRingFile=/home/user/.gnupg/secring.gpg`

    - `sonatypeUsername=`

    - `sonatypePassword=`

    - `stagingProfileId=`

- running `publishFakerCorePublicationToSonatypeRepository` will publish the artifacts to either staging release repo or to snapshots repo, depending on the current version

### Bumping versions

Versions need to be bumped manually through a tag with the next release version that has to follow the

[semver](https://semver.org/) rules, and the tag has to be pushed to origin.

Creating the tag can be either done manually with `git tag` or by using `gradlew tag` task.

#### Pre-releases

To create a new pre-release version (new release candidate)

the following can be used: `./gradlew clean tag -Prelease -PnewPreRelease -PbumpComponent={comp}`, where `comp` can be

one of the following values: `major`, `minor`, or `patch`.

To bump an existing pre-release to the next version (next release candidate for the same release version)

the following can be used: `./gradlew clean tag -Prelease -PpreRelease`.

#### Releases

To promote a pre-release to a release version the following can be used:

`./gradlew clean tag -Prelease -PpromoteToRelease`,

To create a new release version the following can be used:

`./gradlew clean tag -Prelease -PbumpComponent={comp}`, where `comp` can be one of the following values: `major`

, `minor`, or `patch`.

#### Make targets

Alternatively to the above targets from [Makefile](Makefile) can be used for the same purposes.

## Contributing

The [CONTRIBUTING](CONTRIBUTING.adoc) guidelines should help in getting you started on how to contribute to this project.

## Thanks

Many thanks to these awesome tools that help us in creating open-source software:  

[![Intellij IDEA](https://cloud.google.com/tools/images/icon_IntelliJIDEA.png)](http://www.jetbrains.com/idea)

[![YourKit Java profiler](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/features/)

## License

This code is free to use under the terms of the MIT license. See [LICENSE](LICENSE.adoc).