Convert PyAuto's NavigateToURL, GetActiveTabIndex, Refresh, RefreshActiveTab, and AppendTab to the …

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 1039 matching lines @@
       if 'username' in cmd_dict_copy.keys():
         cmd_dict_copy['username'] = 'removed_username'
       raise JSONInterfaceError('Automation call %s received empty response.  '
                                'Additional information:\n%s' % (cmd_dict_copy,
                                additional_info))
     ret_dict = json.loads(result)
     if ret_dict.has_key('error'):
       raise JSONInterfaceError(ret_dict['error'])
     return ret_dict
 
+  def NavigateToURL(self, url, windex=0, tab_index=0, navigation_count=1):
+    """Navigate the given tab to the given URL.
+
+    Note that this method also activates the corresponding tab/window
+    if it's not active already. Blocks until page has loaded.
+
+    Args:
+      url: The URL to which to navigate.
+      windex: The index of the browser window to work on. Defaults to the first
+          window.
+      tab_index: The index of the tab to work on. Defaults to the first tab.
+      navigation_count: the number of navigations to wait for. Defaults to 1.
+    """
+    cmd_dict = {
+        'command': 'NavigateToURL',
+        'url': url,
+        'windex': windex,
+        'tab_index': tab_index,
+        'navigation_count': navigation_count,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=windex)
+
+  def ReloadTab(self, windex, tab_index):

[dennis_jeffrey, 2012/07/03 00:47:04]

should we provide defaults of 0 for "windex" and "tab_index"?

[craigdh, 2012/07/03 16:48:08]

Done.

+    """Reload the given tab.
+
+    Blocks until the page has reloaded.
+
+    Args:
+      windex: The index of the browser window to work on.
+      tab_index: The index of the tab to reload.
+    """
+    cmd_dict = {
+        'command': 'Reload',
+        'windex': windex,
+        'tab_index': tab_index,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=windex)
+
+  def ReloadActiveTab(self, windex=0):
+    """Reload an active tab.
+
+    Args:
+      windex: The index of the browser window to work on. Defaults to the first
+          window.
+    """
+    self.ReloadTab(windex, self.GetActiveTabIndex(windex))
+
+  def GetActiveTabIndex(self, windex=0):
+    """Get the index of the currently active tab in the given browser window.
+
+    Args:
+      windex: The index of the browser window to work on. Defaults to the first
+          window.

[dennis_jeffrey, 2012/07/03 00:47:04]

add a Returns: section to this docstring

[craigdh, 2012/07/03 16:48:08]

Done.

+    """
+    cmd_dict = {
+        'command': 'GetActiveTabIndex',
+        'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict,
+                                          windex=windex).get('tab_index')
+
+  def AppendTab(self, url, windex=0):
+    """Append a new tab.
+
+    Create a new tab at the end of given or first browser window and activate
+    it. Blocks until the page is loaded.

[dennis_jeffrey, 2012/07/03 00:47:04]

Creates a new tab at the end of the given browser window and activates it.
Blocks until the specified page is loaded.

[craigdh, 2012/07/03 16:48:08]

Done.

+
+    Args:
+      url: The url to load, can be string or a GURL object.
+      windex: The index of the browser window to work on. Defaults to the first
+          window.

[dennis_jeffrey, 2012/07/03 00:47:04]

add a Returns: section to this docstring.

[craigdh, 2012/07/03 16:48:08]

Done.

+    """
+    if isinstance(url, GURL):
+      url = url.spec()
+    cmd_dict = {
+        'command': 'AppendTab',
+        'url': url,
+        'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=windex).get('result')
+
   def GetBookmarkModel(self, windex=0):
     """Return the bookmark model as a BookmarkModel object.
 
     This is a snapshot of the bookmark model; it is not a proxy and
     does not get updated as the bookmark model changes.
     """
     bookmarks_as_json = self._GetBookmarksAsJSON(windex)
     if not bookmarks_as_json:
       raise JSONInterfaceError('Could not resolve browser proxy.')
     return bookmark_model.BookmarkModel(bookmarks_as_json)
@@ skipping 2084 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 AppendTab(self, url, windex=0):
-    """Create a new tab.
-
-    Create a new tab at the end of given or first browser window
-    and activate it. Blocks until the url is loaded.
-
-    Args:
-      url: The url to load, can be string or a GURL object.
-      windex: Index of the window to open a tab in. Default 0 - first window.
-
-    Returns:
-      True on success.
-    """
-    if type(url) is GURL:
-      gurl = url
-    else:
-      gurl = GURL(url)
-    return pyautolib.PyUITestBase.AppendTab(self, gurl, windex)
-
   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.
 
@@ skipping 2794 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()