Fix for flakiness in pyauto automation hook WaitForDownloadsToComplete.

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 1028 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=-1)
 
-  def WaitForAllDownloadsToComplete(self, windex=0, timeout=-1):
-    """Wait for all downloads to complete.
+  def WaitForAllDownloadsToComplete(self, pre_download_ids, windex=0,

[Nirnimesh, 2011/08/08 17:26:17]

pre_download_ids should default to [] so that most callers need not worry with
it.

[dennis_jeffrey, 2011/08/08 22:29:51]

Great idea.

+                                    timeout=-1):
+    """Wait for all pending downloads to complete.
 
-    Note: This method does not work for dangerous downloads. Use
-    WaitForGivenDownloadsToComplete (below) instead.
-    """
-    cmd_dict = {'command': 'WaitForAllDownloadsToComplete'}
-    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.
+    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:
-      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.
-      timeout: The timeout to use - default is WaitUntil's default timeout.
+      pre_download_ids: A list of numbers representing the IDs of downloads that
+                        exist *before* downloads to wait for have been
+                        triggered.  Use GetDownloadsInfo() to get these IDs.
+      windex: The window index, defaults to 0 (the first window).
+      timeout: The maximum amount of time (in milliseconds) to wait for
+               downloads to complete.
     """
-    # TODO(alyssad): Remove this wait when downloads are re-implemented in a
-    # testable way.
-    self.WaitUntil(lambda path: os.path.exists(path), timeout=timeout,
-                   args=[download_path])
+    cmd_dict = {
+      'command': 'WaitForAllDownloadsToComplete',
+      'pre_download_ids': pre_download_ids,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=windex, timeout=timeout)
 
   def PerformActionOnDownload(self, id, action, window_index=0):
     """Perform the given action on the download with the given id.
 
     Args:
       id: The id of the download.
       action: The action to perform on the download.
               Possible actions:
                 'open': Opens the download (waits until it has completed first).
                 'toggle_open_files_like_this': Toggles the 'Always Open Files
@@ skipping 3112 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()