io.github.simple4tests.interactions.webdriver.WebDriverInteractions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of interactions-webdriver Show documentation
WebDriverInteractions will keep your Selenium WebDriver tests clean and focused on the test purpose
There is a newer version: 1.3.0
Show newest version
/*
MIT License

Copyright (c) 2022 simple4tests

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */

package io.github.simple4tests.interactions.webdriver;

import org.openqa.selenium.*;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.Select;

public class WebDriverInteractions {

    public static final String DEFAULT_SCROLL_BEHAVIOR = "auto";
    public static final String DEFAULT_SCROLL_BLOCK = "center";
    public static final String DEFAULT_SCROLL_INLINE = "center";

    protected String scrollBehavior;
    protected String scrollBlock;
    protected String scrollInline;

    protected boolean clear;
    protected boolean clearOnce;

    public WebDriver driver;
    public Wait wait;
    public JavaScript javaScript;

    public WebDriverInteractions(WebDriver driver) {
        this.scrollBehavior = DEFAULT_SCROLL_BEHAVIOR;
        this.scrollBlock = DEFAULT_SCROLL_BLOCK;
        this.scrollInline = DEFAULT_SCROLL_INLINE;

        this.clear = false;
        this.clearOnce = false;

        this.driver = driver;
        this.wait = new Wait(driver);
        this.javaScript = new JavaScript(driver);
    }

    protected boolean isNull(CharSequence... value) {
        if (null == value) {
            return true;
        }
        for (CharSequence cs : value) {
            if (null == cs) {
                return true;
            }
        }
        return false;
    }

    protected boolean isNull(Boolean value) {
        return null == value;
    }

    protected boolean isNull(By by) {
        return null == by;
    }

    public WebElement getElement(By by) {
        wait.elementToBePresent(by);
        return driver.findElement(by);
    }

    public WebElement getInteractableElement(By by) {
        return getInteractableElement(by, true, true, true);
    }

    public WebElement getInteractableElement(By by, boolean waitUntilElementIsDisplayed, boolean waitUntilElementIsEnabled, boolean scrollIntoView) {
        WebElement element = getElement(by);
        if (waitUntilElementIsDisplayed) wait.until(input -> element.isDisplayed());
        if (waitUntilElementIsEnabled) wait.until(input -> element.isEnabled());
        if (scrollIntoView) scrollIntoView(element);
        return element;
    }

    public boolean isElementPresent(By by) {
        return 0 < countElements(by);
    }

    public boolean isElementAbsent(By by) {
        return 0 == countElements(by);
    }

    public int countElements(By by) {
        return isNull(by) ? 0 : driver.findElements(by).size();
    }

    public void click(By by) {
        if (isNull(by)) {
            return;
        }
        getInteractableElement(by).click();
    }

    public void doubleClick(By by) {
        if (isNull(by)) {
            return;
        }
        javaScript.execute(
                "var evObj = new MouseEvent('dblclick', {bubbles: true, cancelable: true, view: window});arguments[0].dispatchEvent(evObj);",
                getInteractableElement(by)
        );
    }

    public void setClearOption(boolean alwaysClear) {
        this.clear = alwaysClear;
    }

    public WebDriverInteractions clear() {
        clearOnce = true;
        return this;
    }

    public void clear(By by) {
        if (isNull(by)) {
            return;
        }
        WebElement element = getInteractableElement(by);
        element.sendKeys(Keys.chord(Keys.CONTROL, "a"), Keys.DELETE);
        element.clear();
    }

    public void set(By by, CharSequence... value) {
        if (isNull(by) || isNull(value)) {
            return;
        }
        if (clear || clearOnce || 0 == value.length) {
            clearOnce = false;
            clear(by);
        }
        if (0 < value.length) {
            getInteractableElement(by).sendKeys(value);
        }
    }

    public void upload(By by, String fileAbsolutePath) {
        if (isNull(by) || isNull(fileAbsolutePath) || fileAbsolutePath.isEmpty()) {
            return;
        }
        getInteractableElement(by, false, true, true).sendKeys(fileAbsolutePath);
    }

    public void select(By by, Boolean value) {
        if (isNull(by) || isNull(value)) {
            return;
        }
        WebElement element = getInteractableElement(by);
        if (!value.equals(element.isSelected())) {
            element.click();
        }
    }

    public Select getSelectWithVisibleText(By by, String visibleText) {
        Select select = getSelect(by);
        if (null != select) wait.catchTimeoutException().until(input -> visibleTextExists(select, visibleText));
        return select;
    }

    public Select getSelectWithValue(By by, String value) {
        Select select = getSelect(by);
        if (null != select) wait.catchTimeoutException().until(input -> valueExists(select, value));
        return select;
    }

    /*
      Index starts at 0
     */
    public Select getSelectWithIndex(By by, int index) {
        Select select = getSelect(by);
        if (null != select) wait.catchTimeoutException().until(input -> indexExists(select, index));
        return select;
    }

    public Select getSelect(By by) {
        if (isNull(by)) {
            return null;
        }
        return new Select(getInteractableElement(by));
    }

    public boolean visibleTextExists(Select select, String visibleText) {
        if (isNull(visibleText) || visibleText.isEmpty()) return true;
        for (WebElement option : select.getOptions())
            if (visibleText.trim().equals(option.getText().trim())) {
                return true;
            }
        return false;
    }

    public boolean valueExists(Select select, String value) {
        if (isNull(value) || value.isEmpty()) return true;
        for (WebElement option : select.getOptions())
            if (value.equals(option.getAttribute("value"))) {
                return true;
            }
        return false;
    }

    /*
      Index starts at 0
     */
    public boolean indexExists(Select select, int index) {
        if (index < 0) return true;
        for (WebElement option : select.getOptions())
            if (String.valueOf(index).equals(option.getAttribute("index"))) {
                return true;
            }
        return false;
    }

    public Alert getAlert() {
        return wait.until(ExpectedConditions.alertIsPresent());
    }

    public void switchToDefaultContent() {
        driver.switchTo().defaultContent();
    }

    public void switchToParentFrame() {
        driver.switchTo().parentFrame();
    }

    public void switchToFrame(By by) {
        wait.until(ExpectedConditions.frameToBeAvailableAndSwitchToIt(by));
    }

    public void switchToFrame(int index) {
        wait.until(ExpectedConditions.frameToBeAvailableAndSwitchToIt(index));
    }

    public void switchToFrame(String nameOrId) {
        wait.until(ExpectedConditions.frameToBeAvailableAndSwitchToIt(nameOrId));
    }

    /*
      Index starts at 0
     */
    public void switchToTab(int index) {
        wait.until(input -> index < driver.getWindowHandles().size());
        driver.switchTo().window(driver.getWindowHandles().toArray()[index].toString());
    }

    public void closeTab() {
        driver.close();
    }

    public void setScrollIntoViewOptions(String behavior, String block, String inline) {
        this.scrollBehavior = behavior;
        this.scrollBlock = block;
        this.scrollInline = inline;
    }

    public void scrollIntoView(WebElement webElement) {
        scrollIntoView(webElement, scrollBehavior, scrollBlock, scrollInline);
    }

    public void scrollIntoView(WebElement webElement, String behavior, String block, String inline) {
        javaScript.execute(
                String.format("arguments[0].scrollIntoView({behavior: '%s', block: '%s', inline: '%s'});", behavior, block, inline),
                webElement
        );
    }
}