[system health] Add media browsing stories.

tools/perf/page_sets/system_health/browsing_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.
 
+from page_sets.login_helpers import facebook_login
 from page_sets.system_health import platforms
 from page_sets.system_health import system_health_story
 
 
 class _BrowsingStory(system_health_story.SystemHealthStory):
   """Abstract base class for browsing stories.
 
   A browsing story visits items on the main page. Subclasses provide
   CSS selector to identify the items and implement interaction using
   the helper methods of this class.
   """
 
   IS_SINGLE_PAGE_APP = False
   ITEM_SELECTOR = NotImplemented
-  ITEMS_TO_VISIT = 4
   ABSTRACT_STORY = True
 
   def _WaitForNavigation(self, action_runner):
     if not self.IS_SINGLE_PAGE_APP:
       action_runner.WaitForNavigate()
 
   def _NavigateToItem(self, action_runner, index):
     item_selector = 'document.querySelectorAll("%s")[%d]' % (
         self.ITEM_SELECTOR, index)
     self._ClickLink(action_runner, item_selector)
 
   def _ClickLink(self, action_runner, element_function):
     action_runner.WaitForElement(element_function=element_function)
     action_runner.ClickElement(element_function=element_function)
     self._WaitForNavigation(action_runner)
 
   def _NavigateBack(self, action_runner):
     action_runner.ExecuteJavaScript('window.history.back()')
     self._WaitForNavigation(action_runner)
 
 
+##############################################################################
+# News browsing stories.
+##############################################################################
+
+
 class _NewsBrowsingStory(_BrowsingStory):
   """Abstract base class for news user stories.
 
   A news story imitates browsing a news website:
   1. Load the main page.
   2. Open and scroll the first news item.
   3. Go back to the main page and scroll it.
   4. Open and scroll the second news item.
   5. Go back to the main page and scroll it.
   6. etc.
   """
 
   ITEM_READ_TIME_IN_SECONDS = 3
   ITEM_SCROLL_REPEAT = 2
+  ITEMS_TO_VISIT = 4
   MAIN_PAGE_SCROLL_REPEAT = 0
   ABSTRACT_STORY = True
 
   def _DidLoadDocument(self, action_runner):
     for i in xrange(self.ITEMS_TO_VISIT):
       self._NavigateToItem(action_runner, i)
       self._ReadNewsItem(action_runner)
       self._NavigateBack(action_runner)
       self._ScrollMainPage(action_runner)
 
   def _ReadNewsItem(self, action_runner):
     action_runner.tab.WaitForDocumentReadyStateToBeComplete()
     action_runner.Wait(self.ITEM_READ_TIME_IN_SECONDS)
     action_runner.RepeatableBrowserDrivenScroll(
         repeat_count=self.ITEM_SCROLL_REPEAT)
 
   def _ScrollMainPage(self, action_runner):
     action_runner.tab.WaitForDocumentReadyStateToBeComplete()
     action_runner.RepeatableBrowserDrivenScroll(
         repeat_count=self.MAIN_PAGE_SCROLL_REPEAT)
 
 
-##############################################################################
-# News browsing stories.
-##############################################################################
-
-
 class CnnStory(_NewsBrowsingStory):
   """The second top website in http://www.alexa.com/topsites/category/News"""
   NAME = 'browse:news:cnn'
   URL = 'http://edition.cnn.com/'
   ITEM_SELECTOR = '.cd__content > h3 > a'
   ITEMS_TO_VISIT = 2
   # TODO(ulan): Enable this story on mobile once it uses less memory and
   # does not crash with OOM.
   SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
 
@@ skipping 113 matching lines @@
   def _DidLoadDocument(self, action_runner):
     # Close the popup window. On Nexus 9 (and probably other tables) the popup
     # window does not have a "Close" button, instead it has only a "Send link
     # to phone" button. So on tablets we run with the popup window open. The
     # popup is transparent, so this is mostly an aesthetical issue.
     has_button = action_runner.EvaluateJavaScript(
         '!!document.querySelector("%s")' % self._CLOSE_BUTTON_SELECTOR)
     if has_button:
       action_runner.ClickElement(selector=self._CLOSE_BUTTON_SELECTOR)
     super(WashingtonPostMobileStory, self)._DidLoadDocument(action_runner)
+
+
+##############################################################################
+# Media browsing stories.
+##############################################################################
+
+
+class _MediaBrowsingStory(_BrowsingStory):
+  """Abstract base class for media user stories
+
+  A media story imitates browsing a website with photo or video content:
+  1. Load a page showing a media item
+  2. Click on the next link to go to the next media item
+  3. etc.
+  """
+
+  ABSTRACT_STORY = True
+  ITEM_VIEW_TIME_IN_SECONDS = 3
+  ITEMS_TO_VISIT = 15
+  ITEM_SELECTOR_INDEX = 0
+
+  def _DidLoadDocument(self, action_runner):
+    for _ in xrange(self.ITEMS_TO_VISIT):
+      self._NavigateToItem(action_runner, self.ITEM_SELECTOR_INDEX)
+      self._ViewMediaItem(action_runner)
+
+  def _ViewMediaItem(self, action_runner):
+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+    action_runner.Wait(self.ITEM_VIEW_TIME_IN_SECONDS)
+
+
+class ImgurMobileStory(_MediaBrowsingStory):

