test-support/dev.rnett.kcp.development.testing.generation/TestGenerationBuilder

TestGenerationBuilder

interface TestGenerationBuilder(source)

Properties

path

abstract val path: Path

The absolute test data directory for this group.

pathFromRoot

abstract val pathFromRoot: Path?

The relative path of this group's directory, from the test data root.

Functions

addLevel

fun TestGenerationBuilder.addLevel(level: TestLevel)

Add a test level to this group, and any descendents.

annotation

fun TestGenerationBuilder.annotation(annotation: AnnotationModel)

Add test class annotations to this group, and any descendents.

autoGenerateTests

fun TestGenerationBuilder.autoGenerateTests(skip: (Path) -> Boolean = { false })

Auto-generate tests for this group, inferring test types from directory names.

configure

abstract fun configure(block: TestConfigurationBuilder.() -> Unit)

Apply compiler test framework configuration. Applies to this group's tests, and any descendents.

configureGeneration

abstract fun configureGeneration(block: TestGenerationConfigBuilder.() -> Unit)

Apply test class generation configuration. Applies to this group's tests, and any descendents.

directives

fun TestGenerationBuilder.directives(vararg containers: DirectivesContainer, block: RegisteredDirectivesBuilder.() -> Unit)

generateTests

open fun TestGenerationBuilder.generateTests()

Override this to generate your tests.

group

abstract fun group(path: String? = null, inferPackageNames: Boolean = true, inferType: Boolean = true, block: TestGenerationBuilder.() -> Unit)

Create a sub-group.

group

fun TestGenerationBuilder.group(path: String? = null, type: TestType, block: TestGenerationBuilder.() -> Unit)

Create a group with the given test type.

fun TestGenerationBuilder.group(path: String? = null, vararg levels: TestLevel, block: TestGenerationBuilder.() -> Unit)

Create a group with the given levels.

import

fun TestGenerationBuilder.import(vararg imports: String)

fun TestGenerationBuilder.import(vararg imports: KClass<*>)

Add imports to this group's tests, and any descendents.

method

fun TestGenerationBuilder.method(method: MethodModel)

Add test class methods to this group, and any descendents.

optIn

fun TestGenerationBuilder.optIn(vararg optIns: String)

fun TestGenerationBuilder.optIn(vararg optIns: KClass<*>)

Add opt-in annotations to this group's tests, and any descendents.

optInBox

fun TestGenerationBuilder.optInBox(vararg optIns: String)

fun TestGenerationBuilder.optInBox(vararg optIns: KClass<*>)

Add opt-in annotations to the box() functions in this group's tests, and any descendents.

registerDirectives

fun TestGenerationBuilder.registerDirectives(vararg containers: DirectivesContainer)

removeLevel

fun TestGenerationBuilder.removeLevel(level: TestLevel)

Remove a test level from this group, and any descendents.

tests

abstract fun tests(testClassName: String? = null, customBaseClass: KClass<*>? = null, arguments: TestArguments = TestArguments())

Generate tests for all files in this group's directory and any sub-directories. Should only be used in leaf groups.

abstract fun tests(path: String, testClassName: String? = null, customBaseClass: KClass<*>? = null, arguments: TestArguments = TestArguments())

Generate tests for files in ./$path (from this group's directory) and any sub-directories. Should only be used in leaf groups.

testsPackage

fun TestGenerationBuilder.testsPackage(vararg packageNames: String)

Add a to the package name of test classes generated by this group and any descendents..

withCompilerConfiguration

fun TestGenerationBuilder.withCompilerConfiguration(configurator: CompilerConfiguration.(TestModule) -> Unit)

Apply compiler configuration to this group, and any descendents.

withTestSpec

fun <T> TestGenerationBuilder.withTestSpec(pluginRegistrar: KClass<out BaseSpecCompilerPluginRegistrar<T>>, spec: T)

Use the specified spec for the corresponding pluginRegistrar for this group, and any descendents (unless overridden).