nl.praegus.fitnesse.slim.fixtures.web.mendix.MendixBrowserTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
There is a newer version: 1.38.1
package nl.praegus.fitnesse.slim.fixtures.web.mendix;

import nl.hsac.fitnesse.fixture.slim.SlimFixtureException;
import nl.hsac.fitnesse.fixture.slim.web.BrowserTest;
import nl.hsac.fitnesse.fixture.slim.web.annotation.TimeoutPolicy;
import nl.hsac.fitnesse.fixture.slim.web.annotation.WaitUntil;
import nl.hsac.fitnesse.slim.interaction.ReflectionHelper;
import org.openqa.selenium.*;
import org.openqa.selenium.support.ui.ExpectedCondition;

import java.lang.reflect.Method;
import java.util.Set;

/**
 * Fixture class customized to test mendix web apps.
 */

public class MendixBrowserTest extends BrowserTest {
    private final static Set METHODS_NO_WAIT;
    static {
        METHODS_NO_WAIT = ReflectionHelper.validateMethodNames(BrowserTest.class,
                "open",
                "takeScreenshot",
                "location",
                "back",
                "forward",
                "refresh",
                "alertText",
                "confirmAlert",
                "dismissAlert",
                "openInNewTab",
                "ensureActiveTabIsNotClosed",
                "currentTabIndex",
                "tabCount",
                "ensureOnlyOneTab",
                "closeTab",
                "switchToNextTab",
                "switchToPreviousTab",
                "switchToDefaultContent",
                "switchToFrame",
                "switchToParentFrame",
                "secondsBeforeTimeout",
                "secondsBeforePageLoadTimeout",
                "waitForPage",
                "waitForTagWithText",
                "waitForClassWithText",
                "waitForClass",
                "waitForVisible",
                "waitSeconds",
                "waitMilliseconds",
                "waitMilliSecondAfterScroll",
                "screenshotBaseDirectory",
                "screenshotShowHeight",
                "setBrowserWidth",
                "setBrowserHeight",
                "setBrowserSizeToBy",
                "setBrowserSizeToMaximum",
                "setGlobalValueTo",
                "setSendCommandForControlOnMacTo",
                "sendCommandForControlOnMac",
                "isImplicitWaitForAngularEnabled",
                "setImplicitWaitForAngularTo",
                "globalValue",
                "clearSearchContext",
                "executeScript",
                "secondsBeforeTimeout",
                "secondsBeforePageLoadTimeout",
                "trimOnNormalize",
                "setImplicitFindInFramesTo",
                "setTrimOnNormalize",
                "setRepeatIntervalToMilliseconds",
                "repeatAtMostTimes",
                "repeatAtMostTimes",
                "timeSpentRepeating");
    }

    private boolean waitForJquery = false;
    private int jqueryTimeout = 5; //Timeout in seconds

    private int delayBeforeValue = 0;
    private int inputDelay = 0;
    private String progressIndicator = "css=.mx-progress-indicator";
    private String xpathForHeadTable = ".//table[contains(@class, 'mx-datagrid-head-table')]";
    private String xpathForBodyTable = ".//table[contains(@class, 'mx-datagrid-body-table')]";


    /**
     * Override beforeInvoke to always wait for any spinner to be gone if it's there
     */
    @Override
    protected void beforeInvoke(Method method, Object[] arguments) {
        super.beforeInvoke(method, arguments);
        if (!METHODS_NO_WAIT.contains(method.getName())) {
            try {
                waitForJqueryIfNeeded();
                waitMilliseconds(inputDelay);
                waitUntil(webDriver -> isNotVisibleOnPage(progressIndicator));
            } catch (SlimFixtureException e) {
                String msg = e.getMessage();
                if (msg.startsWith("message:<<") && msg.endsWith(">>")) {
                    msg = msg.substring(10, msg.length() - 2);
                    msg = msg.replaceAll("Timed-out waiting ", "Timed out waiting for spinner to disappear ");
                }
                throw new SlimFixtureException(false, msg);
            }
        }
    }

    public void waitForJquery(boolean wait) {
        waitForJquery = wait;
    }

    public void setJqueryTimeout(int timeout) {
        jqueryTimeout = timeout;
    }

