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
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT 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 02110-1301, USA.
*/
package org.sonar.scanner.protocol.output;
import com.google.protobuf.AbstractMessageLite;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.io.FileUtils;
import org.sonar.core.util.ContextException;
import org.sonar.core.util.Protobuf;
@Immutable
public class ScannerReportWriter {
private final FileStructure fileStructure;
public ScannerReportWriter(FileStructure fileStructure) {
this.fileStructure = fileStructure;
}
public FileStructure getFileStructure() {
return fileStructure;
}
public boolean hasComponentData(FileStructure.Domain domain, int componentRef) {
File file = fileStructure.fileFor(domain, componentRef);
return file.exists() && file.isFile();
}
/**
* Metadata is mandatory
*/
public File writeMetadata(ScannerReport.Metadata metadata) {
Protobuf.write(metadata, fileStructure.metadataFile());
return fileStructure.metadataFile();
}
public File writeActiveRules(Iterable<ScannerReport.ActiveRule> activeRules) {
Protobuf.writeStream(activeRules, fileStructure.activeRules(), false);
return fileStructure.metadataFile();
}
public File writeComponent(ScannerReport.Component component) {
File file = fileStructure.fileFor(FileStructure.Domain.COMPONENT, component.getRef());
Protobuf.write(component, file);
return file;
}
public File writeComponentIssues(int componentRef, Iterable<ScannerReport.Issue> issues) {
File file = fileStructure.fileFor(FileStructure.Domain.ISSUES, componentRef);
Protobuf.writeStream(issues, file, false);
return file;
}
public File writeComponentSignificantCode(int componentRef, Iterable<ScannerReport.LineSgnificantCode> lineSignificantCode) {
File file = fileStructure.fileFor(FileStructure.Domain.SGNIFICANT_CODE, componentRef);
Protobuf.writeStream(lineSignificantCode, file, false);
return file;
}
public void appendComponentIssue(int componentRef, ScannerReport.Issue issue) {
File file = fileStructure.fileFor(FileStructure.Domain.ISSUES, componentRef);
appendDelimitedTo(file, issue, "issue");
}
public File writeComponentChangedLines(int componentRef, ScannerReport.ChangedLines changedLines) {
File file = fileStructure.fileFor(FileStructure.Domain.CHANGED_LINES, componentRef);
Protobuf.write(changedLines, file);
return file;
}
public void appendComponentExternalIssue(int componentRef, ScannerReport.ExternalIssue issue) {
File file = fileStructure.fileFor(FileStructure.Domain.EXTERNAL_ISSUES, componentRef);
appendDelimitedTo(file, issue, "external issue");
}
public void appendAdHocRule(ScannerReport.AdHocRule adHocRule) {
File file = fileStructure.adHocRules();
appendDelimitedTo(file, adHocRule, "ad hoc rule");
}
public void appendComponentMeasure(int componentRef, ScannerReport.Measure measure) {
File file = fileStructure.fileFor(FileStructure.Domain.MEASURES, componentRef);
appendDelimitedTo(file, measure, "measure");
}
private static void appendDelimitedTo(File file, AbstractMessageLite<?, ?> msg, String msgName) {
try (OutputStream out = new BufferedOutputStream(new FileOutputStream(file, true))) {
msg.writeDelimitedTo(out);
} catch (Exception e) {
throw ContextException.of("Unable to write " + msgName, e).addContext("file", file);
}
}
public File writeComponentChangesets(ScannerReport.Changesets changesets) {
File file = fileStructure.fileFor(FileStructure.Domain.CHANGESETS, changesets.getComponentRef());
Protobuf.write(changesets, file);
return file;
}
public File writeComponentDuplications(int componentRef, Iterable<ScannerReport.Duplication> duplications) {
File file = fileStructure.fileFor(FileStructure.Domain.DUPLICATIONS, componentRef);
Protobuf.writeStream(duplications, file, false);
return file;
}
public File writeCpdTextBlocks(int componentRef, Iterable<ScannerReport.CpdTextBlock> blocks) {
File file = fileStructure.fileFor(FileStructure.Domain.CPD_TEXT_BLOCKS, componentRef);
Protobuf.writeStream(blocks, file, false);
return file;
}
public File writeComponentSymbols(int componentRef, Iterable<ScannerReport.Symbol> symbols) {
File file = fileStructure.fileFor(FileStructure.Domain.SYMBOLS, componentRef);
Protobuf.writeStream(symbols, file, false);
return file;
}
public File writeComponentSyntaxHighlighting(int componentRef, Iterable<ScannerReport.SyntaxHighlightingRule> syntaxHighlightingRules) {
File file = fileStructure.fileFor(FileStructure.Domain.SYNTAX_HIGHLIGHTINGS, componentRef);
Protobuf.writeStream(syntaxHighlightingRules, file, false);
return file;
}
public File writeComponentCoverage(int componentRef, Iterable<ScannerReport.LineCoverage> coverageList) {
File file = fileStructure.fileFor(FileStructure.Domain.COVERAGES, componentRef);
Protobuf.writeStream(coverageList, file, false);
return file;
}
public File writeContextProperties(Iterable<ScannerReport.ContextProperty> properties) {
File file = fileStructure.contextProperties();
Protobuf.writeStream(properties, file, false);
return file;
}
public File writeAnalysisWarnings(Iterable<ScannerReport.AnalysisWarning> analysisWarnings) {
File file = fileStructure.analysisWarnings();
Protobuf.writeStream(analysisWarnings, file, false);
return file;
}
public File writeTelemetry(Iterable<ScannerReport.TelemetryEntry> telemetryEntries) {
File file = fileStructure.telemetryEntries();
Protobuf.writeStream(telemetryEntries, file, false);
return file;
}
public File appendAnalysisData(ScannerReport.AnalysisData analysisData) {
File file = fileStructure.analysisData();
appendDelimitedTo(file, analysisData, "analysis data for " + analysisData.getKey());
return file;
}
public File getSourceFile(int componentRef) {
return fileStructure.fileFor(FileStructure.Domain.SOURCE, componentRef);
}
public void writeScaFile(File scaFile) {
File sca = fileStructure.scaDir();
try {
FileUtils.copyFileToDirectory(scaFile, sca);
} catch (IOException e) {
throw new IllegalStateException(String.format("Unable to copy sca file '%s' to sca folder", scaFile), e);
}
}
}
|
