pawl.jbehave.AbstractWebStory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Geeoz Software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package pawl.jbehave;

import org.jbehave.core.configuration.Configuration;
import org.jbehave.core.io.LoadFromClasspath;
import org.jbehave.core.junit.JUnitStory;
import org.jbehave.core.reporters.StoryReporterBuilder;
import org.jbehave.core.steps.InjectableStepsFactory;
import org.jbehave.core.steps.InstanceStepsFactory;
import org.jbehave.web.selenium.PerStoryWebDriverSteps;
import org.jbehave.web.selenium.SeleniumConfiguration;
import org.jbehave.web.selenium.SeleniumContext;
import org.jbehave.web.selenium.WebDriverProvider;
import org.jbehave.web.selenium.WebDriverScreenshotOnFailure;
import org.jbehave.web.selenium.WebDriverSteps;
import pawl.jbehave.step.BrowserSteps;
import pawl.jbehave.step.MailSteps;
import pawl.util.Resources;
import pawl.webdriver.LocalizedWebDriverProvider;

import java.util.LinkedList;
import java.util.List;

import static org.jbehave.core.reporters.Format.CONSOLE;
import static org.jbehave.core.reporters.Format.TXT;

/**
 * AbstractWebStories class provide capability to run all BDD
 * stories this that corresponds to file name patter from default configuration
 * properties.
 *
 * @author Alex Voloshyn
 * @author Mike Dolinin
 * @author Serge Voloshyn
 * @version 1.5 2/26/14
 * @see pawl.jbehave.step.BrowserSteps#setupLink(String)
 * @see pawl.jbehave.step.BrowserSteps#openUrl()
 * @see pawl.jbehave.step.BrowserSteps#openContextPath(String)
 * @see pawl.jbehave.step.BrowserSteps#refreshPage()
 * @see pawl.jbehave.step.BrowserSteps#choose(String, String, String)
 * @see pawl.jbehave.step.BrowserSteps#click(String)
 * @see pawl.jbehave.step.BrowserSteps#clickWithOffset(String, String, String)
 * @see pawl.jbehave.step.BrowserSteps#clickOnLinkWithAttribute(String)
 * @see pawl.jbehave.step.BrowserSteps#fill(String, String)
 * @see pawl.jbehave.step.BrowserSteps#fillFile(String, String)
 * @see pawl.jbehave.step.BrowserSteps#select(String, String)
 * @see pawl.jbehave.step.BrowserSteps#storeTextFromElement(String, String)
 * @see pawl.jbehave.step.BrowserSteps#switchToNewWindow()
 * @see pawl.jbehave.step.BrowserSteps#verifyTitle(String)
 * @see pawl.jbehave.step.BrowserSteps#verifySource(String)
 * @see pawl.jbehave.step.BrowserSteps#verifyElement(String)
 * @see pawl.jbehave.step.BrowserSteps#verifyLink(String)
 * @see pawl.jbehave.step.BrowserSteps#verifyElementText(String, String)
 * @see pawl.jbehave.step.BrowserSteps#verifyElementIsNotPresent(String)
 */
public abstract class AbstractWebStory extends JUnitStory {
    /**
     * JBehave web driver provider.
     */
    private final transient WebDriverProvider driverProvider =
            new LocalizedWebDriverProvider();
    /**
     * JBehave web driver provider.
     */
    private final transient WebDriverSteps lifecycleSteps =
            new PerStoryWebDriverSteps(driverProvider);
    /**
     * Web testing context.
     */
    private final transient SeleniumContext context = new SeleniumContext();

    /**
     * Web pages collection factory.
     */
    private final transient Pages pages = new Pages(getDriverProvider());

    /**
     * JBehave user story launcher.
     */
    public AbstractWebStory() {
        super();
        configuredEmbedder().embedderControls()
                .useThreads(Resources.base().useThreads())
                .useStoryTimeoutInSecs(
                        Resources.base().useStoryTimeoutInSecs())
                .doGenerateViewAfterStories(false)
                .doIgnoreFailureInView(true)
                .doIgnoreFailureInStories(false)
                .doBatch(true);
    }

    // Here we specify the configuration, starting from default
    // SeleniumConfiguration, and changing only what is needed
    @Override
    public final Configuration configuration() {
        return new SeleniumConfiguration()
                .useSeleniumContext(context)
                .useWebDriverProvider(driverProvider)
                        // where to find the stories
                .useStoryLoader(new LoadFromClasspath(this.getClass()))
                        // CONSOLE and TXT reporting
                .useStoryReporterBuilder(
                        new StoryReporterBuilder().withDefaultFormats()
                                .withFormats(CONSOLE, TXT))
                .useStoryPathResolver(new UnderscoredCamelCaseITResolver());
    }

    // Here we specify the steps classes
    @Override
    public final InjectableStepsFactory stepsFactory() {
        final Configuration configuration = configuration();
        final List