Skip to content

Commit ea4bcc2

Browse files
nporteschaikinnporteschaikin
committed
Add JSON reporter
1 parent 736496d commit ea4bcc2

File tree

8 files changed

+120
-33
lines changed

8 files changed

+120
-33
lines changed

‎src/main/java/org/sonarlint/cli/report/JsonReport.java‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
/*
2+
* SonarLint CLI
3+
* Copyright (C) 2016-2017 SonarSource SA
4+
* mailto:info AT sonarsource DOT com
5+
*
6+
* This program is free software; you can redistribute it and/or
7+
* modify it under the terms of the GNU Lesser General Public
8+
* License as published by the Free Software Foundation; either
9+
* version 3 of the License, or (at your option) any later version.
10+
*
11+
* This program is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14+
* Lesser General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU Lesser General Public License
17+
* along with this program; if not, write to the Free Software Foundation,
18+
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19+
*/
20+
package org.sonarlint.cli.report;
21+
22+
import com.google.gson.JsonObject;
23+
import com.google.gson.JsonArray;
24+
import java.io.PrintStream;
25+
import java.util.Collection;
26+
import java.util.Date;
27+
import java.util.function.Function;
28+
import org.sonarlint.cli.util.Logger;
29+
import org.sonarsource.sonarlint.core.client.api.common.RuleDetails;
30+
import org.sonarsource.sonarlint.core.client.api.common.analysis.AnalysisResults;
31+
import org.sonarsource.sonarlint.core.client.api.common.analysis.Issue;
32+
import org.sonarsource.sonarlint.core.tracking.Trackable;
33+
34+
public class JsonReport implements Reporter {
35+
36+
private static final Logger LOGGER = Logger.get();
37+
38+
JsonReport() {
39+
40+
}
41+
42+
@Override
43+
public void execute(String projectName, Date date, Collection<Trackable> trackables, AnalysisResults result, Function<String, RuleDetails> ruleDescriptionProducer) {
44+
for (Trackable trackable : trackables) {
45+
Issue issue = trackable.getIssue();
46+
RuleDetails ruleDetails = ruleDescriptionProducer.apply(issue.getRuleKey());
47+
48+
JsonObject json = new JsonObject();
49+
json.addProperty("type", "issue");
50+
json.addProperty("check_name", issue.getRuleKey());
51+
52+
JsonArray categories = new JsonArray();
53+
json.add("categories", categories);
54+
categories.add("Bug Risk");
55+
56+
json.addProperty("description", issue.getMessage());
57+
58+
JsonObject content = new JsonObject();
59+
json.add("content", content);
60+
content.addProperty("body", ruleDetails.getHtmlDescription());
61+
// // ruleDetails.getExtendedDescription();
62+
63+
JsonObject location = new JsonObject();
64+
json.add("location", location);
65+
location.addProperty("path", issue.getInputFile().getPath().replaceFirst("^/code-rw/", ""));
66+
67+
JsonObject lines = new JsonObject();
68+
location.add("lines", lines);
69+
70+
if (issue.getStartLine() != null) {
71+
lines.addProperty("begin", issue.getStartLine());
72+
73+
if (issue.getStartLine() != null) {
74+
lines.addProperty("end", issue.getEndLine());
75+
} else {
76+
lines.addProperty("end", 1);
77+
}
78+
} else {
79+
lines.addProperty("begin", 1);
80+
lines.addProperty("end", 1);
81+
}
82+
83+
System.out.println(json.toString() + "\0");
84+
}
85+
}
86+
}

‎src/main/java/org/sonarlint/cli/report/ReportFactory.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ public List<Reporter> createReporters(Path basePath) {
4242

4343
list.add(new ConsoleReport());
4444
list.add(new HtmlReport(basePath, getReportFile(basePath), charset));
45+
list.add(new JsonReport());
4546

4647
return list;
4748
}

