gpu: Add test for losing a context in a background tab

content/test/gpu/gpu_tests/context_lost.py

 # Copyright (c) 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 os
 import time
 
 import context_lost_expectations
 
 from telemetry import benchmark as benchmark_module
 from telemetry.core import exceptions
@@ skipping 48 matching lines @@
 
   def CustomizeBrowserOptions(self, options):
     options.AppendExtraBrowserArgs(
         '--disable-domain-blocking-for-3d-apis')
     options.AppendExtraBrowserArgs(
         '--disable-gpu-process-crash-limit')
     # Required for about:gpucrash handling from Telemetry.
     options.AppendExtraBrowserArgs('--enable-gpu-benchmarking')
 
   def ValidateAndMeasurePage(self, page, tab, results):
+    def WaitForPageToFinish():
+      print "Waiting for page to finish."
+      try:
+        util.WaitFor(lambda: tab.EvaluateJavaScript(
+            'window.domAutomationController._finished'), wait_timeout)
+        return True
+      except util.TimeoutException:
+        return False
+
     if page.kill_gpu_process:
       # Doing the GPU process kill operation cooperatively -- in the
       # same page's context -- is much more stressful than restarting
       # the browser every time.
       for x in range(page.number_of_gpu_process_kills):
         if not tab.browser.supports_tab_control:
           raise page_test.Failure('Browser must support tab control')
 
         expected_kills = x + 1
 
@@ skipping 11 matching lines @@
         gpucrash_tab = tab.browser.tabs.New()
         # To access these debug URLs from Telemetry, they have to be
         # written using the chrome:// scheme.
         # The try/except is a workaround for crbug.com/368107.
         try:
           gpucrash_tab.Navigate('chrome://gpucrash')
         except (exceptions.TabCrashException, Exception):
           print 'Tab crashed while navigating to chrome://gpucrash'
         # Activate the original tab and wait for completion.
         tab.Activate()
-        completed = False
-        try:
-          util.WaitFor(lambda: tab.EvaluateJavaScript(
-              'window.domAutomationController._finished'), wait_timeout)
-          completed = True
-        except util.TimeoutException:
-          pass
+        completed = WaitForPageToFinish()
 
         if page.check_crash_count:
           if not tab.browser.supports_system_info:
             raise page_test.Failure('Browser must support system info')
 
           if not tab.EvaluateJavaScript(
             'window.domAutomationController._succeeded'):
             raise page_test.Failure(
               'Test failed (didn\'t render content properly?)')
 
@@ skipping 36 matching lines @@
               'Test didn\'t complete (no context lost event?)')
         if not tab.EvaluateJavaScript(
           'window.domAutomationController._succeeded'):
           raise page_test.Failure(
             'Test failed (context not restored properly?)')
     elif page.force_garbage_collection:
       # Try to corce GC to clean up any contexts not attached to the page.
       # This method seem unreliable, so the page will also attempt to force
       # GC through excessive allocations.
       tab.CollectGarbage()
-      completed = False
-      try:
-        print "Waiting for page to finish."
-        util.WaitFor(lambda: tab.EvaluateJavaScript(
-            'window.domAutomationController._finished'), wait_timeout)
-        completed = True
-      except util.TimeoutException:
-        pass
+      completed = WaitForPageToFinish()
 
       if not completed:
         raise page_test.Failure(
             'Test didn\'t complete (no context restored event?)')
       if not tab.EvaluateJavaScript(
         'window.domAutomationController._succeeded'):
         raise page_test.Failure(
           'Test failed (context not restored properly?)')
-    else:
-      completed = False
-      try:
-        print "Waiting for page to finish."
-        util.WaitFor(lambda: tab.EvaluateJavaScript(
-            'window.domAutomationController._finished'), wait_timeout)
-        completed = True
-      except util.TimeoutException:
-        pass
+    elif page.hide_tab_and_lose_context:
+      if not tab.browser.supports_tab_control:
+        raise page_test.Failure('Browser must support tab control')
+
+      # Test losing a context in a hidden tab. This test passes if the tab
+      # doesn't crash.
+      dummy_tab = tab.browser.tabs.New()
+      tab.EvaluateJavaScript('loseContextUsingExtension()')
+      tab.Activate()
+
+      completed = WaitForPageToFinish()
 
       if not completed:
         raise page_test.Failure('Test didn\'t complete')
+      if not tab.EvaluateJavaScript(
+        'window.domAutomationController._succeeded'):
+        raise page_test.Failure('Test failed')
+    else:
+      completed = WaitForPageToFinish()
+
+      if not completed:
+        raise page_test.Failure('Test didn\'t complete')
       if not tab.EvaluateJavaScript(
         'window.domAutomationController._succeeded'):
         raise page_test.Failure('Test failed')
 
 # Test that navigating to chrome://gpucrash causes the GPU process to crash
 # exactly one time per navigation.
 class GPUProcessCrashesExactlyOnce(page.Page):
   def __init__(self, page_set, base_dir):
     super(GPUProcessCrashesExactlyOnce, self).__init__(
       url='file://gpu_process_crash.html',
       page_set=page_set,
       base_dir=base_dir,
       name='GpuCrash.GPUProcessCrashesExactlyOnce')
     self.script_to_evaluate_on_commit = harness_script
     self.kill_gpu_process = True
     self.number_of_gpu_process_kills = 2
     self.check_crash_count = True
     self.force_garbage_collection = False
