com.sdl.selenium.web.WebLocatorDriverExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Testy Show documentation
Automated Acceptance Testing. Selenium and Selenium WebDriver test framework for web applications. (optimized for dynamic html, ExtJS, Bootstrap, complex UI, simple web applications/sites)
The newest version!
package com.sdl.selenium.web;

import com.google.common.base.Strings;
import com.sdl.selenium.WebLocatorSuggestions;
import com.sdl.selenium.WebLocatorUtils;
import com.sdl.selenium.utils.config.WebLocatorConfig;
import com.sdl.selenium.web.utils.MultiThreadClipboardUtils;
import com.sdl.selenium.web.utils.RetryUtils;
import org.openqa.selenium.*;
import org.openqa.selenium.interactions.Actions;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.FluentWait;
import org.openqa.selenium.support.ui.Wait;
import org.slf4j.Logger;

import java.time.Duration;
import java.util.List;

public class WebLocatorDriverExecutor implements WebLocatorExecutor {

    private static final Logger log = org.slf4j.LoggerFactory.getLogger(WebLocatorDriverExecutor.class);
    private WebDriver driver;

    public WebLocatorDriverExecutor(WebDriver driver) {
        this.driver = driver;
    }

    @Override
    public boolean click(WebLocator el) {
        invalidateCache(el);
        boolean click = false;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            click = RetryUtils.retryRunnableSafe(1, () -> el.getWebElement().click());
        }
        if (!click) {
            click = RetryUtils.retryRunnableSafe(4, () -> {
                findAgain(el);
                el.getWebElement().click();
            });
        }
        return click;
    }

    @Override
    public boolean clickAt(WebLocator el) {
        focus(el);
        return click(el);
    }

    @Override
    public boolean doubleClickAt(WebLocator el) {
        invalidateCache(el);
        boolean clicked = false;
        if (findAgain(el)) {
            try {
                Actions builder = new Actions(driver);
                builder.doubleClick(el.getWebElement()).perform();
                clicked = true;
            } catch (Exception e) {
                // http://code.google.com/p/selenium/issues/detail?id=244
//                log.warn("Exception in doubleClickAt {}", e);
                clicked = fireEventWithJS(el, "dblclick") != null;
            }
        }
        return clicked;
    }

    public boolean submit(WebLocator el) {
        invalidateCache(el);
        boolean submit = false;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            submit = RetryUtils.retryRunnableSafe(1, () -> el.getWebElement().submit());
        }
        if (!submit) {
            submit = RetryUtils.retryRunnableSafe(4, () -> {
                findAgain(el);
                el.getWebElement().submit();
            });
        }
        return submit;
    }

    @Override
    public boolean clear(WebLocator el) {
        invalidateCache(el);
        boolean clear = false;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            clear = RetryUtils.retryRunnableSafe(1, () -> el.getWebElement().clear());
        }
        if (!clear) {
            clear = RetryUtils.retryRunnableSafe(4, () -> {
                findAgain(el);
                el.getWebElement().clear();
            });
        }
        return clear;
    }

    @Override
    public boolean sendKeys(WebLocator el, java.lang.CharSequence... charSequences) {
        return sendKeys(false, el, charSequences);
    }

    @Override
    public boolean sendKeys(boolean showLog, WebLocator el, java.lang.CharSequence... charSequences) {
        invalidateCache(el);
        boolean sendKeys = false;
        if (ensureExists(el)) {
            try {
                el.getWebElement().sendKeys(charSequences);
                sendKeys = true;
            } catch (NoSuchElementException e) {
                try {
                    sendKeys = tryAgainDoSendKeys(el, charSequences);
                } catch (NoSuchElementException ex) {
                    try {
                        mouseOver(el);
                        sendKeys = tryAgainDoSendKeys(el, charSequences);
                    } catch (NoSuchElementException exc) {
                        log.error("final NoSuchElementException in sendKeys: {}", el, exc);
                        throw exc;
                    }
                }
            } catch (WebDriverException e) {
                //TODO this fix is for Chrome
                Actions builder = new Actions(driver);
                builder.click(el.getWebElement());
                builder.sendKeys(charSequences);
                sendKeys = true;
            }
        }
        if (showLog) {
            if (sendKeys) {
                log.info("sendKeys value({}): '{}'", el, getKeysName(charSequences));
            } else {
                log.info("Could not sendKeys {}", el);
            }
        }
        return sendKeys;
    }

    private String getKeysName(java.lang.CharSequence... charSequences) {
        StringBuilder builder = new StringBuilder();
        int i = 0;
        for (CharSequence ch : charSequences) {
            if (i > 0) {
                builder.append(",");
            }
            builder.append(ch instanceof Keys ? ((Keys) ch).name() : ch);
            i++;
        }
        return builder.toString();
    }

    private boolean tryAgainDoSendKeys(WebLocator el, java.lang.CharSequence... charSequences) {
        if (findAgain(el)) {
            el.getWebElement().sendKeys(charSequences); // not sure it will click now
            return true;
        } else {
            log.error("currentElement is null after to try currentElement: {}", el);
            return false;
        }
    }

    @Override
    public boolean setValue(WebLocator el, String value) {
        return doSetValue(true, el, value);
    }

    @Override
    public boolean setValue(boolean showLog, WebLocator el, String value) {
        return doSetValue(showLog, el, value);
    }

    private boolean doSetValue(boolean showLog, WebLocator el, String value) {
        invalidateCache(el);
        int lengthVal = WebLocatorConfig.getMinCharsToType();
        int length = value.length();
        el.getWebElement().sendKeys(Keys.CONTROL, "a");
        el.getWebElement().sendKeys(Keys.DELETE);
        if (lengthVal == -1 || length <= lengthVal) {
            el.currentElement.sendKeys(value);
            if (showLog) {
                log.info("Set value({}): '{}'", el, getLogValue(el, value));
            }
        } else {
            try {
                MultiThreadClipboardUtils.copyString(value);
            } catch (IllegalStateException e) {
                log.warn("IllegalStateException: cannot open system clipboard - try again.");
                MultiThreadClipboardUtils.copyString(value);
            }
            MultiThreadClipboardUtils.pasteString(el);
            el.currentElement.sendKeys(value.substring(length - 1));
            log.info("Paste value({}): string with size: '{}'", el, length);
        }
        return true;
    }

    private String getLogValue(WebLocator el, String value) {
        String info = el.getPathBuilder().getInfoMessage();
        if (Strings.isNullOrEmpty(info)) {
            info = el.getPathBuilder().itemToString();
        }
        info = info.toLowerCase();
        return WebLocatorConfig.getLogParamsExclude().contains(info) ? "*****" : value;
    }

    @Override
    public String getCssValue(final WebLocator el, final String propertyName) {
        invalidateCache(el);
        String cssValue = null;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            cssValue = RetryUtils.retrySafe(1, () -> el.getWebElement().getCssValue(propertyName));
        }
        if (cssValue == null) {
            return RetryUtils.retrySafe(4, () -> {
                findAgain(el);
                return el.getWebElement().getCssValue(propertyName);
            });
        }
        return cssValue;
    }

    @Override
    public String getTagName(final WebLocator el) {
        invalidateCache(el);
        String tagName = null;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            tagName = RetryUtils.retrySafe(1, () -> el.getWebElement().getTagName());
        }
        if (tagName == null) {
            return RetryUtils.retrySafe(4, () -> {
                findAgain(el);
                return el.getWebElement().getTagName();
            });
        }
        return tagName;
    }

    @Override
    public String getAttribute(final WebLocator el, final String attribute) {
        return getAttribute(el, attribute, false);
    }

    @Override
    public String getAttribute(final WebLocator el, final String attribute, boolean instant) {
        invalidateCache(el);
        String attributeValue = null;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            attributeValue = RetryUtils.retrySafe(1, () -> el.getWebElement().getAttribute(attribute));
        }
        if (!instant) {
            if (attributeValue == null) {
                return RetryUtils.retrySafe(4, () -> {
                    findAgain(el);
                    return el.getWebElement().getAttribute(attribute);
                });
            }
        }
        return attributeValue;
    }

    public String getAttributeId(WebLocator el) {
        String id = getAttribute(el, "id");
        if (el.hasId()) {
            final String pathId = el.getPathBuilder().getId();
            if (!id.equals(pathId)) {
                log.warn("id is not same as pathId:{} - {}", id, pathId);
            }
            return id;
        }
        return id;
    }

    private boolean ensureExists(final WebLocator el) {
        boolean present = el.getWebElement() != null || isElementPresent(el);
        if (!present) {
            log.debug("Element not found: {}", el);
        }
        return present;
    }

    @Override
    public String getText(WebLocator el) {
        return getText(el, false);
    }

    @Override
    public String getText(WebLocator el, boolean instant) {
        invalidateCache(el);
        String text = null;
        if (!el.getCurrentElementPath().equals(getSelector(el))) {
            text = RetryUtils.retrySafe(1, () -> el.getWebElement().getText());
        }
        if (!instant && text == null) {
            return RetryUtils.retrySafe(4, () -> {
                findAgain(el);
                return el.getWebElement().getText();
            });
        }
        return text;
    }

    private String getSelector(WebLocator el) {
        String css = el.getCssSelector();
        return Strings.isNullOrEmpty(css) ? el.getXPath() : css;
    }

    private boolean findAgain(WebLocator el) {
        invalidateCache(el);
        return isElementPresent(el);
    }

    private void invalidateCache(WebLocator el) {
        el.currentElement = null;
        el.setCurrentElementPath("");
    }

    @Override
    public String getValue(WebLocator el) {
        return getAttribute(el, "value");
    }

    @Override
    public String getValue(WebLocator el, boolean instant) {
        return getAttribute(el, "value", instant);
    }

    @Override
    @Deprecated
    public boolean isElementPresent(WebLocator el) {
        return findElement(el) != null;
    }

    @Override
    public boolean isPresent(WebLocator el) {
        return findElement(el) != null;
    }

    @Override
    public WebElement findElement(WebLocator el) {
        final String path = getSelector(el);
//        if (isSamePath(el, path)) {
//            log.debug("currentElement already found one time: " + el);
        //return el.currentElement;
//        }
        WebElement webElement = doWaitElement(el, Duration.ZERO);
        el.setCurrentElementPath(path);
        return webElement;
    }

    public List findElements(WebLocator el) {
        if (el.getPathBuilder().getShadowRoot() != null) {
            return el.getPathBuilder().getShadowRoot().findElements(el.getSelector());
        } else if (el.getPathBuilder().getWebElement() != null) {
            return el.getPathBuilder().getWebElement().findElements(el.getSelector());
        } else {
            return driver.findElements(el.getSelector());
        }
    }

    @Override
    @Deprecated
    public WebElement waitElement(final WebLocator el, final long millis, boolean showXPathLog) {
        return waitElement(el, Duration.ofMillis(millis), showXPathLog);
    }

    @Override
    public WebElement waitElement(final WebLocator el, Duration duration, boolean showXPathLog) {
        WebElement webElement = doWaitElement(el, duration);
        if (webElement == null && showXPathLog) {
            log.warn("Element not found after {} seconds; {}", duration.getSeconds(), el.toString());
            logDetails(el);
        }
        return webElement;
    }

    private void logDetails(WebLocator el) {
        if (WebLocatorConfig.isLogXPath()) {
            log.debug("\t" + WebLocatorUtils.getFirebugXPath(el));
        }
        if (WebLocatorConfig.isLogSuggestions()) {
            WebLocatorSuggestions.getSuggestion(el);
        }
    }

    private WebElement doWaitElement(final WebLocator el, Duration duration) {
        WebElement webElement;
        Wait wait = new FluentWait<>(driver)
                .withTimeout(duration)
                .pollingEvery(Duration.ofMillis(1))
                .ignoring(NoSuchElementException.class)
                .ignoring(WebDriverException.class);
        try {
            if (el.getPathBuilder().getShadowRoot() != null) {
                webElement = el.getPathBuilder().getShadowRoot().findElement(el.getSelector());
            } else if (el.getPathBuilder().getWebElement() != null) {
                webElement = el.getPathBuilder().getWebElement().findElement(el.getSelector());
            } else if (el.getPathBuilder().isVisibility()) {
                webElement = wait.until((d) -> ExpectedConditions.visibilityOfElementLocated(el.getSelector()).apply(d));
            } else {
                webElement = wait.until(d -> d.findElement(el.getSelector()));
            }
        } catch (TimeoutException e) {
            webElement = null;
        }
        return el.currentElement = webElement;
    }

    @Override
    public int size(WebLocator el) {
        return findElements(el).size();
    }

    @Override
    public Point getLocation(WebLocator el) {
        return ensureExists(el) ? el.currentElement.getLocation() : null;
    }

    @Override
    public Dimension getSize(WebLocator el) {
        return ensureExists(el) ? el.currentElement.getSize() : null;
    }

    @Override
    public Rectangle getRect(WebLocator el) {
        return ensureExists(el) ? el.currentElement.getRect() : null;
    }

    @Override
    public boolean focus(WebLocator el) {
        return fireEventWithJS(el, "mouseover") != null;
    }

    @Override
    public boolean mouseOver(WebLocator el) {
        boolean mouseOver;
        try {
            if (findAgain(el)) {
                Actions builder = new Actions(driver);
                builder.moveToElement(el.getWebElement()).perform();
                mouseOver = true;
            } else {
                mouseOver = false;
            }
        } catch (WebDriverException e) {
            log.error("Could not mouse over {}, {}", el, e);
            mouseOver = false;
        }
        return mouseOver;
    }

    @Override
    public boolean blur(WebLocator el) {
        return fireEventWithJS(el, "blur") != null;
    }

    @Override
    public boolean isSelected(WebLocator el) {
        return findAgain(el) && el.currentElement.isSelected();
    }

    public boolean isDisplayed(WebLocator el) {
        return findAgain(el) && el.currentElement.isDisplayed();
    }

    public boolean isEnabled(WebLocator el) {
        return findAgain(el) && el.currentElement.isEnabled();
    }

    public String getAccessibleName(WebLocator el) {
        findAgain(el);
        return el.getWebElement().getAccessibleName();
    }

    public String getAriaRole(WebLocator el) {
        findAgain(el);
        return el.getWebElement().getAriaRole();
    }

    public String getDomAttribute(WebLocator el, String name) {
        findAgain(el);
        return el.getWebElement().getDomAttribute(name);
    }

    public String getDomProperty(WebLocator el, String name) {
        findAgain(el);
        return el.getWebElement().getDomProperty(name);
    }

    public SearchContext getShadowRoot(WebLocator el) {
        findAgain(el);
        return el.getWebElement().getShadowRoot();
    }

    public boolean isSamePath(WebLocator el, String path) {
        return el.getWebElement() != null && (el.getCurrentElementPath().equals(path));
    }

    private boolean isCached(WebLocator el) {
        boolean cached = false; // TODO config
        return cached;
    }

    @Override
    public Object executeScript(String script, Object... objects) {
        JavascriptExecutor javascriptExecutor = (JavascriptExecutor) driver;
        try {
            return javascriptExecutor.executeScript(script, objects);
        } catch (WebDriverException e) {
            log.error("WebDriverException in executeScript: " + script, e);
            return null;
        }
    }

    public Object fireEventWithJS(WebLocator el, String eventName) {
        String script = "if(document.createEvent){" +
                "var evObj = document.createEvent('MouseEvents');\n" +
                "evObj.initEvent('" + eventName + "',true,true);\n" +
                "return fireOnThis.dispatchEvent(evObj);\n" +
                "} else if(document.createEventObject) {" +
                "return fireOnThis.fireEvent('on" + eventName + "');" +
                "}";
        String id = getAttributeId(el);
        String cls;
        if (!Strings.isNullOrEmpty(id)) {
            script = "var fireOnThis = document.getElementById('" + id + "');\n" + script;
        } else if (!"".equals(cls = getAttribute(el, "class"))) {
            script = "var fireOnThis = document.getElementsByClassName('" + cls + "')[0];\n" + script;
        } else {
            script = "var fireOnThis = document.evaluate(\"" + el.getXPath() + "\", document, null, XPathResult.ANY_TYPE, null).iterateNext();\n" +
                    "var evObj = document.createEvent('MouseEvents');\n" +
                    "evObj.initEvent('" + eventName + "',true,true);\n" +
                    "return fireOnThis.dispatchEvent(evObj);";
        }
        return executeScript(script);
    }

    @Override
    public void highlight(WebLocator el) {
        highlightElementWithDriver(el.currentElement);
    }

    public boolean download(String fileName, long timeoutMillis) {
        return RunExe.getInstance().download(fileName);
    }

    public boolean browse(WebLocator el) {
        try {
            el.focus();
            Actions builder = new Actions(driver);
            builder.moveToElement(el.getWebElement()).perform();
            builder.click().perform();
            return true;
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            return false;
        }
    }

    /**
     * @param filePath e.g. "C:\\text.txt"
     * @return true of false
     */
    public boolean upload(String filePath) {
        return RunExe.getInstance().upload(filePath);
    }

    private void highlightElementWithDriver(WebElement el) {

        // TODO more tests for this method

//        String highlightStyle = "background: none yellow !important; color: red !important; border: 1px solid green !important;";

//        String script = "(function(element){" +
//            "var original_style = element.getAttribute('style') || '';" +
//            "element.setAttribute('style', original_style + '; " + highlightStyle + "'); " +
//            "setTimeout(function(){element.setAttribute('style', original_style);}, 200);})(arguments[0]);";

//        executeScript(script, element);

//        for (int i = 0; i < 2; i++) {
//            JavascriptExecutor js = (JavascriptExecutor) driver;
//            js.executeScript("arguments[0].setAttribute('style', arguments[1]);", element, highlightStyle);
//            js.executeScript("arguments[0].setAttribute('style', arguments[1]);", element, "");
//        }
    }
}