Refactor Shell unit-tests to allow runtime selection of client rendering API.

Adds support for Metal rasterizers in the unit-test harness.

Author: chinmaygarde

shell/common/BUILD.gn

@@ -2,6 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import("$flutter_root/shell/config.gni")
 import("$flutter_root/shell/gpu/gpu.gni")
 import("$flutter_root/testing/testing.gni")
 
@@ -158,14 +159,30 @@ if (current_toolchain == host_toolchain) {
   }
 
   shell_host_executable("shell_unittests") {
+    defines = []
+
+    if (shell_enable_metal) {
+      defines += [ "SHELL_ENABLE_METAL" ]
+    }
+
     sources = [
-      "canvas_spy_unittests.cc",
-      "input_events_unittests.cc",
-      "persistent_cache_unittests.cc",
-      "pipeline_unittests.cc",
-      "shell_test.cc",
-      "shell_test.h",
-      "shell_unittests.cc",
+      "tests/canvas_spy_unittests.cc",
+      "tests/input_events_unittests.cc",
+      "tests/persistent_cache_unittests.cc",
+      "tests/pipeline_unittests.cc",
+      "tests/shell_test.cc",
+      "tests/shell_test.h",
+      "tests/shell_test_platform_view.cc",
+      "tests/shell_test_platform_view.h",
+      "tests/shell_test_surface.cc",
+      "tests/shell_test_surface.h",
+      "tests/shell_test_surface_gl.cc",
+      "tests/shell_test_surface_gl.h",
+      "tests/shell_test_surface_metal.cc",
+      "tests/shell_test_surface_metal.h",
+      "tests/shell_test_vsync_waiter.cc",
+      "tests/shell_test_vsync_waiter.h",
+      "tests/shell_unittests.cc",
     ]
 
     deps = [
@@ -177,8 +194,25 @@ if (current_toolchain == host_toolchain) {
       "$flutter_root/lib/ui:ui",
       "$flutter_root/shell",
       "$flutter_root/testing:dart",
+      "$flutter_root/testing:metal",
       "$flutter_root/testing:opengl",
     ]
+
+    libs = []
+
+    if (shell_enable_metal) {
+      sources += [
+        "tests/shell_test_surface_metal_impl.h",
+        "tests/shell_test_surface_metal_impl.mm",
+      ]
+
+      deps += [ "//flutter/shell/gpu:gpu_surface_metal" ]
+
+      libs += [
+        "Foundation.framework",
+        "QuartzCore.framework",
+      ]
+    }
   }
 
   shell_host_executable("shell_benchmarks") {

shell/common/canvas_spy_unittests.cc renamed to shell/common/tests/canvas_spy_unittests.cc

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "canvas_spy.h"
+#include "flutter/shell/common/canvas_spy.h"
 #include "gtest/gtest.h"
 #include "third_party/skia/include/core/SkPictureRecorder.h"
 #include "third_party/skia/include/core/SkSurface.h"

shell/common/input_events_unittests.cc renamed to shell/common/tests/input_events_unittests.cc

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "flutter/shell/common/shell_test.h"
+#include "flutter/shell/common/tests/shell_test.h"
 #include "flutter/testing/testing.h"
 
 namespace flutter {

shell/common/persistent_cache_unittests.cc renamed to shell/common/tests/persistent_cache_unittests.cc

@@ -12,8 +12,8 @@
 #include "flutter/fml/file.h"
 #include "flutter/fml/unique_fd.h"
 #include "flutter/shell/common/persistent_cache.h"
-#include "flutter/shell/common/shell_test.h"
 #include "flutter/shell/common/switches.h"
+#include "flutter/shell/common/tests/shell_test.h"
 #include "flutter/testing/testing.h"
 #include "include/core/SkPicture.h"
 

shell/common/pipeline_unittests.cc renamed to shell/common/tests/pipeline_unittests.cc

@@ -2,18 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include <future>
-#define FML_USED_ON_EMBEDDER
+#include "flutter/shell/common/tests/shell_test.h"
 
-#include "flutter/shell/common/shell_test.h"
-
-#include "flutter/flow/layers/layer_tree.h"
 #include "flutter/flow/layers/transform_layer.h"
-#include "flutter/fml/make_copyable.h"
-#include "flutter/fml/mapping.h"
-#include "flutter/runtime/dart_vm.h"
-#include "flutter/shell/gpu/gpu_surface_gl.h"
-#include "flutter/testing/testing.h"
+#include "flutter/shell/common/tests/shell_test_platform_view.h"
 
 namespace flutter {
 namespace testing {
@@ -23,6 +15,24 @@ ShellTest::ShellTest()
 
 ShellTest::~ShellTest() = default;
 
+// |testing::ThreadTest|
+void ShellTest::SetUp() {
+  ThreadTest::SetUp();
+  assets_dir_ =
+      fml::OpenDirectory(GetFixturesPath(), false, fml::FilePermission::kRead);
+  thread_host_ = std::make_unique<ThreadHost>(
+      "io.flutter.test." + GetCurrentTestName() + ".",
+      ThreadHost::Type::Platform | ThreadHost::Type::IO | ThreadHost::Type::UI |
+          ThreadHost::Type::GPU);
+}
+
+// |testing::ThreadTest|
+void ShellTest::TearDown() {
+  ThreadTest::TearDown();
+  assets_dir_.reset();
+  thread_host_.reset();
+}
+
 void ShellTest::SendEnginePlatformMessage(
     Shell* shell,
     fml::RefPtr<PlatformMessage> message) {
@@ -232,6 +242,20 @@ TaskRunners ShellTest::GetTaskRunnersForFixture() {
   };
 }
 
+std::unique_ptr<Shell> ShellTest::CreateShell(
+    Settings settings,
+    ShellTestSurface::ClientRenderingAPI api) {
+  return Shell::Create(
+      GetTaskRunnersForFixture(), settings,
+      [api](Shell& shell) {
+        return std::make_unique<ShellTestPlatformView>(
+            shell, shell.GetTaskRunners(), api);
+      },
+      [](Shell& shell) {
+        return std::make_unique<Rasterizer>(shell, shell.GetTaskRunners());
+      });
+}
+
 std::unique_ptr<Shell> ShellTest::CreateShell(Settings settings,
                                               bool simulate_vsync) {
   return CreateShell(std::move(settings), GetTaskRunnersForFixture(),
@@ -267,132 +291,10 @@ void ShellTest::DestroyShell(std::unique_ptr<Shell> shell,
   latch.Wait();
 }
 
-// |testing::ThreadTest|
-void ShellTest::SetUp() {
-  ThreadTest::SetUp();
-  assets_dir_ =
-      fml::OpenDirectory(GetFixturesPath(), false, fml::FilePermission::kRead);
-  thread_host_ = std::make_unique<ThreadHost>(
-      "io.flutter.test." + GetCurrentTestName() + ".",
-      ThreadHost::Type::Platform | ThreadHost::Type::IO | ThreadHost::Type::UI |
-          ThreadHost::Type::GPU);
-}
-
-// |testing::ThreadTest|
-void ShellTest::TearDown() {
-  ThreadTest::TearDown();
-  assets_dir_.reset();
-  thread_host_.reset();
-}
-
 void ShellTest::AddNativeCallback(std::string name,
                                   Dart_NativeFunction callback) {
   native_resolver_->AddNativeCallback(std::move(name), callback);
 }
 
-void ShellTestVsyncClock::SimulateVSync() {
-  std::scoped_lock lock(mutex_);
-  if (vsync_issued_ >= vsync_promised_.size()) {
-    vsync_promised_.emplace_back();
-  }
-  FML_CHECK(vsync_issued_ < vsync_promised_.size());
-  vsync_promised_[vsync_issued_].set_value(vsync_issued_);
-  vsync_issued_ += 1;
-}
-
-std::future<int> ShellTestVsyncClock::NextVSync() {
-  std::scoped_lock lock(mutex_);
-  vsync_promised_.emplace_back();
-  return vsync_promised_.back().get_future();
-}
-
-void ShellTestVsyncWaiter::AwaitVSync() {
-  FML_DCHECK(task_runners_.GetUITaskRunner()->RunsTasksOnCurrentThread());
-  auto vsync_future = clock_.NextVSync();
-
-  auto async_wait = std::async([&vsync_future, this]() {
-    vsync_future.wait();
-
-    // Post the `FireCallback` to the Platform thread so earlier Platform tasks
-    // (specifically, the `VSyncFlush` call) will be finished before
-    // `FireCallback` is executed. This is only needed for our unit tests.
-    //
-    // Without this, the repeated VSYNC signals in `VSyncFlush` may start both
-    // the current frame in the UI thread and the next frame in the secondary
-    // callback (both of them are waiting for VSYNCs). That breaks the unit
-    // test's assumption that each frame's VSYNC must be issued by different
-    // `VSyncFlush` call (which resets the `will_draw_new_frame` bit).
-    //
-    // For example, HandlesActualIphoneXsInputEvents will fail without this.
-    task_runners_.GetPlatformTaskRunner()->PostTask([this]() {
-      FireCallback(fml::TimePoint::Now(), fml::TimePoint::Now());
-    });
-  });
-}
-
-ShellTestPlatformView::ShellTestPlatformView(PlatformView::Delegate& delegate,
-                                             TaskRunners task_runners,
-                                             bool simulate_vsync)
-    : PlatformView(delegate, std::move(task_runners)),
-      gl_surface_(SkISize::Make(800, 600)),
-      simulate_vsync_(simulate_vsync) {}
-
-ShellTestPlatformView::~ShellTestPlatformView() = default;
-
-std::unique_ptr<VsyncWaiter> ShellTestPlatformView::CreateVSyncWaiter() {
-  return simulate_vsync_ ? std::make_unique<ShellTestVsyncWaiter>(task_runners_,
-                                                                  vsync_clock_)
-                         : PlatformView::CreateVSyncWaiter();
-}
-
-void ShellTestPlatformView::SimulateVSync() {
-  vsync_clock_.SimulateVSync();
-}
-
-// |PlatformView|
-std::unique_ptr<Surface> ShellTestPlatformView::CreateRenderingSurface() {
-  return std::make_unique<GPUSurfaceGL>(this, true);
-}
-
-// |PlatformView|
-PointerDataDispatcherMaker ShellTestPlatformView::GetDispatcherMaker() {
-  return [](DefaultPointerDataDispatcher::Delegate& delegate) {
-    return std::make_unique<SmoothPointerDataDispatcher>(delegate);
-  };
-}
-
-// |GPUSurfaceGLDelegate|
-bool ShellTestPlatformView::GLContextMakeCurrent() {
-  return gl_surface_.MakeCurrent();
-}
-
-// |GPUSurfaceGLDelegate|
-bool ShellTestPlatformView::GLContextClearCurrent() {
-  return gl_surface_.ClearCurrent();
-}
-
-// |GPUSurfaceGLDelegate|
-bool ShellTestPlatformView::GLContextPresent() {
-  return gl_surface_.Present();
-}
-
-// |GPUSurfaceGLDelegate|
-intptr_t ShellTestPlatformView::GLContextFBO() const {
-  return gl_surface_.GetFramebuffer();
-}
-
-// |GPUSurfaceGLDelegate|
-GPUSurfaceGLDelegate::GLProcResolver ShellTestPlatformView::GetGLProcResolver()
-    const {
-  return [surface = &gl_surface_](const char* name) -> void* {
-    return surface->GetProcAddress(name);
-  };
-}
-
-// |GPUSurfaceGLDelegate|
-ExternalViewEmbedder* ShellTestPlatformView::GetExternalViewEmbedder() {
-  return nullptr;
-}
-
 }  // namespace testing
 }  // namespace flutter