org.eclipse.che.selenium.pageobject.TestWebElementRenderChecker.java Source code

Introduction

Here is the source code for org.eclipse.che.selenium.pageobject.TestWebElementRenderChecker.java

Source

/*
 * Copyright (c) 2012-2018 Red Hat, Inc.
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Red Hat, Inc. - initial API and implementation
 */
package org.eclipse.che.selenium.pageobject;

import static org.eclipse.che.selenium.core.constant.TestTimeoutsConstants.ELEMENT_TIMEOUT_SEC;
import static org.eclipse.che.selenium.core.constant.TestTimeoutsConstants.LOAD_PAGE_TIMEOUT_SEC;

import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.che.selenium.core.SeleniumWebDriver;
import org.eclipse.che.selenium.core.webdriver.SeleniumWebDriverHelper;
import org.openqa.selenium.By;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.StaleElementReferenceException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.ExpectedCondition;
import org.openqa.selenium.support.ui.FluentWait;

@Singleton
public class TestWebElementRenderChecker {
    private final SeleniumWebDriver seleniumWebDriver;
    private final SeleniumWebDriverHelper seleniumWebDriverHelper;

    @Inject
    public TestWebElementRenderChecker(SeleniumWebDriver seleniumWebDriver,
            SeleniumWebDriverHelper seleniumWebDriverHelper) {
        this.seleniumWebDriver = seleniumWebDriver;
        this.seleniumWebDriverHelper = seleniumWebDriverHelper;
    }

    /**
     * wait until element have the same size between two checks it means that element is fully opened
     *
     * @param webElement list or context menu which need check
     * @param seconds timeout for check
     */
    public void waitElementIsRendered(WebElement webElement, int seconds) {
        waitElementIsStatic(getFluentWait(seconds), webElement);
    }

    /**
     * wait until element have the same size between two checks it means that element is fully opened
     *
     * @param webElement list or context menu which need check
     */
    public void waitElementIsRendered(WebElement webElement) {
        waitElementIsRendered(webElement, LOAD_PAGE_TIMEOUT_SEC);
    }

    /**
     * wait until element have the same size between two checks it means that element is fully opened
     *
     * @param locator list or context menu Xpath which need check
     */
    public void waitElementIsRendered(By locator) {
        waitElementIsRendered(waitAndGetWebElement(locator));
    }

    /**
     * wait until element have the same size between two checks it means that element is fully opened
     *
     * @param locator list or context menu Xpath which need check
     */
    public void waitElementIsRendered(By locator, int seconds) {
        waitElementIsRendered(waitAndGetWebElement(locator), seconds);
    }

    private Boolean dimensionsAreEquivalent(AtomicInteger sizeHashCode, Dimension newDimension) {
        return sizeHashCode.get() == getSizeHashCode(newDimension);
    }

    private FluentWait<WebDriver> getFluentWait(int seconds) {
        return new FluentWait<WebDriver>(seleniumWebDriver).withTimeout(seconds, TimeUnit.SECONDS)
                .pollingEvery(200, TimeUnit.MILLISECONDS).ignoring(StaleElementReferenceException.class);
    }

    private void waitElementIsStatic(FluentWait<WebDriver> webDriverWait, WebElement webElement) {
        AtomicInteger sizeHashCode = new AtomicInteger();

        webDriverWait.until((ExpectedCondition<Boolean>) driver -> {
            Dimension newDimension = waitAndGetWebElement(webElement).getSize();

            if (dimensionsAreEquivalent(sizeHashCode, newDimension)) {
                return true;
            } else {
                sizeHashCode.set(getSizeHashCode(newDimension));
                return false;
            }
        });
    }

    /**
     * height is multiplied because we must avoid the situation when, in fact, different parties will
     * give the same sum for example 15 + 25 == 25 + 15, but 15 + 25*10000 != 25 + 15*10000
     *
     * @param dimension consist partial sizes
     * @return partial sizes sum with shift
     */
    private int getSizeHashCode(Dimension dimension) {
        return dimension.getWidth() + (dimension.getHeight() * 10000);
    }

    private WebElement waitAndGetWebElement(WebElement webElement) {
        return seleniumWebDriverHelper.waitVisibility(webElement, ELEMENT_TIMEOUT_SEC);
    }

    private WebElement waitAndGetWebElement(By locator) {
        return seleniumWebDriverHelper.waitVisibility(locator, ELEMENT_TIMEOUT_SEC);
    }
}