+    self.hide_tab_and_lose_context = False

[picksi1, 2014/09/12 09:05:25]

It looks like this has already landed, but as an observation for future
refactoring this (ever increasing!) and often repeated list of bools seem to
really be defining a mode or state. Their use-cases are [mostly] mutually
exclusive.

It might be more scalable, and make the code more explicit, to change these into
an enum.

The only slight hiccup is kill_gpu_process & check_crash_count are slightly
entwined, but this could be easily fixed [currently check_crash_count being true
implies kill_gpu_process is true, so check_crash_count could be a standalone
state].

[Sami, 2014/09/12 09:56:28]

Right, what I'd really want to do here is have a custom validator class just for
this page, but I need to look at a few other page sets to see how that is
usually done.

 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.domAutomationController._loaded')
 
 class WebGLContextLostFromGPUProcessExitPage(page.Page):
   def __init__(self, page_set, base_dir):
     super(WebGLContextLostFromGPUProcessExitPage, self).__init__(
       url='file://webgl.html?query=kill_after_notification',
       page_set=page_set,
       base_dir=base_dir,
       name='ContextLost.WebGLContextLostFromGPUProcessExit')
     self.script_to_evaluate_on_commit = harness_script
     self.kill_gpu_process = True
     self.check_crash_count = False
     self.number_of_gpu_process_kills = 1
     self.force_garbage_collection = False
+    self.hide_tab_and_lose_context = False
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.domAutomationController._loaded')
 
 
 class WebGLContextLostFromLoseContextExtensionPage(page.Page):
   def __init__(self, page_set, base_dir):
     super(WebGLContextLostFromLoseContextExtensionPage, self).__init__(
       url='file://webgl.html?query=WEBGL_lose_context',
       page_set=page_set,
       base_dir=base_dir,
       name='ContextLost.WebGLContextLostFromLoseContextExtension')
     self.script_to_evaluate_on_commit = harness_script
     self.kill_gpu_process = False
     self.check_crash_count = False
     self.force_garbage_collection = False
+    self.hide_tab_and_lose_context = False
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.domAutomationController._finished')
 
+
+class WebGLContextLostInHiddenTabPage(page.Page):
+  def __init__(self, page_set, base_dir):
+    super(WebGLContextLostInHiddenTabPage, self).__init__(
+      url='file://webgl.html?query=kill_after_notification',
+      page_set=page_set,
+      base_dir=base_dir,
+      name='ContextLost.WebGLContextLostInHiddenTab')
+    self.script_to_evaluate_on_commit = harness_script
+    self.kill_gpu_process = False
+    self.check_crash_count = False
+    self.force_garbage_collection = False
+    self.hide_tab_and_lose_context = True
+
+  def RunNavigateSteps(self, action_runner):
+    action_runner.NavigateToPage(self)
+    action_runner.WaitForJavaScriptCondition(
+        'window.domAutomationController._loaded')
+
+
 class WebGLContextLostFromQuantityPage(page.Page):
   def __init__(self, page_set, base_dir):
     super(WebGLContextLostFromQuantityPage, self).__init__(
       url='file://webgl.html?query=forced_quantity_loss',
       page_set=page_set,
       base_dir=base_dir,
       name='ContextLost.WebGLContextLostFromQuantity')
     self.script_to_evaluate_on_commit = harness_script
     self.kill_gpu_process = False
     self.check_crash_count = False
     self.force_garbage_collection = True
+    self.hide_tab_and_lose_context = False
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.domAutomationController._loaded')
 
 class WebGLContextLostFromSelectElementPage(page.Page):
   def __init__(self, page_set, base_dir):
     super(WebGLContextLostFromSelectElementPage, self).__init__(
       url='file://webgl_with_select_element.html',
       page_set=page_set,
       base_dir=base_dir,
       name='ContextLost.WebGLContextLostFromSelectElement')
     self.script_to_evaluate_on_commit = harness_script
     self.kill_gpu_process = False
     self.check_crash_count = False
     self.force_garbage_collection = False
+    self.hide_tab_and_lose_context = False
 
   def RunNavigateSteps(self, action_runner):
     action_runner.NavigateToPage(self)
     action_runner.WaitForJavaScriptCondition(
         'window.domAutomationController._loaded')
 
 class ContextLost(benchmark_module.Benchmark):
   enabled = True
   test = _ContextLostValidator
 
   def CreateExpectations(self, page_set):
     return context_lost_expectations.ContextLostExpectations()
 
   # For the record, this would have been another way to get the pages
   # to repeat. pageset_repeat would be another option.
   # options = {'page_repeat': 5}
   def CreatePageSet(self, options):
     ps = page_set.PageSet(
       file_path=data_path,
       user_agent_type='desktop',
       serving_dirs=set(['']))
     ps.AddPage(GPUProcessCrashesExactlyOnce(ps, ps.base_dir))
     ps.AddPage(WebGLContextLostFromGPUProcessExitPage(ps, ps.base_dir))
     ps.AddPage(WebGLContextLostFromLoseContextExtensionPage(ps, ps.base_dir))
     ps.AddPage(WebGLContextLostFromQuantityPage(ps, ps.base_dir))
     ps.AddPage(WebGLContextLostFromSelectElementPage(ps, ps.base_dir))
+    ps.AddPage(WebGLContextLostInHiddenTabPage(ps, ps.base_dir))
     return ps