Adds an automation hook WaitUntilNavigationCompletes() which blocks until pending navigation comple…

chrome/test/pyautolib/pyauto.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 """PyAuto: Python Interface to Chromium's Automation Proxy.
 
 PyAuto uses swig to expose Automation Proxy interfaces to Python.
 For complete documentation on the functionality available,
 run pydoc on this file.
@@ skipping 3094 matching lines @@
     """Removes all events currently in the AutomationEventQueue.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = {
       'command': 'ClearEventQueue',
     }
     return self._GetResultFromJSONRequest(cmd_dict, windex=None)
 
+  def WaitUntilNavigationCompletes(self, tab_index=0, windex=0):
+    """Wait until the specified tab is done navigating.
+
+    It is safe to call ExecuteJavascript() as soon as the call returns. If
+    there is no outstanding navigation the call will return immediately.
+
+    Args:
+      tab_index: index of the tab.
+      windex: index of the window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+      'command': 'WaitUntilNavigationCompletes',
+      'tab_index': tab_index,
+      'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict)
+
   def ExecuteJavascript(self, js, tab_index=0, windex=0, frame_xpath=''):
     """Executes a script in the specified frame of a tab.
 
     By default, execute the script in the top frame of the first tab in the
     first window. The invoked javascript function must send a result back via
     the domAutomationController.send function, or this function will never
     return.
 
     Args:
       js: script to be executed.
@@ skipping 2253 matching lines @@
     successful = result.wasSuccessful()
     if not successful:
       pyauto_tests_file = os.path.join(self.TestsDir(), self._tests_filename)
       print >>sys.stderr, 'Tests can be disabled by editing %s. ' \
                           'Ref: %s' % (pyauto_tests_file, _PYAUTO_DOC_URL)
     sys.exit(not successful)
 
 
 if __name__ == '__main__':
   Main()