/
RuleSetConfigPrinterTest.kt
237 lines (207 loc) · 8.49 KB
/
RuleSetConfigPrinterTest.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
package io.gitlab.arturbosch.detekt.generator.printer.defaultconfig
import io.github.detekt.utils.yaml
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.valuesWithReason
import io.gitlab.arturbosch.detekt.generator.collection.Active
import io.gitlab.arturbosch.detekt.generator.collection.Configuration
import io.gitlab.arturbosch.detekt.generator.collection.DefaultValue
import io.gitlab.arturbosch.detekt.generator.collection.Inactive
import io.gitlab.arturbosch.detekt.generator.collection.Rule
import io.gitlab.arturbosch.detekt.generator.collection.RuleSetProvider
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.ValueSource
internal class RuleSetConfigPrinterTest {
private val ruleSetProviderTemplate = RuleSetProvider(
name = "rulesetName",
description = "description",
defaultActivationStatus = Inactive
)
private val ruleTemplate = Rule(
name = "ruleName",
description = "",
nonCompliantCodeExample = "",
compliantCodeExample = "",
defaultActivationStatus = Inactive,
severity = "",
debt = "",
aliases = null,
parent = ""
)
private val configurationTemplate = Configuration(
name = "name",
description = "description",
defaultValue = DefaultValue.of(1),
defaultAndroidValue = null,
deprecated = null,
)
@Nested
inner class PrintRuleSet {
@Test
fun `starts with name on top level`() {
val ruleset = ruleSetProviderTemplate.copy(name = "rule-set-name")
val actual = yaml { printRuleSet(ruleset, emptyList()) }
assertThat(actual).startsWith("rule-set-name:\n")
}
@Test
fun `includes all rules`() {
val rules = listOf(ruleTemplate.copy(name = "RuleA"), ruleTemplate.copy(name = "RuleB"))
val actual = yaml { printRuleSet(ruleSetProviderTemplate, rules) }
assertThat(actual.lines()).contains(" RuleA:", " RuleB:")
}
@Nested
inner class ActivationStatus {
@Test
fun `has active property`() {
val ruleset = ruleSetProviderTemplate.copy(defaultActivationStatus = Active("1.0.0"))
val actual = yaml { printRuleSet(ruleset, emptyList()) }
assertThat(actual.lines()).contains(" active: true")
}
@Test
fun `has active property if inactive`() {
val ruleset = ruleSetProviderTemplate.copy(defaultActivationStatus = Inactive)
val actual = yaml { printRuleSet(ruleset, emptyList()) }
assertThat(actual.lines()).contains(" active: false")
}
}
}
@Nested
inner class PrintRule {
@Test
fun `starts with rule name`() {
val rule = ruleTemplate.copy(name = "RuleA")
val actual = yaml { printRule(rule) }
assertThat(actual).startsWith("RuleA:\n")
}
@Nested
inner class ActivationStatus {
@Test
fun `has active property`() {
val rule = ruleTemplate.copy(defaultActivationStatus = Active("1.0.0"))
val actual = yaml { printRule(rule) }
assertThat(actual.lines()).contains(" active: true")
}
@Test
fun `has active property if inactive`() {
val rule = ruleTemplate.copy(defaultActivationStatus = Inactive)
val actual = yaml { printRule(rule) }
assertThat(actual.lines()).contains(" active: false")
}
}
@Nested
inner class AutoCorrect {
@Test
fun `has auto correct property`() {
val rule = ruleTemplate.copy(autoCorrect = true)
val actual = yaml { printRule(rule) }
assertThat(actual.lines()).contains(" autoCorrect: true")
}
@Test
fun `omits auto correct property if false`() {
val rule = ruleTemplate.copy(autoCorrect = false)
val actual = yaml { printRule(rule) }
assertThat(actual).doesNotContain(Config.AUTO_CORRECT_KEY)
}
}
@Nested
inner class Exclusion {
@Test
fun `rule is excluded`() {
val anExclusion = exclusions[0]
val anExcludedRuleName = anExclusion.rules.first()
val rule = ruleTemplate.copy(name = anExcludedRuleName)
val actual = yaml { printRule(rule) }
assertThat(actual.lines()).contains(" excludes: ${anExclusion.pattern}")
}
@Test
fun `omits excludes property if rule is not excluded in any exclusion`() {
val rule = ruleTemplate.copy(name = "ARuleNameThatIsNotExcluded")
val actual = yaml { printRule(rule) }
assertThat(actual).doesNotContain(Config.EXCLUDES_KEY)
}
}
}
@Nested
inner class PrintConfiguration {
@Test
fun `ignore deprecated`() {
val given = configurationTemplate.copy(deprecated = "use something else")
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEmpty()
}
@Nested
inner class DefaultValues {
@Test
fun `int default value`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(99))
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEqualTo("name: 99")
}
@Test
fun `boolean default value`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(false))
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEqualTo("name: false")
}
@ValueSource(
strings = [
"", " ", "a", "a b", "a\$b"
]
)
@ParameterizedTest
fun `string default value is quoted`(value: String) {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(value))
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEqualTo("name: '$value'")
}
@Test
fun `empty list default value uses array syntax`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(emptyList()))
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEqualTo("name: []")
}
@Test
fun `string list default value`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(listOf("a", "b", "c")))
val actual = yaml { printConfiguration(given) }
val expected = """
|name:
| - 'a'
| - 'b'
| - 'c'
""".trimMargin()
assertThat(actual).isEqualTo(expected)
}
@Test
fun `empty ValuesWithReason default value uses empty list syntax`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(valuesWithReason()))
val actual = yaml { printConfiguration(given) }
assertThat(actual).isEqualTo("name: []")
}
@Test
fun `ValuesWithReason default value block syntax`() {
val given = configurationTemplate.copy(
defaultValue = DefaultValue.of(
valuesWithReason(
"a" to "reason a",
"b" to null,
"c" to "reason c",
)
)
)
val actual = yaml { printConfiguration(given) }
val expected = """
|name:
| - reason: 'reason a'
| value: 'a'
| - value: 'b'
| - reason: 'reason c'
| value: 'c'
""".trimMargin()
assertThat(actual).isEqualTo(expected)
}
}
}
}