kotest-property

alltypes

interface Arb<A> : Gen<A>

abstract fun edgecases(): List<A>
open fun generate(rs: RandomSource): Sequence<Sample<A>>
open fun minIterations(): Int
abstract fun samples(rs: RandomSource): Sequence<Sample<A>>

interface BasicArb<A> : Arb<A>

abstract fun sample(rs: RandomSource): Sample<A>
open fun samples(rs: RandomSource): Sequence<Sample<A>>

class Counter

Counter()
var count: Int
fun inc(): Int

object DoubleShrinker : Shrinker<Double>

fun shrink(value: Double): List<Double>

interface Exhaustive<A> : Gen<A>

open fun generate(rs: RandomSource): Sequence<Sample<A>>
open fun minIterations(): Int
abstract val values: List<A>

object FloatShrinker : Shrinker<Float>

fun shrink(value: Float): List<Float>

interface Gen<out A>

abstract fun generate(rs: RandomSource): Sequence<Sample<A>>
abstract fun minIterations(): Int

object IntShrinker : Shrinker<Int>

fun shrink(value: Int): List<Int>

kotlin.Long

fun Long.random(): RandomSource

kotlin.random.Random

fun Random.azchar(): Char
fun Random.azstring(range: IntRange): String

class ListShrinker<A> : Shrinker<List<A>>

ListShrinker()
fun shrink(value: List<A>): List<List<A>>

object LongShrinker : Shrinker<Long>

fun shrink(value: Long): List<Long>

class MapShrinker<K, V> : Shrinker<Map<K, V>>

MapShrinker()
fun shrink(value: Map<K, V>): List<Map<K, V>>

class MultiplesShrinker : Shrinker<Int>

MultiplesShrinker(multiple: Int)
fun shrink(value: Int): List<Int>

class PropertyContext

PropertyContext()
fun attempts(): Int
fun classifications(): Map<String, Int>
fun classify(condition: Boolean, label: String): Unit
fun classify(condition: Boolean, trueLabel: String, falseLabel: String): Unit
fun failures(): Int
fun markFailure(): Unit
fun markSuccess(): Unit
fun successes(): Int

data class PropertyFailureInput<T>

PropertyFailureInput(original: T?, shrunk: T?)
val original: T?
val shrunk: T?

object PropertyTesting

var defaultIterationCount: Int
var shouldPrintGeneratedValues: Boolean
var shouldPrintShrinkSteps: Boolean

data class PropTestConfig

PropTestConfig(seed: Long? = null, minSuccess: Int = Int.MAX_VALUE, maxFailure: Int = 0, shrinkingMode: ShrinkingMode = ShrinkingMode.Bounded(1000))
val maxFailure: Int
val minSuccess: Int
val seed: Long?
val shrinkingMode: ShrinkingMode

data class RandomSource

RandomSource(random: Random, seed: Long)
val Default: RandomSource
val random: Random
val seed: Long

data class RTree<out A>

RTree(value: A, children: Lazy<List<RTree<A>>> = lazy { emptyList<RTree<A>>() })
val children: Lazy<List<RTree<A>>>
val value: A

data class Sample<out A>

Sample(value: A, shrinks: RTree<A> = RTree(value))
val shrinks: RTree<A>
val value: A

interface Shrinker<A>

abstract fun shrink(value: A): List<A>

typealias ShrinkFn = suspend () -> List<Any?>
sealed class ShrinkingMode

data class Bounded : ShrinkingMode

Bounded(bound: Int)
val bound: Int

object Off : ShrinkingMode
object Unbounded : ShrinkingMode

object StringShrinker : Shrinker<String>

fun shrink(value: String): List<String>

abstract class TypeReference<T> : Comparable<TypeReference<T>>

TypeReference()
open fun compareTo(other: TypeReference<T>): Int
val type: Type

package io.kotest.property

