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)
The newest version!
package com.sdl.selenium.conditions;

import com.google.common.base.Strings;
import com.sdl.selenium.web.utils.Utils;
import org.slf4j.Logger;

import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collections;
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 log = org.slf4j.LoggerFactory.getLogger(ConditionManager.class);
    public static int SLEEP_INTERVAL = 10;

    private Duration duration = Duration.ofSeconds(10);

    private Instant startTime;

    private List conditionList = new ArrayList<>();

    /**
     * default duration is in 10 seconds.
     */
    public ConditionManager() {
    }

    /**
     * @param timeout milliseconds
     * @deprecated use {@link #ConditionManager(Duration)}
     */
    @Deprecated
    public ConditionManager(long timeout) {
        this();
        this.duration = Duration.ofMillis(timeout);
    }

    public ConditionManager(Duration duration) {
        this();
        this.duration = duration;
    }

    public List getConditionList() {
        return conditionList;
    }

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

    public ConditionManager remove(Condition condition) {
        conditionList.removeIf(i -> i.getMessage().equals(condition.getMessage()));
        return this;
    }

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

    public ConditionManager removeCondition(String message) {
        if (!Strings.isNullOrEmpty(message)) {
            conditionList.removeIf(c -> c.getMessage().equals(message));
        }
        return this;
    }

    public Duration getDuration() {
        return duration;
    }

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

    public void setDuration(Duration duration) {
        this.duration = duration;
    }

    /**
     * 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 = Instant.now();
        Instant now = Instant.now();
        Collections.sort(conditionList);
        while (true) {
            Condition condition = findCondition();
            if (condition != null) {
                log.debug("{} - executed in ({}ms)", condition, Instant.now().toEpochMilli() - startTime.toEpochMilli());
                return condition;
            }
            Utils.sleep(SLEEP_INTERVAL);
            long millis = Instant.now().toEpochMilli() - now.toEpochMilli();
            setDuration(getDuration().minusMillis(millis));
            if (getDuration().isZero() || getDuration().isNegative()) {
                FailCondition failCondition = new FailCondition("TimeoutCondition@") {
                    public boolean execute() {
                        return true;
                    }
                    @Override
                    public boolean isTimeout() {
                        return true;
                    }
                    public String toString() {
                        Condition cond = conditionList.get(0);
                        return (cond.getClassName() == null ? "" : cond.getClassName() + ":") + "TimeoutCondition@" + cond.getMessage();
                    }
                };
                log.debug("{} - executed in ({}ms)", failCondition.toString(), Instant.now().toEpochMilli() - startTime.toEpochMilli());
                return failCondition;
            }
            now = Instant.now();
        }
    }

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