aquality.selenium.elements.ComboBox Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aquality-selenium Show documentation
Library around Selenium WebDriver
There is a newer version: 4.9.0
package aquality.selenium.elements;

import aquality.selenium.core.elements.ElementState;
import aquality.selenium.elements.actions.ComboBoxJsActions;
import aquality.selenium.elements.interfaces.IComboBox;
import org.openqa.selenium.By;
import org.openqa.selenium.InvalidElementStateException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.Select;

import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * Class describing the ComboBox (dropdown list)
 */
public class ComboBox extends Element implements IComboBox {

    private static final String LOG_SELECTING_VALUE = "loc.selecting.value";

    protected ComboBox(final By locator, final String name, final ElementState state) {
        super(locator, name, state);
    }

    protected String getElementType() {
        return getLocalizationManager().getLocalizedMessage("loc.combobox");
    }

    @Override
    public void selectByIndex(int index) {
        logElementAction(LOG_SELECTING_VALUE, String.format("#%s", index));
        doWithRetry(() -> new Select(getElement()).selectByIndex(index));
    }

    @Override
    public void selectByText(String value) {
        logElementAction("loc.combobox.select.by.text", value);
        doWithRetry(() -> new Select(getElement()).selectByVisibleText(value));
    }

    @Override
    public void clickAndSelectByText(String value) {
        click();
        selectByText(value);
    }

    @Override
    public void selectByContainingText(String text) {
        logElementAction("loc.combobox.select.by.text", text);
        applyFunctionToOptionsThatContain(WebElement::getText,
                Select::selectByVisibleText,
                text);
    }

    @Override
    public void selectByContainingValue(String value) {
        logElementAction(LOG_SELECTING_VALUE, value);
        applyFunctionToOptionsThatContain(element -> element.getAttribute(Attributes.VALUE.toString()),
                Select::selectByValue,
                value);
    }

    protected void applyFunctionToOptionsThatContain(Function getValueFunc, BiConsumer selectFunc, String value){
        doWithRetry(() -> {
            Select select = new Select(getElement());
            List elements = select.getOptions();
            boolean isSelected = false;
            for (WebElement el: elements) {
                String currentValue = getValueFunc.apply(el);
                getLogger().debug(currentValue);
                if(currentValue.toLowerCase().contains(value.toLowerCase())){
                    selectFunc.accept(select, currentValue);
                    isSelected = true;
                }
            }
            if (!isSelected){
                throw new InvalidElementStateException(String.format(getLocalizationManager().getLocalizedMessage(
                        "loc.combobox.impossible.to.find.option.contain.value.or.text"), value, getName()));
            }
        });
    }

    @Override
    public void selectByValue(String value) {
        logElementAction(LOG_SELECTING_VALUE, value);
        doWithRetry(() -> new Select(getElement()).selectByValue(value));
    }

    @Override
    public void clickAndSelectByValue(String value) {
        click();
        selectByValue(value);
    }

    @Override
    public String getSelectedValue() {
        logElementAction("loc.combobox.getting.selected.value");
        String value = doWithRetry(
                () -> new Select(getElement()).getFirstSelectedOption().getAttribute(Attributes.VALUE.toString()));
        logElementAction("loc.combobox.selected.value", value);
        return value;
    }

    @Override
    public String getSelectedText() {
        logElementAction("loc.combobox.getting.selected.text");
        String text = doWithRetry(() -> new Select(getElement()).getFirstSelectedOption().getText());
        logElementAction("loc.combobox.selected.text", text);
        return text;
    }

    @Override
    public List getValues() {
        logElementAction("loc.combobox.get.values");
        List values = doWithRetry(() ->
                new Select(getElement()).getOptions()
                        .stream()
                        .map(option -> option.getAttribute(Attributes.VALUE.toString()))
                        .collect(Collectors.toList()));
        logElementAction("loc.combobox.values",
                values.stream().map(value -> String.format("'%s'", value)).collect(Collectors.joining(", ")));
        return values;
    }

    @Override
    public List getTexts() {
        logElementAction("loc.combobox.get.texts");
        List values = doWithRetry(() ->
                new Select(getElement()).getOptions()
                        .stream()
                        .map(WebElement::getText)
                        .collect(Collectors.toList()));

        logElementAction("loc.combobox.texts",
                values.stream().map(value -> String.format("'%s'", value)).collect(Collectors.joining(", ")));
        return values;
    }

    @Override
    public ComboBoxJsActions getJsActions() {
        return new ComboBoxJsActions(this, getElementType());
    }

}