put metrics in xml output

Author: ludviggunne

cli/cmdlineparser.cpp

@@ -128,6 +128,12 @@ namespace {
             reportOut(msg.toXML());
         }
 
+        void reportMetric(const std::string &metric) override
+        {
+            /* Not used here */
+            (void) metric;
+        }
+
         void reportProgress(const std::string & /*filename*/, const char /*stage*/[], const std::size_t /*value*/) override
         {}
     };

cli/cppcheckexecutor.cpp

@@ -277,6 +277,22 @@ namespace {
          */
         void reportErr(const std::string &errmsg);
 
+        void reportMetric(const std::string &metric) override
+        {
+            mFileMetrics.push_back(metric);
+        }
+
+        void reportMetrics()
+        {
+            if (!mFileMetrics.empty()) {
+                std::cout << "    <metrics>" << std::endl;
+                for (const auto &metric : mFileMetrics) {
+                    reportOut("        " + metric);
+                }
+                std::cout << "    </metrics>" << std::endl;
+            }
+        }
+
         /**
          * @brief Write the checkers report
          */
@@ -349,6 +365,11 @@ namespace {
          * Coding standard guideline mapping
          */
         std::map<std::string, std::string> mGuidelineMapping;
+
+        /**
+         * File metrics
+         */
+        std::vector<std::string> mFileMetrics;
     };
 }
 
@@ -483,6 +504,7 @@ int CppCheckExecutor::check_internal(const Settings& settings, Suppressions& sup
     stdLogger.writeCheckersReport(supprs);
 
     if (settings.outputFormat == Settings::OutputFormat::xml) {
+        stdLogger.reportMetrics();
         stdLogger.reportErr(ErrorMessage::getXMLFooter(settings.xml_version));
     }
 

cli/processexecutor.cpp

@@ -78,7 +78,7 @@ ProcessExecutor::ProcessExecutor(const std::list<FileWithDetails> &files, const
 namespace {
     class PipeWriter : public ErrorLogger {
     public:
-        enum PipeSignal : std::uint8_t {REPORT_OUT='1',REPORT_ERROR='2',REPORT_SUPPR_INLINE='3',REPORT_SUPPR='4',CHILD_END='5'};
+        enum PipeSignal : std::uint8_t {REPORT_OUT='1',REPORT_ERROR='2',REPORT_SUPPR_INLINE='3',REPORT_SUPPR='4',CHILD_END='5',REPORT_METRIC='6'};
 
         explicit PipeWriter(int pipe) : mWpipe(pipe) {}
 
@@ -100,6 +100,10 @@ namespace {
             }
         }
 
+        void reportMetric(const std::string &metric) override {
+            writeToPipe(REPORT_METRIC, metric);
+        }
+
         void writeEnd(const std::string& str) const {
             writeToPipe(CHILD_END, str);
         }
@@ -179,7 +183,8 @@ bool ProcessExecutor::handleRead(int rpipe, unsigned int &result, const std::str
         type != PipeWriter::REPORT_ERROR &&
         type != PipeWriter::REPORT_SUPPR_INLINE &&
         type != PipeWriter::REPORT_SUPPR &&
-        type != PipeWriter::CHILD_END) {
+        type != PipeWriter::CHILD_END &&
+        type != PipeWriter::REPORT_METRIC) {
         std::cerr << "#### ThreadExecutor::handleRead(" << filename << ") invalid type " << int(type) << std::endl;
         std::exit(EXIT_FAILURE);
     }
@@ -256,6 +261,8 @@ bool ProcessExecutor::handleRead(int rpipe, unsigned int &result, const std::str
     } else if (type == PipeWriter::CHILD_END) {
         result += std::stoi(buf);
         res = false;
+    } else if (type == PipeWriter::REPORT_METRIC) {
+        mErrorLogger.reportMetric(buf);
     }
 
     return res;

cli/threadexecutor.cpp

@@ -66,6 +66,11 @@ class SyncLogForwarder : public ErrorLogger
         mErrorLogger.reportErr(msg);
     }
 
+    void reportMetric(const std::string &metric) override {
+        std::lock_guard<std::mutex> lg(mReportSync);
+        mErrorLogger.reportMetric(metric);
+    }
+
     void reportStatus(std::size_t fileindex, std::size_t filecount, std::size_t sizedone, std::size_t sizetotal) {
         std::lock_guard<std::mutex> lg(mReportSync);
         mThreadExecutor.reportStatus(fileindex, filecount, sizedone, sizetotal);

lib/cppcheck.cpp

@@ -257,6 +257,11 @@ class CppCheck::CppCheckLogger : public ErrorLogger
         mErrorLogger.reportOut(outmsg, c);
     }
 
+    void reportMetric(const std::string &metric) override
+    {
+        mErrorLogger.reportMetric(metric);
+    }
+
     void reportProgress(const std::string &filename, const char stage[], const std::size_t value) override
     {
         mErrorLogger.reportProgress(filename, stage, value);
@@ -1764,6 +1769,29 @@ void CppCheck::executeAddons(const std::vector<std::string>& files, const std::s
                 }
             }
 
+            if (obj.count("metric") > 0) {
+                picojson::object metric_json = obj["metric"].get<picojson::object>();
+
+                std::stringstream ss;
+                ss << "<";
+
+                bool isFirst = true;
+                for (auto pair : metric_json) {
+                    std::string sep = isFirst ? "" : " ";
+                    isFirst = false;
+                    const std::string id = pair.first;
+                    if (pair.second.is<std::int64_t>())
+                        ss << sep << id << "=\"" << pair.second.get<std::int64_t>() << "\"";
+                    else if (pair.second.is<std::string>())
+                        ss << sep << id << "=\"" << pair.second.get<std::string>() << "\"";
+                }
+
+                ss << "/>";
+                mErrorLogger.reportMetric(ss.str());
+
+                continue;
+            }
+
             errmsg.id = obj["addon"].get<std::string>() + "-" + obj["errorId"].get<std::string>();
             if (misraC2023 && startsWith(errmsg.id, "misra-c2012-"))
                 errmsg.id = "misra-c2023-" + errmsg.id.substr(12);

lib/errorlogger.h

@@ -245,6 +245,13 @@ class CPPCHECKLIB ErrorLogger {
      */
     virtual void reportErr(const ErrorMessage &msg) = 0;
 
+    /**
+     * Information about file metrics reported by addons.
+     *
+     * @param metric The file metric to report, as an XML object.
+     */
+    virtual void reportMetric(const std::string &metric) = 0;
+
     /**
      * Report progress to client
      * @param filename main file that is checked

oss-fuzz/main.cpp

@@ -43,6 +43,7 @@ class DummyErrorLogger : public ErrorLogger {
     void reportProgress(const std::string& /*filename*/,
                         const char /*stage*/[],
                         const std::size_t /*value*/) override {}
+    void reportMetric(const std::string & /*metric*/) override {}
 };
 
 static Settings create_settings()

test/fixture.h

@@ -290,6 +290,10 @@ class TestFixture : public ErrorLogger {
 
     void reportOut(const std::string &outmsg, Color c = Color::Reset) override;
     void reportErr(const ErrorMessage &msg) override;
+    void reportMetric(const std::string &metric) override
+    {
+        (void) metric;
+    }
     void run(const std::string &str);
 
 public:

test/testcppcheck.cpp

@@ -52,6 +52,10 @@ class TestCppcheck : public TestFixture {
             ids.push_back(msg.id);
             errmsgs.push_back(msg);
         }
+
+        void reportMetric(const std::string &metric) override {
+            (void) metric;
+        }
     };
 
     void run() override {