Automate TurboscaleTest workflowsFile download

Testing file download

Learn how to test the file download functionality using Automate TurboScale.

BrowserStack enhances your selenium testing suite by offering features to streamline file download interactions within web applications. These features are especially useful when testing scenarios like invoice generation, PDF downloads, and other file-centric workflows.

This feature is supported only for tests running with the Selenium framework.

Download files on Browserstack remote instances

To download files on BrowserStack’s remote instances, integrate the custom browserstack_executor script into your Automate TurboScale sessions. The following sample code illustrates its use in selenium:

      
      selenium 4 W3C
    

      Java
    

      Node.js
    

      C#
    

      Python
    

      Ruby
    
import org.openqa.selenium.By;
import org.openqa.selenium.Platform;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.firefox.FirefoxProfile;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;

import java.net.URL;

public class JavaSample {

  public static final String BROWSERSTACK_USERNAME = "YOUR_USERNAME";
  public static final String BROWSERSTACK_ACCESS_KEY = "YOUR_ACCESS_KEY";
  public static final String URL = "https://" + BROWSERSTACK_USERNAME + ":" + BROWSERSTACK_ACCESS_KEY + "@hub-cloud.browserstack-ats.com/wd/hub";

  public static void main(String[] args) throws Exception {
    FirefoxProfile profile = new FirefoxProfile();
    profile.setPreference("browser.download.folderList", 1);
    profile.setPreference("browser.download.manager.showWhenStarting", false);
    profile.setPreference("browser.download.manager.focusWhenStarting", false);
    profile.setPreference("browser.download.useDownloadDir", true);
    profile.setPreference("browser.helperApps.alwaysAsk.force", false);
    profile.setPreference("browser.download.manager.alertOnEXEOpen", false);
    profile.setPreference("browser.download.manager.closeWhenDone", true);
    profile.setPreference("browser.download.manager.showAlertOnComplete", false);
    profile.setPreference("browser.download.manager.useWindow", false);
    // You will need to find the content-type of your app and set it here.
    profile.setPreference("browser.helperApps.neverAsk.saveToDisk", "application/octet-stream");

    DesiredCapabilities capabilities = new DesiredCapabilities();
    capabilities.setCapability("browserName", "Firefox");
    capabilities.setCapability("browserVersion", "latest");
    HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
    browserstackOptions.put("os", "Windows");
    browserstackOptions.put("osVersion", "10");
    capabilities.setCapability("bstack:options", browserstackOptions);

    WebDriver driver = new RemoteWebDriver(new URL(URL), caps);
    JavascriptExecutor jse = (JavascriptExecutor) driver;

    driver.get("https://www.browserstack.com/test-on-the-right-mobile-devices");
    Thread.sleep(2000);
    driver.findElement(By.id("accept-cookie-notification")).click();

    // Find element by class name and store in variable "Element"
    WebElement Element = driver.findElement(By.className("icon-csv"));

    // This will scroll the page till the element is found
    jse.executeScript("arguments[0].scrollIntoView();", Element);
    jse.executeScript("window.scrollBy(0,-100)");
    Thread.sleep(1000);

    // Click on the element to download the file
    Element.click();
    Thread.sleep(2000);

    driver.quit();
  }
}
const {
  Builder,
  By,
  Key,
  until
} = require('selenium-webdriver');
const fs = require("fs");
const webdriver = require('selenium-webdriver');
const bb = require('bluebird');
var sleep = require('sleep');
var FirefoxProfile = require('firefox-profile');
var profile = new FirefoxProfile();

