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,17 +159,30 @@ if (current_toolchain == host_toolchain) {
   }
 
   shell_host_executable("shell_unittests") {
+    defines = []
+
+    if (shell_enable_metal) {
+      defines += [ "SHELL_ENABLE_METAL" ]
+    }
+
     sources = [
-      "animator_unittests.cc",
-      "canvas_spy_unittests.cc",
-      "input_events_unittests.cc",
-      "persistent_cache_unittests.cc",
-      "pipeline_unittests.cc",
-      "shell_test.cc",
-      "shell_test.h",
-      "shell_unittests.cc",
-      "vsync_waiters_test.cc",
-      "vsync_waiters_test.h",
+      "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 = [
@@ -180,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

@@ -4,16 +4,11 @@
 
 #define FML_USED_ON_EMBEDDER
 
-#include "flutter/shell/common/shell_test.h"
+#include "flutter/shell/common/tests/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/common/tests/shell_test_platform_view.h"
 #include "flutter/shell/common/vsync_waiter_fallback.h"
-#include "flutter/shell/gpu/gpu_surface_gl.h"
-#include "flutter/testing/testing.h"
 
 namespace flutter {
 namespace testing {
@@ -250,35 +245,66 @@ TaskRunners ShellTest::GetTaskRunnersForFixture() {
   };
 }
 
+static std::unique_ptr<Shell> CreateTestShell(
+    Settings settings,
+    TaskRunners task_runners,
+    bool simulate_vsync,
+    ShellTestSurface::ClientRenderingAPI api) {
+  auto vsync_clock = std::make_shared<ShellTestVsyncClock>();
+  CreateVsyncWaiter on_create_vsync_waiter = [&]() {
+    std::unique_ptr<VsyncWaiter> waiter;
+    if (simulate_vsync) {
+      waiter =
+          std::make_unique<ShellTestVsyncWaiter>(task_runners, vsync_clock);
+    } else {
+      waiter = std::make_unique<VsyncWaiterFallback>(task_runners);
+    }
+    return waiter;
+  };
+
+  Shell::CreateCallback<PlatformView> on_create_platform_view =
+      [&](Shell& shell) {
+        return std::make_unique<ShellTestPlatformView>(
+            shell, shell.GetTaskRunners(), vsync_clock, on_create_vsync_waiter,
+            api);
+      };
+
+  Shell::CreateCallback<Rasterizer> on_create_rasterizer = [](Shell& shell) {
+    return std::make_unique<Rasterizer>(shell, shell.GetTaskRunners());
+  };
+
+  return Shell::Create(task_runners,             //
+                       settings,                 //
+                       on_create_platform_view,  //
+                       on_create_rasterizer      //
+  );
+}
+
+std::unique_ptr<Shell> ShellTest::CreateShell(
+    Settings settings,
+    ShellTestSurface::ClientRenderingAPI api) {
+  return CreateTestShell(settings, GetTaskRunnersForFixture(), false, api);
+}
+
 std::unique_ptr<Shell> ShellTest::CreateShell(Settings settings,
                                               bool simulate_vsync) {
-  return CreateShell(std::move(settings), GetTaskRunnersForFixture(),
-                     simulate_vsync);
+  return CreateTestShell(
+      settings,                                                        //
+      GetTaskRunnersForFixture(),                                      //
+      simulate_vsync,                                                  //
+      ShellTestSurface::ClientRenderingAPI::kClientRenderingAPIOpenGL  //
+  );
 }
 
 std::unique_ptr<Shell> ShellTest::CreateShell(Settings settings,
                                               TaskRunners task_runners,
                                               bool simulate_vsync) {
-  const auto vsync_clock = std::make_shared<ShellTestVsyncClock>();
-  CreateVsyncWaiter create_vsync_waiter = [&]() {
-    if (simulate_vsync) {
-      return static_cast<std::unique_ptr<VsyncWaiter>>(
-          std::make_unique<ShellTestVsyncWaiter>(task_runners, vsync_clock));
-    } else {
-      return static_cast<std::unique_ptr<VsyncWaiter>>(
-          std::make_unique<VsyncWaiterFallback>(task_runners));
-    }
-  };
-  return Shell::Create(
-      task_runners, settings,
-      [vsync_clock, &create_vsync_waiter](Shell& shell) {
-        return std::make_unique<ShellTestPlatformView>(
-            shell, shell.GetTaskRunners(), vsync_clock,
-            std::move(create_vsync_waiter));
-      },
-      [](Shell& shell) {
-        return std::make_unique<Rasterizer>(shell, shell.GetTaskRunners());
-      });
+  return CreateTestShell(
+      settings,                                                        //
+      task_runners,                                                    //
+      simulate_vsync,                                                  //
+      ShellTestSurface::ClientRenderingAPI::kClientRenderingAPIOpenGL  //
+  );
 }
 
 void ShellTest::DestroyShell(std::unique_ptr<Shell> shell) {
@@ -301,70 +327,5 @@ void ShellTest::AddNativeCallback(std::string name,
   native_resolver_->AddNativeCallback(std::move(name), callback);
 }
 
-ShellTestPlatformView::ShellTestPlatformView(
-    PlatformView::Delegate& delegate,
-    TaskRunners task_runners,
-    std::shared_ptr<ShellTestVsyncClock> vsync_clock,
-    CreateVsyncWaiter create_vsync_waiter)
-    : PlatformView(delegate, std::move(task_runners)),
-      gl_surface_(SkISize::Make(800, 600)),
-      create_vsync_waiter_(std::move(create_vsync_waiter)),
-      vsync_clock_(vsync_clock) {}
-
-ShellTestPlatformView::~ShellTestPlatformView() = default;
-
-std::unique_ptr<VsyncWaiter> ShellTestPlatformView::CreateVSyncWaiter() {
-  return create_vsync_waiter_();
-}
-
-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