library/io.github.baole.konture/FunctionDeclarationShouldContext

FunctionDeclarationShouldContext

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

Properties

allFunctions

val allFunctions: List<FunctionDeclarationContext>

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

annotations

val annotations: List<AnnotationDeclaration>

className

val className: String?

declaration

val declaration: FunctionDeclaration

element

val element: FunctionDeclarationContext

The target FunctionDeclarationContext being verified.

filePath

val filePath: String

isExtension

val isExtension: Boolean

kdocText

val kdocText: String?

modifiers

val modifiers: Set<Modifier>

modulePath

val modulePath: String

name

val name: String

packageName

val packageName: String

parameters

val parameters: List<ParameterDeclaration>

returnType

val returnType: String

violations

val violations: MutableList<String>

Mutable collection where assertion failure messages are appended.

visibility

val visibility: Visibility

Functions

addViolation

fun addViolation(message: String)

Appends a custom violation failure message to the assertion run.

anyParameterMatches

fun anyParameterMatches(message: String, predicate: (ParameterDeclaration) -> Boolean)

Asserts that at least one of the function's parameters matches the given predicate block. Appends the message suffix to the violation report on failure.

assertAllAnnotationsOf