ResultsJSONWriter Class Reference

Classes
struct	Result
struct	SingleMeasurement

Public Member Functions
	ResultsJSONWriter (const char *path)
void	addGitHash (std::string gitHash)
void	addChangelistInfo (std::string issue, std::string patchset)
void	addKey (std::map< std::string, std::string > key)
void	addLinks (std::map< std::string, std::string > links)
void	addResult (Result result)
void	flush ()
	~ResultsJSONWriter ()

Detailed Description

Definition at line 196 of file BazelBenchmarkTestRunner.cpp.

Constructor & Destructor Documentation

ResultsJSONWriter()

ResultsJSONWriter::ResultsJSONWriter ( const char *  path )

inline

Definition at line 216 of file BazelBenchmarkTestRunner.cpp.

            : fFileWStream(path)
            , fJson(&fFileWStream, SkJSONWriter::Mode::kPretty)
            , fAddingResults(false) {
        fJson.beginObject();  // Root object.
        fJson.appendS32("version", 1);
    }

~ResultsJSONWriter()

ResultsJSONWriter::~ResultsJSONWriter ( )

inline

Definition at line 293 of file BazelBenchmarkTestRunner.cpp.

                         {
        if (fAddingResults) {
            fJson.endArray();  // "results" array;
        }
        fJson.endObject();  // Root object.
    }

Member Function Documentation

addChangelistInfo()

void ResultsJSONWriter::addChangelistInfo ( std::string  issue, std::string  patchset  )

inline

Definition at line 229 of file BazelBenchmarkTestRunner.cpp.

                                                                {
        assertNotAddingResults();
        fJson.appendCString("issue", issue.c_str());
        fJson.appendCString("patchset", patchset.c_str());
    }

addGitHash()

void ResultsJSONWriter::addGitHash ( std::string  gitHash )

inline

Definition at line 224 of file BazelBenchmarkTestRunner.cpp.

                                       {
        assertNotAddingResults();
        fJson.appendCString("git_hash", gitHash.c_str());
    }

addKey()

void ResultsJSONWriter::addKey ( std::map< std::string, std::string >  key )

inline

Definition at line 235 of file BazelBenchmarkTestRunner.cpp.

                                                  {
        assertNotAddingResults();
        fJson.beginObject("key");
        for (auto const& [name, value] : key) {
            fJson.appendCString(name.c_str(), value.c_str());
        }
        fJson.endObject();
    }

addLinks()

void ResultsJSONWriter::addLinks ( std::map< std::string, std::string >  links )

inline

Definition at line 244 of file BazelBenchmarkTestRunner.cpp.

                                                      {
        assertNotAddingResults();
        fJson.beginObject("links");
        for (auto const& [key, value] : links) {
            fJson.appendCString(key.c_str(), value.c_str());
        }
        fJson.endObject();
    }

addResult()

void ResultsJSONWriter::addResult ( Result  result )

inline

Definition at line 253 of file BazelBenchmarkTestRunner.cpp.

                                  {
        if (!fAddingResults) {
            fAddingResults = true;
            fJson.beginArray("results");  // "results" array.
        }
 
        fJson.beginObject();  // Result object.
 
        // Key.
        fJson.beginObject("key");  // "key" dictionary.
        for (auto const& [name, value] : result.key) {
            fJson.appendCString(name.c_str(), value.c_str());
        }
        fJson.endObject();  // "key" dictionary.
 
        // Measurements.
        fJson.beginObject("measurements");  // "measurements" dictionary.
        for (auto const& [name, singleMeasurements] : result.measurements) {
            fJson.beginArray(name.c_str());  // <name> array.
            for (const SingleMeasurement& singleMeasurement : singleMeasurements) {
                // Based on
                // https://skia.googlesource.com/skia/+/a063eaeaf1e09e4d6f42e0f44a5723622a46d21c/bench/ResultsWriter.h#51.
                //
                // Don't record if NaN or Inf.
                if (SkIsFinite(singleMeasurement.measurement)) {
                    fJson.beginObject();
                    fJson.appendCString("value", singleMeasurement.value.c_str());
                    fJson.appendDoubleDigits("measurement", singleMeasurement.measurement, 16);
                    fJson.endObject();
                }
            }
            fJson.endArray();  // <name> array.
        }
        fJson.endObject();  // "measurements" dictionary.
 
        fJson.endObject();  // Result object.
    }

flush()

void ResultsJSONWriter::flush ( )

inline

Definition at line 291 of file BazelBenchmarkTestRunner.cpp.

{ fJson.flush(); }

---

The documentation for this class was generated from the following file:

• third_party/skia/tools/testrunners/benchmark/BazelBenchmarkTestRunner.cpp