Removing command_execution_timeout_ms in favor of action_max_timeout_ms.

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 404 matching lines @@
     while timeout is None or time.time() - begin <= timeout:
       retval = function(*args)
       if (expect_retval is None and retval) or expect_retval == retval:
         return True
       logging.debug('WaitUntil(%s) still waiting. '
                     'Expecting %s. Last returned %s.' % (
                     function, expect_retval, retval))
       time.sleep(retry_sleep)
     return False
 
-  class CmdExecutionTimeoutChanger(object):

[Nirnimesh, 2011/03/29 20:27:28]

Please let this be. Just change it to use action_timeout_ms

[Huyen, 2011/03/31 02:42:55]

Done. Also change class name to ActionTimeoutChanger.

-    """Facilitate temporary changes to command_execution_timeout_ms.
-
-    Automatically resets to original timeout when object is destroyed.
-    """
-    _saved_timeout = -1  # Saved value for command_execution_timeout_ms
-
-    def __init__(self, ui_test, new_timeout):
-      """Initialize.
-
-      Args:
-        ui_test: a PyUITest object
-        new_timeout: new timeout to use (in milli secs)
-      """
-      self._saved_timeout = ui_test.command_execution_timeout_ms()
-      if new_timeout != self._saved_timeout:
-        ui_test.set_command_execution_timeout_ms(new_timeout)
-      self._ui_test = ui_test
-
-    def __del__(self):
-      """Reset command_execution_timeout_ms to original value."""
-      if self._ui_test.command_execution_timeout_ms() != self._saved_timeout:
-        self._ui_test.set_command_execution_timeout_ms(self._saved_timeout)
-
 
   def _GetResultFromJSONRequest(self, cmd_dict, windex=0):

[Nirnimesh, 2011/03/29 20:27:28]

Since the _GetResultFromJSONRequest below has a default timeout arg, do we still
need this version? Remove it?

[Huyen, 2011/03/31 02:42:55]

Good catch. Nope, removed.

     """Issue call over the JSON automation channel and fetch output.
 
     This method packages the given dictionary into a json string, sends it
+    over the JSON automation channel, loads the json output string returned,
+    and returns it back as a dictionary.
+
+    Args:
+      cmd_dict: the command dictionary. It must have a 'command' key
+                Sample:
+                  {
+                    'command': 'SetOmniboxText',
+                    'text': text,
+                  }
+      windex: 0-based window index on which to work. Default: 0 (first window)
+              Use -ve windex if the automation command does not apply to a
+              browser window. example: chromeos login
+
+    Returns:
+      a dictionary for the output returned by the automation channel.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    return self._GetResultFromJSONRequest(
+        cmd_dict, windex, timeout=self.action_max_timeout_ms())
+
+
+  def _GetResultFromJSONRequest(self, cmd_dict, windex=0, timeout=-1):
+    """Issue call over the JSON automation channel and fetch output.
+
+    This method packages the given dictionary into a json string, sends it
     over the JSON automation channel, loads the json output string returned,
     and returns it back as a dictionary.
 
     Args:
       cmd_dict: the command dictionary. It must have a 'command' key
                 Sample:
                   {
                     'command': 'SetOmniboxText',
                     'text': text,
                   }
       windex: 0-based window index on which to work. Default: 0 (first window)
               Use -ve windex if the automation command does not apply to a
               browser window. example: chromeos login
 
+      timeout: request timeout
+
     Returns:
       a dictionary for the output returned by the automation channel.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
-    ret_dict = json.loads(self._SendJSONRequest(windex, json.dumps(cmd_dict)))
+    if timeout == -1:  # Default
+      timeout = self.action_max_timeout_ms()
+    ret_dict = json.loads(self._SendJSONRequest(

[Nirnimesh, 2011/03/29 20:27:28]

move self._SendJSONRequest to the next line.
It'll look prettier

[Huyen, 2011/03/31 02:42:55]

Done.

+        windex, json.dumps(cmd_dict), timeout))
     if ret_dict.has_key('error'):
       raise JSONInterfaceError(ret_dict['error'])
     return ret_dict
 
   def GetBookmarkModel(self):
     """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.
     """
@@ skipping 262 matching lines @@
              right key. It's useful to dump the preferences first to determine
              what type is expected for a particular preference path.
     """
     cmd_dict = {
       'command': 'SetPrefs',
       'path': path,
       'value': value,
     }
     self._GetResultFromJSONRequest(cmd_dict)
 
   def WaitForAllDownloadsToComplete(self, windex=0):

[Nirnimesh, 2011/03/29 20:27:28]

The WaitForAllDownloadsToComplete below has a default timeout param, so this
version might not be needed.

[Huyen, 2011/03/31 02:42:55]

Done.

+    self.WaitForAllDownloads(
+        self, windex=0, timeout=self.action_max_timeout_ms())
+
+  def WaitForAllDownloadsToComplete(self, windex=0, timeout=-1):
     """Wait for all downloads to complete.
 
     Note: This method does not work for dangerous downloads. Use
     WaitForGivenDownloadsToComplete (below) instead.
     """
+    if timeout == -1:  # Default

[Nirnimesh, 2011/03/29 20:27:28]

Why not just pass timeout ( = -1 ).
_GetResultFromJSONRequest will replace timeout=-1 with
timeout=action_max_timeout_ms() anyway

[Huyen, 2011/03/31 02:42:55]

Done.

+      timeout = self.action_max_timeout_ms()
     cmd_dict = {'command': 'WaitForAllDownloadsToComplete'}
-    self._GetResultFromJSONRequest(cmd_dict, windex=windex)
+    self._GetResultFromJSONRequest(cmd_dict, windex=windex, timeout=timeout)
 
   def WaitForDownloadToComplete(self, download_path, timeout=-1):
     """Wait for the given downloads to complete.
 
     This method works for dangerous downloads as well as regular downloads.
 
     Args:
       download_path: The path to the final download. This is only necessary for
                      the workaround described in the comments below and should
                      be removed when downloads are re-implemented.
@@ skipping 2009 matching lines @@
     if self._options.verbose:
       verbosity = 2
     result = PyAutoTextTestRuner(verbosity=verbosity).run(pyauto_suite)
     del loaded_tests  # Need to destroy test cases before the suite
     del pyauto_suite
     sys.exit(not result.wasSuccessful())
 
 
 if __name__ == '__main__':
   Main()