‎src/main/java/org/sonarlint/cli/util/Logger.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ private Logger() {
3232
this.stdErr = System.err;
3333
this.stdOut = System.out;
3434
}
35-
35+
3636
public Logger(PrintStream stdOut, PrintStream stdErr) {
3737
this.stdErr = stdErr;
3838
this.stdOut = stdOut;
@@ -64,7 +64,7 @@ public boolean isDebugEnabled() {
6464

6565
public void debug(String message) {
6666
if (isDebugEnabled()) {
67-
stdOut.println("DEBUG: " + message);
67+
stdErr.println("DEBUG: " + message);
6868
}
6969
}
7070

@@ -78,11 +78,11 @@ public void debug(String message, Throwable t) {
7878
}
7979

8080
public void info(String message) {
81-
stdOut.println("INFO: " + message);
81+
stdErr.println("INFO: " + message);
8282
}
8383

8484
public void warn(String message) {
85-
stdOut.println("WARN: " + message);
85+
stdErr.println("WARN: " + message);
8686
}
8787

8888
public void error(String message) {

‎src/test/java/org/sonarlint/cli/MainTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public void errorStart() throws IOException {
128128
Exception e = createException("invalid operation", "analysis failed");
129129
doThrow(e).when(sonarLint).runAnalysis(anyMapOf(String.class, String.class), any(ReportFactory.class), any(InputFileFinder.class), any(Path.class));
130130
assertThat(main.run()).isEqualTo(Main.ERROR);
131-
assertThat(getLogs(out)).contains("EXECUTION FAILURE");
131+
assertThat(getLogs(err)).contains("EXECUTION FAILURE");
132132
assertThat(getLogs(err)).contains("invalid operation");
133133
}
134134

@@ -191,7 +191,7 @@ public void errorStop() {
191191
Exception e = createException("invalid operation", "analysis failed");
192192
doThrow(e).when(sonarLint).stop();
193193
assertThat(main.run()).isEqualTo(Main.ERROR);
194-
assertThat(getLogs(out)).contains("EXECUTION FAILURE");
194+
assertThat(getLogs(err)).contains("EXECUTION FAILURE");
195195
assertThat(getLogs(err)).contains("invalid operation");
196196
}
197197

@@ -200,7 +200,7 @@ public void errorAnalysis() throws IOException {
200200
Exception e = createException("invalid operation", "analysis failed");
201201
doThrow(e).when(sonarLint).runAnalysis(anyMapOf(String.class, String.class), eq(reportFactory), eq(fileFinder), any(Path.class));
202202
assertThat(main.run()).isEqualTo(Main.ERROR);
203-
assertThat(getLogs(out)).contains("EXECUTION FAILURE");
203+
assertThat(getLogs(err)).contains("EXECUTION FAILURE");
204204
assertThat(getLogs(err)).contains("invalid operation");
205205
}
206206

@@ -210,7 +210,7 @@ public void showStack() throws IOException {
210210
Exception e = createException("invalid operation", "analysis failed");
211211
doThrow(e).when(sonarLint).runAnalysis(anyMapOf(String.class, String.class), any(ReportFactory.class), any(InputFileFinder.class), any(Path.class));
212212
assertThat(main.run()).isEqualTo(Main.ERROR);
213-
assertThat(getLogs(out)).contains("EXECUTION FAILURE");
213+
assertThat(getLogs(err)).contains("EXECUTION FAILURE");
214214
assertThat(getLogs(err)).contains("invalid operation");
215215
assertThat(getLogs(err)).contains("analysis failed");
216216
}

‎src/test/java/org/sonarlint/cli/StatsTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
import static org.assertj.core.api.Assertions.assertThat;
3535

3636
public class StatsTest {
37-
private PrintStream stdOut = mock(PrintStream.class);
38-
private PrintStream stdErr;
37+
private PrintStream stdOut;
38+
private PrintStream stdErr = mock(PrintStream.class);
3939

4040
@Before
4141
public void setUp() {
@@ -46,8 +46,8 @@ public void setUp() {
4646
public void shouldPrintStats() throws UnsupportedEncodingException {
4747
new Stats().start().stop();
4848

49-
verify(stdOut).println(Mockito.contains("Total time: "));
50-
verify(stdOut).println(Mockito.contains("Final Memory: "));
49+
verify(stdErr).println(Mockito.contains("Total time: "));
50+
verify(stdErr).println(Mockito.contains("Final Memory: "));
5151
}
5252

5353
@Test

‎src/test/java/org/sonarlint/cli/report/ConsoleReportTest.java‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ public void testLog() throws IOException {
7676
report.execute(PROJECT_NAME, DATE, toTrackables(issues), result, k -> null);
7777

7878
stdOut.flush();
79-
assertThat(getLog(out)).contains("SonarLint Report");
80-
assertThat(getLog(out)).contains("5 issues");
81-
assertThat(getLog(out)).contains("1 major");
82-
assertThat(getLog(out)).contains("1 minor");
83-
assertThat(getLog(out)).contains("1 info");
84-
assertThat(getLog(out)).contains("1 critical");
85-
assertThat(getLog(out)).contains("1 blocker");
86-
87-
assertThat(getLog(out)).doesNotContain("new");
79+
assertThat(getLog(err)).contains("SonarLint Report");
80+
assertThat(getLog(err)).contains("5 issues");
81+
assertThat(getLog(err)).contains("1 major");
82+
assertThat(getLog(err)).contains("1 minor");
83+
assertThat(getLog(err)).contains("1 info");
84+
assertThat(getLog(err)).contains("1 critical");
85+
assertThat(getLog(err)).contains("1 blocker");
86+
87+
assertThat(getLog(err)).doesNotContain("new");
8888
}
8989

9090
private List<Trackable> toTrackables(List<Issue> issues) {
@@ -106,9 +106,9 @@ public void testReportWithoutIssues() throws IOException {
106106
List<Issue> issues = new LinkedList<>();
107107
report.execute(PROJECT_NAME, DATE, toTrackables(issues), result, k -> null);
108108
stdOut.flush();
109-
assertThat(getLog(out)).contains("SonarLint Report");
110-
assertThat(getLog(out)).contains("No issues to display");
111-
assertThat(getLog(out)).contains("1 file analyzed");
109+
assertThat(getLog(err)).contains("SonarLint Report");
110+
assertThat(getLog(err)).contains("No issues to display");
111+
assertThat(getLog(err)).contains("1 file analyzed");
112112
}
113113

114114
@Test
@@ -117,9 +117,9 @@ public void testReportMultipleFiles() throws IOException {
117117
List<Issue> issues = new LinkedList<>();
118118
report.execute(PROJECT_NAME, DATE, toTrackables(issues), result, k -> null);
119119
stdOut.flush();
120-
assertThat(getLog(out)).contains("SonarLint Report");
121-
assertThat(getLog(out)).contains("No issues to display");
122-
assertThat(getLog(out)).contains("2 files analyzed");
120+
assertThat(getLog(err)).contains("SonarLint Report");
121+
assertThat(getLog(err)).contains("No issues to display");
122+
assertThat(getLog(err)).contains("2 files analyzed");
123123
}
124124

125125
@Test
@@ -128,10 +128,10 @@ public void testReportNoFilesAnalyzed() throws IOException {
128128
when(result.fileCount()).thenReturn(0);
129129
report.execute(PROJECT_NAME, DATE, toTrackables(issues), result, k -> null);
130130
stdOut.flush();
131-
assertThat(getLog(out)).contains("SonarLint Report");
132-
assertThat(getLog(out)).contains("No files analyzed");
131+
assertThat(getLog(err)).contains("SonarLint Report");
132+
assertThat(getLog(err)).contains("No files analyzed");
133133

134-
assertThat(getLog(out)).doesNotContain("issues");
134+
assertThat(getLog(err)).doesNotContain("issues");
135135
}
136136

137137
private String getLog(ByteArrayOutputStream byteStream) throws IOException {

‎src/test/java/org/sonarlint/cli/report/ReportFactoryTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public void setUp() {
4545
@Test
4646
public void test() {
4747
List<Reporter> reporters = factory.createReporters(Paths.get("test"));
48-
assertThat(reporters).hasSize(2);
48+
assertThat(reporters).hasSize(3);
4949
}
5050

5151
@Test

‎src/test/java/org/sonarlint/cli/util/LoggerTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public void setUp() {
5050
@Test
5151
public void testInfo() {
5252
logger.info("info");
53-
verify(stdOut).println("INFO: info");
53+
verify(stdErr).println("INFO: info");
5454
verifyNoMoreInteractions(stdOut, stdErr);
5555
}
5656

@@ -104,7 +104,7 @@ public void testDebug() {
104104
logger.setDebugEnabled(true);
105105

106106
logger.debug("debug");
107-
verify(stdOut).println("DEBUG: debug");
107+
verify(stdErr).println("DEBUG: debug");
108108

109109
logger.setDebugEnabled(false);
110110
logger.debug("debug");

0 commit comments

Comments
 (0)