    public void setInputDelay(int delay) {
        inputDelay = delay;
    }

    public int getInputDelay() {
        return inputDelay;
    }

    public void identifyProgressIndicatorUsing(String place) {
        this.progressIndicator = place;
    }

    @Override
    public void setBrowserSizeToMaximum() {
        try {
            super.setBrowserSizeToMaximum();
        } catch (WebDriverException e) {
            try{
                setBrowserHeight(900);
                setBrowserWidth(1800);
                System.out.println("Tried to maximize a browser that didn't allow that, tried setting 1800x900 now");
            } catch (WebDriverException f) {
                System.out.println("Resizing not allowed, mobile device?");
            }
        }
    }


    @Override
    public boolean selectForIn(String value, String place, String container) {
        clickIn(place, container);
        return super.selectForIn(value, place, container);
    }

    @Override
    public boolean selectFor(String value, String place) {
        click(place);
        return super.selectFor(value, place);
    }


    public String getCsrfToken() {
        return getSeleniumHelper().executeJavascript("return window.mx.session.sessionData.csrftoken").toString();
    }

    public void delayValueExtractionByMilliseconds(int millis) {
        delayBeforeValue = millis;
    }

    @WaitUntil(TimeoutPolicy.RETURN_NULL)
    public String valueOfInRowWhereIs(String requestedColumnName, String selectOnColumn, String selectOnValue) {

        WebElement element = elementInRowWhereIs(requestedColumnName, selectOnColumn, selectOnValue);
        if(element != null) {
            String result = valueFor(element);
            if (result.length() == 0) {
                result = element.getAttribute("title");
            }
            return result;
        }
        return null;
    }

    @Override
    @WaitUntil(TimeoutPolicy.RETURN_NULL)
    public String valueOfInRowNumber(String requestedColumnName, int rowNumber) {

        int columnIndex = columnIndex(xpathForHeadTable, requestedColumnName);

        String xpath = String.format("%s//tr[%d]/td[%d]", xpathForBodyTable, rowNumber, columnIndex);

        WebElement element = getSeleniumHelper().findByXPath(xpath);
        if(element != null) {
            String result = valueFor(element);
            if (result.length() == 0) {
                result = element.getAttribute("title");
            }
            return result;
        }
        return null;

    }

    @Override
    @WaitUntil(TimeoutPolicy.RETURN_FALSE)
    public boolean clickInRowWhereIs(String requestedColumnName, String selectOnColumn, String selectOnValue) {
        return clickElement(elementInRowWhereIs(requestedColumnName, selectOnColumn, selectOnValue));
    }

    private WebElement elementInRowWhereIs(String requestedColumnName, String selectOnColumn, String selectOnValue) {

        int selectColumnIndex = columnIndex(xpathForHeadTable, selectOnColumn);
        int requestedColumnIndex = columnIndex(xpathForHeadTable, requestedColumnName);

        String xpath = String.format("%s//td[%s][normalize-space(descendant-or-self::text())='%s']/parent::tr/td[%s]", xpathForBodyTable, selectColumnIndex, selectOnValue, requestedColumnIndex);
        return getElement("xpath=" + xpath);

    }

    private int columnIndex(String tableXpath, String columnName) {
        int precedingColumns = getSeleniumHelper().findElements(By.xpath(String.format("%s//th[normalize-space(descendant-or-self::text())='%s']/preceding-sibling::th", tableXpath, columnName))).size();
        return precedingColumns + 1;
    }

    @Override
    @WaitUntil(TimeoutPolicy.RETURN_NULL)
    public String valueOf(String place) {
        waitMilliseconds(delayBeforeValue);
        return super.valueOf(place);
    }


    private void waitForJqueryIfNeeded() {
        if(waitForJquery) {
            try{
                int originalTimeout = secondsBeforeTimeout();
                secondsBeforeTimeout(jqueryTimeout);
                ExpectedCondition condition = jQueryToBeReady();
                waitUntil(condition);
                secondsBeforeTimeout(originalTimeout);
            } catch (WebDriverException e) {
                // ignore. Probably no jQ.
            }
        }
    }

    private ExpectedCondition jQueryToBeReady() {
        return driver -> (Boolean) executeScript("return window.jQuery.active == 0");
    }
}