UI automation framework methods and sample code

UI automation sample: Testing custom UI elements

Using the UI framework, you can also create custom test classes for your custom UI elements. Custom UI elements can be data fields (such as a text field) and control fields (such as a button). BMC recommends that you extend the RXControlField abstract class and RXDataField abstract class to create your custom UI elements classes. The RXControlField class and the RXDataField class are located in the com.bmc.rx.test.framework.elements package.

The following sample code illustrates how to test a custom control field:

package com.bmc.rx.test.framework.elements;
import com.bmc.rx.test.framework.listener.ErrorListener;
import com.bmc.rx.test.framework.utils.web.AngularJs;
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.Rectangle;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Actions;
//This is the sample code snippet for the Custom Control field
public class CustomControlField extends RXControlField {
    
    //Unique Locator for the Custom field
    private static String cssButtonField = "[rx-view-component-id='%s'] button";
    
    public CustomControlField(WebDriver drv,String guid,ErrorListener listener){
        actualcssTag = String.format(cssButtonField, guid);
        driver = drv;
        addListener(listener);
    }
    
    
    /**
    * This method is used to click on the getWebElement()
    */
    @Override
    public void click() {
        getWebElement().click();
        AngularJs.waitForAngularRequestsToFinish(driver);
    }
    
    /** 
    * This method is used to see if getWebElement() is enabled or not 
    */
    public boolean isEnabled() {
        //Implement as per the Custom element's behavior
        return true;
    }
    
    /**
    * This method will be used to see if getWebElement() is visible or not. 
    */
    @Override
    public boolean isVisible() {
        //Implement as per the Custom element's behavior
        return true;
    }
    
    @Override
    public WebElement apply(WebDriver  input) {
        WebElement resultCountElement = null;
        if(driver.findElements(By.cssSelector(actualcssTag)).size() > 0){
            resultCountElement = driver.findElement(By.cssSelector(actualcssTag));    
        }        
        return resultCountElement;
    } 
}

package com.bmc.rx.test.framework.elements;
import java.util.List;
import java.util.NoSuchElementException;
import org.jetbrains.annotations.Nullable;
import org.openqa.selenium.By;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.Rectangle;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Actions;
import org.openqa.selenium.support.FindBy;
import com.bmc.rx.test.framework.listener.ErrorListener;
/**
 * This is a sample code snippet for Custom Data Field
 */ 
public class CustomDataField extends RXDataField {
private static String cssBooleanField = "[rx-view-component-id='%s']";
    private String sBoolean = "rx-boolean";
    String sFieldName = "span";
    String sTrueButton = ".d-icon-check";
    String sFalseButton = ".d-icon-circle_slash_o";
    /**
     * This constructor will be used for initialising the instance of this class.
     */
    public CustomDataField(WebDriver drv,String guid,ErrorListener listener){
        actualcssTag = String.format(cssBooleanField, guid);
        driver = drv;
        addListener(listener);
    }
    /**
     * This method is used to see if element is enabled or not
     */
    @Override
    public boolean isEnabled() {
        //Write the implentation as per the requirement
        return true;
    }
    /*
    * If Data can be passed as 'True' or 'False'
    */
    @Override
    public void setData(Object data){
        //Write the implentation as per the requirement
    }
    /**
     * This method will be used for getting the selected state of the Boolean Field.
     * If the boolean field is set to True, then this method will return true. Else false will be returned
     *
     */
    @Override
    public Boolean getData(){
        //Write the implentation as per the requirement
        return true;
    }
    /**
     * This method is used to set the focus on the element
     */
    @Override
    public void setFieldFocus(){
        new Actions(driver).moveToElement(getWebElement()).perform();
    }
    /**
     * This method will be used for clearing / deselecting whatever was selected in the boolean field.
     */
    @Override
    public void clear(){
        getWebElement().findElement(By.cssSelector(sBoolean)).clear();
    }
    /**
     * This method will be used for getting the label of the element
     */
    @Override
    public String getLabel(){
        try {
            List<WebElement> labels = getWebElement().findElements(By.tagName("label"));
            if (labels.size() == 1) {
                return labels.get(0).getText();
            }
        }catch (Exception e){
            return null;
        }
        return null;
    }
    private boolean isButtonChecked(WebElement button) {
        return button.getAttribute("class").contains("is-checked");
    }
    /**
     * This method will be used to see, if element is visible or not.
     */
    @Override
    public boolean isVisible() {
        if (getWebElement().isDisplayed()){
            return true;
        }else {return false;}
    }
    /**
     * This method will be used to see, if element is readOnly or not.
     */
    @Override
    public boolean isReadOnly() {
        //Write the implentation as per the requirement
        return true;
    }
    @Override
    public WebElement apply(WebDriver  input) {
        WebElement resultCountElement = null;
        if(driver.findElements(By.cssSelector(actualcssTag)).size() > 0){
            resultCountElement = driver.findElement(By.cssSelector(actualcssTag));
        }
        return resultCountElement;
    }
}

For more information about all the methods available in the various elements classes (com.bmc.rx.test.framework.elements), see API documentation for UI automation framework.

Related topic

Testing the user interface with the UI automation framework