App AutomateTest specific scenariosTest app upgrades

Test app upgrade in Appium tests

Testing app upgrades is an important scenario since new versions of your apps are shipped to customers on a frequent basis. Users upgrade to the latest version of your app and not install it from scratch. In such cases, there might be existing user data that needs to be migrated for the app to work correctly. As a result, testing of app-upgrade is very important to ensure that the app works as expected even after the upgrade.

To test app upgrades, ensure that the upgraded app version has the same signatures and bundle ID as the application under test.

Before starting test execution, you first need to upload the app to be upgraded (newer version) using REST API similar to your app under test. The REST API response will return an app_url for each successful app upload. Use the app_url value (returned on uploading the app) to set the browserstack.midSessionInstallApps capability in your Appium test script.

Enable app upgrade test using a capability

BrowserStack SDK
Legacy Integration

If you are using BrowserStack SDK, you can set the following capability within the browserstack.yml file:

Capability	Description	Values
`midSessionInstallApps`	Set this capability if you want to install app(s) in between a test session. Upload your apps to BrowserStack servers using REST API. Use the `app_url` value returned as a result of the upload request to set this capability.	The app_url returned on successful upload. Example: `["bs://<hashed app-id>", "bs://<hashed app-id>"]`

Example:

```yml
midSessionInstallApps :
  - bs://<hashed app-id>
```
browserstack.yml

            Copy icon
            
        Copy
      
    midSessionInstallApps :
  - bs://<hashed app-id>

Capability	Description	Values
`browserstack.midSessionInstallApps`	Set this capability if you want to install app(s) in between a test session. Upload your apps to BrowserStack servers using REST API. Use the `app_url` value returned as a result of the upload request to set this capability.	The app_url returned on successful upload. Example: `["bs://<hashed app-id>", "bs://<hashed app-id>"]`

Test app upgrades

You can now make use of Appium’s install app command. It will allow you to install and launch the upgraded version of your app in between your Appium test session and continue with your test flow with this newer version of the app.

The detailed steps to achieve this are:

Upload the app version say v1.0 and set the app_url value (returned on uploading the app) in app capability. This will be the application under test(AUT) for your Appium test.

Now, upload the upgrade version of app (say v1.1). You need to set the app_url value (returned on uploading the app) in midSessionInstallApps capability in your test script prior to running the test as mentioned above.

If you are using the JSON Wire Protocol, make sure you set the app_url value in browserstack.midSessionInstallApps capability in your test script prior to running the test as mentioned above.

Start your Appium test execution.

In the middle of the test you can install and upgrade the app version using Appium’s install app command. You can launch the installed app using the Start Activity command.

// Use app_url value passed in the "browserstack.midSessionInstallApps" capability
driver.executeScript("mobile:installApp",ImmutableMap.of("appPath", "bs://<hashed app-id>"));

HashMap<String, String> startActivityArgs = new HashMap<>();
startActivityArgs.put("intent", "com.browserstack.sample.MainActivity");
startActivityArgs.put("package", "com.browserstack.sample");

driver.executeScript("mobile:startActivity", startActivityArgs);

Sample Android code snippet

The following code samples explain an app-upgrade test using Appium. A test begins with the app version v1.0 but later gets updated to v1.1 by installing the latest version through the app_url.

W3C Protocol
JSON Wire Protocol

package android;

import io.appium.java_client.MobileBy;
import io.appium.java_client.android.Activity;
import io.appium.java_client.android.AndroidDriver;
import java.io.IOException;
import java.net.URL;

import org.junit.Test;
import org.openqa.selenium.By;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;


public class AppUpgradeBS {
    
    private String APP_PKG = "com.browserstack.sample";
    private String APP_ACT = "com.browserstack.sample.MainActivity";
    
