[py] download file do not return a string

Author: titusfortner

py/selenium/webdriver/remote/remote_connection.py

@@ -59,7 +59,6 @@
     Command.CLEAR_ELEMENT: ("POST", "/session/$sessionId/element/$id/clear"),
     Command.GET_ELEMENT_TEXT: ("GET", "/session/$sessionId/element/$id/text"),
     Command.SEND_KEYS_TO_ELEMENT: ("POST", "/session/$sessionId/element/$id/value"),
-    Command.UPLOAD_FILE: ("POST", "/session/$sessionId/se/file"),
     Command.GET_ELEMENT_TAG_NAME: ("GET", "/session/$sessionId/element/$id/name"),
     Command.IS_ELEMENT_SELECTED: ("GET", "/session/$sessionId/element/$id/selected"),
     Command.IS_ELEMENT_ENABLED: ("GET", "/session/$sessionId/element/$id/enabled"),
@@ -122,6 +121,7 @@
         "/session/$sessionId/webauthn/authenticator/$authenticatorId/credentials",
     ),
     Command.SET_USER_VERIFIED: ("POST", "/session/$sessionId/webauthn/authenticator/$authenticatorId/uv"),
+    Command.UPLOAD_FILE: ("POST", "/session/$sessionId/se/file"),
     Command.GET_DOWNLOADABLE_FILES: ("GET", "/session/$sessionId/se/files"),
     Command.DOWNLOAD_FILE: ("POST", "/session/$sessionId/se/files"),
     Command.DELETE_DOWNLOADABLE_FILES: ("DELETE", "/session/$sessionId/se/files"),

py/selenium/webdriver/remote/webdriver.py

@@ -15,8 +15,10 @@
 # specific language governing permissions and limitations
 # under the License.
 """The WebDriver implementation."""
+import base64
 import contextlib
 import copy
+import os
 import pkgutil
 import types
 import typing
@@ -1136,14 +1138,22 @@ def set_user_verified(self, verified: bool) -> None:
     def get_downloadable_files(self) -> dict:
         """Retrieves the downloadable files as a map of file names and their
         corresponding URLs."""
-        return self.execute(Command.GET_DOWNLOADABLE_FILES)["value"]
+        return self.execute(Command.GET_DOWNLOADABLE_FILES)["value"]["names"]
 
-    def download_file(self, file_name: str) -> str:
-        """Downloads a file with the specified file name.
+    def download_file(self, file_name: str, target_directory: str) -> None:
+        """Downloads a file with the specified file name to the target directory
 
         file_name: The name of the file to download.
+        target_directory: The path to the directory to save the downloaded file.
         """
-        return self.execute(Command.DOWNLOAD_FILE, {"name": file_name})["value"]
+        if not os.path.exists(target_directory):
+            os.makedirs(target_directory)
+
+        contents = self.execute(Command.DOWNLOAD_FILE, {"name": file_name})["value"]["contents"]
+
+        target_file = os.path.join(target_directory, file_name)
+        with open(target_file, "wb") as file:
+            file.write(base64.b64decode(contents))
 
     def delete_downloadable_files(self) -> None:
         """Deletes all downloadable files."""

py/test/selenium/webdriver/remote/remote_downloads_tests.py

@@ -14,47 +14,43 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-import base64
-import io
-import zipfile
-from time import sleep
-
-import pytest
+import os
+import tempfile
 
 from selenium.webdriver.common.by import By
+from selenium.webdriver.support.wait import WebDriverWait
 
 
 def test_get_downloadable_files(driver, pages):
     pages.load("downloads/download.html")
     driver.find_element(By.ID, "file-1").click()
     driver.find_element(By.ID, "file-2").click()
-    sleep(3)
+    WebDriverWait(driver, 3).until(lambda d: len(d.get_downloadable_files()) == 2)
+
+    file_names = driver.get_downloadable_files()
 
-    file_names = driver.get_downloadable_files()["names"]
     assert "file_1.txt" in file_names
     assert "file_2.jpg" in file_names
 
 
 def test_download_file(driver, pages):
     pages.load("downloads/download.html")
     driver.find_element(By.ID, "file-1").click()
-    sleep(3)
+    WebDriverWait(driver, 3).until(lambda d: d.get_downloadable_files())
 
-    file_contents = driver.download_file("file_1.txt")["contents"]
-    file_byte_data = base64.b64decode(file_contents)
-    zip_memory = io.BytesIO(file_byte_data)
+    file_name = driver.get_downloadable_files()[0]
+    with tempfile.TemporaryDirectory() as target_directory:
+        driver.download_file(file_name, target_directory)
 
-    with zipfile.ZipFile(zip_memory, "r") as zip_ref:
-        for name in zip_ref.namelist():
-            with zip_ref.open(name) as file:
-                file_content = file.read()
-                assert "Hello, World!" in file_content.decode("utf-8")
+        target_file = os.path.join(target_directory, file_name)
+        with open(target_file, "r") as file:
+            assert "Hello, World!" in file.read()
 
 
 def test_delete_downloadable_files(driver, pages):
     pages.load("downloads/download.html")
     driver.find_element(By.ID, "file-1").click()
-    sleep(3)
+    WebDriverWait(driver, 3).until(lambda d: d.get_downloadable_files())
 
     driver.delete_downloadable_files()
-    assert not driver.get_downloadable_files()["names"]
+    assert not driver.get_downloadable_files()