net.thucydides.core.steps.ScenarioSteps Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of serenity-core Show documentation

There is a newer version: 4.2.1

package net.thucydides.core.steps;

import net.serenitybdd.core.di.SerenityInfrastructure;
import net.serenitybdd.model.time.SystemClock;
import net.thucydides.core.pages.Pages;
import org.openqa.selenium.WebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.Serializable;

/**
 * A set of reusable steps for use in an acceptance test suite.
 * A step corresponds to an action taken during a web test - clicking on a button or a link,
 * for example. Steps may be reused across more than one test, and may take parameters.
 *
 */
public class ScenarioSteps implements Serializable {
    
    private static final long serialVersionUID = 1L;

    private static final Logger LOGGER = LoggerFactory.getLogger(ScenarioSteps.class);

    private Pages pages;
    private final SystemClock clock;

    public ScenarioSteps() {
        this.clock = SerenityInfrastructure.getClock();
    }

    public ScenarioSteps(final Pages pages) {
        this.pages = pages;
        this.clock = SerenityInfrastructure.getClock();
    }

    public WebDriver getDriver() {
        return pages.getDriver();
    }

    protected void setPages(Pages pages) {
        this.pages = pages;
    }

    public Pages getPages() {
        return pages;
    }

    public Pages onPage() {
        return pages;
    }

    public Pages pages() {
        return getPages();
    }

    public  T onSamePage(Class stepsType) {
        getPages().onSamePage();
        return stepsType.cast(this);
    }

    /**
     * Pause the test to wait for the page to display completely.
     * This is not normally recommended practice, but is useful from time to time.
     */
    public void waitABit(final long delayInMilliseconds) {
        try {
            Thread.sleep(delayInMilliseconds);
        } catch (InterruptedException e) {
            LOGGER.warn("Wait a bit method was interrupted.", e);
        }
    }

    public WaitForBuilder waitFor(int duration) {
        return new ScenarioStepsStepDelayer(clock, this).waitFor(duration);
    }
    

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }
}