KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use ScenarioHolder class of com.tngtech.jgiven.impl package

Best JGiven code snippet using com.tngtech.jgiven.impl.ScenarioHolder

Source:JGivenExtension.java

...5import com.tngtech.jgiven.config.AbstractJGivenConfiguration;6import com.tngtech.jgiven.config.ConfigurationUtil;7import com.tngtech.jgiven.exception.JGivenWrongUsageException;8import com.tngtech.jgiven.impl.ScenarioBase;9import com.tngtech.jgiven.impl.ScenarioHolder;10import com.tngtech.jgiven.report.impl.CommonReportHelper;11import com.tngtech.jgiven.report.model.ReportModel;12import java.util.EnumSet;13import org.junit.jupiter.api.Assumptions;14import org.junit.jupiter.api.Tag;15import org.junit.jupiter.api.TestInstance;16import org.junit.jupiter.api.extension.AfterAllCallback;17import org.junit.jupiter.api.extension.AfterTestExecutionCallback;18import org.junit.jupiter.api.extension.BeforeAllCallback;19import org.junit.jupiter.api.extension.BeforeEachCallback;20import org.junit.jupiter.api.extension.ExtensionContext;21import org.junit.jupiter.api.extension.ExtensionContext.Namespace;22import org.junit.jupiter.api.extension.TestInstancePostProcessor;23/**24 * This extension enables JGiven for JUnit 5 Tests.25 * <p>26 * Just annotate your test class with {@code @ExtendWith( JGivenExtension.class )}27 * <p>28 * You can then inject stage classes by using the {@see ScenarioStage} annotation29 * <p>30 * As an alternative you can also inherit from one of the following predefined base classes:31 * <ul>32 *     <li>{@link ScenarioTest}</li>33 *     <li>{@link SimpleScenarioTest}</li>34 * </ul>35 *36 * @see ScenarioTest37 * @see SimpleScenarioTest38 */39public class JGivenExtension implements40    TestInstancePostProcessor,41    BeforeAllCallback,42    AfterAllCallback,43    BeforeEachCallback,44    AfterTestExecutionCallback {45    private static final Namespace NAMESPACE = Namespace.create("com.tngtech.jgiven");46    private static final String REPORT_MODEL = "report-model";47    @Override48    public void beforeAll(ExtensionContext context) {49        validatePerMethodLifecycle(context);50        ReportModel reportModel = new ReportModel();51        reportModel.setTestClass(context.getTestClass().get());52        if (!context.getDisplayName().equals(context.getTestClass().get().getSimpleName())) {53            reportModel.setName(context.getDisplayName());54        }55        context.getStore(NAMESPACE).put(REPORT_MODEL, reportModel);56        AbstractJGivenConfiguration configuration = ConfigurationUtil.getConfiguration(context.getTestClass().get());57        if (configuration.getTagConfiguration(Tag.class) == null) {58            configuration.configureTag(Tag.class)59                .description("JUnit 5 Tag")60                .color("orange");61        }62    }63    @Override64    public void afterAll(ExtensionContext context) {65        ScenarioHolder.get().removeScenarioOfCurrentThread();66        new CommonReportHelper().finishReport((ReportModel) context.getStore(NAMESPACE).get(REPORT_MODEL));67    }68    @Override69    public void beforeEach(ExtensionContext context) {70        getScenario().startScenario(context.getTestClass().get(), context.getTestMethod().get(),71            ArgumentReflectionUtil.getNamedArgs(context));72    }73    @Override74    public void afterTestExecution(ExtensionContext context) throws Exception {75        ScenarioBase scenario = getScenario();76        try {77            if (context.getExecutionException().isPresent()) {78                scenario.getExecutor().failed(context.getExecutionException().get());79            }80            scenario.finished();81            // ignore test when scenario is not implemented82            Assumptions.assumeTrue(83                EnumSet.of(SUCCESS, FAILED).contains(scenario.getScenarioModel().getExecutionStatus()));84        } catch (Exception e) {85            throw e;86        } catch (Throwable e) {87            throw new RuntimeException(e);88        } finally {89            ScenarioHolder.get().removeScenarioOfCurrentThread();90        }91    }92    @Override93    public void postProcessTestInstance(Object testInstance, ExtensionContext context) {94        ScenarioBase currentScenario = ScenarioHolder.get().getScenarioOfCurrentThread();95        ScenarioBase scenario;96        if (testInstance instanceof ScenarioTestBase) {97            scenario = ((ScenarioTestBase<?, ?, ?>) testInstance).getScenario();98        } else {99            if (currentScenario == null) {100                scenario = new ScenarioBase();101            } else {102                scenario = currentScenario;103            }104        }105        if (scenario != currentScenario) {106            ReportModel reportModel = (ReportModel) context.getStore(NAMESPACE).get(REPORT_MODEL);107            scenario.setModel(reportModel);108            ScenarioHolder.get().setScenarioOfCurrentThread(scenario);109        }110        scenario.getExecutor().injectStages(testInstance);111        scenario.getExecutor().readScenarioState(testInstance);112    }113    private void validatePerMethodLifecycle(ExtensionContext context) {114        if (isPerClassLifecycle(context)) {115            throw new JGivenWrongUsageException(116                "JGiven does not support keeping a test instance over multiple scenarios. Please use Lifecycle '"117                    + TestInstance.Lifecycle.PER_METHOD + "'.");118        }119    }120    private boolean isPerClassLifecycle(ExtensionContext context) {121        return context.getTestInstanceLifecycle()122            .filter(lifecycle -> TestInstance.Lifecycle.PER_CLASS == lifecycle)123            .isPresent();124    }125    private ScenarioBase getScenario() {126        return ScenarioHolder.get().getScenarioOfCurrentThread();127    }128}...

Source:JGivenReportExtractingExtension.java

1package com.tngtech.jgiven.tests;2import com.tngtech.jgiven.exception.JGivenWrongUsageException;3import com.tngtech.jgiven.impl.ScenarioBase;4import com.tngtech.jgiven.impl.ScenarioHolder;5import com.tngtech.jgiven.junit5.JGivenExtension;6import com.tngtech.jgiven.report.model.ReportModel;7import java.util.Map;8import java.util.Optional;9import java.util.concurrent.ConcurrentHashMap;10import org.junit.jupiter.api.extension.ExtensionContext;11/**12 * Extracts the report Model from within the Test context before it gets deleted.13 */14public class JGivenReportExtractingExtension extends JGivenExtension {15    private static final Map<Class<?>, ReportModel> modelHolder = new ConcurrentHashMap<>();16    public static Optional<ReportModel> getReportModelFor(Class<?> testClass) {17        return Optional.ofNullable(modelHolder.get(testClass));18    }19    @Override20    public void afterTestExecution(ExtensionContext context) throws Exception {21        Class<?> testClass = context.getTestClass()22            .orElseThrow(() -> new JGivenWrongUsageException("tests without test class are not supported yet"));23        Optional.ofNullable(ScenarioHolder.get())24            .map(ScenarioHolder::getScenarioOfCurrentThread)25            .map(ScenarioBase::getModel)26            .ifPresent(model -> modelHolder.put(testClass, model));27        super.afterTestExecution(context);28    }29}...

Source:ScenarioTestForTesting.java

1package com.tngtech.jgiven.tests;2import com.tngtech.jgiven.impl.Scenario;3import com.tngtech.jgiven.junit.ScenarioTest;4import com.tngtech.jgiven.impl.ScenarioHolder;5import org.junit.jupiter.api.extension.ExtendWith;6@ExtendWith(JGivenReportExtractingExtension.class)7public class ScenarioTestForTesting<GIVEN, WHEN, THEN> extends ScenarioTest<GIVEN,WHEN,THEN> {8    @Override9    public Scenario<GIVEN, WHEN, THEN> getScenario() {10        if ( ScenarioHolder.get().getScenarioOfCurrentThread() != null) {11            return (Scenario<GIVEN, WHEN, THEN>) ScenarioHolder.get().getScenarioOfCurrentThread();12        }13        return super.getScenario();14    }15}...

ScenarioHolder

Using AI Code Generation

1import com.tngtech.jgiven.Stage;2import com.tngtech.jgiven.annotation.ScenarioState;3import com.tngtech.jgiven.impl.ScenarioHolder;4public class WhenSomeAction extends Stage<WhenSomeAction> {5    ScenarioHolder scenarioHolder;6    public WhenSomeAction some_action() {7        scenarioHolder.getScenario().addAttachment("some attachment", "some data");8        return self();9    }10}11import com.tngtech.jgiven.Stage;12import com.tngtech.jgiven.annotation.ScenarioState;13import com.tngtech.jgiven.impl.ScenarioHolder;14public class ThenSomeOutcome extends Stage<ThenSomeOutcome> {15    ScenarioHolder scenarioHolder;16    public ThenSomeOutcome some_outcome() {17        scenarioHolder.getScenario().addAttachment("some attachment", "some data");18        return self();19    }20}21import com.tngtech.jgiven.Stage;22import com.tngtech.jgiven.annotation.ScenarioState;23import com.tngtech.jgiven.impl.ScenarioHolder;24public class GivenSomeState extends Stage<GivenSomeState> {25    ScenarioHolder scenarioHolder;26    public GivenSomeState some_state() {27        scenarioHolder.getScenario().addAttachment("some attachment", "some data");28        return self();29    }30}31import com.tngtech.jgiven.Stage;32import com.tngtech.jgiven.annotation.ScenarioState;33import com.tngtech.jgiven.impl.ScenarioHolder;34public class GivenSomeOtherState extends Stage<GivenSomeOtherState> {35    ScenarioHolder scenarioHolder;36    public GivenSomeOtherState some_other_state() {37        scenarioHolder.getScenario().addAttachment("some attachment", "some data");38        return self();39    }40}41import com.tngtech.jgiven.Stage;42import com.tngtech.jgiven.annotation.ScenarioState;43import com.tngtech.jgiven.impl.ScenarioHolder;

ScenarioHolder

Using AI Code Generation

1import com.tngtech.jgiven.impl.ScenarioHolder;2import com.tngtech.jgiven.impl.ScenarioModel;3import com.tngtech.jgiven.impl.ScenarioModelBuilder;4import java.lang.reflect.Field;5public class 1 {6    public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {7        ScenarioHolder scenarioHolder = new ScenarioHolder();8        ScenarioModel scenarioModel = new ScenarioModelBuilder().build();9        Field scenarioField = ScenarioHolder.class.getDeclaredField("scenario");10        scenarioField.setAccessible(true);11        scenarioField.set(scenarioHolder, scenarioModel);12        scenarioHolder.getScenario().setRunning(true);13        scenarioHolder.getScenario().addStep("First step");14        scenarioHolder.getScenario().addStep("Second step");15        scenarioHolder.getScenario().setRunning(false);16        System.out.println(scenarioHolder.getScenario().getScenarioCaseModel().getSteps());17    }18}19import com.tngtech.jgiven.impl.ScenarioHolder;20import com.tngtech.jgiven.impl.ScenarioModel;21import com.tngtech.jgiven.impl.ScenarioModelBuilder;22import org.junit.Test;23import java.lang.reflect.Field;24public class 2 {25    public void test1() throws NoSuchFieldException, IllegalAccessException {26        ScenarioHolder scenarioHolder = new ScenarioHolder();27        ScenarioModel scenarioModel = new ScenarioModelBuilder().build();28        Field scenarioField = ScenarioHolder.class.getDeclaredField("scenario");29        scenarioField.setAccessible(true);30        scenarioField.set(scenarioHolder, scenarioModel);31        scenarioHolder.getScenario().setRunning(true);32        scenarioHolder.getScenario().addStep("First step");33        scenarioHolder.getScenario().addStep("Second step");34        scenarioHolder.getScenario().setRunning(false);35        System.out.println(scenarioHolder.getScenario().getScenarioCaseModel().getSteps());36    }37}

ScenarioHolder

Using AI Code Generation

1public class ScenarioHolder {2    private static final ThreadLocal<ScenarioModel> scenarioModelThreadLocal = new ThreadLocal<ScenarioModel>();3    public static ScenarioModel getScenario() {4        return scenarioModelThreadLocal.get();5    }6    public static void setScenario(ScenarioModel scenarioModel) {7        scenarioModelThreadLocal.set(scenarioModel);8    }9}10public class StepExecutor {11    private ScenarioModel scenarioModel;12    public void setScenarioModel(ScenarioModel scenarioModel) {13        this.scenarioModel = scenarioModel;14    }15    public void executeStep(StepModel stepModel) {16        ScenarioHolder.setScenario(scenarioModel);17    }18}19public class MyTest {20    public void test() {21        ScenarioModel scenarioModel = new ScenarioModel();22        StepExecutor stepExecutor = new StepExecutor();23        stepExecutor.setScenarioModel(scenarioModel);24        stepExecutor.executeStep(stepModel);25    }26}27public class MyTest {28    public void test() {29        ScenarioModel scenarioModel = new ScenarioModel();30        StepExecutor stepExecutor = new StepExecutor();31        stepExecutor.setScenarioModel(scenarioModel);32        stepExecutor.executeStep(stepModel);33        ScenarioHolder.getScenario();34    }35}36public class MyTest {37    public void test() {38        ScenarioModel scenarioModel = new ScenarioModel();39        StepExecutor stepExecutor = new StepExecutor();40        stepExecutor.setScenarioModel(scenarioModel);41        stepExecutor.executeStep(stepModel);42        ScenarioHolder.getScenario();43    }44}45public class MyTest {46    public void test() {47        ScenarioModel scenarioModel = new ScenarioModel();

ScenarioHolder

Using AI Code Generation

1import com.tngtech.jgiven.impl.ScenarioHolder;2ScenarioHolder holder = new ScenarioHolder();3import com.tngtech.jgiven.impl.ScenarioHolder;4ScenarioHolder holder = new ScenarioHolder();5import com.tngtech.jgiven.impl.ScenarioHolder;6ScenarioHolder holder = new ScenarioHolder();7import com.tngtech.jgiven.impl.ScenarioHolder;8ScenarioHolder holder = new ScenarioHolder();9import com.tngtech.jgiven.impl.ScenarioHolder;10ScenarioHolder holder = new ScenarioHolder();11import com.tngtech.jgiven.impl.ScenarioHolder;12ScenarioHolder holder = new ScenarioHolder();13import com.tngtech.jgiven.impl.ScenarioHolder;14ScenarioHolder holder = new ScenarioHolder();15import com.tngtech.jgiven.impl.ScenarioHolder;16ScenarioHolder holder = new ScenarioHolder();17import com.tngtech.jgiven.impl.ScenarioHolder;18ScenarioHolder holder = new ScenarioHolder();19import com.tngtech.jgiven.impl.ScenarioHolder;20ScenarioHolder holder = new ScenarioHolder();21import com.tngtech.jgiven.impl.ScenarioHolder;22ScenarioHolder holder = new ScenarioHolder();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.