|
32 | 32 | #include "errorlogger.h" |
33 | 33 | #include "errortypes.h" |
34 | 34 | #include "filesettings.h" |
35 | | -#include "json.h" |
| 35 | +#include "sarifreport.h" |
36 | 36 | #include "settings.h" |
37 | 37 | #include "singleexecutor.h" |
38 | 38 | #include "suppressions.h" |
|
78 | 78 | #endif |
79 | 79 |
|
80 | 80 | namespace { |
81 | | - class SarifReport { |
82 | | - public: |
83 | | - void addFinding(ErrorMessage msg) { |
84 | | - mFindings.push_back(std::move(msg)); |
85 | | - } |
86 | | - |
87 | | - picojson::array serializeRules() const { |
88 | | - picojson::array ret; |
89 | | - std::set<std::string> ruleIds; |
90 | | - for (const auto& finding : mFindings) { |
91 | | - // github only supports findings with locations |
92 | | - if (finding.callStack.empty()) |
93 | | - continue; |
94 | | - if (ruleIds.insert(finding.id).second) { |
95 | | - picojson::object rule; |
96 | | - rule["id"] = picojson::value(finding.id); |
97 | | - // rule.shortDescription.text |
98 | | - picojson::object shortDescription; |
99 | | - shortDescription["text"] = picojson::value(finding.shortMessage()); |
100 | | - rule["shortDescription"] = picojson::value(shortDescription); |
101 | | - // rule.fullDescription.text |
102 | | - picojson::object fullDescription; |
103 | | - fullDescription["text"] = picojson::value(finding.verboseMessage()); |
104 | | - rule["fullDescription"] = picojson::value(fullDescription); |
105 | | - // rule.help.text |
106 | | - picojson::object help; |
107 | | - help["text"] = picojson::value(finding.verboseMessage()); // FIXME provide proper help text |
108 | | - rule["help"] = picojson::value(help); |
109 | | - // rule.properties.precision, rule.properties.problem.severity |
110 | | - picojson::object properties; |
111 | | - properties["precision"] = picojson::value(sarifPrecision(finding)); |
112 | | - double securitySeverity = 0; |
113 | | - if (finding.severity == Severity::error && !ErrorLogger::isCriticalErrorId(finding.id)) |
114 | | - securitySeverity = 9.9; // We see undefined behavior |
115 | | - //else if (finding.severity == Severity::warning) |
116 | | - // securitySeverity = 5.1; // We see potential undefined behavior |
117 | | - if (securitySeverity > 0.5) { |
118 | | - properties["security-severity"] = picojson::value(securitySeverity); |
119 | | - const picojson::array tags{picojson::value("security")}; |
120 | | - properties["tags"] = picojson::value(tags); |
121 | | - } |
122 | | - rule["properties"] = picojson::value(properties); |
123 | | - // rule.defaultConfiguration.level |
124 | | - picojson::object defaultConfiguration; |
125 | | - defaultConfiguration["level"] = picojson::value(sarifSeverity(finding)); |
126 | | - rule["defaultConfiguration"] = picojson::value(defaultConfiguration); |
127 | | - |
128 | | - ret.emplace_back(rule); |
129 | | - } |
130 | | - } |
131 | | - return ret; |
132 | | - } |
133 | | - |
134 | | - static picojson::array serializeLocations(const ErrorMessage& finding) { |
135 | | - picojson::array ret; |
136 | | - for (const auto& location : finding.callStack) { |
137 | | - picojson::object physicalLocation; |
138 | | - picojson::object artifactLocation; |
139 | | - artifactLocation["uri"] = picojson::value(location.getfile(false)); |
140 | | - physicalLocation["artifactLocation"] = picojson::value(artifactLocation); |
141 | | - picojson::object region; |
142 | | - region["startLine"] = picojson::value(static_cast<int64_t>(location.line)); |
143 | | - region["startColumn"] = picojson::value(static_cast<int64_t>(location.column)); |
144 | | - region["endLine"] = region["startLine"]; |
145 | | - region["endColumn"] = region["startColumn"]; |
146 | | - physicalLocation["region"] = picojson::value(region); |
147 | | - picojson::object loc; |
148 | | - loc["physicalLocation"] = picojson::value(physicalLocation); |
149 | | - ret.emplace_back(loc); |
150 | | - } |
151 | | - return ret; |
152 | | - } |
153 | | - |
154 | | - picojson::array serializeResults() const { |
155 | | - picojson::array results; |
156 | | - for (const auto& finding : mFindings) { |
157 | | - // github only supports findings with locations |
158 | | - if (finding.callStack.empty()) |
159 | | - continue; |
160 | | - picojson::object res; |
161 | | - res["level"] = picojson::value(sarifSeverity(finding)); |
162 | | - res["locations"] = picojson::value(serializeLocations(finding)); |
163 | | - picojson::object message; |
164 | | - message["text"] = picojson::value(finding.shortMessage()); |
165 | | - res["message"] = picojson::value(message); |
166 | | - res["ruleId"] = picojson::value(finding.id); |
167 | | - results.emplace_back(res); |
168 | | - } |
169 | | - return results; |
170 | | - } |
171 | | - |
172 | | - picojson::value serializeRuns(const std::string& productName, const std::string& version) const { |
173 | | - picojson::object driver; |
174 | | - driver["name"] = picojson::value(productName); |
175 | | - driver["semanticVersion"] = picojson::value(version); |
176 | | - driver["informationUri"] = picojson::value("https://cppcheck.sourceforge.io"); |
177 | | - driver["rules"] = picojson::value(serializeRules()); |
178 | | - picojson::object tool; |
179 | | - tool["driver"] = picojson::value(driver); |
180 | | - picojson::object run; |
181 | | - run["tool"] = picojson::value(tool); |
182 | | - run["results"] = picojson::value(serializeResults()); |
183 | | - picojson::array runs{picojson::value(run)}; |
184 | | - return picojson::value(runs); |
185 | | - } |
186 | | - |
187 | | - std::string serialize(std::string productName) const { |
188 | | - const auto nameAndVersion = Settings::getNameAndVersion(productName); |
189 | | - productName = nameAndVersion.first.empty() ? "Cppcheck" : nameAndVersion.first; |
190 | | - std::string version = nameAndVersion.first.empty() ? CppCheck::version() : nameAndVersion.second; |
191 | | - if (version.find(' ') != std::string::npos) |
192 | | - version.erase(version.find(' '), std::string::npos); |
193 | | - |
194 | | - picojson::object doc; |
195 | | - doc["version"] = picojson::value("2.1.0"); |
196 | | - doc["$schema"] = picojson::value("https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json"); |
197 | | - doc["runs"] = serializeRuns(productName, version); |
198 | | - |
199 | | - return picojson::value(doc).serialize(true); |
200 | | - } |
201 | | - private: |
202 | | - |
203 | | - static std::string sarifSeverity(const ErrorMessage& errmsg) { |
204 | | - if (ErrorLogger::isCriticalErrorId(errmsg.id)) |
205 | | - return "error"; |
206 | | - switch (errmsg.severity) { |
207 | | - case Severity::error: |
208 | | - case Severity::warning: |
209 | | - case Severity::style: |
210 | | - case Severity::portability: |
211 | | - case Severity::performance: |
212 | | - return "warning"; |
213 | | - case Severity::information: |
214 | | - case Severity::internal: |
215 | | - case Severity::debug: |
216 | | - case Severity::none: |
217 | | - return "note"; |
218 | | - } |
219 | | - return "note"; |
220 | | - } |
221 | | - |
222 | | - static std::string sarifPrecision(const ErrorMessage& errmsg) { |
223 | | - if (errmsg.certainty == Certainty::inconclusive) |
224 | | - return "medium"; |
225 | | - return "high"; |
226 | | - } |
227 | | - |
228 | | - std::vector<ErrorMessage> mFindings; |
229 | | - }; |
230 | | - |
231 | 81 | class CmdLineLoggerStd : public CmdLineLogger |
232 | 82 | { |
233 | 83 | public: |
|
0 commit comments