tools/perf/page_sets/memory_top_10_mobile.py

# Copyright 2015 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 re

from telemetry.page import page as page_module
from telemetry.page import shared_page_state
from telemetry import story as story_module

from devil.android.sdk import keyevent # pylint: disable=import-error

from page_sets import top_10_mobile


class Top10MobileSharedState(shared_page_state.SharedMobilePageState):
  def __init__(self, test, finder_options, story_set):
    super(Top10MobileSharedState, self).__init__(
        test, finder_options, story_set)
    self._story_set = story_set

  def ShouldStopBrowserAfterStoryRun(self, story):
    # Close the browser after the last story in the set.
    # TODO(crbug.com/750055): Switch to close after each background page.
    return self._story_set[-1] == story


class MemoryMeasurementPage(page_module.Page):
  """Abstract class for measuring memory on a story unit."""

  _PHASE = NotImplemented

  def __init__(self, story_set, name, url):
    super(MemoryMeasurementPage, self).__init__(
        page_set=story_set, name=name, url=url,
        shared_page_state_class=Top10MobileSharedState,
        grouping_keys={'phase': self._PHASE})


class ForegroundPage(MemoryMeasurementPage):
  """Take a measurement after loading a regular webpage."""

  _PHASE = 'foreground'

  def __init__(self, story_set, name, url):
    super(ForegroundPage, self).__init__(story_set, name, url)

  def RunPageInteractions(self, action_runner):
    action_runner.tab.WaitForDocumentReadyStateToBeComplete()
    action_runner.MeasureMemory(self.story_set.DETERMINISTIC_MODE)


class BackgroundPage(MemoryMeasurementPage):
  """Take a measurement while Chrome is in the background."""

  _PHASE = 'background'

  def __init__(self, story_set, name):
    super(BackgroundPage, self).__init__(story_set, name, 'about:blank')

  def RunPageInteractions(self, action_runner):
    action_runner.tab.WaitForDocumentReadyStateToBeComplete()

    # Launch clock app, pushing Chrome to the background.
    android_browser = action_runner.tab.browser
    android_browser.Background()

    # Take measurement.
    action_runner.MeasureMemory(self.story_set.DETERMINISTIC_MODE)

    # Go back to Chrome.
    android_browser.platform.android_action_runner.InputKeyEvent(
        keyevent.KEYCODE_BACK)


class MemoryTop10Mobile(story_module.StorySet):
  """User story to measure foreground/background memory in top 10 mobile."""
  DETERMINISTIC_MODE = True

  def __init__(self):
    super(MemoryTop10Mobile, self).__init__(
        archive_data_file='data/memory_top_10_mobile.json',
        cloud_storage_bucket=story_module.PARTNER_BUCKET)

    for url in top_10_mobile.URL_LIST:
      # We name pages so their foreground/background counterparts are easy
      # to identify. For example 'http://google.com' becomes
      # 'http_google_com' and 'after_http_google_com' respectively.
      name = re.sub(r'\W+', '_', url)
      self.AddStory(ForegroundPage(self, name, url))
      self.AddStory(BackgroundPage(self, 'after_' + name))