-
Notifications
You must be signed in to change notification settings - Fork 135
/
FindbugsExecutor.java
314 lines (266 loc) · 11.9 KB
/
FindbugsExecutor.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/*
* SonarQube Findbugs Plugin
* Copyright (C) 2012 SonarSource
* sonarqube@googlegroups.com
*
* This program 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 program 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 program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.plugins.findbugs;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Throwables;
import com.google.common.collect.Lists;
import edu.umd.cs.findbugs.BugCollection;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.DetectorFactoryCollection;
import edu.umd.cs.findbugs.FindBugs;
import edu.umd.cs.findbugs.FindBugs2;
import edu.umd.cs.findbugs.Plugin;
import edu.umd.cs.findbugs.PluginException;
import edu.umd.cs.findbugs.Priorities;
import edu.umd.cs.findbugs.Project;
import edu.umd.cs.findbugs.XMLBugReporter;
import edu.umd.cs.findbugs.config.UserPreferences;
import edu.umd.cs.findbugs.plugins.DuplicatePluginIdException;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.ScannerSide;
import org.sonar.api.batch.fs.FileSystem;
import org.sonar.api.config.Configuration;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.*;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@ScannerSide
public class FindbugsExecutor {
private static final String FINDBUGS_CORE_PLUGIN_ID = "edu.umd.cs.findbugs.plugins.core";
private static final Logger LOG = LoggerFactory.getLogger(FindbugsExecutor.class);
public static final List<String> EXISTING_FINDBUGS_REPORT_PATHS = Arrays.asList("/target/findbugsXml.xml","/target/spotbugsXml.xml");
private FileSystem fs;
private Configuration config;
/**
* Map of priority level names to their numeric values.
*/
private static Map<String, Integer> priorityNameToValueMap = new HashMap<String, Integer>();
static {
priorityNameToValueMap.put("high", Priorities.HIGH_PRIORITY);
priorityNameToValueMap.put("medium", Priorities.NORMAL_PRIORITY);
priorityNameToValueMap.put("low", Priorities.LOW_PRIORITY);
priorityNameToValueMap.put("experimental", Priorities.EXP_PRIORITY);
}
private static final Integer DEFAULT_PRIORITY = Priorities.NORMAL_PRIORITY;
private final FindbugsConfiguration configuration;
public FindbugsExecutor(FindbugsConfiguration configuration, FileSystem fs, Configuration config) {
this.configuration = configuration;
this.fs = fs;
this.config = config;
}
@VisibleForTesting
Collection<ReportedBug> execute() {
return execute(true);
}
public Collection<ReportedBug> execute(boolean useAllPlugin) {
return execute(useAllPlugin,useAllPlugin);
}
public Collection<ReportedBug> execute(boolean useFbContrib, boolean useFindSecBugs) {
// We keep a handle on the current security manager because FB plays with it and we need to restore it before shutting down the executor
// service
SecurityManager currentSecurityManager = System.getSecurityManager();
ClassLoader initialClassLoader = Thread.currentThread().getContextClassLoader();
Thread.currentThread().setContextClassLoader(FindBugs2.class.getClassLoader());
// This is a dirty workaround, but unfortunately there is no other way to make Findbugs generate english messages only - see SONARJAVA-380
Locale initialLocale = Locale.getDefault();
Locale.setDefault(Locale.ENGLISH);
OutputStream xmlOutput = null;
Collection<Plugin> customPlugins = null;
ExecutorService executorService = Executors.newSingleThreadExecutor();
try {
final FindBugs2 engine = new FindBugs2();
Project project = configuration.getFindbugsProject();
if(project.getFileCount() == 0) {
LOG.info("Findbugs analysis skipped for this project.");
return new ArrayList<>();
}
customPlugins = loadFindbugsPlugins(useFbContrib,useFindSecBugs);
disableUpdateChecksOnEveryPlugin();
engine.setProject(project);
XMLBugReporter xmlBugReporter = new XMLBugReporter(project);
xmlBugReporter.setPriorityThreshold(determinePriorityThreshold());
xmlBugReporter.setAddMessages(true);
File xmlReport = configuration.getTargetXMLReport();
LOG.info("Findbugs output report: " + xmlReport.getAbsolutePath());
xmlOutput = FileUtils.openOutputStream(xmlReport);
xmlBugReporter.setOutputStream(new PrintStream(xmlOutput));
engine.setBugReporter(xmlBugReporter);
UserPreferences userPreferences = UserPreferences.createDefaultUserPreferences();
userPreferences.setEffort(configuration.getEffort());
engine.setUserPreferences(userPreferences);
engine.addFilter(configuration.saveIncludeConfigXml().getAbsolutePath(), true);
for (File filterFile : configuration.getExcludesFilters()) {
if (filterFile.isFile()) {
LOG.info("Use filter-file: {}", filterFile);
engine.addFilter(filterFile.getAbsolutePath(), false);
} else {
LOG.warn("FindBugs filter-file not found: {}", filterFile);
}
}
engine.setDetectorFactoryCollection(DetectorFactoryCollection.instance());
engine.setAnalysisFeatureSettings(FindBugs.DEFAULT_EFFORT);
engine.finishSettings();
//Load findbugs report location
List<String> potentialReportPaths = new ArrayList<>();
potentialReportPaths.addAll(EXISTING_FINDBUGS_REPORT_PATHS);
String[] paths = config.getStringArray(FindbugsConstants.REPORT_PATHS);
if(paths != null) potentialReportPaths.addAll(Arrays.asList(paths));
boolean foundExistingReport = false;
//Look for existing reports relative to subproject directory
reportPaths : for(String potentialPath : potentialReportPaths) {
File findbugsReport = new File(fs.baseDir(), potentialPath);
if(findbugsReport.exists() && findbugsReport.length() > 0) {
LOG.info("FindBugs report is already generated {}. Reusing the report.",findbugsReport.getAbsolutePath());
xmlBugReporter.getBugCollection().readXML(new FileReader(findbugsReport));
foundExistingReport = true;
break reportPaths;
}
}
if(!foundExistingReport) { //Avoid rescanning the project if FindBugs was run already
executorService.submit(new FindbugsTask(engine)).get(configuration.getTimeout(), TimeUnit.MILLISECONDS);
}
return toReportedBugs(xmlBugReporter.getBugCollection());
} catch (TimeoutException e) {
throw new IllegalStateException("Can not execute Findbugs with a timeout threshold value of " + configuration.getTimeout() + " milliseconds", e);
} catch (Exception e) {
throw new IllegalStateException("Can not execute Findbugs", e);
} finally {
// we set back the original security manager BEFORE shutting down the executor service, otherwise there's a problem with Java 5
System.setSecurityManager(currentSecurityManager);
resetCustomPluginList(customPlugins);
executorService.shutdown();
IOUtils.closeQuietly(xmlOutput);
Thread.currentThread().setContextClassLoader(initialClassLoader);
Locale.setDefault(initialLocale);
}
}
private static Collection<ReportedBug> toReportedBugs(BugCollection bugCollection) {
// We need to retrieve information such as the message before we shut everything down as we will lose any custom
// bug messages
final Collection<ReportedBug> bugs = new ArrayList<ReportedBug>();
for (final BugInstance bugInstance : bugCollection) {
if (bugInstance.getPrimarySourceLineAnnotation() == null) {
LOG.warn("No source line for " + bugInstance.getType());
continue;
}
bugs.add(new ReportedBug(bugInstance));
}
return bugs;
}
private Integer determinePriorityThreshold() {
Integer integer = priorityNameToValueMap.get(configuration.getConfidenceLevel());
if (integer == null) {
integer = DEFAULT_PRIORITY;
}
return integer;
}
private static class FindbugsTask implements Callable<Object> {
private final FindBugs2 engine;
public FindbugsTask(FindBugs2 engine) {
this.engine = engine;
}
@Override
public Object call() {
try {
engine.execute();
return null;
} catch (InterruptedException | IOException e) {
throw Throwables.propagate(e);
} finally {
engine.dispose();
}
}
}
private Collection<Plugin> loadFindbugsPlugins(boolean useFbContrib,boolean useFindSecBugs) {
ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
List<String> pluginJarPathList = Lists.newArrayList();
try {
Enumeration<URL> urls = contextClassLoader.getResources("findbugs.xml");
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
pluginJarPathList.add(normalizeUrl(url));
}
//Add fb-contrib plugin.
if (useFbContrib && configuration.getFbContribJar() != null) {
// fb-contrib plugin is packaged by Maven. It is not available during execution of unit tests.
pluginJarPathList.add(configuration.getFbContribJar().getAbsolutePath());
}
//Add find-sec-bugs plugin. (same as fb-contrib)
if (useFindSecBugs && configuration.getFindSecBugsJar() != null) {
pluginJarPathList.add(configuration.getFindSecBugsJar().getAbsolutePath());
}
} catch (IOException e) {
throw new IllegalStateException(e);
} catch (URISyntaxException e) {
throw new IllegalStateException(e);
}
List<Plugin> customPluginList = Lists.newArrayList();
for (String path : pluginJarPathList) {
try {
Plugin plugin = Plugin.addCustomPlugin(new File(path).toURI(), contextClassLoader);
if (plugin != null) {
customPluginList.add(plugin);
LOG.info("Loading findbugs plugin: " + path);
}
} catch (PluginException e) {
LOG.warn("Failed to load plugin for custom detector: " + path);
LOG.debug("Cause of failure", e);
} catch (DuplicatePluginIdException e) {
// FB Core plugin is always loaded, so we'll get an exception for it always
if (!FINDBUGS_CORE_PLUGIN_ID.equals(e.getPluginId())) {
// log only if it's not the FV Core plugin
LOG.debug("Plugin already loaded: exception ignored: " + e.getMessage(), e);
}
}
}
return customPluginList;
}
private static String normalizeUrl(URL url) throws URISyntaxException {
return StringUtils.removeStart(StringUtils.substringBefore(url.toURI().getSchemeSpecificPart(), "!"), "file:");
}
/**
* Disable the update check for every plugin. See http://findbugs.sourceforge.net/updateChecking.html
*/
private static void disableUpdateChecksOnEveryPlugin() {
for (Plugin plugin : Plugin.getAllPlugins()) {
plugin.setMyGlobalOption("noUpdateChecks", "true");
}
}
private static void resetCustomPluginList(Collection<Plugin> customPlugins) {
if (customPlugins != null) {
for (Plugin plugin : customPlugins) {
Plugin.removeCustomPlugin(plugin);
}
}
}
}