library/io.github.baole.konture/FunctionAssertionScope

FunctionAssertionScope

class FunctionAssertionScope

Assertion scope DSL for configuring rule expectations on Kotlin functions.

Properties

assertions

val assertions: MutableList<(FunctionDeclaration, MutableList<String>) -> Unit>

Filter or assertion criteria for assertions.

Functions

beAbstract

fun beAbstract()

Filter or assertion criteria for be abstract.

beDocumentedWithKDoc

fun beDocumentedWithKDoc()

Filter or assertion criteria for be documented with k doc.

beExtension

fun beExtension()

Filter or assertion criteria for be extension.

beInline

fun beInline()

Filter or assertion criteria for be inline.

beInternal

fun beInternal()

Filter or assertion criteria for be internal.

beOpen

fun beOpen()

Filter or assertion criteria for be open.

bePrivate

fun bePrivate()

Filter or assertion criteria for be private.

beProtected

fun beProtected()

Filter or assertion criteria for be protected.

bePublic

fun bePublic()

Filter or assertion criteria for be public.

beSuspend

fun beSuspend()

Filter or assertion criteria for be suspend.

haveAllAnnotationsOf

fun haveAllAnnotationsOf(vararg names: String)

fun haveAllAnnotationsOf(names: List<String>)

Asserts that member functions are annotated with all of the specified annotations.

haveAllModifiers

fun haveAllModifiers(vararg modifiers: Modifier)

fun haveAllModifiers(modifiers: List<Modifier>)

Asserts that member functions have all of the specified modifiers.

haveAnnotationOf

fun haveAnnotationOf(vararg annotationNames: String)

fun haveAnnotationOf(annotationName: String)

fun haveAnnotationOf(annotationNames: List<String>)

Filter or assertion criteria for have annotation of.

haveAnnotationOf

fun FunctionAssertionScope.haveAnnotationOf(annotation: KClass<out Annotation>)

Asserts that functions in this assertion scope have the specified annotation class.

haveAnnotationOfType

inline fun <T : Annotation> FunctionAssertionScope.haveAnnotationOfType()

Asserts that functions in this assertion scope have the annotation specified by T.

haveAnyAnnotationOf

fun haveAnyAnnotationOf(vararg names: String)

fun haveAnyAnnotationOf(names: List<String>)

Asserts that member functions are annotated with any of the specified annotations.

haveAnyModifier

fun haveAnyModifier(vararg modifiers: Modifier)

fun haveAnyModifier(modifiers: List<Modifier>)

Asserts that member functions have any of the specified modifiers.

haveAnyVisibility

fun haveAnyVisibility(vararg visibilities: Visibility)

fun haveAnyVisibility(visibilities: List<Visibility>)

Asserts that member functions have any of the specified visibilities.

haveModifier

fun haveModifier(modifier: Modifier)

Filter or assertion criteria for have modifier.

haveNameEndingWith

fun haveNameEndingWith(vararg suffixes: String)

fun haveNameEndingWith(suffix: String)

fun haveNameEndingWith(suffixes: List<String>)

Filter or assertion criteria for have name ending with.

haveNameMatching

fun haveNameMatching(vararg patterns: String)

fun haveNameMatching(pattern: String)

fun haveNameMatching(patterns: List<String>)

Filter or assertion criteria for have name matching.

haveNameStartingWith

fun haveNameStartingWith(vararg prefixes: String)

fun haveNameStartingWith(prefix: String)

fun haveNameStartingWith(prefixes: List<String>)

Filter or assertion criteria for have name starting with.

haveReturnType

fun haveReturnType(vararg typeFqNames: String)

fun haveReturnType(typeFqName: String)

fun haveReturnType(typeFqNames: List<String>)

Filter or assertion criteria for have return type.

haveReturnType

fun FunctionAssertionScope.haveReturnType(type: KClass<*>)

Asserts that functions in this assertion scope have the specified return type.

haveReturnTypeOf

inline fun <T : Any> FunctionAssertionScope.haveReturnTypeOf()

Asserts that functions in this assertion scope have the return type specified by T.