forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MissingRulesConfigValidator.kt
81 lines (70 loc) · 3.13 KB
/
MissingRulesConfigValidator.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
package io.gitlab.arturbosch.detekt.core.config.validation
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.Notification
import io.gitlab.arturbosch.detekt.api.RuleSetProvider
import io.gitlab.arturbosch.detekt.api.internal.DefaultRuleSetProvider
import io.gitlab.arturbosch.detekt.api.internal.SimpleNotification
import io.gitlab.arturbosch.detekt.core.config.YamlConfig
import java.util.ServiceLoader
internal class MissingRulesConfigValidator(
private val baseline: YamlConfig,
private val excludePatterns: Set<Regex>
) : AbstractYamlConfigValidator() {
override fun validate(
configToValidate: YamlConfig,
settings: ValidationSettings
): Collection<Notification> {
if (!settings.checkExhaustiveness) {
return emptyList()
}
return defaultRuleSetNames.flatMap { ruleSet -> validateRuleSet(ruleSet, configToValidate) }
}
private fun validateRuleSet(
ruleSet: String,
configToValidate: YamlConfig
): List<Notification> {
val ruleSetConfigToValidate = configToValidate.getSubMapOrNull(ruleSet)
val ruleSetConfigFromBaseline = baseline.getSubMapOrNull(ruleSet)
return when {
ruleSetConfigFromBaseline == null -> emptyList()
ruleSetConfigToValidate == null -> listOf(ruleSetMissing(ruleSet))
else -> checkForMissingRules(ruleSet, ruleSetConfigToValidate, ruleSetConfigFromBaseline)
}
}
private fun checkForMissingRules(
ruleSetName: String,
ruleSetConfigToValidate: Map<String, Any>,
ruleSetConfigFromBaseline: Map<String, Any>
): List<Notification> {
if (ruleSetConfigToValidate[Config.ACTIVE_KEY] == false) {
return emptyList()
}
return ruleSetConfigFromBaseline.keys
.filter { ruleNameCandidate -> excludePatterns.none { it.matches("$ruleSetName>$ruleNameCandidate") } }
.filter { ruleName -> !ruleSetConfigToValidate.containsKey(ruleName) }
.map { ruleName -> ruleMissing(ruleName, ruleSetName) }
}
private fun ruleMissing(ruleName: String, ruleSetName: String): Notification =
SimpleNotification(
"Rule '$ruleName' from the '$ruleSetName' rule set is missing in the configuration.",
Notification.Level.Warning
)
private fun ruleSetMissing(ruleSetName: String): Notification =
SimpleNotification(
"Rule set '$ruleSetName' is missing in the configuration.",
Notification.Level.Warning
)
@Suppress("UNCHECKED_CAST")
private fun YamlConfig.getSubMapOrNull(propertyName: String) = properties[propertyName] as? Map<String, Any>
companion object {
private val defaultRuleSetNames: List<String> by lazy(Companion::loadDefaultRuleSets)
private fun loadDefaultRuleSets(): List<String> {
return ServiceLoader.load(
RuleSetProvider::class.java,
MissingRulesConfigValidator::class.java.classLoader
)
.filterIsInstance<DefaultRuleSetProvider>()
.map { it.ruleSetId }
}
}
}