[Telemetry] Add run_no_page_interactions options to polymer page.

tools/perf/page_sets/polymer.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 from telemetry.page import page as page_module
 from telemetry.page import page_set as page_set_module
 
 class PolymerPage(page_module.Page):
 
-  def __init__(self, url, page_set):
+  def __init__(self, url, page_set, run_no_page_interactions):
+    """ Base class for all polymer pages.
+
+    Args:
+      run_no_page_interactions: whether the page will run any interactions after
+        navigate steps.
+    """
     super(PolymerPage, self).__init__(
       url=url,
       page_set=page_set)
     self.script_to_evaluate_on_commit = '''
       document.addEventListener("polymer-ready", function() {
         window.__polymer_ready = true;
       });
     '''
+    self._run_no_page_interactions = run_no_page_interactions
+
+  def RunPageInteraction(self, action_runner):

[vmiura, 2015/02/18 01:18:37]

Shouldn't this be "RunPageInteractions"?

+    # If a polymer page wants to customize it actions, it should
+    # overrides the PerformPageInteractions method instead of this method.
+    if self._run_no_page_interactions:
+      return
+    self.PerformPageInteractions(action_runner)
+
+  def PerformPageInteractions(self, action_runner):
+    """ Override this to perform actions after the page has navigated. """
+    pass
 
   def RunNavigateSteps(self, action_runner):
     super(PolymerPage, self).RunNavigateSteps(action_runner)
     action_runner.WaitForJavaScriptCondition(
         'window.__polymer_ready')
 
 
 class PolymerCalculatorPage(PolymerPage):
 
-  def __init__(self, page_set):
+  def __init__(self, page_set, run_no_page_interactions):
     super(PolymerCalculatorPage, self).__init__(
       url=('http://www.polymer-project.org/components/paper-calculator/'
           'demo.html'),
-      page_set=page_set)
+      page_set=page_set, run_no_page_interactions=run_no_page_interactions)
 
-  def RunPageInteractions(self, action_runner):
+  def PerformPageInteractions(self, action_runner):
     self.TapButton(action_runner)
     self.SlidePanel(action_runner)
 
   def TapButton(self, action_runner):
     interaction = action_runner.BeginInteraction(
         'Action_TapAction', is_smooth=True)
     action_runner.TapElement(element_function='''
         document.querySelector(
             'body /deep/ #outerPanels'
         ).querySelector(
@@ skipping 26 matching lines @@
                 '.handle-bar'
               )''')
       action_runner.WaitForJavaScriptCondition('''
           var outer = document.querySelector("body /deep/ #outerPanels");
           outer.opened || outer.wideMode;''')
       interaction.End()
 
 
 class PolymerShadowPage(PolymerPage):
 
-  def __init__(self, page_set):
+  def __init__(self, page_set, run_no_page_interactions):
     super(PolymerShadowPage, self).__init__(
       url='http://www.polymer-project.org/components/paper-shadow/demo.html',
-      page_set=page_set)
+      page_set=page_set, run_no_page_interactions=run_no_page_interactions)
 
-  def RunPageInteractions(self, action_runner):
+  def PerformPageInteractions(self, action_runner):
     action_runner.ExecuteJavaScript(
         "document.getElementById('fab').scrollIntoView()")
     action_runner.Wait(5)
     self.AnimateShadow(action_runner, 'card')
     #FIXME(wiltzius) disabling until this issue is fixed:
     # https://github.com/Polymer/paper-shadow/issues/12
     #self.AnimateShadow(action_runner, 'fab')
 
   def AnimateShadow(self, action_runner, eid):
     for i in range(1, 6):
       action_runner.ExecuteJavaScript(
           'document.getElementById("{0}").z = {1}'.format(eid, i))
       action_runner.Wait(1)
 
 
 class PolymerSampler(PolymerPage):
 
