GM: create GmResultDigest that encapsulates digest type ("bitmap-64bitMD5") and value (12345)

gm/gm_expectations.cpp

 /*
  * Copyright 2013 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #include "gm_expectations.h"
 #include "SkBitmapHasher.h"
 #include "SkImageDecoder.h"
 
 #define DEBUGFAIL_SEE_STDERR SkDEBUGFAIL("see stderr for message")
 
 // These constants must be kept in sync with the JSONKEY_ constants in
 // display_json_results.py !
 const static char kJsonKey_ActualResults[]   = "actual-results";
 const static char kJsonKey_ActualResults_Failed[]        = "failed";
 const static char kJsonKey_ActualResults_FailureIgnored[]= "failure-ignored";
 const static char kJsonKey_ActualResults_NoComparison[]  = "no-comparison";
 const static char kJsonKey_ActualResults_Succeeded[]     = "succeeded";
-const static char kJsonKey_ActualResults_AnyStatus_BitmapHash[]  = "bitmap-64bitMD5";
 
 const static char kJsonKey_ExpectedResults[] = "expected-results";
-const static char kJsonKey_ExpectedResults_AllowedBitmapHashes[] = "allowed-bitmap-64bitMD5s";
-const static char kJsonKey_ExpectedResults_IgnoreFailure[]           = "ignore-failure";
+const static char kJsonKey_ExpectedResults_AllowedDigests[] = "allowed-digests";

[epoger, 2013/05/23 19:18:31]

As the GmResultDigest class learns about additional digest types, we will be
able to write them into the "allowed-digests" section of the JSON expectations
file.

+const static char kJsonKey_ExpectedResults_IgnoreFailure[]  = "ignore-failure";
+
+// Types of result hashes we support in the JSON file.
+const static char kJsonKey_Hashtype_Bitmap_64bitMD5[]  = "bitmap-64bitMD5";
+
 
 namespace skiagm {
 
     void gm_fprintf(FILE *stream, const char format[], ...) {
         va_list args;
         va_start(args, format);
         fprintf(stream, "GM: ");
         vfprintf(stream, format, args);
         va_end(args);
     }
 
     SkString SkPathJoin(const char *rootPath, const char *relativePath) {
         SkString result(rootPath);
         if (!result.endsWith(SkPATH_SEPARATOR)) {
             result.appendUnichar(SkPATH_SEPARATOR);
         }
         result.append(relativePath);
         return result;
     }
 
-    // TODO(epoger): This currently assumes that the result SkHashDigest was
-    // generated as an SkHashDigest of an SkBitmap.  We'll need to allow for other
-    // hash types to cover non-bitmaps.
-    Json::Value ActualResultAsJsonValue(const SkHashDigest& result) {
-        Json::Value jsonValue;
-        jsonValue[kJsonKey_ActualResults_AnyStatus_BitmapHash] = asJsonValue(result);
-        return jsonValue;
-    }
-
     Json::Value CreateJsonTree(Json::Value expectedResults,
                                Json::Value actualResultsFailed,
                                Json::Value actualResultsFailureIgnored,
                                Json::Value actualResultsNoComparison,
                                Json::Value actualResultsSucceeded) {
         Json::Value actualResults;
         actualResults[kJsonKey_ActualResults_Failed] = actualResultsFailed;
         actualResults[kJsonKey_ActualResults_FailureIgnored] = actualResultsFailureIgnored;
         actualResults[kJsonKey_ActualResults_NoComparison] = actualResultsNoComparison;
         actualResults[kJsonKey_ActualResults_Succeeded] = actualResultsSucceeded;
         Json::Value root;
         root[kJsonKey_ActualResults] = actualResults;
         root[kJsonKey_ExpectedResults] = expectedResults;
         return root;
     }
 
 
+    // GmResultDigest class...
+
+    GmResultDigest::GmResultDigest(const SkBitmap &bitmap) {
+        // TODO(epoger): Better handling for error returned by ComputeDigest()?
+        // For now, we just report a digest of 0 in error cases, like before.
+        if (!SkBitmapHasher::ComputeDigest(bitmap, &fHashDigest)) {
+            fHashDigest = 0;
+        }
+    }
+
+    GmResultDigest::GmResultDigest(const Json::Value &jsonTypeValuePair) {
+        // TODO(epoger): We check for various error cases below, but in release
+        // mode we keep on trucking even in these error cases.
+        //
+        // Maybe we should set some sort of fIsBogus boolean flag on the
+        // object created?  Or, instead of a constructor, use a factory method
+        // which can signal success/failure?
+
+        fHashDigest = 0; // default value in case of error
+        if (!jsonTypeValuePair.isArray()) {
+            gm_fprintf(stderr, "found non-array json value when parsing GmResultDigest: %s\n",
+                       jsonTypeValuePair.toStyledString().c_str());
+            DEBUGFAIL_SEE_STDERR;
+        } else if (2 != jsonTypeValuePair.size()) {
+            gm_fprintf(stderr, "found json array with wrong size when parsing GmResultDigest: %s\n",
+                       jsonTypeValuePair.toStyledString().c_str());
+            DEBUGFAIL_SEE_STDERR;
+        } else {
+            // TODO(epoger): The current implementation assumes that the
+            // result digest is always of type kJsonKey_Hashtype_Bitmap_64bitMD5
+            Json::Value jsonHashValue = jsonTypeValuePair[1];
+            if (!jsonHashValue.isIntegral()) {
+                gm_fprintf(stderr,
+                           "found non-integer jsonHashValue when parsing GmResultDigest: %s\n",
+                           jsonTypeValuePair.toStyledString().c_str());
+                DEBUGFAIL_SEE_STDERR;
+            } else {
+                fHashDigest = jsonHashValue.asUInt64();
+            }
+        }
+    }
+
+    bool GmResultDigest::equals(const GmResultDigest &other) const {
+        // TODO(epoger): The current implementation assumes that this
+        // and other are always of type kJsonKey_Hashtype_Bitmap_64bitMD5
+        return (this->fHashDigest == other.fHashDigest);

[scroggo, 2013/05/23 20:42:58]

If we special cased 0, two failed GmResultDigests would not be equal. Would that
be useful so that we catch the error?

[epoger, 2013/05/23 21:06:18]

Good idea!  I took this and ran with it, adding an inValid() method.  What do
you think?

+    }
+
+    Json::Value GmResultDigest::asJsonTypeValuePair() const {
+        // TODO(epoger): The current implementation assumes that the
+        // result digest is always of type kJsonKey_Hashtype_Bitmap_64bitMD5
+        Json::Value jsonTypeValuePair;
+        jsonTypeValuePair.append(Json::Value(kJsonKey_Hashtype_Bitmap_64bitMD5));
+        jsonTypeValuePair.append(Json::UInt64(fHashDigest));
+        return jsonTypeValuePair;
+    }
+
+
     // Expectations class...
 
     Expectations::Expectations(bool ignoreFailure) {
         fIgnoreFailure = ignoreFailure;
     }
 
     Expectations::Expectations(const SkBitmap& bitmap, bool ignoreFailure) {
         fBitmap = bitmap;
         fIgnoreFailure = ignoreFailure;
-        SkHashDigest digest;
-        // TODO(epoger): Better handling for error returned by ComputeDigest()?
-        // For now, we just report a digest of 0 in error cases, like before.
-        if (!SkBitmapHasher::ComputeDigest(bitmap, &digest)) {
-            digest = 0;
-        }
-        fAllowedBitmapChecksums.push_back() = digest;
+        fAllowedResultDigests.push_back(GmResultDigest(bitmap));
     }
 
     Expectations::Expectations(Json::Value jsonElement) {
         if (jsonElement.empty()) {
             fIgnoreFailure = kDefaultIgnoreFailure;
         } else {
             Json::Value ignoreFailure = jsonElement[kJsonKey_ExpectedResults_IgnoreFailure];
             if (ignoreFailure.isNull()) {
                 fIgnoreFailure = kDefaultIgnoreFailure;
             } else if (!ignoreFailure.isBool()) {
                 gm_fprintf(stderr, "found non-boolean json value"
                            " for key '%s' in element '%s'\n",
                            kJsonKey_ExpectedResults_IgnoreFailure,
                            jsonElement.toStyledString().c_str());
                 DEBUGFAIL_SEE_STDERR;
                 fIgnoreFailure = kDefaultIgnoreFailure;
             } else {
                 fIgnoreFailure = ignoreFailure.asBool();
             }
 
-            Json::Value allowedChecksums =
-                jsonElement[kJsonKey_ExpectedResults_AllowedBitmapHashes];
-            if (allowedChecksums.isNull()) {
-                // ok, we'll just assume there aren't any expected checksums to compare against
-            } else if (!allowedChecksums.isArray()) {
+            Json::Value allowedDigests = jsonElement[kJsonKey_ExpectedResults_AllowedDigests];
+            if (allowedDigests.isNull()) {
+                // ok, we'll just assume there aren't any AllowedDigests to compare against
+            } else if (!allowedDigests.isArray()) {
                 gm_fprintf(stderr, "found non-array json value"
                            " for key '%s' in element '%s'\n",
-                           kJsonKey_ExpectedResults_AllowedBitmapHashes,
+                           kJsonKey_ExpectedResults_AllowedDigests,
                            jsonElement.toStyledString().c_str());
                 DEBUGFAIL_SEE_STDERR;
             } else {
-                for (Json::ArrayIndex i=0; i<allowedChecksums.size(); i++) {
-                    Json::Value checksumElement = allowedChecksums[i];
-                    if (!checksumElement.isIntegral()) {
-                        gm_fprintf(stderr, "found non-integer checksum"
-                                   " in json element '%s'\n",
-                                   jsonElement.toStyledString().c_str());
-                        DEBUGFAIL_SEE_STDERR;
-                    } else {
-                        fAllowedBitmapChecksums.push_back() = asChecksum(checksumElement);
-                    }
+                for (Json::ArrayIndex i=0; i<allowedDigests.size(); i++) {
+                    fAllowedResultDigests.push_back(GmResultDigest(allowedDigests[i]));
                 }
             }
         }
     }
 
-    bool Expectations::match(Checksum actualChecksum) const {
-        for (int i=0; i < this->fAllowedBitmapChecksums.count(); i++) {
-            Checksum allowedChecksum = this->fAllowedBitmapChecksums[i];
-            if (allowedChecksum == actualChecksum) {
+    bool Expectations::match(GmResultDigest actualGmResultDigest) const {
+        for (int i=0; i < this->fAllowedResultDigests.count(); i++) {
+            GmResultDigest allowedResultDigest = this->fAllowedResultDigests[i];
+            if (allowedResultDigest.equals(actualGmResultDigest)) {
                 return true;
             }
         }
         return false;
     }
 
     Json::Value Expectations::asJsonValue() const {
-        Json::Value allowedChecksumArray;
-        if (!this->fAllowedBitmapChecksums.empty()) {
-            for (int i=0; i < this->fAllowedBitmapChecksums.count(); i++) {
-                Checksum allowedChecksum = this->fAllowedBitmapChecksums[i];
-                allowedChecksumArray.append(Json::UInt64(allowedChecksum));
+        Json::Value allowedDigestArray;
+        if (!this->fAllowedResultDigests.empty()) {
+            for (int i=0; i < this->fAllowedResultDigests.count(); i++) {
+                allowedDigestArray.append(this->fAllowedResultDigests[i].asJsonTypeValuePair());
             }
         }
 
-        Json::Value jsonValue;
-        jsonValue[kJsonKey_ExpectedResults_AllowedBitmapHashes] = allowedChecksumArray;
-        jsonValue[kJsonKey_ExpectedResults_IgnoreFailure] = this->ignoreFailure();
-        return jsonValue;
+        Json::Value jsonExpectations;
+        jsonExpectations[kJsonKey_ExpectedResults_AllowedDigests] = allowedDigestArray;
+        jsonExpectations[kJsonKey_ExpectedResults_IgnoreFailure]  = this->ignoreFailure();
+        return jsonExpectations;
     }
 
 
     // IndividualImageExpectationsSource class...
 
     Expectations IndividualImageExpectationsSource::get(const char *testName) {
         SkString path = SkPathJoin(fRootDir.c_str(), testName);
         SkBitmap referenceBitmap;
         bool decodedReferenceBitmap =
             SkImageDecoder::DecodeFile(path.c_str(), &referenceBitmap,
@@ skipping 57 matching lines @@
         Json::Reader reader;
         if (!reader.parse(bytes, bytes+size, *jsonRoot)) {
             gm_fprintf(stderr, "error parsing JSON file %s\n", jsonPath);
             DEBUGFAIL_SEE_STDERR;
             return false;
         }
         return true;
     }
 
 }