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

BaseTestGenerator

abstract class BaseTestGenerator : ConfigurationHost(source)

A test generator. Configures test generation, and can override generateTests to generate tests using the DSL.

Inheritors

Constructors

BaseTestGenerator

constructor()

Properties

additionalMethods

open val additionalMethods: List<MethodGenerator<*>>

Additional methods to add to generated test classes.

open val boxOptIns: Set<String>

Opt-ins to add to all test data files as box tests, via a preprocessor.

cleanGeneratedRoot

open val cleanGeneratedRoot: Boolean = true

Whether to clean the root of the generated tests before generating. Defaults to true.

compilerPluginRegistrar

open val compilerPluginRegistrar: CompilerPluginRegistrar?

A CompilerPluginRegistrar to register the compiler plugin. Defaults to the plugin registrar specified in the Gradle plugin.

disableAutogeneration

open val disableAutogeneration: Boolean

Whether to disable autogeneration. Defaults to false. If true, override generateTests or else no tests will be generated.

open val imports: Set<String>

Imports to add to all test data files, via a preprocessor.

open val optIns: Set<String>

Opt-ins to add to all test data files, via a preprocessor.

open val testDataRoot: Path

The root of the test data. Autoconfigured by the Gradle plugin.

testGenerationRoot

open val testGenerationRoot: Path

The root of the generated tests. Autoconfigured by the Gradle plugin.

testsRootPackage

open val testsRootPackage: String

The package name of the generated tests. Defaults to the package of the test generator.

Functions

adjustCompilerConfiguration

open fun adjustCompilerConfiguration(module: TestModule, configuration: CompilerConfiguration)

Called to adjust the compiler configuration before tests are run.

override fun configureTest(testInstance: AbstractKotlinCompilerTest, builder: TestConfigurationBuilder)

coreConfiguration

open fun coreConfiguration(builder: TestConfigurationBuilder)

The core configuration used to set up the other options in this class. Override at your own risk. If you do not call super things will not work as expected.

defaultConfiguration

open fun defaultConfiguration(builder: TestConfigurationBuilder)

The default configuration applied to all tests. Override at your own risk, but not suite as dangerous as coreConfiguration.

open fun TestGenerationBuilder.generateTests()

Override this to generate your tests.