profile.setPreference('browser.download.folderList', 1);
profile.setPreference('browser.download.manager.showWhenStarting', false);
profile.setPreference('browser.download.manager.focusWhenStarting', false);
profile.setPreference('browser.download.useDownloadDir', true);
profile.setPreference('browser.helperApps.alwaysAsk.force', false);
profile.setPreference('browser.download.manager.alertOnEXEOpen', false);
profile.setPreference('browser.download.manager.closeWhenDone', true);
profile.setPreference('browser.download.manager.showAlertOnComplete', false);
profile.setPreference('browser.download.manager.useWindow', false);
// You will need the content-type of your app from developer tools on your browser and set it here. We are downloading a csv file.
profile.setPreference('browser.helperApps.neverAsk.saveToDisk', 'application/octet-stream');
profile.updatePreferences();
profile.encode((err, encoded) => {

  var capabilities = {
    'bstack:options' : {
      "os" : "Windows",
      "osVersion" : "10",
      "userName" : "YOUR_USERNAME",
      "accessKey" : "YOUR_ACCESS_KEY",
    },
    "browserName" : "Firefox",
    "browserVersion" : "latest",
  }

  var driver = new webdriver.Builder()
    .usingServer('https://hub-ft.browserstack.com/wd/hub')
    .withCapabilities(capabilities)
    .build();
  // Navigate to the link
  driver.get('https://www.browserstack.com/test-on-the-right-mobile-devices').then(function() {

    // Find element by class name and store in variable "element"             
    driver.findElement(By.className('icon-csv')).then(function(element) {

      // This will scroll the page till the element is found   
      driver.executeScript('arguments[0].scrollIntoView();', element).then(function() {
        driver.executeScript('window.scrollBy(0,-200)').then(function() {

          // Accept the cookie popup
          driver.findElement(By.id("accept-cookie-notification")).click().then(function() {

            // Click on the element to download the file
            element.click().then(function() {
              bb.delay(5000).then(function() {
                driver.quit();
              });
            });
          });
        });
      });
    });
  });
});
// Applies to selenium W3C protocol versions
using System.Collections.Generic;
using System.Threading;
using OpenQA.selenium.Firefox;
using OpenQA.selenium.Remote;
using OpenQA.selenium;
using System.IO;
using System;
using System.Text;

namespace seleniumTest
{
    class Program
    {
        public static void Main(string[] args)
        {

            FirefoxProfile firefoxProfile = new FirefoxProfile();
            firefoxProfile.SetPreference("browser.download.showWhenStarting", false);
            firefoxProfile.SetPreference("browser.download.folderList", 1);
            firefoxProfile.SetPreference("browser.download.manager.focusWhenStarting", false);
            firefoxProfile.SetPreference("browser.download.useDownloadDir", true);
            firefoxProfile.SetPreference("browser.helperApps.alwaysAsk.force", false);
            firefoxProfile.SetPreference("browser.download.manager.alertOnEXEOpen", false);
            firefoxProfile.SetPreference("browser.download.manager.closeWhenDone", true);
            firefoxProfile.SetPreference("browser.download.manager.showAlertOnComplete", false);
            firefoxProfile.SetPreference("browser.download.manager.useWindow", false);
            firefoxProfile.SetPreference("browser.helperApps.neverAsk.saveToDisk", "application/octet-stream");

            FirefoxOptions capabilities = new FirefoxOptions();
            capabilities.BrowserVersion = "latest";
            Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
            browserstackOptions.Add("os", "Windows");
            browserstackOptions.Add("osVersion", "10");
            browserstackOptions.Add("buildName", "selenium C# Firefox Profile");
            browserstackOptions.Add("userName", "YOUR_USERNAME");
            browserstackOptions.Add("accessKey", "YOUR_ACCESS_KEY");
            browserstackOptions.Add("browserName", "Firefox");
            capabilities.AddAdditionalOption("bstack:options", browserstackOptions);
            capabilities.Profile = firefoxProfile;

            RemoteWebDriver driver = new RemoteWebDriver(
              new Uri("https://hub-ft.browserstack.com/wd/hub"), capabilities
            );

            // Navigate to the link
            driver.Navigate().GoToUrl("https://www.browserstack.com/test-on-the-right-mobile-devices");
            IJavaScriptExecutor jse = (IJavaScriptExecutor)driver;

            Thread.Sleep(2000);

            // This will scroll the page till the element is found
            driver.ExecuteScript("arguments[0].scrollIntoView();", driver.FindElementByClassName("icon-csv"));
            driver.ExecuteScript("window.scrollBy(0,-100)");
            Thread.Sleep(2000);

            // Find element by class name and then click"             
            driver.FindElementByClassName("icon-csv").Click();
            Thread.Sleep(1000);
            driver.ExecuteScript("browserstack_executor: {\"action\": \"fileExists\"}");
            driver.ExecuteScript("browserstack_executor: {\"action\": \"getFileProperties\"}");
            driver.Quit();
        }
    }
}
from selenium import webdriver
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
import time
profile = webdriver.FirefoxProfile()
profile.set_preference('browser.download.folderList', 1)
profile.set_preference('browser.download.manager.showWhenStarting', False)
profile.set_preference('browser.download.manager.focusWhenStarting', False)
profile.set_preference('browser.download.useDownloadDir', True)
profile.set_preference('browser.helperApps.alwaysAsk.force', False)
profile.set_preference('browser.download.manager.alertOnEXEOpen', False)
profile.set_preference('browser.download.manager.closeWhenDone', True)
profile.set_preference('browser.download.manager.showAlertOnComplete', False)
profile.set_preference('browser.download.manager.useWindow', False)
# You will need to find the content-type of your app and set it here. We are downloading a gzip file.
profile.set_preference('browser.helperApps.neverAsk.saveToDisk', 'application/octet-stream')
profile.update_preferences()

