com.sdl.selenium.conditions.ConditionManager 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)

There is a newer version: 20.08.432.0_b2d2a09

Show newest version

package com.sdl.selenium.conditions;

import com.sdl.selenium.web.utils.Utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;

/**
 * Example how to add conditions to ConditionManager:
 * ConditionManager manager = new ConditionManager().add(new SuccessCondition() {
    public boolean execute() {
        return logoutButton.isElementPresent();
    }
});
 * 
 * OR more specific cases:
 *  ConditionManager manager = new ConditionManager();
 manager.add(
     new MessageBoxFailCondition("Wrong email or password.")).add(
     new RenderSuccessCondition(logoutButton)
 );
 Condition condition = manager.execute();
 logged = condition.isSuccess();
 
 */
public class ConditionManager  {
    private static final Logger LOGGER = LoggerFactory.getLogger(ConditionManager.class);

    public static int SLEEP_INTERVAL = 50;

    private long timeout = 10000;

    private long startTime;

    private List conditionList = new ArrayList<>();

    /**
     * default timeout in milliseconds is 10000.
     */
    public ConditionManager() {
        this.add(new FailCondition("TimeoutCondition@") {
            public boolean execute() {
                return new Date().getTime() - startTime > timeout;
            }
            @Override
            public boolean isTimeout(){
                return true;
            }
            public String toString() {
                return getMessage() + timeout;
            }
        });
    }

    /**
     * @param timeout milliseconds
     */
    public ConditionManager(long timeout) {
        this();
        this.timeout = timeout;
    }

    public List getConditionList() {
        return conditionList;
    }

    public ConditionManager add(Condition condition) {
        conditionList.add(condition);
        return this;
    }

    public ConditionManager remove(Condition condition) {
        conditionList.remove(condition);
        return this;
    }

    public ConditionManager removeConditions(String... messages){
        for (String message : messages){
            removeCondition(message);
        }
        return this;
    }

    public ConditionManager removeCondition(String message){
        if(message != null && message.length() > 0){
            for (Condition condition : conditionList) {
                if(condition.equals(message)){
                    conditionList.remove(condition);
                    break;
                }
            }
        }
        return this;
    }

    public long getTimeout() {
        return timeout;
    }

    /**
     *
     * @param timeout milliseconds
     */
    public void setTimeout(long timeout) {
        this.timeout = timeout;
    }

    /**
     * Iterates through conditions list until one of the conditions is met or the method times out
     * in case of timeout a FailCondition("@TimeoutCondition@") will be returned
     * @return the executed Condition, unless the method times out
     */
    public Condition execute() {
        startTime = new Date().getTime();
        Collections.sort(conditionList);
        while (true) {
            Condition condition = findCondition();
            if(condition != null){
                LOGGER.debug("{} - executed in ({}ms)", condition, new Date().getTime() - startTime);
                return condition;
            }
            Utils.sleep(SLEEP_INTERVAL);
        }
    }

    protected Condition findCondition(){
        for (Condition condition : getConditionList()) {
            if (condition.execute()) {
                return condition;
            }
        }
        return null;
    }
}