[chromedriver] setting browser default download directory

chrome/test/chromedriver/client/run_py_tests.py

 #!/usr/bin/env python
 # Copyright 2013 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.
 
 """End to end tests for ChromeDriver."""
 
 import base64
 import json
 import math
@@ skipping 122 matching lines @@
         'ChromeDriverTest.testSwitchToWindow',
         'ChromeDriverTest.testShouldHandleNewWindowLoadingProperly',
     ]
 )
 _ANDROID_NEGATIVE_FILTER['chromedriver_webview_shell'] = (
     _ANDROID_NEGATIVE_FILTER['chrome_shell'])
 
 
 class ChromeDriverBaseTest(unittest.TestCase):
   """Base class for testing chromedriver functionalities."""
-
+  
+  download_dir = tempfile.mkdtemp(dir='/tmp')

[samuong, 2014/10/01 20:22:12]

This is going to be used by all tests, which is not necessary.

Could you create a subclass class of ChromeDriverBaseTest (maybe call it
ChromeDriverDownloadTest?) which contains just the testFileDownload() test, and
only set the download_dir for that class?

[andrewcheng, 2014/10/08 22:08:26]

def setUp(self):
    if self._testMethodName == 'testFileDownLoad':
       self.download_dir = tempfile.mkdtemp(dir='/tmp')
    else:
       self.download_dir =  None

Done.

+  
   def __init__(self, *args, **kwargs):
     super(ChromeDriverBaseTest, self).__init__(*args, **kwargs)
     self._drivers = []
 
   def tearDown(self):
     for driver in self._drivers:
       try:
         driver.Quit()
       except:
         pass
 
   def CreateDriver(self, server_url=None, **kwargs):
     if server_url is None:
       server_url = _CHROMEDRIVER_SERVER_URL
 
     android_package = None
     android_activity = None
     android_process = None
     if _ANDROID_PACKAGE_KEY:
       android_package = constants.PACKAGE_INFO[_ANDROID_PACKAGE_KEY].package
       if _ANDROID_PACKAGE_KEY == 'chromedriver_webview_shell':
         android_activity = constants.PACKAGE_INFO[_ANDROID_PACKAGE_KEY].activity
         android_process = '%s:main' % android_package
 
-    driver = chromedriver.ChromeDriver(server_url,
+    driver = chromedriver.ChromeDriver(server_url, self.download_dir, 
                                        chrome_binary=_CHROME_BINARY,
                                        android_package=android_package,
                                        android_activity=android_activity,
                                        android_process=android_process,
                                        **kwargs)
     self._drivers += [driver]
     return driver
 
 
 class ChromeDriverTest(ChromeDriverBaseTest):
   """End to end tests for ChromeDriver."""
-
+  
   @staticmethod
   def GlobalSetUp():
     ChromeDriverTest._http_server = webserver.WebServer(
         chrome_paths.GetTestData())
     ChromeDriverTest._sync_server = webserver.SyncWebServer()
     if _ANDROID_PACKAGE_KEY:
       ChromeDriverTest._device = device_utils.DeviceUtils(
           android_commands.GetAttachedDevices()[0])
       http_host_port = ChromeDriverTest._http_server._server.server_port
       sync_host_port = ChromeDriverTest._sync_server._server.server_port
@@ skipping 10 matching lines @@
   @staticmethod
   def GetHttpUrlForFile(file_path):
     return ChromeDriverTest._http_server.GetUrl() + file_path
 
   def setUp(self):
     self._driver = self.CreateDriver()
 
   def testStartStop(self):
     pass
 
+  def testFileDownLoad(self):
+    self._driver.Load(self.GetHttpUrlForFile('/chromedriver/download.html'))

[samuong, 2014/10/01 20:22:12]

Before clicking, please also add a check that ensures that the file is *not* in
the download directory.

[andrewcheng, 2014/10/08 22:08:26]

Done.

[andrewcheng, 2014/10/08 22:08:26]

   This is a random generated dir - very unlikely,  a download dir will  exist. 
However, we can put a check as following, in case it does exist

    self.assertFalse(os.path.isfile(download_name), 
             "Test user prefer download directory failed! - download file
already exist")

+    self._driver.FindElement('id', 'red-dot').Click()
+    time.sleep(0.5)

[samuong, 2014/10/01 20:22:13]

I'm a bit worried that this is going to be flaky, and also this test will always
take >0.5 seconds. Could you change this to a loop (with a timeout) that waits
until the file exists?

[andrewcheng, 2014/10/08 22:08:26]

    download_name = ChromeDriverBaseTest.download_dir + "/a_red_dot.png";
    timeout = time.time() + 60*1   # 1 minutes from now
    while True:
       time.sleep(0.1)
       if os.path.isfile(download_name) or time.time() > timeout:
             break
    #
    self.assertTrue(os.path.isfile(download_name), 
                    "Test user prefer download di rectory failed!")
Done.

+    download_name = ChromeDriverBaseTest.download_dir+"/a_red_dot.png";

[samuong, 2014/10/01 20:22:12]

minor style nit: please put spaces around the +

We try to follow the Google Python Style Guide
(http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Whitespace) with
a few exceptions (http://www.chromium.org/chromium-os/python-style-guidelines).

[andrewcheng, 2014/10/08 22:08:26]

Done.

+    self.assertTrue(os.path.isfile(download_name), "Test user prefer download directory failed!")

[samuong, 2014/10/01 20:22:12]

Another style nit: please keep lines within 80 characters. The style guide sets
a maximum width of 80 characters and there are presubmits which will block the
commit if code exceeds this.

[andrewcheng, 2014/10/08 22:08:26]

Done.

+    os.remove(download_name)
+    os.removedirs(ChromeDriverBaseTest.download_dir)    

[samuong, 2014/10/01 20:22:12]

If we add another test that uses the download directory, and it runs after this
test, it will fail because the directory does not exist. Please move this into
the tearDown() function (and call tempfile.mkdtemp() in the setUp() function).

[andrewcheng, 2014/10/08 22:08:26]

Done.

 

  def tearDown(self):
    try:
       if self.download_dir:
          os.removedirs(self.download_dir)
          self.download_dir = None

+        
   def testLoadUrl(self):
     self._driver.Load(self.GetHttpUrlForFile('/chromedriver/empty.html'))
 
   def testGetCurrentWindowHandle(self):
     self._driver.GetCurrentWindowHandle()
 
   def _WaitForNewWindow(self, old_handles):
     """Wait for at least one new window to show up in 20 seconds.
 
     Args:
@@ skipping 950 matching lines @@
 
   all_tests_suite = unittest.defaultTestLoader.loadTestsFromModule(
       sys.modules[__name__])
   tests = unittest_util.FilterTestSuite(all_tests_suite, options.filter)
   ChromeDriverTest.GlobalSetUp()
   MobileEmulationCapabilityTest.GlobalSetUp()
   result = unittest.TextTestRunner(stream=sys.stdout, verbosity=2).run(tests)
   ChromeDriverTest.GlobalTearDown()
   MobileEmulationCapabilityTest.GlobalTearDown()
   sys.exit(len(result.failures) + len(result.errors))