Appium integration

The integration with Appium enables you to run Appium scripts utilizing the features of OpenText Functional Testing Lab.

In this topic:

• Prepare your environment
• Prepare your Appium test
• Appium script execution
• Use Appium with SSL
• Appium setup code snippets
• Common Appium API calls
• Report test status to the lab
• Retrieve Appium logs
• Parallel tests

Prepare your environment

To prepare your environment to run an automated Appium test, you need to configure your working environment such as Visual Studio or Eclipse to recognize the Appium project.

Visual Studio

To set up your Visual Studio environment with Appium, follow these steps:

1. Create a new Unit Test project in Visual Studio.
2. Right click on References in the Solution Explorer and select Add Manage Nuget Packages.
3. Search for ‘Appium Webdriver’ and click Install. This updates the references to include the Appium drivers.
4. Search for ‘Selenium WebDriver’ and click Install. This updates the references to include the Selenium drivers.
5. Instantiate the Appium web driver.
6. Set the desired capabilities as described in Appium Capabilities.

Eclipse

To set up your Eclipse environment, follow these steps:

1. Download the latest archive files for the following:

   1. Selenium WebDriver Java Client

   2. Java-Client for Appium Mobile WebDriver

2. Extract the contents of the downloaded archive files.
3. In Eclipse, select your Appium project and choose Select Properties from the right-click menu.
4. Click on the Java Build Path node and select the Libraries tab.

5. Click on Add External JARs and add the downloaded jars, one at a time:

   1. the Java-client jar file extracted from the Selenium Java client download

   2. the jar files in the libs folder of the extracted Selenium client download

   3. the Java-client jar file extracted from the Java-Client for Appium download

6. Click OK to close the Properties dialog box.

Back to top

Prepare your Appium test

To prepare your Appium test to run on OpenText Functional Testing Lab:

• In the code that starts the session, replace the Appium server URL and port with the URL and port of OpenText Functional Testing Lab using the following format (see below for an example):

  driver = new AndroidDriver(new URL("http://<my OpenText Functional Testing Lab Server>:<port>/wd/hub"), capabilities);

  driver = new IOSDriver(new URL("http://<my OpenText Functional Testing Lab Server>:<port>/wd/hub"), capabilities);

• Make your apps available for the test by uploading them to OpenText Functional Testing Lab. For details, see Manage apps.

Back to top

Appium script execution

The following guidelines should be considered when running an Appium test:

• Safari Driver is not supported on Linux and Windows.

• When running your Appium tests through OpenText Functional Testing Lab, you can indicate the method of automation to use during script execution.

  OS	Details
  iOS	OpenText Functional Testing Lab enables you to run tests on iOS devices without requiring a Mac machine. The automation method used for iOS is XCUITest.
  Android 8 & higher	UiAutomator2 is the default automation engine. The uiautomator2 driver uses Google's UiAutomator2 technology to allow automation on a device or emulator. To overwrite the default and use UiAutomator1, set the automationName Appium capability to "android".

Back to top

Use Appium with SSL

To work with Appium and OpenText Functional Testing Lab using SSL, the Appium client needs to trust the OpenText Functional Testing Lab certificate.

If the SSL certificate is not signed by a well known certification authority, perform the following:

Back to top

Appium setup code snippets

The following code snippets show sample setups for Android native apps, Chrome, iOS native apps, and iOS Safari. The lines in bold are mandatory.

For a list of the common capabilities and their support in OpenText Functional Testing Lab, see Appium Capabilities.

Android native/hybrid app

DesiredCapabilities capabilities = new DesiredCapabilities();

capabilities.setCapability("platformName", "Android");

capabilities.setCapability("oauthClientId", "oauth2-…");

capabilities.setCapability("oauthClientSecret", "ke1SUI…");

capabilities.setCapability("appPackage", "com.Advantage.aShopping");

capabilities.setCapability("appActivity", "com.Advantage.aShopping.SplashActivity");

Android Chrome browser

