-
-
Notifications
You must be signed in to change notification settings - Fork 755
/
XmlOutputFormatSpec.kt
209 lines (182 loc) · 7.75 KB
/
XmlOutputFormatSpec.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
package io.github.detekt.report.xml
import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.test.TestDetektion
import io.gitlab.arturbosch.detekt.test.createIssue
import io.gitlab.arturbosch.detekt.test.createIssueForRelativePath
import io.gitlab.arturbosch.detekt.test.createLocation
import io.gitlab.arturbosch.detekt.test.createRuleInfo
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.EnumSource
import java.util.Locale
import kotlin.io.path.Path
import kotlin.io.path.absolute
import kotlin.io.path.invariantSeparatorsPathString
private const val TAB = "\t"
class XmlOutputFormatSpec {
private val entity1 = Entity(
"Sample1",
"",
createLocation(
path = "src/main/com/sample/Sample1.kt",
position = 11 to 1,
)
)
private val entity2 = Entity(
"Sample2",
"",
createLocation(
path = "src/main/com/sample/Sample2.kt",
position = 22 to 2,
)
)
private val outputFormat = XmlOutputReport()
@Test
fun `renders empty report`() {
val result = outputFormat.render(TestDetektion())
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
</checkstyle>
""".trimIndent()
)
}
@Test
fun `renders one reported issue in single file`() {
val smell = createIssue("id_a", entity1, "TestMessage")
val result = outputFormat.render(TestDetektion(smell))
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="${entity1.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
</file>
</checkstyle>
""".trimIndent()
)
}
@Test
fun `renders two reported issues in single file`() {
val smell1 = createIssue("id_a", entity1, "TestMessage")
val smell2 = createIssue("id_b", entity1, "TestMessage")
val result = outputFormat.render(TestDetektion(smell1, smell2))
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="${entity1.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_b" />
</file>
</checkstyle>
""".trimIndent()
)
}
@Test
fun `renders one reported issue across multiple files`() {
val smell1 = createIssue("id_a", entity1, "TestMessage")
val smell2 = createIssue("id_a", entity2, "TestMessage")
val result = outputFormat.render(TestDetektion(smell1, smell2))
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="${entity1.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
</file>
<file name="${entity2.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_a" />
</file>
</checkstyle>
""".trimIndent()
)
}
@Test
fun `renders issues with relative path`() {
val issueA = createIssueForRelativePath(
ruleInfo = createRuleInfo("id_a"),
basePath = "${System.getProperty("user.dir")}/Users/tester/detekt/",
relativePath = "Sample1.kt"
)
val issueB = createIssueForRelativePath(
ruleInfo = createRuleInfo("id_b"),
basePath = "${System.getProperty("user.dir")}/Users/tester/detekt/",
relativePath = "Sample2.kt"
)
val outputFormat = XmlOutputReport()
outputFormat.basePath = Path("Users/tester/detekt/").absolute()
val result = outputFormat.render(TestDetektion(issueA, issueB))
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="Sample1.kt">
$TAB<error line="1" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
</file>
<file name="Sample2.kt">
$TAB<error line="1" column="1" severity="error" message="TestMessage" source="detekt.id_b" />
</file>
</checkstyle>
""".trimIndent()
)
}
@Test
fun `renders two reported issues across multiple files`() {
val smell1 = createIssue("id_a", entity1, "TestMessage")
val smell2 = createIssue("id_b", entity1, "TestMessage")
val smell3 = createIssue("id_a", entity2, "TestMessage")
val smell4 = createIssue("id_b", entity2, "TestMessage")
val result = outputFormat.render(
TestDetektion(
smell1,
smell2,
smell3,
smell4
)
)
assertThat(result).isEqualTo(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="${entity1.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
$TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_b" />
</file>
<file name="${entity2.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_a" />
$TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_b" />
</file>
</checkstyle>
""".trimIndent()
)
}
@Nested
inner class `severity level conversion` {
@ParameterizedTest
@EnumSource(Severity::class)
fun `renders detektion with severity as XML with severity`(severity: Severity) {
val xmlSeverity = severity.name.lowercase(Locale.US)
val issue = createIssue(
ruleName = "issue_id",
entity = entity1,
message = "message",
severity = severity,
)
val expected = """
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
<file name="${entity1.location.filePath.absolutePath.invariantSeparatorsPathString}">
$TAB<error line="${issue.location.source.line}" column="${issue.location.source.column}" severity="$xmlSeverity" message="${issue.message}" source="detekt.${issue.ruleInfo.id}" />
</file>
</checkstyle>
""".trimIndent()
val actual = outputFormat.render(TestDetektion(issue))
assertThat(actual).isEqualTo(expected)
}
}
}