tegral-di-test/guru.zoroark.tegral.di.test.check

Package-level declarations

Types

DependencyKind

enum DependencyKind : Enum<DependencyKind>

A "kind" of dependency detected by DependencyTrackingInjectionEnvironment.

DependencyTrackingInjectionEnvironment

class DependencyTrackingInjectionEnvironment(context: EnvironmentContext) : InjectionEnvironment

Fake environment that tracks dependencies on the instantiation of components.

IdentifierDependencies

data class IdentifierDependencies(val kind: DependencyKind, val dependencies: List<Identifier<*>>)

The dependencies for an identifier, with the kind of dependency "towards" those dependencies.

NoUnusedCheck

class NoUnusedCheck(ignoredValues: Set<Identifier<*>>) : TegralDiCheck

Checks that all the components within modules are injected somewhere, except for the specified in the set passed as a parameter.

NoUnusedCheckDsl

class NoUnusedCheckDsl

DSL receiver for creating a NoUnusedCheck with excluded components. Use the exclude functions to exclude components by their identifiers.

TegralDiCheck

fun interface TegralDiCheck

An individual Tegral DI check that can be ran.

TegralDiCheckDsl

class TegralDiCheckDsl

DSL receiver class for the Tegral DI check DSL.

TegralDiCheckException

class TegralDiCheckException(message: String) : TegralDiException

Exception type for check failures (i.e. when a check is not met).

Functions

complete

fun TegralDiCheckDsl.complete()

Checks that the modules are complete and that all dependencies and injections can be properly resolved.

exclude

inline fun <T : Any> NoUnusedCheckDsl.exclude(qualifier: Qualifier = EmptyQualifier)

Excludes an identifier built from the generic type parameter and the given qualifier, or EmptyQualifier if no qualifier is provided.

fun NoUnusedCheckDsl.exclude(kclass: KClass<*>, qualifier: Qualifier = EmptyQualifier)

Excludes an identifier built from the given class and the given qualifier, or EmptyQualifier if no qualifier is provided.

modules

fun TegralDiCheckDsl.modules(vararg modules: InjectableModule)

Adds the given modules to this Tegral DI check instance.

noCycle

fun TegralDiCheckDsl.noCycle()

Checks that no cyclic dependencies are present within the modules.

noUnused

inline fun TegralDiCheckDsl.noUnused(block: NoUnusedCheckDsl.() -> Unit = {})

Creates a NoUnusedCheck.

safeInjection

fun TegralDiCheckDsl.safeInjection()

Check that verifies no injection is actually performed during the instantiation of components.

tegralDiCheck

fun tegralDiCheck(block: TegralDiCheckDsl.() -> Unit)

DSL for checking your Tegral DI modules.