library/io.github.baole.konture/ModulesShould

ModulesShould

class ModulesShould : ModulesShouldDependencyAssertions, ModulesShouldInboundDependencyAssertions, ModulesShouldExternalDependencyAssertions, ModulesShouldStructureAssertions, ModulesShouldCompositeAssertions

Fluent API for defining assertion rules on Gradle modules.

Properties

builder

open override val builder: ModulesRuleBuilder

Filter or assertion criteria for builder.

Functions

allOf

open fun allOf(vararg blocks: ModulesShould.() -> Unit): ModulesRuleBuilder

Filter or assertion criteria for all of.

anyOf

open fun anyOf(vararg blocks: ModulesShould.() -> Unit): ModulesRuleBuilder

Asserts that selected modules satisfy at least one of the specified assertion blocks.

applyPlugin

open infix fun applyPlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for apply plugin.

beEmpty

open fun beEmpty(): ModulesRuleBuilder

Filter or assertion criteria for be empty.

beFreeOfCycles

open fun beFreeOfCycles(): ModulesRuleBuilder

Filter or assertion criteria for be free of cycles.

beLeafModule

open fun beLeafModule(): ModulesRuleBuilder

Filter or assertion criteria for be leaf module.

beStandalone

open fun beStandalone(): ModulesRuleBuilder

Filter or assertion criteria for be standalone.

containClass

open infix fun containClass(fqName: String): ModulesRuleBuilder

