Convert cookie and download automation commands 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 1512 matching lines @@
 
     Args:
       windex: the index of the browser window to work on.
               Default: 0 (first window)
     """
     cmd_dict = {
         'command': 'OmniboxAcceptInput',
     }
     self._GetResultFromJSONRequest(cmd_dict, windex=windex)
 
+  def GetCookie(self, url, windex=0):
+    """Get the value of the cookie at url in context of the specified browser.
+
+    Args:
+      url: Either a GURL object or url string specifing the cookie url.
+      windex: The index of the browser window to work on. Defaults to the first
+          window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    if isinstance(url, GURL):
+      url = url.spec()
+    cmd_dict = {
+        'command': 'GetCookiesInBrowserContext',
+        'url': url,
+        'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=None)['cookies']
+
+  def DeleteCookie(self, url, cookie_name, windex=0):
+    """Delete the cookie at url with name cookie_name.
+
+    Args:
+      url: Either a GURL object or url string specifing the cookie url.
+      cookie_name: The name of the cookie to delete as a string.
+      windex: The index of the browser window to work on. Defaults to the first
+          window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    if isinstance(url, GURL):
+      url = url.spec()
+    cmd_dict = {
+        'command': 'DeleteCookieInBrowserContext',
+        'url': url,
+        'cookie_name': cookie_name,
+        'windex': windex,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
+  def SetCookie(self, url, value, windex=0):
+    """Set the value of the cookie at url to value in the context of a browser.
+
+    Args:
+      url: Either a GURL object or url string specifing the cookie url.
+      value: A string to set as the cookie's value.
+      windex: The index of the browser window to work on. Defaults to the first
+          window.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    if isinstance(url, GURL):
+      url = url.spec()
+    cmd_dict = {
+        'command': 'SetCookieInBrowserContext',
+        'url': url,
+        'value': value,
+        'windex': windex,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
   def GetInstantInfo(self):
     """Return info about the instant overlay tab.
 
     Returns:
       A dictionary.
       Examples:
         { u'enabled': True,
           u'active': True,
           u'current': True,
           u'loading': True,
@@ skipping 294 matching lines @@
       'unmodifiedText': char,
       'nativeKeyCode': 0,
       'windowsKeyCode': ord((char).upper()),
       'modifiers': 0,
       'windex': windex,
       'tab_index': tab_index,
     }
     # Sending request for a char.
     self._GetResultFromJSONRequest(cmd_dict, windex=None)
 
+  def SetDownloadShelfVisible(self, is_visible, windex=0):
+    """Set download shelf visibility for the specified browser window.
+
+    Args:
+      is_visible: A boolean indicating the desired shelf visibility.
+      windex: The window index, defaults to 0 (the first window).
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+      'command': 'SetDownloadShelfVisible',
+      'is_visible': is_visible,
+      'windex': windex,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=None)
+
+  def IsDownloadShelfVisible(self, windex=0):
+    """Determine whether the download shelf is visible in the given window.
+
+    Args:
+      windex: The window index, defaults to 0 (the first window).
+
+    Returns:
+      A boolean indicating the shelf visibility.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+      'command': 'IsDownloadShelfVisible',
+      'windex': windex,
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=None)['is_visible']
+
+  def GetDownloadDirectory(self, tab_index=None, windex=0):
+    """Get the path to the download directory.
+
+    Warning: Depending on the concept of an active tab is dangerous as it can
+    change during the test. Always supply a tab_index explicitly.
+
+    Args:
+      tab_index: The index of the tab to work on. Defaults to the active tab.
+      windex: The index of the browser window to work on. Defaults to 0.
+
+    Returns:
+      The path to the download directory as a FilePath object.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    if tab_index is None:
+      tab_index = self.GetActiveTabIndex(windex)
+    cmd_dict = {
+      'command': 'GetDownloadDirectory',
+      'tab_index': tab_index,
+      'windex': windex,
+    }
+    return FilePath(self._GetResultFromJSONRequest(cmd_dict,
+                                                   windex=None)['path'])
+
   def WaitForAllDownloadsToComplete(self, pre_download_ids=[], windex=0,
                                     timeout=-1):
     """Wait for all pending downloads to complete.
 
     This function assumes that any downloads to wait for have already been
     triggered and have started (it is ok if those downloads complete before this
     function is called).
 
     Args:
       pre_download_ids: A list of numbers representing the IDs of downloads that
@@ skipping 4502 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()