Usage¶

Getting started¶

Assuming you are using MavenCentral already, you just add the following into your projects build.gralde.kts:

testImplementation("tech.antibytes.kfixture:core:$KFixtureVersion")

Generating Values¶

You initialise the Generator with kotlinFixture() and you may retrieve atomic values via the fixture extension:

class MySpec {
    private val fixture = kotlinFixture()

    @Test
    fun myAwesomeTest() {
        val value: String = fixture.fixture()
        ...
    }
}

In opposite to JVM libraries, KFixture cannot generate values for arbitrary types due to the nature of KMP. This goes especially for Generics like List or Array. However KFixture has a preset of supported generic types which can accessed like:

class MySpec {
    private val fixture = kotlinFixture()

    @Test
    fun myAwesomeTest() {
        val value: List<String> = fixture.listFixture()
        ...
    }
}

or via:

class MySpec {
    private val fixture = kotlinFixture()

    @Test
    fun myAwesomeTest() {
        val value: List<String> = fixture.fixture(type = List::class)
        ...
    }
}

Setting a Seed¶

KFixture uses Kotlin's Random implementation to generate the most basic values. The default Random Seed value is set to 0, but you can set a custom value:

class MySpec {
    private val fixture = kotlinFixture {
        seed = 42
    }
    ...
}

Build-In types¶

Atomics¶

Following types are directly supported by the fixture extension:

AtomicArrays¶

Following types are directly supported by the fixture extension:

Complex Types¶

Iterables¶

Others¶