impeller::testing::GoldenDigest Class Reference

Manages a global variable for tracking instances of golden images. More...

#include <golden_digest.h>

Public Member Functions
void	AddDimension (const std::string &name, const std::string &value)
void	AddImage (const std::string &test_name, const std::string &filename, int32_t width, int32_t height)
bool	Write (WorkingDirectory *working_directory)

Static Public Member Functions
static GoldenDigest *	Instance ()

Detailed Description

Manages a global variable for tracking instances of golden images.

Definition at line 18 of file golden_digest.h.

Member Function Documentation

AddDimension()

void impeller::testing::GoldenDigest::AddDimension	(	const std::string &	name,
		const std::string &	value
	)

Definition at line 27 of file golden_digest.cc.

                                                        {
  std::stringstream ss;
  ss << "\"" << value << "\"";
  dimensions_[name] = ss.str();
}

References value.

Referenced by impeller::GoldenPlaygroundTest::SetUp(), and impeller::testing::GoldenTests::SetUp().

AddImage()

void impeller::testing::GoldenDigest::AddImage	(	const std::string &	test_name,
		const std::string &	filename,
		int32_t	width,
		int32_t	height
	)

Definition at line 34 of file golden_digest.cc.

                                            {
  entries_.push_back({test_name, filename, width, height, kMaxDiffPixelsPercent,
                      kMaxColorDelta});
}

References kMaxColorDelta, and kMaxDiffPixelsPercent.

Referenced by impeller::GoldenPlaygroundTest::SaveScreenshot().

Instance()

GoldenDigest * impeller::testing::GoldenDigest::Instance ( )

static

Definition at line 18 of file golden_digest.cc.

                                     {
  if (!instance_) {
    instance_ = new GoldenDigest();
  }
  return instance_;
}

Referenced by main(), impeller::GoldenPlaygroundTest::SaveScreenshot(), impeller::GoldenPlaygroundTest::SetUp(), and impeller::testing::GoldenTests::SetUp().

Write()

bool impeller::testing::GoldenDigest::Write

(

WorkingDirectory *

working_directory

)

Writes a "digest.json" file to working_directory.

Returns true on success.

Definition at line 42 of file golden_digest.cc.

                                                            {
  std::ofstream fout;
  fout.open(working_directory->GetFilenamePath("digest.json"));
  if (!fout.good()) {
    return false;
  }
 
  fout << "{" << std::endl;
  fout << "  \"dimensions\": {" << std::endl;
  bool is_first = true;
  for (const auto& dimension : dimensions_) {
    if (!is_first) {
      fout << "," << std::endl;
    }
    is_first = false;
    fout << "    \"" << dimension.first << "\": " << dimension.second;
  }
  fout << std::endl << "  }," << std::endl;
  fout << "  \"entries\":" << std::endl;
 
  fout << "  [" << std::endl;
  is_first = true;
  for (const auto& entry : entries_) {
    if (!is_first) {
      fout << "," << std::endl;
    }
    is_first = false;
 
    fout << "    { " << "\"testName\" : \"" << entry.test_name << "\", "
         << "\"filename\" : \"" << entry.filename << "\", "
         << "\"width\" : " << entry.width << ", "
         << "\"height\" : " << entry.height << ", ";
 
    if (entry.max_diff_pixels_percent ==
        static_cast<int64_t>(entry.max_diff_pixels_percent)) {
      fout << "\"maxDiffPixelsPercent\" : " << entry.max_diff_pixels_percent
           << ".0, ";
    } else {
      fout << "\"maxDiffPixelsPercent\" : " << entry.max_diff_pixels_percent
           << ", ";
    }
 
    fout << "\"maxColorDelta\":" << entry.max_color_delta << " ";
    fout << "}";
  }
  fout << std::endl << "  ]" << std::endl;
 
  fout << "}" << std::endl;
 
  fout.close();
  return true;
}

References impeller::testing::WorkingDirectory::GetFilenamePath().

Referenced by main().

---

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

• impeller/golden_tests/golden_digest.h
• impeller/golden_tests/golden_digest.cc