-
Notifications
You must be signed in to change notification settings - Fork 71
/
CheckstyleConfiguration.java
182 lines (162 loc) · 6.83 KB
/
CheckstyleConfiguration.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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2024 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package org.sonar.plugins.checkstyle;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.batch.fs.FilePredicates;
import org.sonar.api.batch.fs.FileSystem;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.rule.ActiveRules;
import org.sonar.api.scanner.ScannerSide;
import com.google.common.annotations.VisibleForTesting;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.PropertiesExpander;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
@ExtensionPoint
@ScannerSide
public class CheckstyleConfiguration {
public static final String PROPERTY_GENERATE_XML = "sonar.checkstyle.generateXml";
private static final Logger LOG = LoggerFactory.getLogger(CheckstyleConfiguration.class);
private final CheckstyleProfileExporter confExporter;
private final ActiveRules activeRules;
private final org.sonar.api.config.Configuration conf;
private final FileSystem fileSystem;
public CheckstyleConfiguration(
org.sonar.api.config.Configuration conf,
ActiveRules activeRules,
FileSystem fileSystem) {
this.conf = conf;
confExporter = new CheckstyleProfileExporter(conf);
this.activeRules = activeRules;
this.fileSystem = fileSystem;
}
// used for unit testing
protected CheckstyleConfiguration(
org.sonar.api.config.Configuration conf,
CheckstyleProfileExporter confExporter,
ActiveRules activeRules,
FileSystem fileSystem) {
this.conf = conf;
this.confExporter = confExporter;
this.activeRules = activeRules;
this.fileSystem = fileSystem;
}
/**
* Creates and retrieves the Checkstyle configuration file with the rules from sonar.
*
* @return The location of the created Checkstyle configuration file.
* @throws IllegalStateException if the Checkstyle configuration file failed to save.
*/
public File getXmlDefinitionFile() {
final File xmlFile = new File(fileSystem.workDir(), "checkstyle.xml");
try (Writer writer = new OutputStreamWriter(new FileOutputStream(xmlFile, false),
StandardCharsets.UTF_8)) {
confExporter.exportProfile(activeRules, writer);
writer.flush();
return xmlFile;
}
catch (IOException ex) {
throw new IllegalStateException("Fail to save the Checkstyle configuration to "
+ xmlFile.getPath(), ex);
}
}
/**
* Obtains the list of input source files for Checkstyle to run against.
*
* @return The list of source files.
*/
public List<InputFile> getSourceFiles() {
final FilePredicates predicates = fileSystem.predicates();
final Iterable<InputFile> files = fileSystem.inputFiles(predicates.and(
predicates.hasLanguage(CheckstyleConstants.JAVA_KEY),
predicates.hasType(InputFile.Type.MAIN)));
final List<InputFile> fileList = new ArrayList<>();
for (InputFile file : files) {
fileList.add(file);
}
return fileList;
}
/**
* Obtains the file location of the xml report from Checkstyle.
* This location is only valid if {@link #PROPERTY_GENERATE_XML}
* is turned on.
*
* @return The file location or {@code null}.
*/
public File getTargetXmlReport() {
return conf.getBoolean(PROPERTY_GENERATE_XML)
.map(aBoolean -> new File(fileSystem.workDir(), "checkstyle-result.xml"))
.orElse(null);
}
/**
* Generates the checkstyle configuration with the rules from sonar.
*
* @return The Checkstyle configuration.
* @throws CheckstyleException if there is an error generating the Checkstyle configuration.
*/
public Configuration getCheckstyleConfiguration() throws CheckstyleException {
final File xmlConfig = getXmlDefinitionFile();
LOG.info("Checkstyle configuration: {}", xmlConfig.getAbsolutePath());
final Configuration configuration = toCheckstyleConfiguration(xmlConfig);
defineCharset(configuration);
return configuration;
}
@VisibleForTesting
static Configuration toCheckstyleConfiguration(File xmlConfig) throws CheckstyleException {
return ConfigurationLoader.loadConfiguration(xmlConfig.getAbsolutePath(),
new PropertiesExpander(new Properties()));
}
private void defineCharset(Configuration configuration) {
defineModuleCharset(configuration);
for (Configuration module : configuration.getChildren()) {
defineModuleCharset(module);
}
}
private void defineModuleCharset(Configuration module) {
if (module instanceof DefaultConfiguration
&& ("Checker".equals(module.getName())
|| "com.puppycrawl.tools.checkstyle.Checker".equals(module.getName()))) {
final Charset charset = getCharset();
final String charsetName = charset.name();
LOG.info("Checkstyle charset: {}", charsetName);
((DefaultConfiguration) module).addProperty("charset", charsetName);
}
}
/**
* Retrieves the charset of the underlying file system.
*
* @return The charset.
*/
public Charset getCharset() {
return fileSystem.encoding();
}
}