-  def __init__(self, page_set, anchor, scrolling_page=False):
+  def __init__(self, page_set, anchor, run_no_page_interactions,
+               scrolling_page=False):
     """Page exercising interactions with a single Paper Sampler subpage.
 
     Args:
       page_set: Page set to inforporate this page into.
       anchor: string indicating which subpage to load (matches the element
           type that page is displaying)
       scrolling_page: Whether scrolling the content pane is relevant to this
           content page or not.
     """
     super(PolymerSampler, self).__init__(
       url=('http://www.polymer-project.org/components/%s/demo.html' % anchor),
-      page_set=page_set)
+      page_set=page_set, run_no_page_interactions=run_no_page_interactions)
     self.scrolling_page = scrolling_page
     self.iframe_js = 'document'
 
   def RunNavigateSteps(self, action_runner):
     super(PolymerSampler, self).RunNavigateSteps(action_runner)
     waitForLoadJS = """
       window.Polymer.whenPolymerReady(function() {
         %s.contentWindow.Polymer.whenPolymerReady(function() {
           window.__polymer_ready = true;
         })
       });
       """ % self.iframe_js
     action_runner.ExecuteJavaScript(waitForLoadJS)
     action_runner.WaitForJavaScriptCondition(
         'window.__polymer_ready')
 
-  def RunPageInteractions(self, action_runner):
+  def PerformPageInteractions(self, action_runner):
     #TODO(wiltzius) Add interactions for input elements and shadow pages
     if self.scrolling_page:
       # Only bother scrolling the page if its been marked as worthwhile
       self.ScrollContentPane(action_runner)
     self.TouchEverything(action_runner)
 
   def ScrollContentPane(self, action_runner):
     element_function = (self.iframe_js + '.querySelector('
         '"core-scroll-header-panel").$.mainContainer')
     interaction = action_runner.BeginInteraction('Scroll_Page', is_smooth=True)
@@ skipping 54 matching lines @@
     interaction = action_runner.BeginInteraction(
         'Swipe_Widget', is_smooth=True)
     action_runner.SwipeElement(element_function=element_function,
                                left_start_ratio=0.75,
                                speed_in_pixels_per_second=300)
     interaction.End()
 
 
 class PolymerPageSet(page_set_module.PageSet):
 
-  def __init__(self):
+  def __init__(self, run_no_page_interactions=False):
     super(PolymerPageSet, self).__init__(
       user_agent_type='mobile',
       archive_data_file='data/polymer.json',
       bucket=page_set_module.PUBLIC_BUCKET)
 
-    self.AddUserStory(PolymerCalculatorPage(self))
-    self.AddUserStory(PolymerShadowPage(self))
+    self.AddUserStory(PolymerCalculatorPage(self, run_no_page_interactions))
+    self.AddUserStory(PolymerShadowPage(self, run_no_page_interactions))
 
     # Polymer Sampler subpages that are interesting to tap / swipe elements on
     TAPPABLE_PAGES = [
         'paper-button',
         'paper-checkbox',
         'paper-fab',
         'paper-icon-button',
         # crbug.com/394756
         # 'paper-radio-button',
         #FIXME(wiltzius) Disabling x-shadow until this issue is fixed:
         # https://github.com/Polymer/paper-shadow/issues/12
         #'paper-shadow',
         'paper-tabs',
         'paper-toggle-button',
         ]
     for p in TAPPABLE_PAGES:
-      self.AddUserStory(PolymerSampler(self, p))
+      self.AddUserStory(PolymerSampler(
+          self, p, run_no_page_interactions=run_no_page_interactions))
 
     # Polymer Sampler subpages that are interesting to scroll
     SCROLLABLE_PAGES = [
         'core-scroll-header-panel',
         ]
     for p in SCROLLABLE_PAGES:
-      self.AddUserStory(PolymerSampler(self, p, scrolling_page=True))
+      self.AddUserStory(PolymerSampler(
+          self, p, run_no_page_interactions=run_no_page_interactions,
+          scrolling_page=True))
+
+    for page in self:
+      assert (page.__class__.RunPageInteractions ==
+              PolymerPage.RunPageInteractions), (
+              'Pages in this page set must not override PolymerPage\' '
+              'RunPageInteractions method.')