Convert more PyAuto proxy calls to the JSON interface.

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 1195 matching lines @@
     Returns:
       An integer index for the currently active tab.
     """
     cmd_dict = {
         'command': 'GetActiveTabIndex',
         'windex': windex,
     }
     return self._GetResultFromJSONRequest(cmd_dict,
                                           windex=None).get('tab_index')
 
+  def ActivateTab(self, tab_index=0, windex=0):
+    """Activates the given tab in the specified window.
+
+    Warning: Depending on the concept of an active tab is dangerous as it can
+    change during the test. Instead use functions that accept a tab_index
+    explicitly.
+
+    Args:
+      tab_index: Integer index of the tab to activate; defaults to the first

[Nirnimesh, 2012/07/18 19:22:56]

'first tab' -> 0

[craigdh, 2012/07/18 19:45:25]

Done.

+          tab.
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+        'command': 'ActivateTab',
+        'tab_index': tab_index,
+        'windex': windex,
+    }
+    self.BringBrowserToFront(windex)

[Nirnimesh, 2012/07/18 19:22:56]

shouldn't this be done on the C++ side?

[craigdh, 2012/07/18 19:45:25]

Bringing the browser to the front is available in Python via the BrowserProxy.
ActivateTab() was previously implemented in pyautolib.cc by two separate browser
proxy calls (one to bring the browser forward and one to activate the tab). The
reason it's still separate here is because the JSON interface version of
ActivateTab already exists for ChromeDriver but does not bring the window to the
front, and the BringBrowserToFront needed to be implemented for the browser
proxy interface anyway. So this saves adding an additional automation function
that would be nearly identical to one that already exists.

+    self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
+  def BringBrowserToFront(self, windex=0):
+    """Activate the browser's window and bring it to front.
+
+    Args:
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+        'command': 'BringBrowserToFront',
+        'windex': windex,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
   def AppendTab(self, url, windex=0):
     """Append a new tab.
 
     Creates a new tab at the end of given browser window and activates
     it. Blocks until the specified |url| is loaded.
 
     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.
 
     Returns:
       True if the url loads successfully in the new tab. False otherwise.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     if isinstance(url, GURL):
       url = url.spec()
     cmd_dict = {
         'command': 'AppendTab',
         'url': url,
         'windex': windex,
     }
     return self._GetResultFromJSONRequest(cmd_dict, windex=None).get('result')
 
+  def GetTabCount(self, windex=0):
+    """Gets the number of tab in the given browser window.
+
+    Args:
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Returns:
+      The tab count.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+        'command': 'GetTabCount',
+        'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=None)['tab_count']
+
+  def GetTabInfo(self, tab_index=0, windex=0):
+    """Gets information about the specified tab.
+
+    Args:
+      tab_index: Integer index of the tab to activate; defaults to the first
+          tab.
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Returns:
+      A dictionary containing information about the tab.
+      Example:
+        { u'title': "Hello World",
+          u'url': "http://foo.bar", }
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+        'command': 'GetTabInfo',
+        'tab_index': tab_index,
+        'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
+  def GetActiveTabTitle(self, windex=0):
+    """Gets the title of the active tab.
+
+    Warning: Depending on the concept of an active tab is dangerous as it can
+    change during the test. Use GetTabInfo and supply a tab_index explicitly.
+
+    Args:
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Returns:
+      The tab title as a string.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    return self.GetTabInfo(self.GetActiveTabIndex(windex), windex)['title']
+
+  def GetActiveTabURL(self, windex=0):
+    """Gets the URL of the active tab.
+
+    Warning: Depending on the concept of an active tab is dangerous as it can
+    change during the test. Use GetTabInfo and supply a tab_index explicitly.
+
+    Args:
+      windex: Integer index of the browser window to use; defaults to the first
+          window.
+
+    Returns:
+      The tab URL as a GURL object.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    return GURL(self.GetTabInfo(self.GetActiveTabIndex(windex), windex)['url'])
+
   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 4944 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()