catapult/telemetry/telemetry/page/page_test_unittest.py

# Copyright 2013 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 json
import os
import unittest

from telemetry import decorators
from telemetry import story
from telemetry.page import page as page_module
from telemetry.page import page_test
from telemetry.testing import options_for_unittests
from telemetry.testing import page_test_test_case
from telemetry.util import wpr_modes
from telemetry.wpr import archive_info


class PageTestThatFails(page_test.PageTest):

  def ValidateAndMeasurePage(self, page, tab, results):
    raise page_test.Failure


class PageTestForBlank(page_test.PageTest):

  def ValidateAndMeasurePage(self, page, tab, results):
    contents = tab.EvaluateJavaScript('document.body.textContent')
    if contents.strip() != 'Hello world':
      raise page_test.MeasurementFailure(
          'Page contents were: ' + contents)


class PageTestForReplay(page_test.PageTest):

  def ValidateAndMeasurePage(self, page, tab, results):
    # Web Page Replay returns '404 Not found' if a page is not in the archive.
    contents = tab.EvaluateJavaScript('document.body.textContent')
    if '404 Not Found' in contents.strip():
      raise page_test.MeasurementFailure('Page not in archive.')


class PageTestQueryParams(page_test.PageTest):

  def ValidateAndMeasurePage(self, page, tab, results):
    query = tab.EvaluateJavaScript('window.location.search')
    expected = '?foo=1'
    if query.strip() != expected:
      raise page_test.MeasurementFailure(
          'query was %s, not %s.' % (query, expected))


class PageTestWithAction(page_test.PageTest):

  def __init__(self):
    super(PageTestWithAction, self).__init__()

  def ValidateAndMeasurePage(self, page, tab, results):
    pass


class PageWithAction(page_module.Page):

  def __init__(self, url, story_set):
    super(PageWithAction, self).__init__(url, story_set, story_set.base_dir)
    self.run_test_action_called = False

  def RunPageInteractions(self, _):
    self.run_test_action_called = True


class PageTestUnitTest(page_test_test_case.PageTestTestCase):

  def setUp(self):
    self._options = options_for_unittests.GetCopy()
    self._options.browser_options.wpr_mode = wpr_modes.WPR_OFF

  def testGotToBlank(self):
    story_set = self.CreateStorySetFromFileInUnittestDataDir('blank.html')
    measurement = PageTestForBlank()
    all_results = self.RunMeasurement(
        measurement, story_set, options=self._options)
    self.assertEquals(0, len(all_results.failures))

  def testGotQueryParams(self):
    story_set = self.CreateStorySetFromFileInUnittestDataDir(
        'blank.html?foo=1')
    measurement = PageTestQueryParams()
    all_results = self.RunMeasurement(
        measurement, story_set, options=self._options)
    self.assertEquals(0, len(all_results.failures))

  def testFailure(self):
    story_set = self.CreateStorySetFromFileInUnittestDataDir('blank.html')
    measurement = PageTestThatFails()
    all_results = self.RunMeasurement(
        measurement, story_set, options=self._options)
    self.assertEquals(1, len(all_results.failures))

  # This test is disabled because it runs against live sites, and needs to be
  # fixed. crbug.com/179038
  @decorators.Disabled('all')
  def testRecordAndReplay(self):
    test_archive = '/tmp/google.wpr'
    google_url = 'http://www.google.com/'
    foo_url = 'http://www.foo.com/'
    archive_info_template = ("""
{
"archives": {
  "%s": ["%s"]
}
}
""")
    try:
      story_set = story.StorySet.PageSet()
      measurement = PageTestForReplay()

      # First record an archive with only www.google.com.
      self._options.browser_options.wpr_mode = wpr_modes.WPR_RECORD

      story_set._wpr_archive_info = archive_info.WprArchiveInfo(
          '', json.loads(archive_info_template % (test_archive, google_url)),
          story_set.bucket)
      story_set.pages = [page_module.Page(google_url, story_set)]
      all_results = self.RunMeasurement(
          measurement, story_set, options=self._options)
      self.assertEquals(0, len(all_results.failures))

      # Now replay it and verify that google.com is found but foo.com is not.
      self._options.browser_options.wpr_mode = wpr_modes.WPR_REPLAY

      story_set._wpr_archive_info = archive_info.WprArchiveInfo(
          '', json.loads(archive_info_template % (test_archive, foo_url)),
          story_set.bucket)
      story_set.pages = [page_module.Page(foo_url, story_set)]
      all_results = self.RunMeasurement(
          measurement, story_set, options=self._options)
      self.assertEquals(1, len(all_results.failures))

      story_set._wpr_archive_info = archive_info.WprArchiveInfo(
          '', json.loads(archive_info_template % (test_archive, google_url)),
          story_set.bucket)
      story_set.pages = [page_module.Page(google_url, story_set)]
      all_results = self.RunMeasurement(
          measurement, story_set, options=self._options)
      self.assertEquals(0, len(all_results.failures))

      self.assertTrue(os.path.isfile(test_archive))

    finally:
      if os.path.isfile(test_archive):
        os.remove(test_archive)

  def testRunActions(self):
    story_set = self.CreateEmptyPageSet()
    page = PageWithAction('file://blank.html', story_set)
    story_set.AddStory(page)
    measurement = PageTestWithAction()
    self.RunMeasurement(measurement, story_set, options=self._options)
    self.assertTrue(page.run_test_action_called)


class MultiTabPageTestUnitTest(unittest.TestCase):

  def testNoTabForPageReturnsFalse(self):
    class PageTestWithoutTabForPage(page_test.PageTest):

      def ValidateAndMeasurePage(self, *_):
        pass
    test = PageTestWithoutTabForPage()
    self.assertFalse(test.is_multi_tab_test)

  def testHasTabForPageReturnsTrue(self):
    class PageTestWithTabForPage(page_test.PageTest):

      def ValidateAndMeasurePage(self, *_):
        pass

      def TabForPage(self, *_):
        pass
    test = PageTestWithTabForPage()
    self.assertTrue(test.is_multi_tab_test)

  def testHasTabForPageInAncestor(self):
    class PageTestWithTabForPage(page_test.PageTest):

      def ValidateAndMeasurePage(self, *_):
        pass

      def TabForPage(self, *_):
        pass

    class PageTestWithTabForPageInParent(PageTestWithTabForPage):
      pass
    test = PageTestWithTabForPageInParent()
    self.assertTrue(test.is_multi_tab_test)