modulecheck-runtime:testing/modulecheck.runtime.test/RunnerTestEnvironment

RunnerTestEnvironment

open class RunnerTestEnvironment(val projectCache: ProjectCache, val logger: ReportingLogger, val ruleFilter: RuleFilter, settings: (RunnerTestEnvironment) -> ModuleCheckSettings, codeGeneratorBindings: (ModuleCheckSettings) -> List<CodeGeneratorBinding>, rules: (ModuleCheckSettings, RuleFilter) -> List<ModuleCheckRule<*>>, findingFactory: (List<ModuleCheckRule<*>>) -> FindingFactory<out Finding>, names: List<String>, testLocation: TestLocation) : ProjectTestEnvironment(source)

Defines a test environment which uses a ModuleCheckRunner.

Parameters

settings

A function to generate ModuleCheckSettings.

codeGeneratorBindings

A function to generate a list of CodeGeneratorBinding.

rules

A function to generate a list of ModuleCheckRule.

findingFactory

A function to generate a FindingFactory.

names

Array of variant names for the test.

testLocation

details about the actual test function, so that we can get the test name. This must be grabbed as soon as possible, since default functions, inline functions, sequences, and iterators all redirect things and have a chance of hiding the original calling function completely.

Constructors

RunnerTestEnvironment

constructor(projectCache: ProjectCache, logger: ReportingLogger, ruleFilter: RuleFilter, settings: (RunnerTestEnvironment) -> ModuleCheckSettings, codeGeneratorBindings: (ModuleCheckSettings) -> List<CodeGeneratorBinding>, rules: (ModuleCheckSettings, RuleFilter) -> List<ModuleCheckRule<*>>, findingFactory: (List<ModuleCheckRule<*>>) -> FindingFactory<out Finding>, names: List<String>, testLocation: TestLocation)

Properties

codeGeneratorBindings

open override val codeGeneratorBindings: List<CodeGeneratorBinding>

dependencyModuleDescriptorAccess

open override val dependencyModuleDescriptorAccess: DependencyModuleDescriptorAccess

val findingFactory: FindingFactory<out Finding>

val logger: ReportingLogger

A ReportingLogger for logging reporting events.

open override val projectCache: ProjectCache

An instance of ProjectCache.

projectDependencyFactory

val projectDependencyFactory: ProjectDependency.Factory

projectProvider

open val projectProvider: ProjectProvider

open override val root: File

val ruleFilter: RuleFilter

A RuleFilter for filtering out unwanted rules.

val rules: List<ModuleCheckRule<*>>

val settings: ModuleCheckSettings

open override val workingDir: File

Functions

fun McProject.addDependency(configurationName: ConfigurationName, project: McProject, asTestFixture: Boolean)

open fun allProjects(): List<McProject>

androidApplication

open fun androidApplication(path: String, androidPackage: String, config: McProjectBuilder<AndroidApplicationPluginBuilder>.() -> Unit): McProject

androidDynamicFeature

open fun androidDynamicFeature(path: String, androidPackage: String, config: McProjectBuilder<AndroidDynamicFeaturePluginBuilder>.() -> Unit): McProject

open fun androidLibrary(path: String, androidPackage: String, config: McProjectBuilder<AndroidLibraryPluginBuilder>.() -> Unit): McProject

open fun androidTest(path: String, androidPackage: String, config: McProjectBuilder<AndroidTestPluginBuilder>.() -> Unit): McProject

fun String.clean(): String

open override fun String.cleanOutput(): String

fun McProject.createJavaFile(content: String, sourceSetName: SourceSetName): JavaFile

fun ProjectTestEnvironment.createJavaFile(content: String, project: McProject, sourceSetName: SourceSetName, jvmTarget: JvmTarget): JavaFile

createKotlinFile

fun McProject.createKotlinFile(content: String, sourceSetName: SourceSetName): KotlinFile

fun ProjectTestEnvironment.createKotlinFile(content: String, project: McProject, sourceSetName: SourceSetName, jvmTarget: JvmTarget): KotlinFile

open suspend fun McProject.editSimple(config: McProjectBuilder<PlatformPluginBuilder<PlatformPlugin>>.() -> Unit): McProject

open operator fun File.invoke(text: () -> String)

open fun javaProject(path: String, config: McProjectBuilder<JavaLibraryPluginBuilder>.() -> Unit): McProject

open fun kotlinProject(path: String, config: McProjectBuilder<KotlinJvmPluginBuilder>.() -> Unit): McProject

fun ReportingLogger.parsedReport(): List<Pair<String, List<ProjectFindingReport>>>

Parses the log report into a list of pairs, each containing a report title and a list of ProjectFindingReport.

resolveReferences

open suspend fun resolveReferences()

open infix fun <T, U : T> T.shouldBe(expected: U?)

open infix fun String.shouldBe(expected: String)

open infix fun Sequence<*>.shouldBe(expected: List<*>)

shouldBeNoTrimIndent

open infix fun String.shouldBeNoTrimIndent(expected: String)

open infix override fun File.shouldHaveText(expected: String)

open fun simpleProject(buildFileText: String?, path: String): McProject

open override fun tearDown()

open suspend fun PlatformPlugin.toBuilder(): PlatformPluginBuilder<*>

toProjectBuilder

open suspend fun <P : PlatformPluginBuilder<*>> McProject.toProjectBuilder(): McProjectBuilder<P>

trimmedShouldBe

open fun <T, U : T> T.trimmedShouldBe(expected: U?, vararg excludeFromStack: KClass<*>)

useRelativePaths

fun String.useRelativePaths(): String