[petrcermak, 2016/08/04 13:32:42]

Note that you could share common properties by defining abstract base classes.
Example:

class _ImgurStory(_MediaBrowsingStory):
  NAME = 'browse:media:imgur'
  URL = 'http://imgur.com/gallery/5UlBN'
  IS_SINGLE_APP = True
  ABSTRACT_STORY = True

class ImgurDesktopStory(_ImgurStory):
  ITEM_SELECTOR = ...
  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY

class ImgurMobileStory(_ImgurStory):
  ...

Feel free to ignore if you prefer it this way.

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Right on. I decided to keep the current structure to keep it uniform.

+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/5UlBN'
+  ITEM_SELECTOR = '.Navbar-customAction'
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+
+class ImgurDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:imgur'
+  URL = 'http://imgur.com/gallery/5UlBN'
+  ITEM_SELECTOR = '.navNext'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+
+
+class YoutubeMobileStory(_MediaBrowsingStory):

[petrcermak, 2016/08/04 13:32:42]

nit: can you please change this to YouTubeMobileStory (capitalization of "T") so
that it's consistent with loading_stories.py?

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  NAME = 'browse:media:youtube'
+  URL = 'https://m.youtube.com/watch?v=QGfhS1hfTWw&autoplay=false'
+  ITEM_SELECTOR = '._mhgb > a'
+  IS_SINGLE_PAGE_APP = True

[petrcermak, 2016/08/04 13:32:42]

nit: Can you please order the class fields consistently (here you have
IS_SINGLE_PAGE_APP before SUPPORTED_PLATFORMS, but the ordering is reversed in
YoutubeDesktopStory)

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  ITEM_SELECTOR_INDEX = 3
+
+
+class YoutubeDesktopStory(_MediaBrowsingStory):

[petrcermak, 2016/08/04 13:32:42]

ditto (capital "T")

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  NAME = 'browse:media:youtube'
+  URL = 'https://www.youtube.com/watch?v=QGfhS1hfTWw&autoplay=false'
+  ITEM_SELECTOR = '.yt-uix-simple-thumb-related'
+  SUPPORTED_PLATFORMS = platforms.DESKTOP_ONLY
+  IS_SINGLE_PAGE_APP = True
+  ITEM_VIEW_TIME_IN_SECONDS = 5

[petrcermak, 2016/08/04 13:32:42]

Could you please add a short comment why you override the default arguments here
(e.g. because it crashes otherwise).

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  ITEMS_TO_VISIT = 8
+  ITEM_SELECTOR_INDEX = 3
+
+
+class FacebookMobileStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebookphotos'

[petrcermak, 2016/08/04 13:32:42]

nit: I think facebook_photos would be better (consistent with 'google_images' in
loading_stories.py)

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  URL = (
+      'https://m.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153911739606676/?type=3&source=54&ref=page_internal')
+  ITEM_SELECTOR = '._57-p > a'
+  IS_SINGLE_PAGE_APP = True
+  SUPPORTED_PLATFORMS = platforms.MOBILE_ONLY
+  ITEM_SELECTOR_INDEX = 1
+
+  def _Login(self, action_runner):
+    action_runner.Navigate('https://m.facebook.com/NASA')

[petrcermak, 2016/08/04 13:32:42]

Why do you go to NASA and then back to Rihanna? If this is intentional, please
add a comment with an explanation

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Leftover, changed to rihanna.

+    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
+

[petrcermak, 2016/08/04 13:32:42]

nit: too many blank lines (should be 2)

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+
+
+class FacebookDesktopStory(_MediaBrowsingStory):
+  NAME = 'browse:media:facebookphotos'

[petrcermak, 2016/08/04 13:32:42]

ditto (facebook_photos)

[Hannes Payer (out of office), 2016/08/05 10:21:05]

Done.

+  URL = (
+      'https://www.facebook.com/rihanna/photos/a.207477806675.138795.10092511675/10153911739606676/?type=3&theater')
+  ITEM_SELECTOR = '.snowliftPager.next'
+  IS_SINGLE_PAGE_APP = True
+  # Recording currently does not work. The page gets stuck in the
+  # theater viewer.
+  SUPPORTED_PLATFORMS = platforms.NO_PLATFORMS
+
+  def _Login(self, action_runner):
+    facebook_login.LoginWithDesktopSite(action_runner, 'facebook3',
+                                self.credentials_path)