[java] download file to disk without string return

Author: titusfortner

java/src/org/openqa/selenium/HasDownloads.java

@@ -48,20 +48,13 @@ default void requireDownloadsEnabled(Capabilities capabilities) {
   List<String> getDownloadableFiles();
 
   /**
-   * Downloads a file with the given file name.
+   * Downloads a file to a given location.
    *
    * @param fileName the name of the file to be downloaded
-   * @return a String representing a base64 encoded zip file
+   * @param targetLocation the location where the file will be downloaded to
+   * @throws IOException if an I/O error occurs while downloading the file
    */
-  String downloadFile(String fileName);
-
-  /**
-   * Downloads a file to a given location.
-   *
-   * @param  fileName          the name of the file to be downloaded
-   * @param  downloadLocation  the location where the file will be downloaded to
-   * @throws IOException       if an I/O error occurs while downloading the file
-   */void downloadFile(String fileName, Path downloadLocation) throws IOException;
+  void downloadFile(String fileName, Path targetLocation) throws IOException;
 
   /** Deletes the downloadable files. */
   void deleteDownloadableFiles();

java/src/org/openqa/selenium/remote/RemoteWebDriver.java

@@ -722,36 +722,27 @@ public void removeVirtualAuthenticator(VirtualAuthenticator authenticator) {
   @SuppressWarnings("unchecked")
   public List<String> getDownloadableFiles() {
     requireDownloadsEnabled(capabilities);
+
     Response response = execute(DriverCommand.GET_DOWNLOADABLE_FILES);
     Map<String, List<String>> value = (Map<String, List<String>>) response.getValue();
     return value.get("names");
   }
 
-  /**
-   * Downloads a file with the specified file name.
-   *
-   * @param fileName the name of the file to be downloaded
-   * @return string representation of the Base64 zipped content
-   * @throws WebDriverException if capability to enable downloads is not set
-   */
-  @Override
-  @SuppressWarnings("unchecked")
-  public String downloadFile(String fileName) {
-    requireDownloadsEnabled(capabilities);
-    Response response = execute(DriverCommand.DOWNLOAD_FILE, Map.of("name", fileName));
-    return ((Map<String, String>) response.getValue()).get("contents");
-  }
-
   /**
    * Downloads a file from the specified location.
    *
    * @param fileName the name of the file to download
-   * @param downloadLocation the location where the file should be downloaded
+   * @param targetLocation the location where the file should be downloaded
    * @throws IOException if an I/O error occurs during the file download
    */
+  @SuppressWarnings("unchecked")
   @Override
-  public void downloadFile(String fileName, Path downloadLocation) throws IOException {
-    Zip.unzip(downloadFile(fileName), downloadLocation.toFile());
+  public void downloadFile(String fileName, Path targetLocation) throws IOException {
+    requireDownloadsEnabled(capabilities);
+
+    Response response = execute(DriverCommand.DOWNLOAD_FILE, Map.of("name", fileName));
+    String contents = ((Map<String, String>) response.getValue()).get("contents");
+    Zip.unzip(contents, targetLocation.toFile());
   }
 
   /**
@@ -762,6 +753,7 @@ public void downloadFile(String fileName, Path downloadLocation) throws IOExcept
   @Override
   public void deleteDownloadableFiles() {
     requireDownloadsEnabled(capabilities);
+
     execute(DriverCommand.DELETE_DOWNLOADABLE_FILES);
   }
 

java/test/org/openqa/selenium/grid/router/RemoteWebDriverDownloadTest.java

@@ -21,23 +21,17 @@
 import static org.openqa.selenium.testing.drivers.Browser.IE;
 import static org.openqa.selenium.testing.drivers.Browser.SAFARI;
 
-import java.io.BufferedReader;
-import java.io.ByteArrayInputStream;
 import java.io.IOException;
-import java.io.InputStreamReader;
 import java.io.StringReader;
 import java.net.URL;
-import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.time.Duration;
-import java.util.Base64;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
-import java.util.zip.ZipInputStream;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -138,40 +132,15 @@ void canDownloadFiles() throws IOException {
 
     String fileName = ((HasDownloads) driver).getDownloadableFiles().get(0);
 
-    Path downloadLocation = Files.createTempDirectory("download");
-    ((HasDownloads) driver).downloadFile(fileName, downloadLocation);
+    Path targetLocation = Files.createTempDirectory("download");
+    ((HasDownloads) driver).downloadFile(fileName, targetLocation);
 
-    String fileContent = String.join("", Files.readAllLines(downloadLocation.resolve(fileName)));
+    String fileContent = String.join("", Files.readAllLines(targetLocation.resolve(fileName)));
     assertThat(fileContent).isEqualTo("Hello, World!");
 
     driver.quit();
   }
 
-  @Test
-  void canUseDownloadedContent() throws IOException {
-    URL gridUrl = server.getUrl();
-    WebDriver driver = new RemoteWebDriver(gridUrl, capabilities);
-    driver = new Augmenter().augment(driver);
-
-    driver.get(appServer.whereIs("downloads/download.html"));
-    driver.findElement(By.id("file-1")).click();
-
-    new WebDriverWait(driver, Duration.ofSeconds(5))
-        .until(d -> !((HasDownloads) d).getDownloadableFiles().isEmpty());
-
-    String fileName = ((HasDownloads) driver).getDownloadableFiles().get(0);
-
-    String base64Zip = ((HasDownloads) driver).downloadFile(fileName);
-    byte[] decodedBytes = Base64.getDecoder().decode(base64Zip);
-    ByteArrayInputStream bais = new ByteArrayInputStream(decodedBytes);
-    try (ZipInputStream zis = new ZipInputStream(bais)) {
-      zis.getNextEntry();
-      BufferedReader reader =
-          new BufferedReader(new InputStreamReader(zis, StandardCharsets.UTF_8));
-      assertThat(reader.readLine()).isEqualTo("Hello, World!");
-    }
-  }
-
   @Test
   @Ignore(IE)
   @Ignore(SAFARI)