Handle Telemetry's TimeoutException in retries of flaky tests.

content/test/gpu/gpu_tests/gpu_test_base_unittest.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 unittest
 
 from telemetry import benchmark as benchmark_module
 from telemetry.core import exceptions
 from telemetry.story import story_set as story_set_module
 from telemetry.testing import fakes
 
@@ skipping 27 matching lines @@
     self._times_to_fail = times_to_fail
     self.ValidateAndMeasurePage.side_effect = self.maybeFail
 
   def maybeFail(self, page, tab, results):
     if self._times_to_fail > 0:
       self._times_to_fail = self._times_to_fail - 1
       raise Exception('Deliberate exception')
 
 
 class FakePage(gpu_test_base.PageBase):
-  def __init__(self, benchmark, name, manager_mock=None):
+  def __init__(self, benchmark, name, manager_mock=None,
+               shared_page_state_class=gpu_test_base.FakeGpuSharedPageState):
     super(FakePage, self).__init__(
       name=name,
       url='http://nonexistentserver.com/' + name,
       page_set=benchmark.GetFakeStorySet(),
-      shared_page_state_class=gpu_test_base.FakeGpuSharedPageState,
+      shared_page_state_class=shared_page_state_class,
       expectations=benchmark.GetExpectations())
     if manager_mock == None:
       self.RunNavigateSteps = mock.Mock()
       self.RunPageInteractions = mock.Mock()
     else:
       self.RunNavigateSteps = manager_mock.RunNavigateSteps
       self.RunPageInteractions = manager_mock.RunPageInteractions
 
 
+class SharedPageStateWhichTimesOutNTimes(gpu_test_base.FakeGpuSharedPageState):
+  # This has to be a class variable because it's not possible to
+  # interpose on SharedPageState's constructor.
+  times_to_fail = 1
+
+  def DidRunStory(self, results):  #pylint: disable=arguments-differ
+    if SharedPageStateWhichTimesOutNTimes.times_to_fail > 0:
+      SharedPageStateWhichTimesOutNTimes.times_to_fail = \
+          SharedPageStateWhichTimesOutNTimes.times_to_fail - 1
+      super(SharedPageStateWhichTimesOutNTimes, self).DidRunStory(
+        results, force_timeout_exception=True)
+    super(SharedPageStateWhichTimesOutNTimes, self).DidRunStory(
+      self, results)
+
+
 class FakeTest(gpu_test_base.TestBase):
   def __init__(self,
                times_to_fail_test=0,
                manager_mock=None,
                max_failures=None):
     super(FakeTest, self).__init__(max_failures)
     self._fake_pages = []
     self._fake_story_set = story_set_module.StorySet()
     self._created_story_set = False
     validator_mock = manager_mock.validator if manager_mock else None
@@ skipping 37 matching lines @@
 
 class CrashingPage(FakePage):
   def __init__(self, benchmark, name, manager_mock=None):
     super(CrashingPage, self).__init__(benchmark, name,
                                        manager_mock=manager_mock)
     self.RunNavigateSteps.side_effect = (
       exceptions.DevtoolsTargetCrashException(None))
 
 
 class PageWhichFailsNTimes(FakePage):
-  def __init__(self, benchmark, name, times_to_fail, manager_mock=None):
-    super(PageWhichFailsNTimes, self).__init__(benchmark, name,
-                                               manager_mock=manager_mock)
+  def __init__(self, benchmark, name, times_to_fail, manager_mock=None,
+               shared_page_state_class=gpu_test_base.FakeGpuSharedPageState):
+    super(PageWhichFailsNTimes, self).__init__(
+      benchmark, name, manager_mock=manager_mock,
+      shared_page_state_class=shared_page_state_class)
     self._times_to_fail = times_to_fail
     self.RunNavigateSteps.side_effect = self.maybeFail
 
   def maybeFail(self, action_runner):
     if self._times_to_fail > 0:
       self._times_to_fail = self._times_to_fail - 1
       raise Exception('Deliberate exception')
 
 class PageRunExecutionTest(unittest.TestCase):
   def testNoGarbageCollectionCalls(self):
@@ skipping 178 matching lines @@
                 mock.call.validator.WillNavigateToPage(
                   page, mock.ANY),
                 mock.call.page.RunNavigateSteps(mock.ANY),
                 mock.call.validator.DidNavigateToPage(
                   page, mock.ANY),
                 mock.call.page.RunPageInteractions(mock.ANY),
                 mock.call.validator.ValidateAndMeasurePage(
                   page, mock.ANY, mock.ANY)]
     self.assertTrue(manager.mock_calls == expected)
 
+  def testFlakyFailureInDidRunStory(self):
+    manager = mock.Mock()
+    test, finder_options = self.setupTest(manager_mock=manager)
+    page = PageWhichFailsNTimes(
+      test, 'page1', 1, manager_mock=manager.page,
+      shared_page_state_class=SharedPageStateWhichTimesOutNTimes)
+    SharedPageStateWhichTimesOutNTimes.times_to_fail = 1
+    test.AddFakePage(page)
+    test.GetExpectations().Flaky('page1')
+    self.assertEqual(test.Run(finder_options), 0,
+                     'Test should run with no errors')
+    expected = [mock.call.validator.WillNavigateToPage(
+                  page, mock.ANY),
+                mock.call.page.RunNavigateSteps(mock.ANY),
+                mock.call.validator.WillNavigateToPage(
+                  page, mock.ANY),
+                mock.call.page.RunNavigateSteps(mock.ANY),
+                mock.call.validator.DidNavigateToPage(
+                  page, mock.ANY),
+                mock.call.page.RunPageInteractions(mock.ANY),
+                mock.call.validator.ValidateAndMeasurePage(
+                  page, mock.ANY, mock.ANY)]
+    self.assertTrue(manager.mock_calls == expected)
+
   def testFlakyPageExceedingNumRetries(self):
     manager = mock.Mock()
     test, finder_options = self.setupTest(manager_mock=manager)
     page = PageWhichFailsNTimes(test, 'page1', 2, manager_mock=manager.page)
     test.AddFakePage(page)
     test.GetExpectations().Flaky('page1', max_num_retries=1)
     self.assertNotEqual(test.Run(finder_options), 0,
                      'Test should fail')
     expected = [mock.call.validator.WillNavigateToPage(
                   page, mock.ANY),
@@ skipping 57 matching lines @@
                 mock.call.page2.RunNavigateSteps(mock.ANY),
                 mock.call.validator.WillNavigateToPage(
                   page2, mock.ANY),
                 mock.call.page2.RunNavigateSteps(mock.ANY),
                 mock.call.validator.DidNavigateToPage(
                   page2, mock.ANY),
                 mock.call.page2.RunPageInteractions(mock.ANY),
                 mock.call.validator.ValidateAndMeasurePage(
                   page2, mock.ANY, mock.ANY)]
     self.assertTrue(manager.mock_calls == expected)