suspend fun <A> checkAll(genA: Gen<A>, property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend fun <A> checkAll(iterations: Int, genA: Gen<A>, property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend fun <A> checkAll(config: PropTestConfig, genA: Gen<A>, property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend fun <A> checkAll(iterations: Int, config: PropTestConfig, genA: Gen<A>, property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend inline fun <reified A> checkAll(noinline property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend inline fun <reified A> checkAll(iterations: Int, noinline property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend inline fun <reified A> checkAll(config: PropTestConfig, noinline property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend inline fun <reified A> checkAll(iterations: Int, config: PropTestConfig, noinline property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend fun <A, B> checkAll(genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend fun <A, B> checkAll(config: PropTestConfig, genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend fun <A, B> checkAll(iterations: Int, genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend fun <A, B> checkAll(iterations: Int, config: PropTestConfig, genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend inline fun <reified A, reified B> checkAll(noinline property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend inline fun <reified A, reified B> checkAll(config: PropTestConfig, noinline property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend inline fun <reified A, reified B> checkAll(iterations: Int, noinline property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend inline fun <reified A, reified B> checkAll(iterations: Int, config: PropTestConfig, noinline property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend fun <A> forAll(genA: Gen<A>, property: PropertyContext.(A) -> Boolean): PropertyContext
suspend fun <A> forAll(iterations: Int, genA: Gen<A>, property: PropertyContext.(A) -> Boolean): PropertyContext
suspend fun <A> forAll(config: PropTestConfig, genA: Gen<A>, property: PropertyContext.(A) -> Boolean): PropertyContext
suspend fun <A> forAll(iterations: Int, config: PropTestConfig, genA: Gen<A>, property: PropertyContext.(A) -> Boolean): PropertyContext
suspend inline fun <reified A> forAll(crossinline property: suspend PropertyContext.(A) -> Boolean): PropertyContext
suspend inline fun <reified A> forAll(iterations: Int, crossinline property: suspend PropertyContext.(A) -> Boolean): PropertyContext
suspend inline fun <reified A> forAll(config: PropTestConfig, crossinline property: suspend PropertyContext.(A) -> Boolean): PropertyContext
suspend inline fun <reified A> forAll(iterations: Int, config: PropTestConfig, crossinline property: suspend PropertyContext.(A) -> Boolean): PropertyContext
suspend fun <A, B> forAll(genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Boolean): PropertyContext
suspend fun <A, B> forAll(config: PropTestConfig = PropTestConfig(), genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Boolean): PropertyContext
suspend fun <A, B> forAll(iterations: Int, genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Boolean): PropertyContext
suspend fun <A, B> forAll(iterations: Int, config: PropTestConfig, genA: Gen<A>, genB: Gen<B>, property: suspend PropertyContext.(A, B) -> Boolean): PropertyContext
suspend inline fun <reified A, reified B> forAll(crossinline property: PropertyContext.(A, B) -> Boolean): PropertyContext
suspend inline fun <reified A, reified B> forAll(config: PropTestConfig = PropTestConfig(), crossinline property: PropertyContext.(A, B) -> Boolean): PropertyContext
suspend inline fun <reified A, reified B> forAll(iterations: Int, crossinline property: PropertyContext.(A, B) -> Boolean): PropertyContext
suspend inline fun <reified A, reified B> forAll(iterations: Int, config: PropTestConfig, crossinline property: PropertyContext.(A, B) -> Boolean): PropertyContext
interface Gen<out A>

abstract fun generate(rs: RandomSource): Sequence<Sample<A>>
abstract fun minIterations(): Int

kotlin.Long

fun Long.random(): RandomSource

kotlin.random.Random

fun Random.azchar(): Char
fun Random.azstring(range: IntRange): String

fun <A, B> RTree<A>.map(f: (A) -> B): RTree<B>
fun <A, B : A> Gen<A>.merge(other: Gen<B>): Gen<A>
class PropertyContext

PropertyContext()
fun attempts(): Int
fun classifications(): Map<String, Int>
fun classify(condition: Boolean, label: String): Unit
fun classify(condition: Boolean, trueLabel: String, falseLabel: String): Unit
fun failures(): Int
fun markFailure(): Unit
fun markSuccess(): Unit
fun successes(): Int

object PropertyTesting

var defaultIterationCount: Int
var shouldPrintGeneratedValues: Boolean
var shouldPrintShrinkSteps: Boolean

data class PropTestConfig

PropTestConfig(seed: Long? = null, minSuccess: Int = Int.MAX_VALUE, maxFailure: Int = 0, shrinkingMode: ShrinkingMode = ShrinkingMode.Bounded(1000))
val maxFailure: Int
val minSuccess: Int
val seed: Long?
val shrinkingMode: ShrinkingMode

data class RandomSource

RandomSource(random: Random, seed: Long)
val Default: RandomSource
val random: Random
val seed: Long

fun <A> Shrinker<A>.rtree(a: A): RTree<A>
data class RTree<out A>

RTree(value: A, children: Lazy<List<RTree<A>>> = lazy { emptyList<RTree<A>>() })
val children: Lazy<List<RTree<A>>>
val value: A

data class Sample<out A>

Sample(value: A, shrinks: RTree<A> = RTree(value))
val shrinks: RTree<A>
val value: A

fun <A> sampleOf(a: A, shrinker: Shrinker<A>): Sample<A>
interface Shrinker<A>

abstract fun shrink(value: A): List<A>

sealed class ShrinkingMode

data class Bounded : ShrinkingMode

Bounded(bound: Int)
val bound: Int

object Off : ShrinkingMode
object Unbounded : ShrinkingMode

package io.kotest.property.arbitrary

interface Arb<A> : Gen<A>

abstract fun edgecases(): List<A>
open fun generate(rs: RandomSource): Sequence<Sample<A>>
open fun minIterations(): Int
abstract fun samples(rs: RandomSource): Sequence<Sample<A>>

fun <A> arb(edgecases: List<A> = emptyList(), f: (RandomSource) -> A): Arb<A>
fun <A> arb(shrinker: Shrinker<A>, f: (RandomSource) -> A): Arb<A>
fun <A> arb(shrinker: Shrinker<A>, edgecases: List<A> = emptyList(), f: (RandomSource) -> A): Arb<A>
interface BasicArb<A> : Arb<A>

abstract fun sample(rs: RandomSource): Sample<A>
open fun samples(rs: RandomSource): Sequence<Sample<A>>

fun Arb.Companion.bigInt(range: IntRange): Arb<BigInteger>
fun <A, B> Shrinker<A>.bimap(f: (B) -> A, g: (A) -> B): Shrinker<B>
fun <A, T> Arb.Companion.bind(arbA: Arb<A>, createFn: (A) -> T): Arb<T>
fun <A, B, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, createFn: (A, B) -> T): Arb<T>
fun <A, B, C, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>, createFn: (A, B, C) -> T): Arb<T>
fun <A, B, C, D, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>, arbD: Arb<D>, createFn: (A, B, C, D) -> T): Arb<T>
fun <A, B, C, D, E, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>, arbD: Arb<D>, arbE: Arb<E>, createFn: (A, B, C, D, E) -> T): Arb<T>
fun <A, B, C, D, E, F, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>, arbD: Arb<D>, arbE: Arb<E>, arbF: Arb<F>, createFn: (A, B, C, D, E, F) -> T): Arb<T>
fun <A, B, C, D, E, F, G, T> Arb.Companion.bind(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>, arbD: Arb<D>, arbE: Arb<E>, arbF: Arb<F>, arbG: Arb<G>, createFn: (A, B, C, D, E, F, G) -> T): Arb<T>
fun Arb.Companion.bool(): Arb<Boolean>
fun Arb.Companion.byte(): Arb<Byte>
val ByteShrinker: Shrinker<Byte>
fun Arb.Companion.char(range: CharRange, vararg ranges: CharRange): Arb<Char>
fun Arb.Companion.char(ranges: List<CharRange> = CharSets.BASIC_LATIN): Arb<Char>
fun <A> Arb.Companion.choice(vararg gens: Gen<A>): Arb<A>
fun <A : Any> Arb.Companion.choose(a: Pair<Int, A>, b: Pair<Int, A>, vararg cs: Pair<Int, A>): Arb<A>
fun <A> Arb.Companion.constant(a: A): Arb<A>
fun <A> Arb.Companion.create(fn: (RandomSource) -> A): Arb<A>
fun Arb.Companion.date(minYear: Int = 1970, maxYear: Int = 2030): <ERROR CLASS>
fun Arb.Companion.date(yearRange: IntRange): <ERROR CLASS>
fun Arb.Companion.datetime(minYear: Int = 1970, maxYear: Int = 2030): <ERROR CLASS>
fun Arb.Companion.datetime(yearRange: IntRange): <ERROR CLASS>
fun <reified A> Arb.Companion.default(): Arb<A>
fun <A> defaultForClass(kClass: KClass<*>): Arb<A>?
fun <A> Arb<A>.distinct(): Arb<A>
fun Arb.Companion.double(): Arb<Double>
object DoubleShrinker : Shrinker<Double>

fun shrink(value: Double): List<Double>

fun <T> Arb.Companion.element(collection: Collection<T>): Arb<T>
fun Arb.Companion.email(usernameSize: IntRange = 3..10, domainSize: IntRange = 3..10): Arb<String>
fun <reified T : Enum<T>> Arb.Companion.enum(): Arb<T>
fun Arb.Companion.factors(k: Int): Arb<Int>
fun Arb.Companion.file(): Arb<File>
fun Arb.Companion.file(directoryName: String, recursive: Boolean = false): Arb<File>
fun <A> Arb<A>.filter(predicate: (A) -> Boolean): Arb<A>
fun <A, reified B : A> Arb<A>.filterIsInstance(): Arb<B>
fun <A> Arb<A>.filterNot(f: (A) -> Boolean): Arb<A>
fun <A, B> Arb<A>.flatMap(f: (A) -> Arb<B>): Arb<B>
fun Arb.Companion.float(): Arb<Float>
object FloatShrinker : Shrinker<Float>

fun shrink(value: Float): List<Float>

fun <reified A> Arb.Companion.forClass(kClass: KClass<*>): Arb<A>
fun Arb.Companion.int(min: Int, max: Int): Arb<Int>
fun Arb.Companion.int(range: IntRange = Int.MIN_VALUE..Int.MAX_VALUE): Arb<Int>
object IntShrinker : Shrinker<Int>

fun shrink(value: Int): List<Int>

fun Arb.Companion.lines(file: File, charset: Charset = Charsets.UTF_8): Arb<String>
@JvmOverloads fun <A> Arb.Companion.list(gen: Gen<A>, range: IntRange = 0..100): Arb<List<A>>
class ListShrinker<A> : Shrinker<List<A>>

ListShrinker()
fun shrink(value: List<A>): List<List<A>>

fun Arb.Companion.localDate(minYear: Int = 1970, maxYear: Int = 2030): Arb<LocalDate>
fun Arb.Companion.localDateTime(minYear: Int = 1970, maxYear: Int = 2030): Arb<LocalDateTime>
fun Arb.Companion.localTime(): Arb<LocalTime>
fun Arb.Companion.long(min: Long = Long.MIN_VALUE, max: Long = Long.MAX_VALUE): Arb<Long>
fun Arb.Companion.long(range: LongRange = Long.MIN_VALUE..Long.MAX_VALUE): Arb<Long>
object LongShrinker : Shrinker<Long>

fun shrink(value: Long): List<Long>

fun <A, B> Arb<A>.map(f: (A) -> B): Arb<B>
fun <K, V> Arb.Companion.map(arb: Arb<Pair<K, V>>, minSize: Int = 1, maxSize: Int = 100): Arb<Map<K, V>>
fun <K, V> Arb.Companion.map(keyArb: Arb<K>, valueArb: Arb<V>, minSize: Int = 1, maxSize: Int = 100): Arb<Map<K, V>>
class MapShrinker<K, V> : Shrinker<Map<K, V>>

MapShrinker()
fun shrink(value: Map<K, V>): List<Map<K, V>>

fun Arb.Companion.multiples(k: Int, max: Int): Arb<Int>
class MultiplesShrinker : Shrinker<Int>

MultiplesShrinker(multiple: Int)
fun shrink(value: Int): List<Int>

fun Arb.Companion.nats(max: Int = Int.MAX_VALUE): Arb<Int>
fun Arb.Companion.negativeDoubles(): Arb<Double>
fun Arb.Companion.negativeInts(min: Int = Int.MIN_VALUE): Arb<Int>
fun <A> Arb<A>.next(rs: RandomSource = RandomSource.Default): A
fun <A> Arb<A>.next(predicate: (A) -> Boolean = { true }, random: RandomSource?): A
fun Arb.Companion.numericDoubles(from: Double = Double.MIN_VALUE, to: Double = Double.MAX_VALUE): Arb<Double>
fun Arb.Companion.numericFloats(from: Float = Float.MIN_VALUE, to: Float = Float.MAX_VALUE): Arb<Float>
fun <K, V> Arb.Companion.pair(k: Arb<K>, v: Arb<V>): Arb<Pair<K, V>>
fun Arb.Companion.period(maxYear: Int = 10): Arb<Period>
fun Arb.Companion.positiveDoubles(): Arb<Double>
fun Arb.Companion.positiveInts(max: Int = Int.MAX_VALUE): Arb<Int>
fun Arb.Companion.regex(regex: String): Arb<String!>
fun Arb.Companion.regex(regex: Regex): Arb<String!>
@JvmOverloads fun <A> Arb.Companion.set(gen: Gen<A>, range: IntRange = 0..100): Arb<Set<A>>
fun Arb.Companion.short(): Arb<Short>
val ShortShrinker: Shrinker<Short>
fun <A> Arb.Companion.shuffle(list: List<A>): Arb<List<A>>
fun <A> Arb<A>.single(rs: RandomSource = RandomSource.Default): A
fun Arb.Companion.string(minSize: Int = 0, maxSize: Int = 100): Arb<String>
fun Arb.Companion.string(range: IntRange): Arb<String>
object StringShrinker : Shrinker<String>

fun shrink(value: String): List<String>

fun <A> Arb.Companion.subsequence(list: List<A>): Arb<List<A>>
fun <A> Arb<A>.take(count: Int, rs: RandomSource = RandomSource.Default): Sequence<A>
fun <reified A> targetDefaultForClass(): Arb<A>?
fun <A, B, C> Arb.Companion.triple(arbA: Arb<A>, arbB: Arb<B>, arbC: Arb<C>): Arb<Triple<A, B, C>>
abstract class TypeReference<T> : Comparable<TypeReference<T>>

TypeReference()
open fun compareTo(other: TypeReference<T>): Int
val type: Type

@ExperimentalUnsignedTypes fun Arb.Companion.ushort(): Arb<UShort>
val UShortShrinker: Shrinker<UShort>
fun Arb.Companion.uuid(uuidVersion: UUIDVersion = UUIDVersion.V4, allowNilValue: Boolean = true): Arb<UUID>

package io.kotest.property.exhaustive

fun <A> Exhaustive<A>.andNull(): Exhaustive<A?>
fun Exhaustive.Companion.azstring(range: IntRange): Exhaustive<String>
fun Exhaustive.Companion.boolean(): Exhaustive<Boolean>
fun Exhaustive.Companion.bytes(from: Byte = Byte.MIN_VALUE, to: Byte = Byte.MAX_VALUE): Exhaustive<Byte>
fun <A> Exhaustive.Companion.collection(collection: Collection<A>): Exhaustive<A>
fun <A> Exhaustive.Companion.constant(a: A): Exhaustive<A>
fun <reified T : Enum<T>> Exhaustive.Companion.enum(): Exhaustive<T>
interface Exhaustive<A> : Gen<A>

open fun generate(rs: RandomSource): Sequence<Sample<A>>
open fun minIterations(): Int
abstract val values: List<A>

fun <A> exhaustive(as: List<A>): Exhaustive<A>
fun Exhaustive.Companion.ints(range: IntRange): Exhaustive<Int>
fun Exhaustive.Companion.lines(file: File, charset: Charset = Charsets.UTF_8): Exhaustive<String>
fun Exhaustive.Companion.longs(range: LongRange): Exhaustive<Long>
fun Exhaustive.Companion.nullable(): Exhaustive<Nothing?>
operator fun <A> Exhaustive<A>.plus(other: Exhaustive<A>): Exhaustive<A>
operator fun <A, B : A> Exhaustive<A>.times(other: Exhaustive<B>): Exhaustive<Pair<A, B>>

package io.kotest.property.internal

fun PropertyContext.checkMaxSuccess(config: PropTestConfig, seed: Long): Unit
class Counter

Counter()
var count: Int
fun inc(): Int

data class PropertyFailureInput<T>

PropertyFailureInput(original: T?, shrunk: T?)
val original: T?
val shrunk: T?

suspend fun <A> proptest(iterations: Int, genA: Gen<A>, config: PropTestConfig, property: suspend PropertyContext.(A) -> Unit): PropertyContext
suspend fun <A, B> proptest(iterations: Int, genA: Gen<A>, genB: Gen<B>, config: PropTestConfig, property: suspend PropertyContext.(A, B) -> Unit): PropertyContext
suspend fun <A, B, C> proptest(iterations: Int, genA: Gen<A>, genB: Gen<B>, genC: Gen<C>, config: PropTestConfig, property: suspend PropertyContext.(A, B, C) -> Unit): PropertyContext
typealias ShrinkFn = suspend () -> List<Any?>
fun <A> shrinkfn(a: Sample<A>, property: suspend PropertyContext.(A) -> Unit, shrinkingMode: ShrinkingMode): ShrinkFn
fun <A, B> shrinkfn(a: Sample<A>, b: Sample<B>, property: suspend PropertyContext.(A, B) -> Unit, shrinkingMode: ShrinkingMode): ShrinkFn
fun <A, B, C> shrinkfn(a: Sample<A>, b: Sample<B>, c: Sample<C>, property: suspend PropertyContext.(A, B, C) -> Unit, shrinkingMode: ShrinkingMode): ShrinkFn