This repository has been archived by the owner on Feb 11, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
/
CheckstyleIntegrationTest.groovy
215 lines (186 loc) · 8.77 KB
/
CheckstyleIntegrationTest.groovy
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
package com.novoda.staticanalysis.internal.checkstyle
import com.novoda.test.Fixtures
import com.novoda.test.TestProject
import com.novoda.test.TestProjectRule
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.Parameterized
import static com.novoda.test.LogsSubject.assertThat
@RunWith(Parameterized.class)
public class CheckstyleIntegrationTest {
public static final String DEFAULT_CONFIG = "configFile new File('${Fixtures.Checkstyle.MODULES.path}')"
@Parameterized.Parameters
public static List<Object[]> rules() {
return [TestProjectRule.forJavaProject(), TestProjectRule.forAndroidProject()].collect { [it] as Object[] }
}
@Rule
public final TestProjectRule projectRule
public CheckstyleIntegrationTest(TestProjectRule projectRule) {
this.projectRule = projectRule
}
@Test
public void shouldFailBuildWhenCheckstyleWarningsOverTheThreshold() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withPenalty('''{
maxWarnings = 0
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.buildAndFail('check')
assertThat(result.logs).containsLimitExceeded(0, 1)
assertThat(result.logs).containsCheckstyleViolations(0, 1,
result.buildFile('reports/checkstyle/main.html'))
}
@Test
public void shouldFailBuildWhenCheckstyleErrorsOverTheThreshold() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withPenalty('''{
maxWarnings = 100
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.buildAndFail('check')
assertThat(result.logs).containsLimitExceeded(1, 0)
assertThat(result.logs).containsCheckstyleViolations(1, 1,
result.buildFile('reports/checkstyle/main.html'),
result.buildFile('reports/checkstyle/test.html'))
}
@Test
public void shouldNotFailBuildWhenNoCheckstyleWarningsOrErrorsEncounteredAndNoThresholdTrespassed() {
TestProject.Result result = projectRule.newProject()
.withPenalty('''{
maxWarnings = 0
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).doesNotContainCheckstyleViolations()
}
@Test
public void shouldNotFailBuildWhenCheckstyleWarningsAndErrorsEncounteredAndNoThresholdTrespassed() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withPenalty('''{
maxWarnings = 100
maxErrors = 100
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).containsCheckstyleViolations(1, 1,
result.buildFile('reports/checkstyle/main.html'),
result.buildFile('reports/checkstyle/test.html'))
}
@Test
public void shouldNotFailBuildWhenCheckstyleConfiguredToNotIgnoreFailures() {
projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withFile(Fixtures.Checkstyle.MODULES, 'config/checkstyle/checkstyle.xml')
.withPenalty('''{
maxWarnings = 1
maxErrors = 1
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG, "ignoreFailures = false"))
.build('check')
}
@Test
public void shouldNotFailBuildWhenCheckstyleConfiguredToExcludePattern() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withFile(Fixtures.Checkstyle.MODULES, 'config/checkstyle/checkstyle.xml')
.withPenalty('''{
maxWarnings = 1
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG, "exclude 'Greeter.java'"))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).containsCheckstyleViolations(0, 1,
result.buildFile('reports/checkstyle/main.html'))
}
@Test
public void shouldNotFailBuildWhenCheckstyleConfiguredToIgnoreFaultySourceFolder() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withFile(Fixtures.Checkstyle.MODULES, 'config/checkstyle/checkstyle.xml')
.withPenalty('''{
maxWarnings = 1
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG, "exclude project.fileTree('${Fixtures.Checkstyle.SOURCES_WITH_ERRORS}')"))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).containsCheckstyleViolations(0, 1,
result.buildFile('reports/checkstyle/main.html'))
}
@Test
public void shouldNotFailBuildWhenCheckstyleConfiguredToIgnoreFaultySourceSet() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withFile(Fixtures.Checkstyle.MODULES, 'config/checkstyle/checkstyle.xml')
.withPenalty('''{
maxWarnings = 1
maxErrors = 0
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG, "exclude ${projectRule.printSourceSet('test')}.java.srcDirs"))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).containsCheckstyleViolations(0, 1,
result.buildFile('reports/checkstyle/main.html'))
}
@Test
public void shouldNotFailWhenCheckstyleNotConfigured() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withSourceSet('test', Fixtures.Checkstyle.SOURCES_WITH_ERRORS)
.withPenalty('''{
maxWarnings = 0
maxErrors = 0
}''')
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).doesNotContainCheckstyleViolations()
}
@Test
public void shouldNotFailBuildWhenNoCheckstyleWarningsOrErrorsEncounteredAndNegativeThresholdsProvided() {
TestProject.Result result = projectRule.newProject()
.withPenalty('''{
maxWarnings = -10
maxErrors = -10
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.build('check')
assertThat(result.logs).doesNotContainLimitExceeded()
assertThat(result.logs).doesNotContainCheckstyleViolations()
}
@Test
public void shouldFailBuildWhenCheckstyleWarningsOrErrorsEncounteredAndNegativeThresholdsProvided() {
TestProject.Result result = projectRule.newProject()
.withSourceSet('main', Fixtures.Checkstyle.SOURCES_WITH_WARNINGS)
.withPenalty('''{
maxWarnings = -10
maxErrors = -10
}''')
.withCheckstyle(checkstyle(DEFAULT_CONFIG))
.buildAndFail('check')
assertThat(result.logs).containsLimitExceeded(0, 1)
assertThat(result.logs).containsCheckstyleViolations(0, 1,
result.buildFile('reports/checkstyle/main.html'))
}
private static String checkstyle(String configFile, String... configs) {
"""checkstyle {
${configFile}
${configs.join('\n\t\t\t')}
}"""
}
}