Add more logging in ScreenCapturerIntegrationTest

webrtc/modules/desktop_capture/screen_capturer_integration_test.cc

 /*
  *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #include <string.h>
 
 #include <algorithm>
 #include <initializer_list>
+#include <iostream>  // TODO(zijiehe): Remove once flaky has been resolved.
 #include <memory>
 #include <utility>
 
+// TODO(zijiehe): Remove once flaky has been resolved.
+#include "webrtc/base/base64.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/base/constructormagic.h"
 #include "webrtc/base/logging.h"
 #include "webrtc/modules/desktop_capture/desktop_capturer.h"
 #include "webrtc/modules/desktop_capture/desktop_capture_options.h"
 #include "webrtc/modules/desktop_capture/desktop_frame.h"
 #include "webrtc/modules/desktop_capture/desktop_region.h"
 #include "webrtc/modules/desktop_capture/mock_desktop_capturer_callback.h"
 #include "webrtc/modules/desktop_capture/rgba_color.h"
 #include "webrtc/modules/desktop_capture/screen_drawer.h"
@@ skipping 81 matching lines @@
     // by |c|) its primary colors is |i|, and the other two are 0x7f. So we
     // won't draw a black or white rectangle.
     for (int c = 0; c < 3; c++) {
       // A fixed size rectangle.
       for (int i = 0; i < kTestArea - kRectSize; i += 16) {
         DesktopRect rect = DesktopRect::MakeXYWH(i, i, kRectSize, kRectSize);
         rect.Translate(drawer->DrawableRegion().top_left());
         RgbaColor color((c == 0 ? (i & 0xff) : 0x7f),
                         (c == 1 ? (i & 0xff) : 0x7f),
                         (c == 2 ? (i & 0xff) : 0x7f));
-        TestCaptureOneFrame(capturers, drawer.get(), rect, color);
+        if (!TestCaptureOneFrame(capturers, drawer.get(), rect, color)) {
+          // Fail fast.
+          return;

[Sergey Ulanov, 2016/11/18 01:21:42]

Not sure why we need to return result here? The caller could use
ASSERT_NO_FATAL_FAILURE() to verify that there are no failures.

[Hzj_jie, 2016/11/18 04:32:00]

Ah, it's simply because I do not know this function.

+        }
       }
 
       // A variable-size rectangle.
       for (int i = 0; i < kTestArea - kRectSize; i += 16) {
         DesktopRect rect = DesktopRect::MakeXYWH(kRectSize, kRectSize, i, i);
         rect.Translate(drawer->DrawableRegion().top_left());
         RgbaColor color((c == 0 ? (i & 0xff) : 0x7f),
                         (c == 1 ? (i & 0xff) : 0x7f),
                         (c == 2 ? (i & 0xff) : 0x7f));
-        TestCaptureOneFrame(capturers, drawer.get(), rect, color);
+        if (!TestCaptureOneFrame(capturers, drawer.get(), rect, color)) {
+          // Fail fast.
+          return;
+        }
       }
     }
   }
 
   void TestCaptureUpdatedRegion() {
     TestCaptureUpdatedRegion({capturer_.get()});
   }
 
 #if defined(WEBRTC_WIN)
   // Enable allow_directx_capturer in DesktopCaptureOptions, but let
@@ skipping 23 matching lines @@
 #endif  // defined(WEBRTC_WIN)
 
   std::unique_ptr<DesktopCapturer> capturer_;
   MockDesktopCapturerCallback callback_;
 
  private:
   // Repeats capturing the frame by using |capturers| one-by-one for 600 times,
   // typically 30 seconds, until they succeeded captured a |color| rectangle at
   // |rect|. This function uses |drawer|->WaitForPendingDraws() between two
   // attempts to wait for the screen to update.
-  void TestCaptureOneFrame(std::vector<DesktopCapturer*> capturers,
+  //
+  // Returns false to indicate the error.
+  // TODO(zijiehe): Remove return value of this function once flaky of
+  // ScreenCapturerIntegrationTest has been resolved.
+  bool TestCaptureOneFrame(std::vector<DesktopCapturer*> capturers,
                            ScreenDrawer* drawer,
                            DesktopRect rect,
                            RgbaColor color) {
     const int wait_capture_round = 600;
     drawer->Clear();
     size_t succeeded_capturers = 0;
     for (int i = 0; i < wait_capture_round; i++) {
       drawer->DrawRectangle(rect, color);
       drawer->WaitForPendingDraws();
       for (size_t j = 0; j < capturers.size(); j++) {
         if (capturers[j] == nullptr) {
           // DesktopCapturer should return an empty updated_region() if no
-          // update detected. So we won't test it again if it has captured
-          // the rectangle we drew.
+          // update detected. So we won't test it again if it has captured the
+          // rectangle we drew.
           continue;
         }
         std::unique_ptr<DesktopFrame> frame = CaptureFrame(capturers[j]);
         if (!frame) {
-          // CaptureFrame() has triggered an assertion failure already, we
-          // only need to return here.
-          return;
+          // CaptureFrame() has triggered an assertion failure already, we only
+          // need to return here.
+          return false;
         }
 
         if (ArePixelsColoredBy(
             *frame, rect, color, drawer->MayDrawIncompleteShapes())) {
           capturers[j] = nullptr;
           succeeded_capturers++;
         }
+        // The following else if statement is for debugging purpose only, which
+        // should be removed after flaky of ScreenCapturerIntegrationTest has
+        // been resolved.
+        else if (i == wait_capture_round - 1) {
+          std::string result;
+          rtc::Base64::EncodeFromArray(frame->data(),
+                                       frame->size().height() * frame->stride(),
+                                       &result);
+          // LOG and ASSERT won't output a long string, so we can only use

[Sergey Ulanov, 2016/11/18 01:21:42]

What do you mean by "long string"? It looks like |result| is split into multiple
lines.
I think LOG(LS_INFO) should work here.

[Hzj_jie, 2016/11/18 04:32:00]

Done.

+          // std::out here.
+          std::cout << frame->size().width() << " x " << frame->size().height()
+                    << std::endl;
+          // Split the entire string (can be over 4M) into several lines to
+          // avoid browser from stucking.
+          static const size_t kLineLength = 32768;
+          const char* result_end = result.c_str() + result.length();
+          for (const char* it = result.c_str();
+               it < result_end;
+               it += kLineLength) {
+            const size_t max_length = result_end - it;
+            std::cout << std::string(it, std::min(kLineLength, max_length))
+                      << std::endl;
+          }
+          EXPECT_TRUE(false) << "ScreenCapturerIntegrationTest is flaky. "
+                                "Please disable *all* tests in "
+                                "screen_capturer_integration_test.cc";
+        }
       }
 
       if (succeeded_capturers == capturers.size()) {
         break;
       }
     }
 
-    ASSERT_EQ(succeeded_capturers, capturers.size());
+    EXPECT_EQ(succeeded_capturers, capturers.size());
+    return succeeded_capturers == capturers.size();
   }
 
   // Expects |capturer| to successfully capture a frame, and returns it.
   std::unique_ptr<DesktopFrame> CaptureFrame(DesktopCapturer* capturer) {
     std::unique_ptr<DesktopFrame> frame;
     EXPECT_CALL(callback_,
                 OnCaptureResultPtr(DesktopCapturer::Result::SUCCESS, _))
         .WillOnce(SaveUniquePtrArg(&frame));
     capturer->CaptureFrame();
     EXPECT_TRUE(frame);
@@ skipping 63 matching lines @@
        DISABLED_MaybeCaptureUpdatedRegionWithDirectxCapturer) {
   // Even DirectX capturer is not supported in current system, we should be able
   // to select a usable capturer.
   MaybeCreateDirectxCapturer();
   TestCaptureUpdatedRegion();
 }
 
 #endif  // defined(WEBRTC_WIN)
 
 }  // namespace webrtc