io.cucumber.core.plugin.UpdateManualScenario Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of serenity-cucumber Show documentation
There is a newer version: 4.2.8
package io.cucumber.core.plugin;

import io.cucumber.messages.types.Tag;
import net.thucydides.model.domain.TestResult;
import net.thucydides.core.steps.BaseStepListener;
import net.thucydides.model.util.EnvironmentVariables;

import java.util.List;
import java.util.Optional;

public class UpdateManualScenario {

    private final BaseStepListener baseStepListener;
    private final ManualScenarioChecker manualScenarioChecker;
    private final String scenarioDescription;

    private UpdateManualScenario(BaseStepListener baseStepListener,
                                 EnvironmentVariables environmentVariables,
                                 String scenarioDescription) {
        this.baseStepListener = baseStepListener;
        this.manualScenarioChecker = new ManualScenarioChecker(environmentVariables);
        this.scenarioDescription = scenarioDescription;
    }

    public static UpdateManualScenarioBuilder forScenario(String description) {
        return new UpdateManualScenarioBuilder(description);
    }

    public void updateManualScenario(TestResult result, List scenarioTags) {

        Optional lastTestedVersion = manualScenarioChecker.lastTestedVersionFromTags(scenarioTags);
        Optional testEvidence = manualScenarioChecker.testEvidenceFromTags(scenarioTags);
        Boolean manualTestIsUpToDate = manualScenarioChecker.scenarioResultIsUpToDate(scenarioTags);

        if (!manualTestIsUpToDate) {
            updateCurrentScenarioResultTo(TestResult.PENDING, lastTestedVersion, manualTestIsUpToDate, testEvidence);
        } else if (isUnsuccessful(result)) {
            recordManualFailureForCurrentScenarioWithResult(result, lastTestedVersion, manualTestIsUpToDate, testEvidence);
        } else {
            updateCurrentScenarioResultTo(result, lastTestedVersion, manualTestIsUpToDate, testEvidence);
        }
    }

    private void recordManualFailureForCurrentScenarioWithResult(TestResult result,
                                                                 Optional lastTestedVersion,
                                                                 Boolean manualTestIsUpToDate,
                                                                 Optional testEvidence) {
        String failureMessage = failureMessageFrom(scenarioDescription)
                                .orElse(result.getAdjective() + " manual test");

        baseStepListener.latestTestOutcome().ifPresent(
                outcome -> outcome.setTestFailureMessage(failureMessage)
        );
        updateCurrentScenarioResultTo(result, lastTestedVersion, manualTestIsUpToDate, testEvidence);

    }

    private void updateCurrentScenarioResultTo(TestResult result,
                                               Optional lastTestedVersion,
                                               Boolean manualTestIsUpToDate,
                                               Optional testEvidence) {
        baseStepListener.overrideResultTo(result);
        baseStepListener.recordManualTestResult(result, lastTestedVersion, manualTestIsUpToDate, testEvidence);
    }

    private Optional failureMessageFrom(String description) {
        if (description == null || description.isEmpty()) {
            return Optional.empty();
        }
        String firstLine = description.split("\r?\n")[0];
        if (firstLine.trim().toLowerCase().startsWith("failure:")) {
            return Optional.of("Failed manual test: " + firstLine.trim().substring(8).trim());
        } else {
            return Optional.empty();
        }
    }

    private boolean isUnsuccessful(TestResult result) {
        return (result == TestResult.FAILURE || result == TestResult.ERROR || result == TestResult.COMPROMISED);
    }

    public static class UpdateManualScenarioBuilder {
        private final String description;

        UpdateManualScenarioBuilder(String description) {
            this.description = description;
        }

        public UpdateManualScenario inContext(BaseStepListener baseStepListener,
                                       EnvironmentVariables environmentVariables) {
            return new UpdateManualScenario(baseStepListener, environmentVariables, description);
        }
    }
}