[system-health] Generalize loading stories to single-page stories

tools/perf/page_sets/system_health/single_page_stories.py

 # Copyright 2016 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.
 
 import logging
 
 from page_sets.login_helpers import dropbox_login
 from page_sets.login_helpers import google_login
 
 from telemetry import story
@@ skipping 15 matching lines @@
   # https://mail.google.com.
   action_runner.Navigate(
       'https://mail.google.com/mail/mu/mp/872/trigger_redirection_loop')
   action_runner.tab.WaitForDocumentReadyStateToBeComplete()
 
 
 def _LogIntoDropboxAccount(action_runner, credentials_path):
   dropbox_login.LoginAccount(action_runner, 'dropbox', credentials_path)
 
 
-def _CloseInboxInterstitialAndWaitUntilGmailReady(platform, action_runner):
-  if platform == 'desktop':
-    # Wait until the UI loads.
-    action_runner.WaitForJavaScriptCondition(
-        'document.getElementById("loading").style.display === "none"')
-  elif platform == 'mobile':
-    # Close the "Get Inbox by Gmail" interstitial.
-    action_runner.WaitForJavaScriptCondition(
-        'document.querySelector("#isppromo a") !== null')
-    action_runner.ExecuteJavaScript(
-        'document.querySelector("#isppromo a").click()')
-    # Wait until the UI loads.
-    action_runner.WaitForJavaScriptCondition(
-        'document.getElementById("apploadingdiv").style.height === "0px"')
+def _WaitUntilDesktopGmailReady(action_runner):
+  # Wait until the UI loads.
+  action_runner.WaitForJavaScriptCondition(
+      'document.getElementById("loading").style.display === "none"')
 
 
-def _WaitUntilBubblesReady(_, action_runner):
+def _CloseInboxInterstitialAndWaitUntilMobileGmailReady(action_runner):
+  # Close the "Get Inbox by Gmail" interstitial.
+  action_runner.WaitForJavaScriptCondition(
+      'document.querySelector("#isppromo a") !== null')
+  action_runner.ExecuteJavaScript(
+      'document.querySelector("#isppromo a").click()')
+  # Wait until the UI loads.
+  action_runner.WaitForJavaScriptCondition(
+      'document.getElementById("apploadingdiv").style.height === "0px"')
+
+
+def _WaitUntilBubblesReady(action_runner):
   # The #logo element is removed right before the main menu is displayed.
   action_runner.WaitForJavaScriptCondition(
       'document.getElementById("logo") === null')
 
 
-def _WaitUntilSpyChaseReady(_, action_runner):
+def _WaitUntilSpyChaseReady(action_runner):
   # The background of the game canvas is set when the "Tap screen to play"
   # caption is displayed.
   action_runner.WaitForJavaScriptCondition(
       'document.querySelector("#game canvas").style.background !== ""')
 
 
-def _WaitUntilFlickrReady(_, action_runner):
+def _WaitUntilFlickrReady(action_runner):
   # Wait until the 'Recently tagged' view loads.
   action_runner.WaitForJavaScriptCondition('''
       document.querySelector(
           '.search-photos-everyone-trending-view .photo-list-view') !== null''')
 
 
 class _PageSpec(object):
 
   def __init__(self, name, url, login_hook=None, post_load_hook=None):
-    assert isinstance(url, (dict, str))
     self._name = name
     self._url = url
     self._login_hook = login_hook
     self._post_load_hook = post_load_hook
 
   @property
   def name(self):
     return self._name
 
   @property
   def url(self):
     return self._url
 
   @property
   def login_hook(self):
     return self._login_hook
 
   @property
   def post_load_hook(self):
     return self._post_load_hook
 
+  def Resolve(self, platform_name):

[nednguyen, 2016/06/24 17:08:26]

