gm self-test: make sure we report failures in individual rendering modes

gm/gmmain.cpp

 /*
  * Copyright 2011 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 /*
  * Code for the "gm" (Golden Master) rendering comparison tool.
  *
@@ skipping 176 matching lines @@
     { " cross-process, shared address", SkGPipeWriter::kCrossProcess_Flag
         | SkGPipeWriter::kSharedAddressSpace_Flag }
 };
 
 class GMMain {
 public:
     GMMain() {
         // Set default values of member variables, which tool_main()
         // may override.
         fUseFileHierarchy = false;
+        fSimulatePipePlaybackFailure = false;

[borenet, 2013/03/14 18:48:21]

I'm not sure I like the technique of baking test code directly into the
application itself...

[epoger, 2013/03/14 18:57:12]

It rubs me the wrong way too, but I couldn't think of a better way of validating
the behavior.  Any ideas?

Adding Ravi in CC... back in TvAds, I could have done this by mocking out some
resource in such a way that it returned failure.  I can't figure out an
analogous approach here, but maybe there is one...

[borenet, 2013/03/14 19:02:21]

Yeah, I guess there's not a good way to force this to fail.  It might be better
if this were behind a #ifdef SELF_TEST thing, or even only included in debug
builds.

[rmistry, 2013/03/14 19:47:34]

Sorry, I may have been able to help for Java or Python but I have no experience
with mocking in C++.

[epoger, 2013/03/14 22:36:26]

I'd rather not require a compile-time flag, because that would require the gm
self-test to compile a special version of the code, which seems like both a
hassle and an opportunity for gm to behave different in the "real world" than it
does in test.

I don't think it's so bad to have this command-line option... the code to
implement it is very tight, and anybody who specifies it knows what they will
get!

[borenet, 2013/03/15 20:15:53]

Fair enough.

         fMismatchPath = NULL;
     }
 
     SkString make_name(const char shortName[], const char configName[]) {
         SkString name;
         if (0 == strlen(configName)) {
             name.append(shortName);
         } else if (fUseFileHierarchy) {
             name.appendf("%s%c%s", configName, SkPATH_SEPARATOR, shortName);
         } else {
@@ skipping 47 matching lines @@
         // The common case: no error means nothing to record.
         if (kEmptyErrorBitfield == errorType) {
             return;
         }
 
         // If only certain error type(s) were reported, we know we can ignore them.
         if (errorType == (errorType & kIgnorable_ErrorBitmask)) {
             return;
         }
 
-        FailRec& rec = fFailedTests.push_back(make_name(
-            name.c_str(), renderModeDescriptor));
+        SkString completeName = name;
+        completeName.append(renderModeDescriptor);

[epoger, 2013/03/14 17:22:19]

fixing a minor discrepancy revealed by this test

+        FailRec& rec = fFailedTests.push_back(completeName);
         rec.fIsPixelError =
             (kEmptyErrorBitfield != (errorType & kImageMismatch_ErrorBitmask));
     }
 
     // List contents of fFailedTests via SkDebug.
     void ListErrors() {
         for (int i = 0; i < fFailedTests.count(); ++i) {
             if (fFailedTests[i].fIsPixelError) {
                 gm_fprintf(stderr, "\t\t%s pixel_error\n", fFailedTests[i].fName.c_str());
             } else {
@@ skipping 622 matching lines @@
         ErrorBitfield errors = kEmptyErrorBitfield;
         for (size_t i = 0; i < SK_ARRAY_COUNT(gPipeWritingFlagCombos); ++i) {
             SkBitmap bitmap;
             SkISize size = gm->getISize();
             setup_bitmap(gRec, size, &bitmap);
             SkCanvas canvas(bitmap);
             PipeController pipeController(&canvas);
             SkGPipeWriter writer;
             SkCanvas* pipeCanvas = writer.startRecording(
               &pipeController, gPipeWritingFlagCombos[i].flags);
-            invokeGM(gm, pipeCanvas, false, false);
+            if (!this->fSimulatePipePlaybackFailure) {
+                invokeGM(gm, pipeCanvas, false, false);
+            }
             complete_bitmap(&bitmap);
             writer.endRecording();
             SkString string("-pipe");
             string.append(gPipeWritingFlagCombos[i].name);
             errors |= compare_test_results_to_reference_bitmap(
                 gm, gRec, string.c_str(), bitmap, &referenceBitmap);
             if (errors != kEmptyErrorBitfield) {
                 break;
             }
         }
@@ skipping 25 matching lines @@
         }
         return errors;
     }
 
     //
     // member variables.
     // They are public for now, to allow easier setting by tool_main().
     //
 
     bool fUseFileHierarchy;
+    bool fSimulatePipePlaybackFailure;
 
     const char* fMismatchPath;
 
     // information about all failed tests we have encountered so far
     SkTArray<FailRec> fFailedTests;
 
     // Where to read expectations (expected image checksums, etc.) from.
     // If unset, we don't do comparisons.
     SkAutoTUnref<ExpectationsSource> fExpectationsSource;
 
@@ skipping 83 matching lines @@
 "    [--modulo <remainder> <divisor>]: only run tests for which \n"
 "        testIndex %% divisor == remainder\n"
 "    [--nopdf]: skip the pdf rendering test pass\n"
 "    [--nopipe]: Skip SkGPipe replay\n"
 "    [--readPath|-r <path>]: read reference images from this dir, and report\n"
 "        any differences between those and the newly generated ones\n"
 "    [--noreplay]: do not exercise SkPicture replay\n"
 "    [--resourcePath|-i <path>]: directory that stores image resources\n"
 "    [--nortree]: Do not exercise the R-Tree variant of SkPicture\n"
 "    [--noserialize]: do not exercise SkPicture serialization & deserialization\n"
+"    [--simulatePipePlaybackFailure]: simulate a rendering failure in pipe mode only\n"
 "    [--tiledPipe]: Exercise tiled SkGPipe replay\n"
 "    [--notileGrid]: Do not exercise the tile grid variant of SkPicture\n"
 "    [--tileGridReplayScales <scales>]: Comma separated list of floating-point scale\n"
 "        factors to be used for tileGrid playback testing. Default value: 1.0\n"
 "    [--writeJsonSummary <path>]: write a JSON-formatted result summary to this file\n"
 "    [--verbose] print diagnostics (e.g. list each config to be tested)\n"
 "    [--writePath|-w <path>]: write rendered images into this directory\n"
 "    [--writePicturePath|-wp <path>]: write .skp files into this directory\n"
              );
 }
@@ skipping 246 matching lines @@
         } else if ((0 == strcmp(*argv, "--resourcePath")) ||
                    (0 == strcmp(*argv, "-i"))) {
             argv++;
             if (argv < stop && **argv) {
                 resourcePath = *argv;
             }
         } else if (strcmp(*argv, "--serialize") == 0) {
             doSerialize = true;
         } else if (strcmp(*argv, "--noserialize") == 0) {
             doSerialize = false;
+        } else if (strcmp(*argv, "--simulatePipePlaybackFailure") == 0) {
+            gmmain.fSimulatePipePlaybackFailure = true;
         } else if (strcmp(*argv, "--tiledPipe") == 0) {
             doTiledPipe = true;
         } else if (!strcmp(*argv, "--verbose") || !strcmp(*argv, "-v")) {
             doVerbose = true;
         } else if ((0 == strcmp(*argv, "--writePath")) ||
             (0 == strcmp(*argv, "-w"))) {
             argv++;
             if (argv < stop && **argv) {
                 writePath = *argv;
             }
@@ skipping 387 matching lines @@
     SkGraphics::Term();
 
     return (0 == testsFailed) ? 0 : -1;
 }
 
 #if !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_NACL)
 int main(int argc, char * const argv[]) {
     return tool_main(argc, (char**) argv);
 }
 #endif