-
Notifications
You must be signed in to change notification settings - Fork 111
/
CheckstyleValidator.java
267 lines (255 loc) · 9.05 KB
/
CheckstyleValidator.java
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/*
* Copyright (c) 2011-2024 Qulice.com
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.checkstyle;
import com.jcabi.aspects.Tv;
import com.jcabi.log.Logger;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.PropertiesExpander;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.qulice.spi.Environment;
import com.qulice.spi.ResourceValidator;
import com.qulice.spi.Violation;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import org.apache.commons.lang3.StringUtils;
import org.cactoos.text.IoCheckedText;
import org.cactoos.text.Replaced;
import org.cactoos.text.TextOf;
import org.cactoos.text.Trimmed;
import org.xml.sax.InputSource;
/**
* Validator with Checkstyle.
*
* @since 0.3
* @checkstyle ClassDataAbstractionCoupling (260 lines)
*/
public final class CheckstyleValidator implements ResourceValidator {
/**
* Checkstyle checker.
*/
private final Checker checker;
/**
* Listener of checkstyle messages.
*/
private final CheckstyleListener listener;
/**
* Environment to use.
*/
private final Environment env;
/**
* Constructor.
* @param env Environment to use.
*/
@SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
public CheckstyleValidator(final Environment env) {
this.env = env;
this.checker = new Checker();
this.checker.setModuleClassLoader(
Thread.currentThread().getContextClassLoader()
);
try {
this.checker.configure(this.configuration());
} catch (final CheckstyleException ex) {
throw new IllegalStateException("Failed to configure checker", ex);
}
this.listener = new CheckstyleListener(this.env);
this.checker.addListener(this.listener);
}
@Override
@SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
public Collection<Violation> validate(final Collection<File> files) {
final List<File> sources = this.getNonExcludedFiles(files);
try {
this.checker.process(sources);
} catch (final CheckstyleException ex) {
throw new IllegalStateException("Failed to process files", ex);
}
final List<AuditEvent> events = this.listener.events();
final Collection<Violation> results = new LinkedList<>();
for (final AuditEvent event : events) {
final String check = event.getSourceName();
results.add(
new Violation.Default(
this.name(),
check.substring(check.lastIndexOf('.') + 1),
event.getFileName(),
String.valueOf(event.getLine()),
event.getMessage()
)
);
}
return results;
}
@Override public String name() {
return "Checkstyle";
}
/**
* Filters out excluded files from further validation.
* @param files Files to validate
* @return List of relevant files
*/
public List<File> getNonExcludedFiles(final Collection<File> files) {
final List<File> relevant = new LinkedList<>();
for (final File file : files) {
final String name = file.getPath().substring(
this.env.basedir().toString().length()
);
if (this.env.exclude("checkstyle", name)) {
continue;
}
if (!name.matches("^.*\\.java$")) {
continue;
}
relevant.add(file);
}
return relevant;
}
/**
* Load checkstyle configuration.
* @return The configuration just loaded
* @see #validate(Collection)
*/
private Configuration configuration() {
final File cache =
new File(this.env.tempdir(), "checkstyle/checkstyle.cache");
final File parent = cache.getParentFile();
if (!parent.exists() && !parent.mkdirs()) {
throw new IllegalStateException(
String.format(
"Unable to create directories needed for %s",
cache.getPath()
)
);
}
final Properties props = new Properties();
props.setProperty("cache.file", cache.getPath());
props.setProperty("header", this.header());
final InputSource src = new InputSource(
this.getClass().getResourceAsStream("checks.xml")
);
final Configuration config;
try {
config = ConfigurationLoader.loadConfiguration(
src,
new PropertiesExpander(props),
ConfigurationLoader.IgnoredModulesOptions.OMIT
);
} catch (final CheckstyleException ex) {
throw new IllegalStateException("Failed to load config", ex);
}
return config;
}
/**
* Create header content, from file.
* @return The content of header
* @see #configuration()
*/
private String header() {
final String name = this.env.param("license", "LICENSE.txt");
final URL url = this.toUrl(name);
final String content;
try {
content = new IoCheckedText(
new Replaced(
new Trimmed(
new TextOf(
url.openStream()
)
),
"[\\r\\n]+$",
""
)
).asString();
} catch (final IOException ex) {
throw new IllegalStateException("Failed to read license", ex);
}
final StringBuilder builder = new StringBuilder(Tv.HUNDRED);
final String eol = System.getProperty("line.separator");
builder.append("/*").append(eol);
for (final String line
: StringUtils.splitPreserveAllTokens(content, eol)) {
builder.append(" *");
if (!line.trim().isEmpty()) {
builder.append(' ').append(line.trim());
}
builder.append(eol);
}
builder.append(" */");
final String license = builder.toString();
Logger.debug(this, "LICENSE found: %s", url);
Logger.debug(
this,
"LICENSE full text after parsing:\n%s",
license
);
return license;
}
/**
* Convert file name to URL.
* @param name The name of file
* @return The URL
* @see #header()
*/
private URL toUrl(final String name) {
final URL url;
if (name.startsWith("file:")) {
try {
url = Paths.get(name.substring(5)).toUri().toURL();
} catch (final MalformedURLException ex) {
throw new IllegalStateException("Invalid URL", ex);
}
} else {
url = this.env.classloader().getResource(name);
if (url == null) {
throw new IllegalStateException(
String.format(
"'%s' resource is not found in classpath",
name
)
);
}
}
return url;
}
}