All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.tapack.satisfy.SatisfyStoryReporter Maven / Gradle / Ivy

There is a newer version: 0.6.6
Show newest version
/*
 * Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Tapack Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Tapack Software is supplied to you by Tapack in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Tapack Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Tapack Software.
 *
 * Neither the name, trademarks, service marks or logos of Tapack may be used
 * to endorse or promote products derived from the Tapack Software without
 * specific prior written permission from Tapack.
 *
 * The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.tapack.io/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Tapack and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Tapack and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Tapack or visit www.tapack.io if you need additional
 * information or have any questions.
 */

package io.tapack.satisfy;

import net.thucydides.core.model.TestTag;
import net.thucydides.core.steps.ExecutedStepDescription;
import net.thucydides.core.steps.StepEventBus;
import net.thucydides.core.steps.StepFailure;
import org.jbehave.core.model.*;
import org.jbehave.core.reporters.StoryReporter;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import static net.thucydides.core.model.TestTag.withName;

public class SatisfyStoryReporter implements StoryReporter {

    private static final String OPEN_PARAM_CHAR = "\uff5f";
    private static final String CLOSE_PARAM_CHAR = "\uff60";
    private boolean isScenarioWithFailure = false;
    private boolean isStoryWithFailure = false;
    private boolean isStoryWithPending = false;

    @Override
    public void storyNotAllowed(Story story, String filter) {

    }

    @Override
    public void storyCancelled(Story story, StoryDuration storyDuration) {

    }

    @Override
    public void beforeStory(Story story, boolean givenStory) {

    }

    @Override
    public void afterStory(boolean givenStory) {

    }

    @Override
    public void narrative(Narrative narrative) {

    }

    @Override
    public void lifecyle(Lifecycle lifecycle) {

    }

    @Override
    public void scenarioNotAllowed(Scenario scenario, String filter) {
        StepEventBus.getEventBus().updateCurrentStepTitle(normalized(scenario.getTitle()));
        StepEventBus.getEventBus().stepIgnored();
        List tags = new ArrayList<>();
        tags.add(withName(filter).andType("Stories with skipped scenario"));
        StepEventBus.getEventBus().addTagsToCurrentTest(tags);
    }

    @Override
    public void beforeScenario(String scenarioTitle) {
        if (!scenarioTitle.isEmpty()) {
            StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                    .withTitle("Scenario: " + scenarioTitle));
        }
    }

    @Override
    public void scenarioMeta(Meta meta) {

    }

    @Override
    public void afterScenario() {
        if (aStepInScenarioFailed()) {
            StepEventBus.getEventBus().stepIgnored();
        } else if (aPreviousStepHasSuspended()) {
            StepEventBus.getEventBus().stepIgnored();
        } else {
            StepEventBus.getEventBus().stepFinished();
        }
    }

    @Override
    public void givenStories(GivenStories givenStories) {

    }

    @Override
    public void givenStories(List storyPaths) {

    }

    @Override
    public void beforeExamples(List steps, ExamplesTable table) {

    }

    @Override
    public void example(Map tableRow) {

    }

    @Override
    public void afterExamples() {

    }

    public void beforeStep(String stepTitle) {
        if (aPreviousStepHasFailed() || aPreviousStepHasSuspended()) {
            StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                    .withTitle(stepTitle));
        }
    }

    public void successful(String title) {
        if (aPreviousStepHasFailed() || aPreviousStepHasSuspended()) {
            StepEventBus.getEventBus().updateCurrentStepTitle(normalized
                    (title));
            StepEventBus.getEventBus().stepIgnored();
        }
    }

    public void ignorable(String title) {
        StepEventBus.getEventBus().updateCurrentStepTitle(normalized(title));
        StepEventBus.getEventBus().stepIgnored();
    }

    public void pending(String stepTitle) {
        if (StepEventBus.getEventBus().aStepInTheCurrentTestHasFailed()) {
            StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                    .withTitle(normalized(stepTitle)));
            StepEventBus.getEventBus().stepIgnored();
        } else {
            StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                    .withTitle(normalized(stepTitle)));
            StepEventBus.getEventBus().stepPending();
        }
    }

    public void notPerformed(String stepTitle) {
        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                .withTitle(normalized(stepTitle)));
        StepEventBus.getEventBus().stepIgnored();
    }

    public void failed(String stepTitle, Throwable cause) {
        Throwable rootCause = cause.getCause() != null ? cause.getCause() :
                cause;
        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription
                .withTitle(normalized(stepTitle)));
        StepEventBus.getEventBus().stepFailed(new StepFailure
                (ExecutedStepDescription.withTitle(normalized(stepTitle))
                        , rootCause));
        isStoryWithFailure = true;
    }

    @Override
    public void failedOutcomes(String step, OutcomesTable table) {

    }

    @Override
    public void restarted(String step, Throwable cause) {

    }

    @Override
    public void dryRun() {

    }

    @Override
    public void pendingMethods(List methods) {

    }

    private String normalized(String value) {
        return value.replaceAll(OPEN_PARAM_CHAR, "{").replaceAll
                (CLOSE_PARAM_CHAR, "}");
    }

    private boolean aPreviousStepHasFailed() {
        boolean aPreviousStepHasFailed = false;
        if (StepEventBus.getEventBus().aStepInTheCurrentTestHasFailed()) {
            if (isStoryWithFailure) {
                aPreviousStepHasFailed = true;
            } else {
                isStoryWithFailure = true;
            }
        }
        return aPreviousStepHasFailed;
    }

    private boolean aPreviousStepHasSuspended() {
        boolean aPreviousStepHasSuspended = false;
        if (StepEventBus.getEventBus().currentTestIsSuspended()) {
            if (isStoryWithPending) {
                aPreviousStepHasSuspended = true;
            } else {
                isStoryWithPending = true;
            }
        }
        return aPreviousStepHasSuspended;
    }


    private boolean aStepInScenarioFailed() {
        boolean aPreviousStepHasFailed = false;
        if (StepEventBus.getEventBus().aStepInTheCurrentTestHasFailed()) {
            if (isScenarioWithFailure) {
                aPreviousStepHasFailed = true;
            } else {
                isScenarioWithFailure = true;
            }
        }
        return aPreviousStepHasFailed;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy