cc/test/layer_tree_test.h

   1 // Copyright 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CC_TEST_LAYER_TREE_TEST_H_
   6 #define CC_TEST_LAYER_TREE_TEST_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "base/threading/thread.h"
  10 #include "cc/animation/animation_delegate.h"
  11 #include "cc/trees/layer_tree_host.h"
  12 #include "cc/trees/layer_tree_host_impl.h"
  13 #include "testing/gtest/include/gtest/gtest.h"
  14
  15 namespace Webkit {
  16 class WebGraphicsContext3D;
  17 }
  18
  19 namespace cc {
  20 class FakeLayerTreeHostClient;
  21 class FakeOutputSurface;
  22 class LayerImpl;
  23 class LayerTreeHost;
  24 class LayerTreeHostClient;
  25 class LayerTreeHostImpl;
  26 class TestContextProvider;
  27 class TestWebGraphicsContext3D;
  28
  29 // Used by test stubs to notify the test when something interesting happens.
  30 class TestHooks : public AnimationDelegate {
  31  public:
  32   TestHooks();
  33   virtual ~TestHooks();
  34
  35   void ReadSettings(const LayerTreeSettings& settings);
  36
  37   virtual void WillBeginImplFrameOnThread(LayerTreeHostImpl* host_impl,
  38                                           const BeginFrameArgs& args) {}
  39   virtual void BeginMainFrameAbortedOnThread(LayerTreeHostImpl* host_impl,
  40                                              bool did_handle) {}
  41   virtual void BeginCommitOnThread(LayerTreeHostImpl* host_impl) {}
  42   virtual void CommitCompleteOnThread(LayerTreeHostImpl* host_impl) {}
  43   virtual void WillActivateTreeOnThread(LayerTreeHostImpl* host_impl) {}
  44   virtual void DidActivateTreeOnThread(LayerTreeHostImpl* host_impl) {}
  45   virtual void InitializedRendererOnThread(LayerTreeHostImpl* host_impl,
  46                                            bool success) {}
  47   virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
  48       LayerTreeHostImpl* host_impl,
  49       LayerTreeHostImpl::FrameData* frame_data,
  50       DrawSwapReadbackResult::DrawResult draw_result);
  51   virtual void DrawLayersOnThread(LayerTreeHostImpl* host_impl) {}
  52   virtual void SwapBuffersOnThread(LayerTreeHostImpl* host_impl, bool result) {}
  53   virtual void SwapBuffersCompleteOnThread(LayerTreeHostImpl* host_impl) {}
  54   virtual void UpdateVisibleTilesOnThread(LayerTreeHostImpl* host_impl) {}
  55   virtual void AnimateLayers(LayerTreeHostImpl* host_impl,
  56                              base::TimeTicks monotonic_time) {}
  57   virtual void UpdateAnimationState(LayerTreeHostImpl* host_impl,
  58                                     bool has_unfinished_animation) {}
  59   virtual void WillAnimateLayers(LayerTreeHostImpl* host_impl,
  60                                  base::TimeTicks monotonic_time) {}
  61   virtual void ApplyScrollAndScale(const gfx::Vector2d& scroll_delta,
  62                                    float scale) {}
  63   virtual void Animate(base::TimeTicks monotonic_time) {}
  64   virtual void WillBeginMainFrame() {}
  65   virtual void DidBeginMainFrame() {}
  66   virtual void Layout() {}
  67   virtual void DidInitializeOutputSurface(bool succeeded) {}
  68   virtual void DidFailToInitializeOutputSurface() {}
  69   virtual void DidAddAnimation() {}
  70   virtual void WillCommit() {}
  71   virtual void DidCommit() {}
  72   virtual void DidCommitAndDrawFrame() {}
  73   virtual void DidCompleteSwapBuffers() {}
  74   virtual void ScheduleComposite() {}
  75   virtual void ScheduleAnimation() {}
  76   virtual void DidDeferCommit() {}
  77   virtual void DidSetVisibleOnImplTree(LayerTreeHostImpl* host_impl,
  78                                        bool visible) {}
  79   virtual base::TimeDelta LowFrequencyAnimationInterval() const;
  80
  81   // Implementation of AnimationDelegate:
  82   virtual void NotifyAnimationStarted(base::TimeTicks monotonic_time,
  83                                       Animation::TargetProperty target_property)
  84       OVERRIDE {}
  85   virtual void NotifyAnimationFinished(
  86       base::TimeTicks monotonic_time,
  87       Animation::TargetProperty target_property) OVERRIDE {}
  88
  89   virtual scoped_ptr<OutputSurface> CreateOutputSurface(bool fallback) = 0;
  90   virtual scoped_refptr<ContextProvider> OffscreenContextProvider() = 0;
  91 };
  92
  93 class BeginTask;
  94 class LayerTreeHostClientForTesting;
  95 class TimeoutTask;
  96
  97 // The LayerTreeTests runs with the main loop running. It instantiates a single
  98 // LayerTreeHostForTesting and associated LayerTreeHostImplForTesting and
  99 // LayerTreeHostClientForTesting.
 100 //
 101 // BeginTest() is called once the main message loop is running and the layer
 102 // tree host is initialized.
 103 //
 104 // Key stages of the drawing loop, e.g. drawing or commiting, redirect to
 105 // LayerTreeTest methods of similar names. To track the commit process, override
 106 // these functions.
 107 //
 108 // The test continues until someone calls EndTest. EndTest can be called on any
 109 // thread, but be aware that ending the test is an asynchronous process.
 110 class LayerTreeTest : public testing::Test, public TestHooks {
 111  public:
 112   virtual ~LayerTreeTest();
 113
 114   virtual void EndTest();
 115   void EndTestAfterDelay(int delay_milliseconds);
 116
 117   void PostAddAnimationToMainThread(Layer* layer_to_receive_animation);
 118   void PostAddInstantAnimationToMainThread(Layer* layer_to_receive_animation);
 119   void PostAddLongAnimationToMainThread(Layer* layer_to_receive_animation);
 120   void PostSetNeedsCommitToMainThread();
 121   void PostSetNeedsUpdateLayersToMainThread();
 122   void PostReadbackToMainThread();
 123   void PostSetNeedsRedrawToMainThread();
 124   void PostSetNeedsRedrawRectToMainThread(const gfx::Rect& damage_rect);
 125   void PostSetVisibleToMainThread(bool visible);
 126   void PostSetNextCommitForcesRedrawToMainThread();
 127
 128   void DoBeginTest();
 129   void Timeout();
 130
 131  protected:
 132   LayerTreeTest();
 133
 134   virtual void InitializeSettings(LayerTreeSettings* settings) {}
 135
 136   virtual void ScheduleComposite() OVERRIDE;
 137
 138   void RealEndTest();
 139
 140   virtual void DispatchAddAnimation(Layer* layer_to_receive_animation,
 141                                     double animation_duration);
 142   void DispatchSetNeedsCommit();
 143   void DispatchSetNeedsUpdateLayers();
 144   void DispatchReadback();
 145   void DispatchSetNeedsRedraw();
 146   void DispatchSetNeedsRedrawRect(const gfx::Rect& damage_rect);
 147   void DispatchSetVisible(bool visible);
 148   void DispatchSetNextCommitForcesRedraw();
 149   void DispatchComposite();
 150   void DispatchDidAddAnimation();
 151
 152   virtual void AfterTest() = 0;
 153   virtual void WillBeginTest();
 154   virtual void BeginTest() = 0;
 155   virtual void SetupTree();
 156
 157   virtual void RunTest(bool threaded,
 158                        bool delegating_renderer,
 159                        bool impl_side_painting);
 160   virtual void RunTestWithImplSidePainting();
 161
 162   bool HasImplThread() { return proxy() ? proxy()->HasImplThread() : false; }
 163   base::SingleThreadTaskRunner* ImplThreadTaskRunner() {
 164     DCHECK(proxy());
 165     return proxy()->ImplThreadTaskRunner() ? proxy()->ImplThreadTaskRunner()
 166                                            : main_task_runner_.get();
 167   }
 168   base::SingleThreadTaskRunner* MainThreadTaskRunner() {
 169     return main_task_runner_.get();
 170   }
 171   Proxy* proxy() const {
 172     return layer_tree_host_ ? layer_tree_host_->proxy() : NULL;
 173   }
 174
 175   bool TestEnded() const { return ended_; }
 176
 177   LayerTreeHost* layer_tree_host() { return layer_tree_host_.get(); }
 178   bool delegating_renderer() const { return delegating_renderer_; }
 179   FakeOutputSurface* output_surface() { return output_surface_; }
 180   int LastCommittedSourceFrameNumber(LayerTreeHostImpl* impl) const;
 181
 182   void DestroyLayerTreeHost();
 183
 184   // Override this for pixel tests, where you need a real output surface.
 185   virtual scoped_ptr<OutputSurface> CreateOutputSurface(bool fallback) OVERRIDE;
 186   // Override this for unit tests, which should not produce pixel output.
 187   virtual scoped_ptr<FakeOutputSurface> CreateFakeOutputSurface(bool fallback);
 188
 189   virtual scoped_refptr<ContextProvider> OffscreenContextProvider() OVERRIDE;
 190
 191   TestWebGraphicsContext3D* TestContext();
 192
 193
 194  private:
 195   LayerTreeSettings settings_;
 196   scoped_ptr<LayerTreeHostClientForTesting> client_;
 197   scoped_ptr<LayerTreeHost> layer_tree_host_;
 198   FakeOutputSurface* output_surface_;
 199
 200   bool beginning_;
 201   bool end_when_begin_returns_;
 202   bool timed_out_;
 203   bool scheduled_;
 204   bool schedule_when_set_visible_true_;
 205   bool started_;
 206   bool ended_;
 207   bool delegating_renderer_;
 208
 209   int timeout_seconds_;
 210
 211   scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
 212   scoped_ptr<base::Thread> impl_thread_;
 213   base::CancelableClosure timeout_;
 214   scoped_refptr<TestContextProvider> compositor_contexts_;
 215   base::WeakPtr<LayerTreeTest> main_thread_weak_ptr_;
 216   base::WeakPtrFactory<LayerTreeTest> weak_factory_;
 217 };
 218
 219 }  // namespace cc
 220
 221 #define SINGLE_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME) \
 222   TEST_F(TEST_FIXTURE_NAME, RunSingleThread_DirectRenderer) {   \
 223     RunTest(false, false, false);                               \
 224   }                                                             \
 225   class SingleThreadDirectNeedsSemicolon##TEST_FIXTURE_NAME {}
 226
 227 #define SINGLE_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME) \
 228   TEST_F(TEST_FIXTURE_NAME, RunSingleThread_DelegatingRenderer) {   \
 229     RunTest(false, true, false);                                    \
 230   }                                                                 \
 231   class SingleThreadDelegatingNeedsSemicolon##TEST_FIXTURE_NAME {}
 232
 233 #define SINGLE_THREAD_TEST_F(TEST_FIXTURE_NAME)            \
 234   SINGLE_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME); \
 235   SINGLE_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME)
 236
 237 #define MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)        \
 238   TEST_F(TEST_FIXTURE_NAME, RunMultiThread_DirectRenderer_MainThreadPaint) { \
 239     RunTest(true, false, false);                                             \
 240   }
 241
 242 #define MULTI_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME)                 \
 243   MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)                \
 244       TEST_F(TEST_FIXTURE_NAME, RunMultiThread_DirectRenderer_ImplSidePaint) { \
 245     RunTest(true, false, true);                                                \
 246   }                                                                            \
 247   class MultiThreadDirectNeedsSemicolon##TEST_FIXTURE_NAME {}
 248
 249 #define MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME) \
 250   TEST_F(TEST_FIXTURE_NAME,                                               \
 251          RunMultiThread_DelegatingRenderer_MainThreadPaint) {             \
 252     RunTest(true, true, false);                                           \
 253   }
 254
 255 #define MULTI_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME)          \
 256   MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME) TEST_F( \
 257       TEST_FIXTURE_NAME, RunMultiThread_DelegatingRenderer_ImplSidePaint) { \
 258     RunTest(true, true, true);                                              \
 259   }                                                                         \
 260   class MultiThreadDelegatingNeedsSemicolon##TEST_FIXTURE_NAME {}
 261
 262 #define MULTI_THREAD_NOIMPL_TEST_F(TEST_FIXTURE_NAME)            \
 263   MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME); \
 264   MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)
 265
 266 #define MULTI_THREAD_TEST_F(TEST_FIXTURE_NAME)            \
 267   MULTI_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME); \
 268   MULTI_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME)
 269
 270 #define SINGLE_AND_MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F( \
 271     TEST_FIXTURE_NAME)                                         \
 272   SINGLE_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME);     \
 273   MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)
 274
 275 #define SINGLE_AND_MULTI_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME) \
 276   SINGLE_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME);                \
 277   MULTI_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME)
 278
 279 #define SINGLE_AND_MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F( \
 280     TEST_FIXTURE_NAME)                                             \
 281   SINGLE_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME);     \
 282   MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)
 283
 284 #define SINGLE_AND_MULTI_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME) \
 285   SINGLE_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME);                \
 286   MULTI_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME)
 287
 288 #define SINGLE_AND_MULTI_THREAD_NOIMPL_TEST_F(TEST_FIXTURE_NAME)            \
 289   SINGLE_AND_MULTI_THREAD_DIRECT_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME); \
 290   SINGLE_AND_MULTI_THREAD_DELEGATING_RENDERER_NOIMPL_TEST_F(TEST_FIXTURE_NAME)
 291
 292 #define SINGLE_AND_MULTI_THREAD_TEST_F(TEST_FIXTURE_NAME)            \
 293   SINGLE_AND_MULTI_THREAD_DIRECT_RENDERER_TEST_F(TEST_FIXTURE_NAME); \
 294   SINGLE_AND_MULTI_THREAD_DELEGATING_RENDERER_TEST_F(TEST_FIXTURE_NAME)
 295
 296 #endif  // CC_TEST_LAYER_TREE_TEST_H_