Getting Started

ToC

• Installing
  • Releases
  • Snapshots
  • Faker BOM
• Generating Data

Installing

Releases

Installation is as simple as adding kotlin-faker dependency to your build configuration file:

testImplementation("io.github.serpro69:kotlin-faker:$fakerVersion")

testImplementation 'io.github.serpro69:kotlin-faker:$fakerVersion'

<dependency>
    <groupId>io.github.serpro69</groupId>
    <artifactId>kotlin-faker</artifactId>
    <version>${kotlin-faker.version}</version>
</dependency>

Release artifacts are available for download from maven central, and you usually don't need to add any additional repositories information.

Snapshots

Snapshot are automatically published on each commit to master. If you want to try out the latest functionality - add the dependency the same way as described above, but change the version to the current snapshot version, and add the sonatype snapshots repository to your repositories block in the build configuration file:

repositories {
    maven {
        url = URI("https://oss.sonatype.org/content/repositories/snapshots/")
    }
}

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

<repositories>
    <repository>
        <id>sonatype-snapshot</id>
        <name>Sonatype Snapshot</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
</repositories>

Faker BOM

See Kotlin-faker BOM page for details on how to use a Bill-of-Materials to simplify dependency management.

Generating Data

Creating a Faker instance can be done either by creating a class instance directly:

val faker = Faker()

faker.name.firstName()
faker.address.city()

Faker faker = new Faker();

faker.getName().firstName()
faker.getAddress().city()

Or by using the Faker DSL (Which also gives you dsl-like access to Faker Configuration .)

val faker = faker {
    // faker config
}

faker.name.firstName()
faker.address.city()

Faker faker = faker(fromConsumer(f -> {
    // faker config
}));

faker.getName().firstName()
faker.getAddress().city()

Faker faker = faker(f -> {
    // faker config
    return Unit.INSTANCE;
});

faker.getName().firstName()
faker.getAddress().city()

This concludes this short "getting started" guide. Jump to Faker Configuration page to learn how to configure Faker to generate localized data, ensure deterministic random data generation and other configuration options or just click the next button to go to next wiki page.