library/io.github.baole.konture/FileDeclarationShouldContext

FileDeclarationShouldContext

Context receiver for writing declarative assertions on a FileDeclarationContext element. Provides easy access to all element properties and custom helper assertions.

Properties

allFiles

val allFiles: List<FileDeclarationContext>

The complete list of file declaration contexts in this test run scope.

classes

val classes: List<ClassDeclaration>

declaration

val declaration: FileDeclaration

element

val element: FileDeclarationContext

The target FileDeclarationContext being verified.

filePath

val filePath: String

imports

val imports: List<String>

kdocText

val kdocText: String?

modulePath

val modulePath: String

name

val name: String

packageName

val packageName: String

topLevelFunctions

val topLevelFunctions: List<FunctionDeclaration>

topLevelProperties

val topLevelProperties: List<PropertyDeclaration>

violations

val violations: MutableList<String>

Mutable collection where assertion failure messages are appended.

Functions

addViolation

fun addViolation(message: String)

Appends a custom violation failure message to the assertion run.

assertNoWildcardImports

fun assertNoWildcardImports()

Asserts that this file does not use any wildcard star imports.

assertOnlyOneClassPerFile

fun assertOnlyOneClassPerFile()

Asserts that this file contains at most one class declaration.

check

fun check(condition: Boolean, message: String? = null)

Asserts condition is true, recording a violation with message when false. When message is omitted, a default message referencing element is used.

containsClassWith

fun containsClassWith(predicate: (ClassDeclaration) -> Boolean): Boolean

Checks if this file contains any classes matching the given predicate.

hasImport

fun hasImport(predicate: (String) -> Boolean): Boolean

Checks if this file contains an import matching the given predicate.

hasImportContaining

fun hasImportContaining(vararg segments: String): Boolean

Checks if this file contains any import with matching package path segment strings.