Best Practices for utilizing #Locator-Free Elements

Locator-Free Elements present an excellent opportunity to enhance the reliability and maintainability of your automation scripts. By eliminating the dependence on the underlying web application's DOM structure, teams can simplify automation development and ensure ease of maintenance.

In this article, we will explore best practices for harnessing the power of Locator-Free Elements to optimize your test automation process.

Setting up Locator-Free Elements

When using the Locator-free approach, the system automatically calculates the label/hint appropriate for a given element. By following these recommendations, you can maximize the benefits of Locator-Free Elements in your automation workflow.

Ensure a clear and stable Label

A label acts as a reference to the element you want to interact with. It can be the label of a dropdown field, the placeholder text of an input field, or the self-text of an element like a button or link. This is automatically calculated by the system.

When you hover over an element in the Recorder, the system displays this value. Ensure that the label accurately reflects the element it represents, improving the readability of your scripts.

For example, if you have a dropdown field for selecting a country, the label could be "Country".

Utilize Label Operators

Sometimes, label values may not be all that static. The calculated label on the Recorder may include certain portions that may change from one use case to another. In such cases, leverage operators like equals (ignoring case), starts with, ends with, contains, or matches regex to handle dynamic labels effectively. This provides stability in your automation scripts, even when labels change dynamically.

Example: Suppose the label of a button changes dynamically due to localized versions. And assume that all these labels start with "Submit".

By utilizing the "starts with" operator, you can consistently interact with the button regardless of its specific localization. For instance, "Label starts with 'Submit'."

Employ Anchor Text

Anchor text narrows down the search for a label on the page. Choose functionally meaningful anchor text that assists in locating the desired element efficiently.

For example, specifying an anchor text like "Shipping Address" when dealing with a set of related fields can enhance the accuracy of your script.

Leverage Anchor Text Operators

Similar to label operators, anchor text operators, such as starts with, ends with, or contains, can be employed when the anchor text is dynamic. By utilizing these operators, you can handle varying anchor text effectively and maintain stability in your automation scripts.

Utilize Index as a Tie-Breaker

In cases where multiple elements match the specified attributes of a Locator-Free Element (combination of label and anchor text), utilize the index as a tie-breaker. This ensures that the script interacts with the intended element, even in scenarios where there are multiple matches.

Example: If you have multiple buttons with the same label and you want to interact with the second one, specify the index as "2nd" to ensure interaction with the desired element. For example, "2nd 'Select' button".

The same can be indicated in the logic editor by appending the label with a "#n". For the above example, you would pass the label as: "Submit#2".

Note: You could use a negative index to point to an element from the bottom of the list. For example, if you need to point to an instance that is 2nd from the bottom of the screen, you could pass "Submit#-2".

Dealing with Dynamic Text

Dynamic text poses a challenge in element identification, but with the right approach, you can overcome this hurdle and maintain stability in your scripts.

Identify Text Patterns

Although labels and anchor text may change dynamically, patterns usually exist. By identifying these patterns through starts with, ends with, regex, or similar operators, you can achieve stability even when working with dynamic text.

Example: Suppose you have a dynamic label that always ends a year number in the current century. By utilizing the "regex" operator, you can handle the dynamic nature of the label. For instance, "Label matching regex '20[0-9]{2}".

Ensuring Meaningful Anchor Text

To ensure ease of maintenance and longevity of your automation scripts, it's crucial to select meaningful anchor text rather than relying on random text.

Focus on Functionality

Choose anchor text that not only exists above or to the left of the label but is functionally meaningful. Selecting text that holds significance in the context of the element helps maintain stability and simplifies future maintenance.

Example: Rather than selecting random text as anchor text, choose text that holds functional relevance. For instance, if you are interacting with a button that initiates a purchase, use "Checkout" as the anchor text.

Using Variables for Labels

Leveraging variables for labels can enhance the flexibility and adaptability of your automation scripts.

Incorporate Logic

If labels or anchor text are derived using logical operations, consider using variables (local parameters, Action parameters, or Global Properties) to hold the values. For example, when obtaining a Purchase Order number through a SQL query, storing the result in a variable allows for seamless interaction with the corresponding element.

Example: Suppose you have a dynamic label derived by concatenating a user's first name and last name. Store the concatenated result in a variable and use it as the label for interacting with the element. For instance, "Label using 'Full Name' variable."

Smart Locators as a Supplement

While Locator-Free Elements offer substantial benefits, there may still be situations where Smart Locators are the preferred solution.

Container Elements

For elements that are treated as part of a group, Smart-Locators are beneficial. They simplify the identification and interaction of related elements, streamlining your automation process.

Here is an article with further details and an example.

Non-Textual Attributes

Smart Locators are particularly useful when elements possess non-textual attributes. By harnessing AI-infused neighborhood analysis, Smart-Locators offer enhanced reliability and require less maintenance compared to traditional XPath or CSS.

Conclusion

By following these best practices for utilizing Locator-Free Elements, you are well on your way to optimizing the reliability, readability, and maintainability of your automation scripts. By eliminating the reliance on DOM structure and focusing on functionally meaningful labels and anchor text, you can enhance your test automation process and improve overall productivity in QA.