Konsist 0.17.0/com.lemonappdev.konsist.api.architecture/KoArchitectureAssertion/assertArchitecture

assertArchitecture

abstract fun KoScope.assertArchitecture(layerDependenciesFunc: LayerDependencies.() -> Unit)
abstract fun List<KoFileDeclaration>.assertArchitecture(layerDependenciesFunc: LayerDependencies.() -> Unit)

Asserts the architecture with the specified layerDependenciesFunc defined as a function literal with receiver LayerDependencies.

Parameters

layerDependenciesFunc

The function literal with receiver LayerDependencies that allows configuring the dependencies of the architecture.

abstract fun KoScope.assertArchitecture(additionalMessage: String? = null, testName: String? = null, layerDependenciesFunc: LayerDependencies.() -> Unit)
abstract fun List<KoFileDeclaration>.assertArchitecture(additionalMessage: String? = null, testName: String? = null, layerDependenciesFunc: LayerDependencies.() -> Unit)

Asserts the architecture with the specified layerDependenciesFunc defined as a function literal with receiver LayerDependencies.

Parameters

additionalMessage

An optional message to provide additional context when the assertion fails. This message will be included in the assertion error if the assertion fails.

testName

An optional test name recommended for Kotest tests. By default, test name is derived from JUnit method name, however for Kotest framework it must be manually specified to be displayed in error messages and enable suppression.

layerDependenciesFunc

The function literal with receiver LayerDependencies that allows configuring the dependencies of the architecture.

abstract fun KoScope.assertArchitecture(layerDependenciesFunc: LayerDependencies)
abstract fun List<KoFileDeclaration>.assertArchitecture(layerDependenciesFunc: LayerDependencies)

Asserts the architecture with the specified layerDependenciesFunc.

Parameters

layerDependenciesFunc

The LayerDependencies instance representing the configured dependencies of the architecture.

abstract fun KoScope.assertArchitecture(additionalMessage: String? = null, testName: String? = null, layerDependenciesFunc: LayerDependencies)
abstract fun List<KoFileDeclaration>.assertArchitecture(additionalMessage: String? = null, testName: String? = null, layerDependenciesFunc: LayerDependencies)

Asserts the architecture with the specified layerDependenciesFunc.

Parameters

additionalMessage

An optional message to provide additional context when the assertion fails. This message will be included in the assertion error if the assertion fails.

testName

An optional test name recommended for Kotest tests. By default, test name is derived from JUnit method name, however for Kotest framework it must be manually specified to be displayed in error messages and enable suppression.

layerDependenciesFunc

The LayerDependencies instance representing the configured dependencies of the architecture.