    @Test
    public void testAppUpgrade () throws IOException {

        DesiredCapabilities capabilities = new DesiredCapabilities();
        HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
        // Set your access credentials
        capabilities.setCapability("bstack:options", browserstackOptions);
        capabilities.setCapability("platformName", "android");
        capabilities.setCapability("platformVersion", "9.0");
        capabilities.setCapability("deviceName", "Google Pixel 3");

        // Set app_url of the application under test(AUT) which is version v1.0 of app
        capabilities.setCapability("app", "bs://<hashed app-id>");
        
        // Set app_url obtained after uploading the upgrade version v1.1 of app
        browserstackOptions.put("midSessionInstallApps", new String[]{"bs://<hashed app-id>"});

        AndroidDriver driver = new AndroidDriver(new URL("https://hub.browserstack.com/wd/hub"), capabilities);
        WebDriverWait wait = new WebDriverWait(driver, 10);

        try {

            //Your test goes with v1.0 goes here
            // Close the app under test
            driver.terminateApp(APP_PKG);
            driver.executeScript("mobile:terminateApp",ImmutableMap.of("appId", APP_PKG));

            // Install the upgrade version of the app
            // Specify the app_url of the upgrade version(v1.1) of the app that was passed in "browserstack.midSessionInstallApps" capability

            driver.executeScript("mobile:installApp",ImmutableMap.of("appPath", "bs://<hashed app-id>"));

            // Launch the app using the package and launcher activity of the app
            HashMap<String, String> startActivityArgs = new HashMap<>();
            startActivityArgs.put("intent", APP_ACT);
            startActivityArgs.put("package", APP_PKG);

            driver.executeScript("mobile:startActivity", startActivityArgs);
            //Your test with upgrade version v1.1 goes


        } finally {
            driver.quit();
        }
    }
}

In case of Android, you can also pass publicly accessible URL as a value in the driver.installApp command. The public URL should have a downloadable Android app (.apk/.aab) file.

For JSONwire browserstack.midSessionInstallApps and W3C midSessionInstallApps capabilities can also be used to install any other app in between the test session.

Sample iOS code snippet

```csharp
public class BrowserStackSample {

  public static void main(String[] args)
      throws MalformedURLException, InterruptedException {
    DesiredCapabilities caps = new DesiredCapabilities();
    HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();

    // Passing browserstack capabilities inside bstack:options
    caps.setCapability("bstack:options", browserstackOptions);

    // Set URL of the application under test
    caps.setCapability("app", "bs://your_initial_app_url");
    browserstackOptions.put("midSessionInstallApps", new String[] { "bs://your_upgraded_app_url" });

    // Specify device and os_version for testing
    caps.setCapability("deviceName", "iPhone 14");
    caps.setCapability("platformName", "ios");
    caps.setCapability("platformVersion", "16");

    IOSDriver driver = new IOSDriver(new URL("http://hub.browserstack.com/wd/hub"), caps);

    driver.terminateApp("bundleID");
    driver.installApp("bs://your_upgraded_app_url");
    driver.activateApp("bundleID");
    driver.quit();
  }
```
iOS Code Snippet

      
      
    

        
            Copy icon
            
          
        Copy
      
    public class BrowserStackSample {
  public static void main(String[] args)
      throws MalformedURLException, InterruptedException {
    DesiredCapabilities caps = new DesiredCapabilities();
    HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
    // Passing browserstack capabilities inside bstack:options
    caps.setCapability("bstack:options", browserstackOptions);
    // Set URL of the application under test
    caps.setCapability("app", "bs://your_initial_app_url");
    browserstackOptions.put("midSessionInstallApps", new String[] { "bs://your_upgraded_app_url" });
    // Specify device and os_version for testing
    caps.setCapability("deviceName", "iPhone 14");
    caps.setCapability("platformName", "ios");
    caps.setCapability("platformVersion", "16");
    IOSDriver driver = new IOSDriver(new URL("http://hub.browserstack.com/wd/hub"), caps);
    driver.terminateApp("bundleID");
    driver.installApp("bs://your_upgraded_app_url");
    driver.activateApp("bundleID");
    driver.quit();
  }

  

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!