open infix fun containClass(type: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for contain class.

containClass

inline fun <T : Any> ModulesShould.containClass(): ModulesRuleBuilder

Asserts that modules contain the class specified by type parameter T.

containClasses

open fun containClasses(): ModulesRuleBuilder

Filter or assertion criteria for contain classes.

containClassesInPackage

open infix fun containClassesInPackage(packagePattern: String): ModulesRuleBuilder

Filter or assertion criteria for contain classes in package.

containClassesWithAnnotation

open infix fun containClassesWithAnnotation(annotationFqName: String): ModulesRuleBuilder

open infix fun containClassesWithAnnotation(annotation: KClass<out Annotation>): ModulesRuleBuilder

Filter or assertion criteria for contain classes with annotation.

containClassesWithAnnotation

inline fun <T : Annotation> ModulesShould.containClassesWithAnnotation(): ModulesRuleBuilder

Asserts that modules contain classes annotated with annotation type parameter T.

containFiles

open fun containFiles(): ModulesRuleBuilder

Filter or assertion criteria for contain files.

containOnlyClassesWithVisibility

open fun containOnlyClassesWithVisibility(vararg visibilities: Visibility): ModulesRuleBuilder

open fun containOnlyClassesWithVisibility(visibilities: List<Visibility>): ModulesRuleBuilder

Asserts that all classes in matching modules have one of the specified visibilities.

containOnlyFunctionsWithVisibility

open fun containOnlyFunctionsWithVisibility(vararg visibilities: Visibility): ModulesRuleBuilder

open fun containOnlyFunctionsWithVisibility(visibilities: List<Visibility>): ModulesRuleBuilder

Asserts that all top-level functions in matching modules have one of the specified visibilities.

containOnlyPropertiesWithVisibility

open fun containOnlyPropertiesWithVisibility(vararg visibilities: Visibility): ModulesRuleBuilder

open fun containOnlyPropertiesWithVisibility(visibilities: List<Visibility>): ModulesRuleBuilder

Asserts that all top-level properties in matching modules have one of the specified visibilities.

dependOnExternalLibraries

open fun dependOnExternalLibraries(vararg coordinates: String, includeTransitive: Boolean = true): ModulesRuleBuilder

open fun dependOnExternalLibraries(coordinates: List<String>, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for depend on external libraries.

dependOnExternalLibrary

open fun dependOnExternalLibrary(coordinate: String, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for depend on external library.

dependOnModule

open infix fun dependOnModule(targetPath: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module.

dependOnModuleApi

open infix fun dependOnModuleApi(targetPath: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module api.

dependOnModuleImplementation

open infix fun dependOnModuleImplementation(targetPath: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module implementation.

dependOnModules

open fun dependOnModules(vararg targetPaths: String): ModulesRuleBuilder

open infix fun dependOnModules(targetPaths: List<String>): ModulesRuleBuilder

Filter or assertion criteria for depend on modules.

dependOnModuleTransitively

open infix fun dependOnModuleTransitively(targetPath: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module transitively.

dependOnModuleViaConfiguration

open fun dependOnModuleViaConfiguration(targetPath: String, configuration: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module via configuration.

haveBuildId

open infix fun haveBuildId(buildId: String): ModulesRuleBuilder

Filter or assertion criteria for have build id.

haveDependencies

open fun haveDependencies(vararg coordinates: String, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for have dependencies.

haveDependency

open fun haveDependency(coordinate: String, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for have dependency.

havePlugin

open infix fun havePlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for have plugin.

havePlugins

open fun havePlugins(vararg pluginIds: String): ModulesRuleBuilder

open infix fun havePlugins(pluginIds: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have plugins.

haveProjectDir

open infix fun haveProjectDir(dirPattern: String): ModulesRuleBuilder

Filter or assertion criteria for have project dir.

haveSourceSet

open infix fun haveSourceSet(sourceSetName: String): ModulesRuleBuilder

Filter or assertion criteria for have source set.

haveSourceSets

open fun haveSourceSets(vararg sourceSetNames: String): ModulesRuleBuilder

open infix fun haveSourceSets(sourceSetNames: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have source sets.

mayBeDependedOnBy

open fun mayBeDependedOnBy(vararg dependentPaths: String): ModulesRuleBuilder

open infix fun mayBeDependedOnBy(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun mayBeDependedOnBy(dependentPath: String): ModulesRuleBuilder

open infix fun mayBeDependedOnBy(dependentPaths: List<String>): ModulesRuleBuilder

open fun mayBeDependedOnBy(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for may be depended on by.

mayDependOn

open fun mayDependOn(vararg targetPaths: String): ModulesRuleBuilder

open infix fun mayDependOn(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun mayDependOn(targetPath: String): ModulesRuleBuilder

open infix fun mayDependOn(targetPaths: List<String>): ModulesRuleBuilder

open fun mayDependOn(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for may depend on module.

mustNotBeDependedOnBy

open fun mustNotBeDependedOnBy(vararg dependentPaths: String): ModulesRuleBuilder

open infix fun mustNotBeDependedOnBy(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun mustNotBeDependedOnBy(dependentPath: String): ModulesRuleBuilder

open infix fun mustNotBeDependedOnBy(dependentPaths: List<String>): ModulesRuleBuilder

open fun mustNotBeDependedOnBy(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for must not be depended on by.

mustNotDependOn

open fun mustNotDependOn(vararg targetPaths: String): ModulesRuleBuilder

open infix fun mustNotDependOn(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun mustNotDependOn(targetPath: String): ModulesRuleBuilder

open infix fun mustNotDependOn(targetPaths: List<String>): ModulesRuleBuilder

open fun mustNotDependOn(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for must not depend on module.

noneOf

open fun noneOf(vararg blocks: ModulesShould.() -> Unit): ModulesRuleBuilder

Filter or assertion criteria for none of.

notApplyPlugin

open infix fun notApplyPlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for not apply plugin.

notCall

open fun notCall(fqName: String): ModulesRuleBuilder

open fun notCall(kClass: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for not call.

notCall

inline fun <T : Any> ModulesShould.notCall(): ModulesRuleBuilder

Asserts that modules do not call members of type parameter T.

notContainClass

open infix fun notContainClass(fqName: String): ModulesRuleBuilder

open infix fun notContainClass(type: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for not contain class.

notContainClass

inline fun <T : Any> ModulesShould.notContainClass(): ModulesRuleBuilder

Asserts that modules do not contain the class specified by type parameter T.

notContainClasses

open fun notContainClasses(): ModulesRuleBuilder

Filter or assertion criteria for not contain classes.

notContainClassesInPackage

open infix fun notContainClassesInPackage(packagePattern: String): ModulesRuleBuilder

Filter or assertion criteria for not contain classes in package.

notContainClassesWithAnnotation

open infix fun notContainClassesWithAnnotation(annotationFqName: String): ModulesRuleBuilder

open infix fun notContainClassesWithAnnotation(annotation: KClass<out Annotation>): ModulesRuleBuilder

Filter or assertion criteria for not contain classes with annotation.

notContainClassesWithAnnotation

inline fun <T : Annotation> ModulesShould.notContainClassesWithAnnotation(): ModulesRuleBuilder

Asserts that modules do not contain classes annotated with annotation type parameter T.

notContainCycles

open fun notContainCycles(): ModulesRuleBuilder

Asserts that selected modules do not contain dependency cycles. Alias for beFreeOfCycles.

notDependOn

open fun notDependOn(vararg targetPaths: String): ModulesRuleBuilder

open infix fun notDependOn(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun notDependOn(targetPath: String): ModulesRuleBuilder

open infix fun notDependOn(targetPaths: List<String>): ModulesRuleBuilder

open fun notDependOn(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for not depend on module.

notDependOnExternalLibraries

open fun notDependOnExternalLibraries(vararg coordinates: String, includeTransitive: Boolean = true): ModulesRuleBuilder

open fun notDependOnExternalLibraries(coordinates: List<String>, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for not depend on external libraries.

notDependOnModuleTransitively

open infix fun notDependOnModuleTransitively(targetPath: String): ModulesRuleBuilder

Filter or assertion criteria for not depend on module transitively.

notDependOnModuleViaConfiguration

open fun notDependOnModuleViaConfiguration(targetPath: String, configuration: String): ModulesRuleBuilder

Filter or assertion criteria for not depend on module via configuration.

notHaveBuildId

open infix fun notHaveBuildId(buildId: String): ModulesRuleBuilder

Filter or assertion criteria for not have build id.

notHaveDependencies

open fun notHaveDependencies(vararg coordinates: String, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for not have dependencies.

notHaveDependency

open fun notHaveDependency(coordinate: String, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for not have dependency.

notHaveName

open fun notHaveName(vararg paths: String): ModulesRuleBuilder

open infix fun notHaveName(path: String): ModulesRuleBuilder

open infix fun notHaveName(paths: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have name.

notHaveNameEndingWith

open fun notHaveNameEndingWith(vararg suffixes: String): ModulesRuleBuilder

open infix fun notHaveNameEndingWith(suffix: String): ModulesRuleBuilder

open infix fun notHaveNameEndingWith(suffixes: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have name ending with.

notHaveNameMatching

open fun notHaveNameMatching(vararg patterns: String): ModulesRuleBuilder

open infix fun notHaveNameMatching(pattern: String): ModulesRuleBuilder

open infix fun notHaveNameMatching(patterns: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have name matching.

notHaveNameStartingWith

open fun notHaveNameStartingWith(vararg prefixes: String): ModulesRuleBuilder

open infix fun notHaveNameStartingWith(prefix: String): ModulesRuleBuilder

open infix fun notHaveNameStartingWith(prefixes: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have name starting with.

notHavePlugin

open infix fun notHavePlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for not have plugin.

notHavePlugins

open fun notHavePlugins(vararg pluginIds: String): ModulesRuleBuilder

open infix fun notHavePlugins(pluginIds: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have plugins.

notHaveProjectDir

open infix fun notHaveProjectDir(dirPattern: String): ModulesRuleBuilder

Filter or assertion criteria for not have project dir.

notReferenceClass

open fun notReferenceClass(fqName: String): ModulesRuleBuilder

open fun notReferenceClass(kClass: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for not reference class.

notReferenceClass

inline fun <T : Any> ModulesShould.notReferenceClass(): ModulesRuleBuilder

Asserts that modules do not reference class type parameter T.

onlyBeDependedOnBy

open fun onlyBeDependedOnBy(vararg allowedPatterns: String): ModulesRuleBuilder

open infix fun onlyBeDependedOnBy(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun onlyBeDependedOnBy(allowedPattern: String): ModulesRuleBuilder

open infix fun onlyBeDependedOnBy(allowedPatterns: List<String>): ModulesRuleBuilder

open fun onlyBeDependedOnBy(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for only be depended on by.

onlyDependOn

open fun onlyDependOn(vararg targetPaths: String): ModulesRuleBuilder

open infix fun onlyDependOn(predicate: (String) -> Boolean): ModulesRuleBuilder

open infix fun onlyDependOn(targetPath: String): ModulesRuleBuilder

open infix fun onlyDependOn(targetPaths: List<String>): ModulesRuleBuilder

open fun onlyDependOn(description: String, predicate: (String) -> Boolean): ModulesRuleBuilder

Filter or assertion criteria for only depend on module.

onlyDependOnExternalLibraries

open fun onlyDependOnExternalLibraries(vararg coordinates: String, includeTransitive: Boolean = true): ModulesRuleBuilder

open fun onlyDependOnExternalLibraries(coordinates: List<String>, includeTransitive: Boolean = true): ModulesRuleBuilder

Filter or assertion criteria for only depend on external libraries.

satisfy

open infix fun satisfy(assertion: (Module) -> Boolean): ModulesRuleBuilder

Asserts that selected modules satisfy a custom boolean condition.

open fun satisfy(assertion: (Module, MutableList<String>) -> Unit): ModulesRuleBuilder

Asserts that selected modules satisfy a custom violation-collecting assertion.

open infix fun satisfy(description: String): ModulesRuleBuilder

Asserts that selected modules satisfy custom description description.

open fun satisfy(description: String, assertion: (Module, ProjectGraph) -> Boolean): ModulesRuleBuilder

Asserts that selected modules satisfy a custom condition with description.

open fun satisfy(id: String, description: String? = null, predicate: SatisfyContext<Module>.(Module) -> Boolean): ModulesRuleBuilder

Asserts that selected modules satisfy a custom predicate within a SatisfyContext block identified by id and optional description.