Locator Strategies in Appium Vega Driver

​

Supported strategies

​

UiSelector

element = driver.find_element("UiSelector", '{"args": {"text": "Element Text"}}')

element = driver.findElement(AppiumBy.ByAndroidUIAutomator.androidUIAutomator("{\"args\": {\"role\":\"edit\"} }"));

​

XPath

element = driver.find_element(by="xpath", value="//[contains(@description, \"Music\")]")

element = driver.findElement(AppiumBy.xpath("//[contains(@description, \"Music\")]"));

const element = await driver.$('//[contains(@description, "Music")]');

element = @driver.wait { |d| d.find_element :xpath, '//[contains(@description, "Music")]' }

​

Key components

1. Axis - Specifies the direction of the search, such as descendant, ancestor, and following.
   // Descendant axis
   "//button"  // All button descendants
   "/button"   // Direct child buttons
   
2. Node test - Specifies the node type to select, such as element, attribute, or text().
   "//*"           // Any element
   "//button"      // Button elements
   "//text()"      // Text nodes
   
3. Predicate - Filters the selected nodes that are based on various conditions, such as attribute values, position, or custom functions.
   "//button[@text='Login']"              // Exact match
   "//button[contains(@text, 'Login')]"   // Partial match
   

​

Special use cases

// Root element
driver.findElement(By.xpath("/root"));

// Elements by description
driver.findElement(By.xpath("//*[contains(@description, 'Music')]"));

// Complex hierarchical selection
driver.findElement(By.xpath("//parent/*[2]//child[@visible='true']"));

​

Comparison of selector strategies

​

Best practices

1. Choose the right strategy
   • Use UiSelector for platform-specific tests
   • Use XPath for cross-platform compatibility
   • Prefer UiSelector when performance is critical
2. Element location
   • Use unique identifiers when possible
   • Avoid absolute paths
   • Keep selectors as simple as possible
   • Regularly validate selectors’ reliability
3. Performance considerations
   • Complex XPath queries may impact test execution time
   • Cache frequently used elements
   • Use app-specific IDs when available
4. Maintenance tips
   • Document locator strategies
   • Review locators regularly
   • Update with UI changes
   • Maintain cross-platform compatibility
   • Use meaningful names in test code