Appium-Capabilities-7 : Complete Details on “appium:options” — (W3C Capabilities)

Get a step-by-step walkthrough in the video below!

In this article, we’ll explore the following key points related to "appium:options":

• What is appium:options?
  Understand the purpose and structure of the appium:options capability in Appium.
• Why Use appium:options?
  Explore the benefits and use cases of using appium:options for cleaner, standardized capability configurations.
• Demo: Positive & Negative Scenarios with appium:options
  Execute and analyze both successful and failing test scenarios using appium:options to showcase its impact.

What is appium:options?

appium:options is a namespaced capability container introduced to support the W3C WebDriver standard, which requires vendor-specific capabilities to be grouped under a namespaced key.

It encapsulates all Appium-specific capabilities, including those that are:

• Common (across platforms)
• Android-specific
• iOS-specific
• Driver-specific (UiAutomator2, XCUITest, Espresso, etc.)

Why Use appium:options?

• W3C WebDriver compliant
• Avoids capability clashes
• Cleaner structure and better validation

Step 1: Create a map for appium:options

Map<String,Object> appiumOptions=new HashMap<>();
  
  appiumOptions.put("platformVersion", "13");
  appiumOptions.put("automationName", "uiautomator2");
  appiumOptions.put("deviceName", "Pixel6");
  appiumOptions.put("app", apkpath);
  appiumOptions.put("noReset", true);
  appiumOptions.put("autoGrantPermissions", true);
  appiumOptions.put("newCommandTimeout", 120);

Example:

Press enter or click to view image in full size

Step 2: Wrap appium options inside Capabilities

  UiAutomator2Options cap=new UiAutomator2Options();
  //PlatformName at root-level
  cap.setPlatformName("android");
  
  //Step 2: Wrap appium options inside Capabilities
  cap.setCapability("appium:options", appiumOptions); 
  
  
  driver = new AndroidDriver(new URL("http://127.0.0.1:4723"), cap);
  driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(100));

Example:

Press enter or click to view image in full size

Why Is platformName Outside appium:options?

platformName is defined by the W3C as a standard capability,

so it must not be vendor-namespaced like appium:options.

Mixing W3C and Non-W3C

You can still mix platformName at the root level and others inside appium:options:

{
  "platformName": "Android",
  "appium:options": {
    "automationName": "uiautomator2",
    "deviceName": "emulator-5554",
    "platformVersion": "11.0",
    "app": "/path/to/app.apk",
    "noReset": true
  }
}

Example: appium-config.json

Scenario: When the "platformName" capability is defined inside "appium:options", observe the following impact:

Script:

Press enter or click to view image in full size

Impact: Session will not created.

Press enter or click to view image in full size

Summary Points:

Press enter or click to view image in full size

GitHub Link:

GitHub - AppiumGuide/AppiumGuide

Contribute to AppiumGuide/AppiumGuide development by creating an account on GitHub.

github.com

🎬 Explore More! Watch My Latest Videos on YouTube!

AppiumGuide

📌 Step-by-Step Appium Tutorial for Beginners & Experts with Practical Examples 👍 ✅ Learn Appium from Scratch with…

www.youtube.com

Visit My Official Blog:

Home-Index Page

A comprehensive Appium guide for mobile app automation, covering setup, testing on iOS/Android, best practices, and…

appiumguide-by-kodumururamesh.blogspot.com