It seems to me that we are going down to the path of declarative json page set
(https://bugs.chromium.org/p/chromium/issues/detail?id=239179)

How is this more simpler than just create a bunch of page classes? My worry with
this kind of strategy is it makes it harder for new comers to know how to
fix/tweaks the page behaviors when they need to.

[petrcermak, 2016/06/27 19:31:21]

You're right. I rewrote the file completely ;-)

+    return _PageSpec(self.name,
+                     self._ResolveField(self._url, platform_name),
+                     self._ResolveField(self._login_hook, platform_name),
+                     self._ResolveField(self._post_load_hook, platform_name))
+
+  def _ResolveField(self, field, platform_name):
+    if isinstance(field, dict):
+      return field.get(platform_name)
+    return field
+
 
 _SINGLE_PAGE_SPECS = {
     # Search and e-commerce.
     'search': [
         _PageSpec(
             name='google',
             url='https://www.google.com/#hl=en&q=science'),
         _PageSpec(
             name='baidu',
             url='https://www.baidu.com/s?word=google'),
@@ skipping 111 matching lines @@
     # Online tools (documents, emails, storage, ...).
     'tools': [
         _PageSpec(
             name='docs',
             url=(
                 'https://docs.google.com/document/d/1GvzDP-tTLmJ0myRhUAfTYWs3ZUFilUICg8psNHyccwQ/edit?usp=sharing')),
         _PageSpec(
             name='gmail',
             url='https://mail.google.com/mail/',
             login_hook=_LogIntoGoogleAccountAndSetUpGmailSession,
-            post_load_hook=_CloseInboxInterstitialAndWaitUntilGmailReady),
+            post_load_hook={
+                'desktop': _WaitUntilDesktopGmailReady,
+                'mobile': _CloseInboxInterstitialAndWaitUntilMobileGmailReady}),
         _PageSpec(
             name='maps',
             url='https://www.google.com/maps/place/London,+UK/'),
         _PageSpec(
             name='stackoverflow',
             url=(
                 'https://stackoverflow.com/questions/36827659/compiling-an-application-for-use-in-highly-radioactive-environments')),
         _PageSpec(
             name='dropbox',
             url='https://www.dropbox.com',
@@ skipping 32 matching lines @@
         _PageSpec(
             name='alphabetty',
             url={'desktop': 'https://king.com/play/alphabetty'}),
     ],
 }
 
 
 DUMP_WAIT_TIME = 3
 
 
-class _LoadCase(page_module.Page):
-  """Generic System Health user story that loads a page and measures memory."""
+class _SinglePageCase(page_module.Page):
+  """Abstract base class for single-page System Health user stories."""
+  CASE = NotImplemented
 
-  def __init__(self, story_set, group, url, page_spec):
-    # For example, the name of the story for the |page_spec| with name
+  def __init__(self, story_set, group, page_spec):
+    # For example, the name of the load story for the |page_spec| with name
     # 'example' from the 'sample' URL |group| will be 'load:sample:example'.
-    name = 'load:%s:%s' % (group, page_spec.name)
-    super(_LoadCase, self).__init__(
-        page_set=story_set, name=name, url=url,
+    story_name = ':'.join((self.CASE, group, page_spec.name))
+    super(_SinglePageCase, self).__init__(
+        page_set=story_set, name=story_name, url=page_spec.url,
         credentials_path='../data/credentials.json',
-        grouping_keys={'case': 'load', 'group': group})
+        grouping_keys={'case': self.CASE, 'group': group})
     self._page_spec = page_spec
 
   @property
   def platform(self):
     return self.story_set.PLATFORM
 
   def _TakeMemoryMeasurement(self, action_runner):
     # TODO(petrcermak): This method is essentially the same as
     # MemoryHealthPage._TakeMemoryMeasurement() in memory_health_story.py.
     # Consider sharing the common code.
     action_runner.Wait(DUMP_WAIT_TIME)
     action_runner.ForceGarbageCollection()
     action_runner.Wait(DUMP_WAIT_TIME)
     tracing_controller = action_runner.tab.browser.platform.tracing_controller
     if not tracing_controller.is_tracing_running:
       return  # Tracing is not running, e.g., when recording a WPR archive.
     if not action_runner.tab.browser.DumpMemory():
       logging.error('Unable to get a memory dump for %s.', self.name)
 
   def RunNavigateSteps(self, action_runner):
     if self._page_spec.login_hook:
       self._page_spec.login_hook(action_runner, self.credentials_path)
-    super(_LoadCase, self).RunNavigateSteps(action_runner)
+    super(_SinglePageCase, self).RunNavigateSteps(action_runner)
 
   def RunPageInteractions(self, action_runner):
     action_runner.tab.WaitForDocumentReadyStateToBeComplete()
     if self._page_spec.post_load_hook:
-      self._page_spec.post_load_hook(self.platform, action_runner)
+      self._page_spec.post_load_hook(action_runner)
+
+
+class _LoadCase(_SinglePageCase):
+  """Generic System Health user story that loads a page and measures memory."""
+  CASE = 'load'
+
+  def RunPageInteractions(self, action_runner):
+    super(_LoadCase, self).RunPageInteractions(action_runner)
     self._TakeMemoryMeasurement(action_runner)
 
 
 class _MemorySystemHealthStorySet(story.StorySet):
   """User stories for the System Health Plan.
 
   See https://goo.gl/Jek2NL.
   """
   PLATFORM = NotImplemented
 
   def __init__(self):
     super(_MemorySystemHealthStorySet, self).__init__(
         archive_data_file=('../data/memory_system_health_%s.json' %
                            self.PLATFORM),
         cloud_storage_bucket=story.PARTNER_BUCKET)
 
     for group_name, page_specs in _SINGLE_PAGE_SPECS.iteritems():
       for page_spec in page_specs:
-        url = page_spec.url
-        if isinstance(url, dict):
-          url = url.get(self.PLATFORM)
-          if url is None:
-            continue  # URL not supported on the platform.
-        self.AddStory(_LoadCase(self, group_name, url, page_spec))
+        resolved_page_spec = page_spec.Resolve(self.PLATFORM)
+        if not resolved_page_spec.url:
+          continue  # URL not supported on the platform.
+        self.AddStory(_LoadCase(self, group_name, resolved_page_spec))
 
 
 class DesktopMemorySystemHealthStorySet(_MemorySystemHealthStorySet):
   """Desktop user stories for Chrome Memory System Health Plan."""
   PLATFORM = 'desktop'
 
 
 class MobileMemorySystemHealthStorySet(_MemorySystemHealthStorySet):
   """Mobile user stories for Chrome Memory System Health Plan."""
   PLATFORM = 'mobile'