-
Notifications
You must be signed in to change notification settings - Fork 11
/
ExternalUtils.java
287 lines (263 loc) · 9.93 KB
/
ExternalUtils.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
package com.coala.core.utils;
import org.apache.commons.exec.CommandLine;
import org.apache.commons.exec.DefaultExecuteResultHandler;
import org.apache.commons.exec.DefaultExecutor;
import org.apache.commons.exec.ExecuteException;
import org.apache.commons.exec.ExecuteWatchdog;
import org.apache.commons.exec.Executor;
import org.apache.commons.exec.PumpStreamHandler;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.json.JSONArray;
import org.json.JSONObject;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Iterator;
public class ExternalUtils {
/**
* Invoke coala-json.
*
* @param file
* The IFile to run the analysis on.
* @param bear
* The coala Bear to use for analysis.
* @throws IOException
* exception
* @throws ExecuteException
* exception
* @throws InterruptedException
* exception
*/
public static void runBearOnFile(final IFile file, String bear)
throws ExecuteException, IOException, InterruptedException {
if (!checkPrerequisite("coala")) {
DialogUtils.installcoalaDialog();
return;
}
String path = file.getRawLocation().toOSString();
CommandLine cmdLine = new CommandLine("coala-json");
cmdLine.addArgument("-f" + path);
cmdLine.addArgument("-b" + bear);
System.out.println(cmdLine.toString());
final ByteArrayOutputStream stdout = new ByteArrayOutputStream();
PumpStreamHandler pumpStreamHandler = new PumpStreamHandler(stdout);
// Asynchronously handle coala-json output
DefaultExecuteResultHandler resultHandler = new DefaultExecuteResultHandler() {
@Override
public void onProcessComplete(int exitValue) {
try {
processJsonAndMark(stdout.toString(), file);
} catch (IOException ex) {
ex.printStackTrace();
}
}
@Override
public void onProcessFailed(ExecuteException executeException) {
System.out.println("Running coala failed");
executeException.printStackTrace();
}
};
// Timeout command execution after 60 seconds.
ExecuteWatchdog watchdog = new ExecuteWatchdog(60 * 1000);
Executor executor = new DefaultExecutor();
executor.setWatchdog(watchdog);
executor.setExitValue(1);
executor.setStreamHandler(pumpStreamHandler);
executor.execute(cmdLine, resultHandler);
}
/**
* Run coala using the .coafile in the project directory.
*
* @param path
* The path to the project's root.
* @param project
* The IProject object of the current project.
*/
public static void runcoafile(final String path, final IProject project)
throws ExecuteException, IOException {
if (!checkPrerequisite("coala")) {
DialogUtils.installcoalaDialog();
return;
}
File cwd = new File(path);
CommandLine cmdLine = new CommandLine("coala-json");
final ByteArrayOutputStream stdout = new ByteArrayOutputStream();
PumpStreamHandler pumpStreamHandler = new PumpStreamHandler(stdout);
// Asynchronously handle coala-json output
DefaultExecuteResultHandler resultHandler = new DefaultExecuteResultHandler() {
@Override
public void onProcessComplete(int exitValue) {
try {
processJsonAndMark(stdout.toString(), project);
} catch (IOException ex) {
ex.printStackTrace();
}
}
@Override
public void onProcessFailed(ExecuteException executeException) {
System.out.println("Running coala failed with output: " + stdout.toString());
executeException.printStackTrace();
}
};
// Timeout command execution after 60 seconds.
ExecuteWatchdog watchdog = new ExecuteWatchdog(60 * 1000);
Executor executor = new DefaultExecutor();
executor.setWatchdog(watchdog);
executor.setExitValue(1);
executor.setStreamHandler(pumpStreamHandler);
executor.setWorkingDirectory(cwd);
executor.execute(cmdLine, resultHandler);
}
/**
* Process the JSON output of coala and add marker for each problem.
*
* @param json
* Output of running coala-json.
* @param file
* The IFile to add markers on.
* @throws IOException
* exception
*/
public static void processJsonAndMark(String json, IFile file) throws IOException {
JSONObject jsonObject = new JSONObject(json);
JSONObject results = jsonObject.getJSONObject("results");
Iterator<?> keys = results.keys();
while (keys.hasNext()) {
String key = (String) keys.next();
JSONArray result = results.getJSONArray(key);
if (result instanceof JSONArray) {
for (int i = 0; i < result.length(); i++) {
String diff = null;
String message = result.getJSONObject(i).getString("message");
String origin = result.getJSONObject(i).getString("origin");
String filePath = result.getJSONObject(i).getJSONArray("affected_code").getJSONObject(0)
.getString("file");
if (result.getJSONObject(i).get("diffs") instanceof JSONObject) {
diff = result.getJSONObject(i).getJSONObject("diffs").getString(filePath);
} else {
diff = null;
}
int severity = result.getJSONObject(i).getInt("severity");
JSONArray affectedCodeArray = result.getJSONObject(i).getJSONArray("affected_code");
for (int j = 0; j < affectedCodeArray.length(); j++) {
int endLine = affectedCodeArray.getJSONObject(j).getJSONObject("end").getInt("line");
createCoolMarker(file, endLine, 3 - severity, message, diff);
}
}
}
}
}
/**
* Process the JSON output of coala and add marker for each problem.
*
* @param json
* Output of running coala-json.
* @param project
* The IProject containing files to add markers on.
* @throws IOException
* exception
*/
public static void processJsonAndMark(String json, IProject project) throws IOException {
JSONObject jsonObject = new JSONObject(json);
JSONObject results = jsonObject.getJSONObject("results");
Iterator<?> keys = results.keys();
while (keys.hasNext()) {
String key = (String) keys.next();
JSONArray result = results.getJSONArray(key);
if (result instanceof JSONArray) {
for (int i = 0; i < result.length(); i++) {
String diff = null;
String projectPath = project.getLocation().toOSString();
String filePath = result.getJSONObject(i).getJSONArray("affected_code").getJSONObject(0)
.getString("file");
IPath path = new Path(filePath.substring(projectPath.length()));
IFile file = project.getFile(path);
String message = result.getJSONObject(i).getString("message");
String origin = result.getJSONObject(i).getString("origin");
if (result.getJSONObject(i).get("diffs") instanceof JSONObject) {
diff = result.getJSONObject(i).getJSONObject("diffs").getString(filePath);
} else {
diff = null;
}
int severity = result.getJSONObject(i).getInt("severity");
JSONArray affectedCodeArray = result.getJSONObject(i).getJSONArray("affected_code");
for (int j = 0; j < affectedCodeArray.length(); j++) {
int endLine = affectedCodeArray.getJSONObject(j).getJSONObject("end").getInt("line");
createCoolMarker(file, endLine, 3 - severity, message, diff);
}
}
}
}
}
/**
* Searches for the given binary in the PATH environmental variable.
*
* @param binary
* The executable that needs to be checked
* @return True is the binary is present, false otherwise
*/
private static boolean checkPrerequisite(String binary) {
ProcessBuilder pb = new ProcessBuilder(isWindows() ? "where" : "which", binary);
boolean foundBinary = false;
try {
Process proc = pb.start();
int errCode = proc.waitFor();
if (errCode == 0) {
try (BufferedReader reader = new BufferedReader(
new InputStreamReader(proc.getInputStream()))) {
foundBinary = true;
}
} else {
System.out.println(binary + " not in PATH");
}
} catch (IOException ex) {
System.out.println("Something went wrong while searching for " + binary);
} catch (InterruptedException ex) {
System.out.println("Something went wrong while searching for " + binary);
}
return foundBinary;
}
private static boolean isWindows() {
return System.getProperty("os.name").toLowerCase().contains("windows");
}
/**
* Creates a problem marker.
*
* @param file
* The IFile to add markers on.
* @param lineNum
* Line number of marker.
* @param flag
* Severity 1 for error, 2 for warning.
* @param message
* Problem message on marker.
* @param diff
* The diff to fix the issue.
*/
public static void createCoolMarker(IFile file, int lineNum, int flag, String message,
String diff) {
IResource resource = (IResource) file;
try {
IMarker marker = resource.createMarker("com.coala.core.problem");
marker.setAttribute(IMarker.LINE_NUMBER, lineNum);
if (flag == 1) {
marker.setAttribute(IMarker.SEVERITY, IMarker.SEVERITY_ERROR);
} else if (flag == 2) {
marker.setAttribute(IMarker.SEVERITY, IMarker.SEVERITY_WARNING);
}
marker.setAttribute(IMarker.MESSAGE, message);
marker.setAttribute("file", file.toString());
marker.setAttribute("diff", diff);
} catch (CoreException ex) {
ex.printStackTrace();
}
}
}