|
28 | 28 | #include "errorlogger.h" |
29 | 29 | #include "errortypes.h" |
30 | 30 | #include "filesettings.h" |
| 31 | +#include "json.h" |
31 | 32 | #include "settings.h" |
32 | 33 | #include "singleexecutor.h" |
33 | 34 | #include "suppressions.h" |
|
71 | 72 | #endif |
72 | 73 |
|
73 | 74 | namespace { |
| 75 | + class SarifReport { |
| 76 | + public: |
| 77 | + void addFinding(ErrorMessage msg) { |
| 78 | + mFindings.push_back(std::move(msg)); |
| 79 | + } |
| 80 | + |
| 81 | + picojson::array serializeRules() const { |
| 82 | + picojson::array ret; |
| 83 | + std::set<std::string> ruleIds; |
| 84 | + for (const auto& finding : mFindings) { |
| 85 | + if (ruleIds.insert(finding.id).second) { |
| 86 | + picojson::object rule; |
| 87 | + rule["id"] = picojson::value(finding.id); |
| 88 | + picojson::object shortDescription; |
| 89 | + shortDescription["text"] = picojson::value(finding.shortMessage()); |
| 90 | + rule["shortDescription"] = picojson::value(shortDescription); |
| 91 | + ret.emplace_back(rule); |
| 92 | + } |
| 93 | + } |
| 94 | + return ret; |
| 95 | + } |
| 96 | + |
| 97 | + static picojson::array serializeLocations(const ErrorMessage& finding) { |
| 98 | + picojson::array ret; |
| 99 | + for (const auto& location : finding.callStack) { |
| 100 | + picojson::object physicalLocation; |
| 101 | + picojson::object artifactLocation; |
| 102 | + artifactLocation["uri"] = picojson::value(location.getOrigFile(false)); |
| 103 | + physicalLocation["artifactLocation"] = picojson::value(artifactLocation); |
| 104 | + picojson::object region; |
| 105 | + region["startLine"] = picojson::value(static_cast<int64_t>(location.line)); |
| 106 | + region["startColumn"] = picojson::value(static_cast<int64_t>(location.column)); |
| 107 | + physicalLocation["region"] = picojson::value(region); |
| 108 | + picojson::object loc; |
| 109 | + loc["physicalLocation"] = picojson::value(physicalLocation); |
| 110 | + ret.emplace_back(loc); |
| 111 | + } |
| 112 | + return ret; |
| 113 | + } |
| 114 | + |
| 115 | + picojson::array serializeResults() const { |
| 116 | + picojson::array results; |
| 117 | + for (const auto& finding : mFindings) { |
| 118 | + picojson::object res; |
| 119 | + res["level"] = picojson::value(sarifLevel(finding.severity)); |
| 120 | + if (!finding.callStack.empty()) |
| 121 | + res["locations"] = picojson::value(serializeLocations(finding)); |
| 122 | + picojson::object message; |
| 123 | + message["text"] = picojson::value(finding.shortMessage()); |
| 124 | + res["message"] = picojson::value(message); |
| 125 | + res["ruleId"] = picojson::value(finding.id); |
| 126 | + results.emplace_back(res); |
| 127 | + } |
| 128 | + return results; |
| 129 | + } |
| 130 | + |
| 131 | + picojson::value serializeRuns(const std::string& productName, const std::string& version) const { |
| 132 | + picojson::object driver; |
| 133 | + driver["name"] = picojson::value(productName); |
| 134 | + driver["version"] = picojson::value(version); |
| 135 | + driver["informationUri"] = picojson::value("https://cppcheck.sourceforge.io"); |
| 136 | + driver["rules"] = picojson::value(serializeRules()); |
| 137 | + picojson::object tool; |
| 138 | + tool["driver"] = picojson::value(driver); |
| 139 | + picojson::object run; |
| 140 | + run["tool"] = picojson::value(tool); |
| 141 | + run["results"] = picojson::value(serializeResults()); |
| 142 | + picojson::array runs{picojson::value(run)}; |
| 143 | + return picojson::value(runs); |
| 144 | + } |
| 145 | + |
| 146 | + std::string serialize(std::string productName) const { |
| 147 | + const auto nameAndVersion = Settings::getNameAndVersion(productName); |
| 148 | + productName = nameAndVersion.first.empty() ? "Cppcheck" : nameAndVersion.first; |
| 149 | + std::string version = nameAndVersion.first.empty() ? CppCheck::version() : nameAndVersion.second; |
| 150 | + if (version.find(' ') != std::string::npos) |
| 151 | + version.erase(version.find(' '), std::string::npos); |
| 152 | + |
| 153 | + picojson::object doc; |
| 154 | + doc["version"] = picojson::value("2.1.0"); |
| 155 | + doc["$schema"] = picojson::value("https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json"); |
| 156 | + doc["runs"] = serializeRuns(productName, version); |
| 157 | + |
| 158 | + return picojson::value(doc).serialize(true); |
| 159 | + } |
| 160 | + private: |
| 161 | + |
| 162 | + |
| 163 | + static std::string sarifLevel(Severity severity) { |
| 164 | + switch (severity) { |
| 165 | + case Severity::error: |
| 166 | + return "error"; |
| 167 | + case Severity::warning: |
| 168 | + case Severity::style: |
| 169 | + case Severity::portability: |
| 170 | + case Severity::performance: |
| 171 | + return "warning"; |
| 172 | + case Severity::information: |
| 173 | + case Severity::internal: |
| 174 | + case Severity::debug: |
| 175 | + case Severity::none: |
| 176 | + return "note"; |
| 177 | + } |
| 178 | + return "note"; |
| 179 | + } |
| 180 | + |
| 181 | + |
| 182 | + |
| 183 | + std::vector<ErrorMessage> mFindings; |
| 184 | + }; |
| 185 | + |
74 | 186 | class CmdLineLoggerStd : public CmdLineLogger |
75 | 187 | { |
76 | 188 | public: |
@@ -104,6 +216,9 @@ namespace { |
104 | 216 | } |
105 | 217 |
|
106 | 218 | ~StdLogger() override { |
| 219 | + if (mSettings.outputFormat == Settings::OutputFormat::sarif) { |
| 220 | + reportErr(mSarifReport.serialize(mSettings.cppcheckCfgProductName)); |
| 221 | + } |
107 | 222 | delete mErrorOutput; |
108 | 223 | } |
109 | 224 |
|
@@ -182,6 +297,11 @@ namespace { |
182 | 297 | * CTU information |
183 | 298 | */ |
184 | 299 | std::string mCtuInfo; |
| 300 | + |
| 301 | + /** |
| 302 | + * SARIF report generator |
| 303 | + */ |
| 304 | + SarifReport mSarifReport; |
185 | 305 | }; |
186 | 306 | } |
187 | 307 |
|
@@ -455,7 +575,9 @@ void StdLogger::reportErr(const ErrorMessage &msg) |
455 | 575 | if (!mShownErrors.insert(msg.toString(mSettings.verbose)).second) |
456 | 576 | return; |
457 | 577 |
|
458 | | - if (mSettings.xml) |
| 578 | + if (mSettings.outputFormat == Settings::OutputFormat::sarif) |
| 579 | + mSarifReport.addFinding(msg); |
| 580 | + else if (mSettings.xml) |
459 | 581 | reportErr(msg.toXML()); |
460 | 582 | else |
461 | 583 | reportErr(msg.toString(mSettings.verbose, mSettings.templateFormat, mSettings.templateLocation)); |
|
0 commit comments