Allow chromedriver to install an extension and get all installed extension IDs.

chrome/test/pyautolib/pyauto.py

 #!/usr/bin/python
 
 # Copyright (c) 2011 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,
@@ skipping 1698 matching lines @@
     """
     cmd_dict = {  # Prepare command for the json interface
       'command': 'SelectTranslateOption',
       'tab_index': tab_index,
       'option': 'set_target_language',
       'target_language': new_language
     }
     return self._GetResultFromJSONRequest(
         cmd_dict, windex=window_index)['translation_success']
 
+  def InstallExtension(self, extension_path):
+    """Installs an extension from the given path.
+
+    The path must be absolute and may be a crx file or an unpacked extension
+    directory. Returns the extension ID if successfully installed and loaded.
+    Otherwise, throws an exception. The extension must not already be installed.

[dennis_jeffrey, 2011/11/22 23:32:16]

Mention the possibility of an exception in the "Raises:" field of this
docstring.

[kkania, 2011/11/23 17:31:23]

Done.

+
+    Args:
+      extension_path: The absolute path to the extension to install. If the
+                      extension is packed, it must have a .crx extension.
+
+    Returns:
+      The ID of the extension.

[dennis_jeffrey, 2011/11/22 23:32:16]

'of the installed extension'

[kkania, 2011/11/23 17:31:23]

Done.

+    """
+    cmd_dict = {
+        'command': 'InstallExtension',
+        'path': extension_path
+    }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=-1)['id']
+
   def GetExtensionsInfo(self):
     """Returns information about all installed extensions.
 
     Returns:
       A list of dictionaries representing each of the installed extensions.
       Example:

[dennis_jeffrey, 2011/11/22 23:32:16]

Maybe we could modify this example now that there are some additional fields
returned by the automation hook, such as "is_component_extension" and
"is_internal_extension"

[kkania, 2011/11/23 17:31:23]

Done.

       [ { u'api_permissions': [u'bookmarks', u'experimental', u'tabs'],
           u'background_url': u'',
           u'description': u'Bookmark Manager',
           u'effective_host_permissions': [u'chrome://favicon/*',
                                           u'chrome://resources/*'],
           u'host_permissions': [u'chrome://favicon/*', u'chrome://resources/*'],
           u'id': u'eemcgdkfndhakfknompkggombfjjjeno',
           u'name': u'Bookmark Manager',
           u'options_url': u'',
           u'public_key': u'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDQcByy+eN9jza\
@@ skipping 14 matching lines @@
           u'name': u'Facebook for Google Chrome',
           u'options_url': u'',
           u'public_key': u'...',
           u'version': u'2.0.9'
           u'is_enabled': True,
           u'allowed_in_incognito': True} ]
     """
     cmd_dict = {  # Prepare command for the json interface
       'command': 'GetExtensionsInfo'
     }
-    return self._GetResultFromJSONRequest(cmd_dict)['extensions']
+    return self._GetResultFromJSONRequest(cmd_dict, windex=-1)['extensions']
 
   def UninstallExtensionById(self, id):
     """Uninstall the extension with the given id.
 
     Args:
       id: The string id of the extension.
 
     Returns:
       True, if the extension was successfully uninstalled, or
       False, otherwise.
@@ skipping 633 matching lines @@
       'tab_index': tab_index,
     }
     self._GetResultFromJSONRequest(cmd_dict, windex=windex)
 
   def SetTheme(self, crx_file_path):
     """Installs the given theme synchronously.
 
     A theme file is a file with a .crx suffix, like an extension.  The theme
     file must be specified with an absolute path.  This method call waits until
     the theme is installed and will trigger the "theme installed" infobar.
+    If the install is unsuccessful, will throw an exception.

[dennis_jeffrey, 2011/11/22 23:32:16]

Mention this in the "Raises:" section of this docstring

[kkania, 2011/11/23 17:31:23]

Done.

 
     Uses InstallExtension().
 
     Returns:
-      The ID of the installed theme, on success.  The empty string, otherwise.
+      The ID of the installed theme.
     """
-    return self.InstallExtension(crx_file_path, True)
+    return self.InstallExtension(crx_file_path)
 
   def WaitUntilDownloadedThemeSet(self, theme_name):
     """Waits until the theme has been set.
 
     This should not be called after SetTheme(). It only needs to be called after
     downloading a theme file (which will automatically set the theme).
 
     Uses WaitUntil so timeout is capped by automation timeout.
 
     Args:
@@ skipping 666 matching lines @@
     """
     cmd_dict = {
       'command': 'GetNTPInfo',
     }
     return self._GetResultFromJSONRequest(cmd_dict)
 
   def _CheckNTPThumbnailShown(self, thumbnail):
     if self.GetNTPThumbnailIndex(thumbnail) == -1:
       raise NTPThumbnailNotShownError()
 
   def InstallApp(self, app_crx_file_path):

[dennis_jeffrey, 2011/11/22 23:32:16]

I think we should get rid of this function now (and also UninstallApp below) -
we'll need to change the places where it's used (it's used in at least ntp.py).

[kkania, 2011/11/23 17:31:23]

Done.

     """Installs the specified app synchronously.
 
     An app file is a file with a .crx suffix, like an extension or theme.  The
     app file must be specified with an absolute path.  This method will not
     return until the app is installed.
 
     Returns:
       The ID of the installed app, on success.  The empty string, otherwise.
     """
     return self.InstallExtension(app_crx_file_path, False)
@@ skipping 1665 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()