impeller::testing::GoldenDigestManager Class Reference

#include <golden_digest_manager.h>

Public Member Functions
	GoldenDigestManager (const std::string &working_directory)
	~GoldenDigestManager ()
const std::string &	GetWorkingDirectory () const
std::string	GetFullPath (const std::string &filename) const
void	AddDimension (const std::string &name, const std::string &value)
void	AddImage (const std::string &test_name, const std::string &golden_filename, int32_t width, int32_t height)
bool	Write ()
void	ClearDigestData ()

Detailed Description

Manages a global variable for tracking a directory containing instances of golden images.

Definition at line 17 of file golden_digest_manager.h.

Constructor & Destructor Documentation

GoldenDigestManager()

impeller::testing::GoldenDigestManager::GoldenDigestManager ( const std::string &  working_directory )

explicit

Constructs a GoldenDigest that will accumulate golden image filenames and Dimension key/value pairs for the specified working directory and write them to a file named "digest.json" in that directory when |Write| is called.

Definition at line 19 of file golden_digest_manager.cc.

    : working_directory_(working_directory_path) {}

~GoldenDigestManager()

impeller::testing::GoldenDigestManager::~GoldenDigestManager

(

)

Definition at line 23 of file golden_digest_manager.cc.

                                          {
  if (entries_written_ < entries_.size() ||
      dimensions_written_ < dimensions_.size()) {
    FML_LOG(WARNING)                                  //
        << "golden digest at " << working_directory_  //
        << " incomplete, with only "                  //
        << dimensions_written_ << " out of "          //
        << dimensions_.size() << " dimensions "       //
        << "and "                                     //
        << entries_written_ << " out of "             //
        << entries_.size() << " image entries"        //
        << " written";
  }
}

References FML_LOG.

Member Function Documentation

AddDimension()

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

Definition at line 47 of file golden_digest_manager.cc.

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

References flutter::name, and value.

AddImage()

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

Definition at line 54 of file golden_digest_manager.cc.

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

References height, kMaxColorDelta, kMaxDiffPixelsPercent, and width.

ClearDigestData()

void impeller::testing::GoldenDigestManager::ClearDigestData

(

)

Clears all accumulated dimension and golden image data if the digest should not be written.

(Failing to call either this method or the |Write| method causes a warning to be written to the console about unwritten data left in the digest manater.)

Definition at line 123 of file golden_digest_manager.cc.

                                          {
  dimensions_.clear();
  entries_.clear();
 
  dimensions_written_ = 0u;
  entries_written_ = 0u;
}

GetFullPath()

std::string impeller::testing::GoldenDigestManager::GetFullPath

(

const std::string &

filename

)

const

Definition at line 42 of file golden_digest_manager.cc.

                                     {
  return fml::paths::JoinPaths({working_directory_, filename});
}

References fml::paths::JoinPaths().

Referenced by Write().

GetWorkingDirectory()

const std::string & impeller::testing::GoldenDigestManager::GetWorkingDirectory

(

)

const

Definition at line 38 of file golden_digest_manager.cc.

                                                                {
  return working_directory_;
}

Write()

bool impeller::testing::GoldenDigestManager::Write

(

)

Writes a "digest.json" file to the working directory.

(Failing to call either this method or the |ClearDigestData| method causes a warning to be written to the console about unwritten data left in the digest manater.)

Returns true on success.

Definition at line 62 of file golden_digest_manager.cc.

                                {
  std::ofstream fout;
  fout.open(GetFullPath("digest.json"));
  if (!fout.good()) {
    return false;
  }
 
  // If we wrote some stuff before, this will be an update on top of that
  // work, rewriting the file again from the beginning. This allows test
  // suites to defensively write the digest after every group of tests.
  dimensions_written_ = 0u;
  entries_written_ = 0u;
 
  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;
    dimensions_written_++;
  }
  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 << "}";
    entries_written_++;
  }
  fout << std::endl << "  ]" << std::endl;
 
  fout << "}" << std::endl;
 
  fout.close();
  return true;
}

References GetFullPath().

---

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

• impeller/testing/golden_digest_manager.h
• impeller/testing/golden_digest_manager.cc