Add "test mode" to media controls to make layout tests easier

This CL adds a test mode flag to modern media controls that hides the
loading panel. This will be used for other changes as well, such as
not showing the transition for the overlay play button. This is to be
used for layout testing to prevent mismatch issues arising from the
animations being at a different point.

Bug: 775534
Change-Id: Ie79560f1f012992d50222d31f5a953b30a925916
Reviewed-on: https://chromium-review.googlesource.com/997015
Commit-Queue: Tommy Steimel <steimel@chromium.org>
Reviewed-by: Nate Chapin <japhet@chromium.org>
Reviewed-by: Mounir Lamouri <mlamouri@chromium.org>
Cr-Commit-Position: refs/heads/master@{#548820}

third_party/WebKit/Source/core/html/media/MediaControls.h

@@ -51,6 +51,9 @@ class CORE_EXPORT MediaControls : public GarbageCollectedMixin {
   // TODO(mlamouri): required by LayoutVTTCue.
   virtual LayoutObject* ContainerLayoutObject() = 0;
 
+  // Used for layout tests to disable some animations.
+  virtual void SetTestMode(bool) = 0;
+
   // TODO: the following are required by other parts of the media controls
   // implementation and could be removed when the full implementation has moved
   // to modules.

third_party/WebKit/Source/core/testing/Internals.cpp

@@ -2518,6 +2518,14 @@ bool Internals::isMediaElementSuspended(HTMLMediaElement* media_element) {
   return false;
 }
 
+void Internals::setMediaControlsTestMode(HTMLMediaElement* media_element,
+                                         bool enable) {
+  DCHECK(media_element);
+  MediaControls* media_controls = media_element->GetMediaControls();
+  DCHECK(media_controls);
+  media_controls->SetTestMode(enable);
+}
+
 void Internals::registerURLSchemeAsBypassingContentSecurityPolicy(
     const String& scheme) {
   SchemeRegistry::RegisterURLSchemeAsBypassingContentSecurityPolicy(scheme);

third_party/WebKit/Source/core/testing/Internals.h

@@ -394,6 +394,7 @@ class Internals final : public ScriptWrappable {
   void setPersistent(HTMLVideoElement*, bool);
   void forceStaleStateForMediaElement(HTMLMediaElement*, int target_state);
   bool isMediaElementSuspended(HTMLMediaElement*);
+  void setMediaControlsTestMode(HTMLMediaElement*, bool);
 
   void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
   void registerURLSchemeAsBypassingContentSecurityPolicy(

third_party/WebKit/Source/core/testing/Internals.idl

@@ -240,6 +240,7 @@ enum EffectiveConnectionType {
     void setPersistent(HTMLVideoElement video, boolean persistent);
     void forceStaleStateForMediaElement(HTMLMediaElement mediaElement, long state);
     boolean isMediaElementSuspended(HTMLMediaElement mediaElement);
+    void setMediaControlsTestMode(HTMLMediaElement mediaElement, boolean enable);
 
     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme, sequence<DOMString> policyAreas);

third_party/WebKit/Source/modules/media_controls/MediaControlsImpl.cpp

@@ -808,6 +808,18 @@ LayoutObject* MediaControlsImpl::ContainerLayoutObject() {
   return GetLayoutObject();
 }
 
+void MediaControlsImpl::SetTestMode(bool enable) {
+  is_test_mode_ = enable;
+  if (loading_panel_)
+    loading_panel_->OnTestModeUpdated();
+  // TODO(steimel): Add other test mode changes, such as stopping the overlay
+  // play button transition.
+}
+
+bool MediaControlsImpl::GetTestMode() const {
+  return is_test_mode_;
+}
+
 void MediaControlsImpl::MaybeShow() {
   panel_->SetIsWanted(true);
   panel_->SetIsDisplayed(true);

third_party/WebKit/Source/modules/media_controls/MediaControlsImpl.h

@@ -100,6 +100,7 @@ class MODULES_EXPORT MediaControlsImpl final : public HTMLDivElement,
   void NetworkStateChanged() override;
   LayoutObject* PanelLayoutObject() override;
   LayoutObject* ContainerLayoutObject() override;
+  void SetTestMode(bool) override;
   // Return the internal elements, which is used by registering clicking
   // EventHandlers from MediaControlsWindowEventListener.
   HTMLDivElement* PanelElement() override;
@@ -110,6 +111,8 @@ class MODULES_EXPORT MediaControlsImpl final : public HTMLDivElement,
     RefreshCastButtonVisibilityWithoutUpdate();
   }
 
+  bool GetTestMode() const;
+
   // Called by the fullscreen buttons to toggle fulllscreen on/off.
   void EnterFullscreen();
   void ExitFullscreen();
@@ -363,6 +366,8 @@ class MODULES_EXPORT MediaControlsImpl final : public HTMLDivElement,
   // certain pointer events. In particular, when the user is interacting via
   // touch events, we want to ignore pointerover/pointerout/pointermove events.
   bool is_touch_interaction_ = false;
+
+  bool is_test_mode_ = false;
 };
 
 DEFINE_ELEMENT_TYPE_CASTS(MediaControlsImpl, IsMediaControls());

third_party/WebKit/Source/modules/media_controls/elements/MediaControlLoadingPanelElement.cpp

@@ -157,6 +157,14 @@ void MediaControlLoadingPanelElement::UpdateDisplayState() {
     return;
   }
 
+  // If the controls are in test mode, we always hide the loading panel. So hide
+  // if necessary and return.
+  if (GetMediaControls().GetTestMode()) {
+    if (state_ != State::kHidden)
+      HideAnimation();
+    return;
+  }
+
   switch (state_) {
     case State::kHidden:
       // If the media controls are loading metadata then we should show the
@@ -205,6 +213,10 @@ void MediaControlLoadingPanelElement::OnControlsShown() {
   UpdateDisplayState();
 }
 
+void MediaControlLoadingPanelElement::OnTestModeUpdated() {
+  UpdateDisplayState();
+}
+
 void MediaControlLoadingPanelElement::OnAnimationEnd() {
   // If we have gone back to the loading metadata state (e.g. the source
   // changed). Then we should jump back to playing.

third_party/WebKit/Source/modules/media_controls/elements/MediaControlLoadingPanelElement.h

@@ -33,6 +33,8 @@ class MODULES_EXPORT MediaControlLoadingPanelElement final
   void OnControlsHidden();
   // Inform the loading panel that the Media Controls have been shown.
   void OnControlsShown();
+  // Inform the loading panel that the Media Controls are entering test mode.
+  void OnTestModeUpdated();
 
   void Trace(Visitor*);