Upload files to devices in App Automate

App Automate provides preloaded media files on BrowserStack remote devices to test scenarios that require access to files from the device.

Apart from preloaded media files, you can also upload your media or non-media files in App Automate.

Use either of the following methods to upload your media or non-media files to BrowserStack remote devices:

• Use BrowserStack’s API and capability
• Use Appium’s push and pull file commands

Use BrowserStack’s API and capability

App Automate provides a REST API request and a capability to upload your files to BrowserStack’s remote devices and access them during testing.

In this section, you’ll learn:

• Which file types and OS versions are supported
• How to upload a file to BrowserStack
• How to set the capability in test script

Supported file types and OS version

The following tab list the supported file types you can upload, and the OS version on which you can upload the files.

Upload your file to BrowserStack

Run the following upload media cURL command to upload your file to BrowserStack servers:

  curl -u "username:accesskey" \
  -X POST "https://api-cloud.browserstack.com/app-automate/upload-media" \
  -F "file=@/path/to/your/file" \
  -F "custom_id=SampleFile"

A sample response for the given cURL command is as follows. It returns the value of the media_url parameter.

{
  "media_url": "media://90c7a8h8dc82308108734e9a46c24d8f01de12881",
  "custom_id": "SampleFile"
}

The file you uploaded will be available in the following folders on the device:

Set the capability in test script

Set the browserstack.uploadMedia capability to the value of the media_url parameter returned in the API response as shown in the following code snippets:

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.uploadMedia", new String[]{"media://90c7a8h8dc82308108734e9a46c24d8f01de12881"});

var capabilities = {
	'browserstack.uploadMedia': ['media://90c7a8h8dc82308108734e9a46c24d8f01de12881']
}

DesiredCapabilities capability = new DesiredCapabilities();
capability.SetCapability("browserstack.uploadMedia", new[] {"media://90c7a8h8dc82308108734e9a46c24d8f01de12881"});

$capabilities = new DesiredCapabilities();
$capabilities->setCapability("browserstack.uploadMedia", ["media://90c7a8h8dc82308108734e9a46c24d8f01de12881"]);

desired_cap = {
	'browserstack.uploadMedia': ['media://90c7a8h8dc82308108734e9a46c24d8f01de12881']
}

desired_caps = {
    'browserstack.uploadMedia': ['media://90c7a8h8dc82308108734e9a46c24d8f01de12881']
}

Appium’s push and pull file command

You can also upload files using Appium’s push and pull file command, which doesn’t use any BrowserStack capability or API to upload your files to BrowserStack remote devices during testing.

During testing, use Appium’s push file command to copy your files (media, data, text, etc.) to the device and the pull file command to retrieve the files from the device.

// Push a file
driver.pushFile("/sdcard/Download/image.jpg", new File("/Users/johndoe/Desktop/image.jpg"));

// Pull file
byte[] fileBase64 = driver.pullFile("/sdcard/Download/image.jpg");

// Push file webdriver.io example
let data = Buffer.from("Hello World").toString('base64');
driver.pushFile('/sdcard/Download/file.txt', data);

// Push file wd example
await driver.pushFileToDevice('/sdcard/Download/file.txt', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');

// Pull file webdriver.io example
let data = driver.pullFile('/sdcard/Download/file.txt');

// Pull file wd example
let data = await driver.pullFile('/sdcard/Download/file.txt');

// Push a file
driver.PushFile("/sdcard/Download/image.jpg", new FileInfo("/Users/johndoe/Desktop/image.jpg"))

// Pull file
byte[] fileBase64 = driver.PullFile("/sdcard/Download/image.jpg");

// Push a file
$driver->pushFile('/sdcard/Download/file.txt', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');

// Pull file
$data = $driver->pullFile('/sdcard/Download/file.txt');

# Push a file
dest_path = '/sdcard/Download/file.txt'
driver.push_file(dest_path, 'Hello World'.encode("utf-8"))

# Pull file
file_base64 = driver.pull_file(dest_path)

# Push a file
driver.push_file('/sdcard/Download/image.jpg', File.read('/Users/johndoe/Desktop/image.jpg'))

# Pull file
pull_file('/sdcard/Download/image.jpg')

// Push an image file
driver.pushFile("@com.browserstack.Sample-iOS:documents/image.jpg", new File("/Users/johndoe/Desktop/image.jpg"));

// Pull file
byte[] fileBase64 = driver.pullFile("@com.browserstack.Sample-iOS:documents/image.jpg");

// Push file webdriver.io example
let data = Buffer.from("Hello World").toString('base64');
driver.pushFile('@com.browserstack.Sample-iOS:documents/file.txt', data);

// Push file wd example
await driver.pushFileToDevice('@com.browserstack.Sample-iOS:documents/file.txt', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');

// Pull file webdriver.io example
let data = driver.pullFile('@com.browserstack.Sample-iOS:documents/file.txt');

// Pull file wd example
let data = await driver.pullFile('@com.browserstack.Sample-iOS:documents/file.txt');

// Push an image file
driver.PushFile("@com.browserstack.Sample-iOS:documents/image.jpg", new FileInfo("/Users/johndoe/Desktop/image.jpg"))

// Pull file
byte[] fileBase64 = driver.PullFile("@com.browserstack.Sample-iOS:documents/image.jpg");

$driver->pushFile('@com.browserstack.Sample-iOS:documents/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');

// Pull file
$data = $driver->pullFile('@com.browserstack.Sample-iOS:documents/foo.bar');

# Push an image file
driver.push_file('@com.browserstack.Sample-iOS:documents/image1.png', source_path='/Users/johndoe/Desktop/image1.png')

# Push a text file
dest_path = '@com.browserstack.Sample-iOS:documents/file.txt'
driver.push_file(dest_path, 'Hello World'.encode("utf-8"))

# Pull file
file_base64 = driver.pull_file(dest_path)

# Push an image file
driver.push_file('@com.browserstack.Sample-iOS:documents/image.jpg', File.read('/Users/johndoe/Desktop/image.jpg'))

# Pull file
pull_file('@com.browserstack.Sample-iOS:documents/image.jpg')

Need some help?

If you need any help with this feature, get in touch with us.