DesiredCapabilities capabilities = new DesiredCapabilities();

capabilities.setCapability("platformName", "Android");

capabilities.setCapability("oauthClientId", "oauth2-…");

capabilities.setCapability("oauthClientSecret", "ke1SUI…");

capabilities.setCapability("browserName", "chrome");

iOS native/hybrid app

DesiredCapabilities capabilities = new DesiredCapabilities();

capabilities.setCapability("platformName", "iOS");

capabilities.setCapability("oauthClientId", "oauth2-…");

capabilities.setCapability("oauthClientSecret", "ke1SUI…");

capabilities.setCapability("bundleId", "com.mf.iShopping");

iOS Safari browser

DesiredCapabilities capabilities = new DesiredCapabilities();

capabilities.setCapability("platformName", "iOS");

capabilities.setCapability("oauthClientId", "oauth2-…");

capabilities.setCapability("oauthClientSecret", "ke1SUI…");

capabilities.setCapability("browserName", "safari");

For additional code samples see Appium code example - Java and Appium simulations.

Back to top

Common Appium API calls

Use the following Appium API calls to manage your apps.

Kill application

The Kill API call stops the application. It does not simply minimize the app—it terminates the process. The script name is mc:application:kill, and must use one of the following arguments:

• appPackage (Android) or bundleId (iOS)

• id or uuid as used in the REST API reference - Apps Install / Uninstall.

The following sample code terminates the Android Advantage app:

Map<String, Object> params = new HashMap<String, Object>();
params.put("appPackage", "com.Advantage.aShopping");
appiumDriver.executeScript("mc:application:kill", params);Copy Code

The line beginning with "params.put" can be replaced with any of the following options:

• params.put("bundleId", "com.mf.iShopping");

• params.put("uuid", "bf441f2b-3f16-4bb5-950d-4e3eaf2efffb");

• params.put("id", "com.Advantage.aShopping");

For additional code samples see Appium code example - Java and Appium simulations.

Network virtualization capabilities

Refer to the Network Virtualization help center for examples on how to add network virtualization capabilities within OpenText Functional Testing Lab.

Back to top

Report test status to the lab

OpenText Core SDP only

You can report if a test passed or failed from your Appium or Selenium script. You can then view this in the Results tab of the lab. For more details, see Test results.

To report test status from your Appium/ Selenium test, define a map (Java) or dictionary (C#) with the attributes status and comment. Use the executeScript API to set the status and comments during testing. Comments can be information related to the test failure, for example, the test execution message.

Java example

Map<String, String> status = new HashMap<>();
status.put("status", status); //status can be "Passed" or "Failed"
status.put("comment", comment); //comments can be information relating to the failure, for example, the execution message.
wd.executeScript("FTLab:status", status);Copy Code

C# example

Dictionary<string, string> statusmap = new Dictionary<string, string>();
            statusmap.Add("status", status); //status can be "Passed" or "Failed"
            statusmap.Add("comment", comment); //comments can be information relating to the failure, for example, the execution message.
            driver.ExecuteScript("FTLab:status", statusmap);Copy Code

Note: When create Android/iOS driver fails, a status of Not available is sent to the lab.

Back to top

Retrieve Appium logs

A log file is generated during the execution of your Appium tests.

To retrieve the log, use the mc-wd:downloadLogs script and specify the encoding.

When the connector receives this command, logs are retrieved for all sessions in the current Appium process. Attach the string to the response body.

The Appium user's test code uses the string from the response body and processes it accordingly.

For example:

For additional code samples see Appium code example - Java and Appium simulations.

Back to top

Parallel tests

You can run parallel Appium and Selenium tests on OpenText Functional Testing Lab.

You can do this through coding, or using your CI (Continuous Integration) tools such as Jenkins. For an example of how to run parallel tests in Jenkins, see the Parallel Test Executor plugin in the Jenkins Wiki.

Back to top

See also:

• Appium Capabilities
• Running Appium tests
• Appium code example - Java
• Appium simulations
• REST API reference