desired_cap = {
	'bstack:options' : {
		"os" : "Windows",
		"osVersion" : "10",
	},
	"browserName" : "Firefox",
	"browserVersion" : "latest",
}

options.set_capability('bstack:options', desired_cap)
driver = webdriver.Remote(
    command_executor='https://hub-ft.browserstack.com/wd/hub',
    options=options)
# Navigate to the link
driver.get("https://www.browserstack.com/test-on-the-right-mobile-devices")

# Accept the cookie popup
test=driver.find_element_by_id("accept-cookie-notification").click()
time.sleep(2)

# Find element by class name and store in variable "element"
element = driver.find_element_by_class_name("icon-csv")
driver.execute_script("arguments[0].scrollIntoView();", element)
driver.execute_script("window.scrollBy(0,-100)")
time.sleep(2)

# Click on the element to download the file
clicked = element.click()
time.sleep(2)
driver.quit()
require 'rubygems'
require 'selenium-webdriver'

# Input capabilities
profile = selenium::WebDriver::Firefox::Profile.new
profile['browser.download.folderList'] = 1
profile['browser.download.manager.showWhenStarting'] = false
profile['browser.download.manager.focusWhenStarting'] = false
profile['browser.download.useDownloadDir'] = true
profile['browser.helperApps.alwaysAsk.force'] = false
profile['browser.download.manager.alertOnEXEOpen'] = false
profile['browser.download.manager.closeWhenDone'] = true
profile['browser.download.manager.showAlertOnComplete'] = false
profile['browser.download.manager.useWindow'] = false
# You will need to find the content-type of your app and set it here.
profile['browser.helperApps.neverAsk.saveToDisk'] = "application/octet-stream"

capabilities = {
	'bstack:options' => {
		"os" => "Windows",
		"osVersion" => "10",
	},
	"browserName" => "Firefox",
	"browserVersion" => "latest",
}

driver = selenium::WebDriver.for(
    :remote,
    :url => "https://YOUR_USERNAME:YOUR_ACCESS_KEY@hub-cloud.browserstack.com/wd/hub",
    :capabilities => capabilities
)
driver.navigate.to "https://rubygems.org/gems/selenium-webdriver"
driver.find_element(:id => 'download').click
driver.quit

Work with the downloaded file

BrowserStack provides a range of JavaScript executors to help you work with downloaded files. Use the following tabs to learn about different Javascript executors:

Protip: Any of the custom Javascript executors will work even if fileName argument is not passed. The results will be for the last downloaded file in the session.

System.out.println(jse.executeScript("browserstack_executor: {\"action\": \"fileExists\", \"arguments\": {\"fileName\": \"<file name>\"}}"));

The fileExists function within the browserstack_executor script returns a boolean value as a response.

Use the above code snippets to verify whether a specific file was downloaded.

Protip: The following snippet verifies whether the last file was downloaded in the test session.

System.out.println(jse.executeScript("browserstack_executor: {\"action\": \"fileExists\"}"));

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!