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

How to use Scenario method of com.tngtech.jgiven.impl.Scenario class

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

Source:MockScenarioModelBuilder.java

...14import com.tngtech.jgiven.config.TagConfiguration;15import com.tngtech.jgiven.exception.JGivenWrongUsageException;16import com.tngtech.jgiven.format.ObjectFormatter;17import com.tngtech.jgiven.impl.Config;18import com.tngtech.jgiven.impl.ScenarioModelBuilder;19import com.tngtech.jgiven.impl.util.AssertionUtil;20import com.tngtech.jgiven.impl.util.WordUtil;21import com.tngtech.jgiven.report.model.*;22import xyz.multicatch.mockgiven.core.annotations.as.AsProviderFactory;23import xyz.multicatch.mockgiven.core.annotations.caseas.CaseAsFactory;24import xyz.multicatch.mockgiven.core.annotations.caseas.CaseAsProviderFactory;25import xyz.multicatch.mockgiven.core.annotations.description.AnnotatedDescriptionFactory;26import xyz.multicatch.mockgiven.core.annotations.description.DescriptionData;27import xyz.multicatch.mockgiven.core.annotations.description.DescriptionQueue;28import xyz.multicatch.mockgiven.core.annotations.description.InlineWithNext;29import xyz.multicatch.mockgiven.core.annotations.tag.AnnotationTagExtractor;30import xyz.multicatch.mockgiven.core.annotations.tag.AnnotationTagUtils;31import xyz.multicatch.mockgiven.core.resources.TextResourceProvider;32import xyz.multicatch.mockgiven.core.scenario.cases.CaseDescription;33import xyz.multicatch.mockgiven.core.scenario.cases.CaseDescriptionFactory;34import xyz.multicatch.mockgiven.core.scenario.cases.ExtendedScenarioCaseModel;35import xyz.multicatch.mockgiven.core.scenario.methods.DescriptionFactory;36import xyz.multicatch.mockgiven.core.scenario.methods.arguments.ArgumentUtils;37import xyz.multicatch.mockgiven.core.scenario.methods.arguments.ParameterFormatterFactory;38import xyz.multicatch.mockgiven.core.scenario.methods.arguments.ParameterFormatterUtils;39import xyz.multicatch.mockgiven.core.scenario.state.CurrentScenarioState;40import xyz.multicatch.mockgiven.core.scenario.steps.ExtendedStepModel;41import xyz.multicatch.mockgiven.core.scenario.steps.StepCommentFactory;42import xyz.multicatch.mockgiven.core.scenario.steps.StepModelFactory;43import xyz.multicatch.mockgiven.core.utils.ExceptionUtils;44public class MockScenarioModelBuilder extends ScenarioModelBuilder {45    private static final Set<String> STACK_TRACE_FILTER = ImmutableSet46            .of("sun.reflect", "com.tngtech.jgiven.impl.intercept", "com.tngtech.jgiven.impl.intercept", "$$EnhancerByCGLIB$$",47                    "java.lang.reflect", "net.sf.cglib.proxy", "com.sun.proxy");48    private static final boolean FILTER_STACK_TRACE = Config.config()49                                                            .filterStackTrace();50    private final Stack<ExtendedStepModel> parentSteps = new Stack<>();51    private final CurrentScenarioState currentScenarioState;52    private final StepCommentFactory stepCommentFactory;53    private final DescriptionFactory descriptionFactory;54    private final CaseDescriptionFactory caseDescriptionFactory;55    private final DescriptionQueue descriptionQueue;56    private AbstractJGivenConfiguration configuration;57    private StepModelFactory stepModelFactory;58    private AnnotationTagExtractor annotationTagExtractor;59    private ParameterFormatterFactory formatterFactory;60    private ExtendedScenarioModel scenarioModel;61    private ExtendedScenarioCaseModel scenarioCaseModel;62    private ExtendedStepModel currentStep;63    private Word introWord;64    private long scenarioStartedNanos;65    private ReportModel reportModel;66    public MockScenarioModelBuilder(CurrentScenarioState currentScenarioState, TextResourceProvider textResourceProvider) {67        this.currentScenarioState = currentScenarioState;68        this.stepCommentFactory = new StepCommentFactory();69        this.descriptionFactory = new DescriptionFactory(new AsProviderFactory(), new AnnotatedDescriptionFactory(), textResourceProvider);70        this.caseDescriptionFactory = new CaseDescriptionFactory(new CaseAsFactory(), new CaseAsProviderFactory());71        this.descriptionQueue = new DescriptionQueue();72        this.configuration = new DefaultConfiguration();73        initializeDependentOnConfiguration();74    }75    public MockScenarioModelBuilder(76            CurrentScenarioState currentScenarioState,77            StepCommentFactory stepCommentFactory,78            DescriptionFactory descriptionFactory,79            CaseDescriptionFactory caseDescriptionFactory,80            DescriptionQueue descriptionQueue81    ) {82        this.currentScenarioState = currentScenarioState;83        this.stepCommentFactory = stepCommentFactory;84        this.descriptionFactory = descriptionFactory;85        this.caseDescriptionFactory = caseDescriptionFactory;86        this.descriptionQueue = descriptionQueue;87        this.configuration = new DefaultConfiguration();88        initializeDependentOnConfiguration();89    }90    private void initializeDependentOnConfiguration() {91        formatterFactory = new ParameterFormatterFactory(configuration);92        stepModelFactory = new StepModelFactory(currentScenarioState, formatterFactory, descriptionFactory);93        annotationTagExtractor = AnnotationTagExtractor.forConfig(configuration);94    }95    @Override96    public void scenarioStarted(String description) {97        scenarioStartedNanos = System.nanoTime();98        String readableDescription = description;99        if (description.contains("_")) {100            readableDescription = description.replace('_', ' ');101        } else if (!description.contains(" ")) {102            readableDescription = WordUtil.camelCaseToCapitalizedReadableText(description);103        }104        scenarioCaseModel = new ExtendedScenarioCaseModel();105        scenarioModel = new ExtendedScenarioModel();106        scenarioModel.addCase(scenarioCaseModel);107        scenarioModel.setDescription(readableDescription);108    }109    @Override110    public void addStepMethod(111            Method paramMethod,112            List<NamedArgument> arguments,113            InvocationMode mode,114            boolean hasNestedSteps115    ) {116        ExtendedStepModel stepModel = stepModelFactory.create(paramMethod, arguments, mode, introWord);117        DescriptionData description = DescriptionData.of(stepModel);118        descriptionQueue.add(description);119        if (introWord != null) {120            introWord = null;121        }122        if (!paramMethod.isAnnotationPresent(InlineWithNext.class)) {123            stepModel.setDescription(descriptionQueue.join());124            if (parentSteps.empty()) {125                getCurrentScenarioCase().addStep(stepModel);126            } else {127                parentSteps.peek()128                           .addNestedStep(stepModel);129            }130            if (hasNestedSteps) {131                parentSteps.push(stepModel);132            }133            currentStep = stepModel;134        }135    }136    @Override137    public void introWordAdded(String value) {138        introWord = new Word();139        introWord.setIntroWord(true);140        introWord.setValue(value);141    }142    @Override143    public void stepCommentAdded(List<NamedArgument> arguments) {144        if (currentStep == null) {145            throw new JGivenWrongUsageException("A step comment must be added after the corresponding step, "146                    + "but no step has been executed yet.");147        }148        currentStep.setComment(stepCommentFactory.create(arguments));149    }150    private ScenarioCaseModel getCurrentScenarioCase() {151        if (scenarioCaseModel == null) {152            scenarioStarted("A Scenario");153        }154        return scenarioCaseModel;155    }156    @Override157    public void stepMethodInvoked(158            Method method,159            List<NamedArgument> arguments,160            InvocationMode mode,161            boolean hasNestedSteps162    ) {163        if (method.isAnnotationPresent(IntroWord.class)) {164            introWordAdded(descriptionFactory.create(currentScenarioState.getCurrentStage(), method));165        } else if (method.isAnnotationPresent(StepComment.class)) {166            stepCommentAdded(arguments);167        } else {168            addTags(method.getAnnotations());169            addTags(method.getDeclaringClass()170                          .getAnnotations());171            addStepMethod(method, arguments, mode, hasNestedSteps);172        }173    }174    @Override175    public void stepMethodFailed(Throwable t) {176        if (currentStep != null) {177            currentStep.setStatus(StepStatus.FAILED);178        }179    }180    @Override181    public void stepMethodFinished(182            long durationInNanos,183            boolean hasNestedSteps184    ) {185        if (hasNestedSteps && !parentSteps.isEmpty()) {186            currentStep = parentSteps.peek();187        }188        if (currentStep != null) {189            currentStep.setDurationInNanos(durationInNanos);190            if (hasNestedSteps) {191                if (currentStep.getStatus() != StepStatus.FAILED) {192                    currentStep.inheritStatusFromNested();193                }194                parentSteps.pop();195            }196        }197        if (!hasNestedSteps && !parentSteps.isEmpty()) {198            currentStep = parentSteps.peek();199        }200    }201    @Override202    public void scenarioFailed(Throwable e) {203        scenarioCaseModel.setException(e, getStackTrace(e));204    }205    private List<String> getStackTrace(Throwable throwable) {206        if (FILTER_STACK_TRACE) {207            return ExceptionUtils.getFilteredStackTrace(throwable, STACK_TRACE_FILTER);208        } else {209            return ExceptionUtils.getStackTrace(throwable);210        }211    }212    @Override213    public void scenarioStarted(214            Class<?> testClass,215            Method method,216            List<NamedArgument> namedArguments217    ) {218        readConfiguration(testClass);219        readAnnotations(testClass, method);220        scenarioModel.setClassName(testClass.getName());221        scenarioModel.setExplicitParametersWithoutUnderline(ArgumentUtils.getNames(namedArguments));222        scenarioModel.setTestMethodName(method.getName());223        List<ObjectFormatter<?>> formatter = formatterFactory.create(method.getParameters(), namedArguments);224        List<String> arguments = ParameterFormatterUtils.toStringList(formatter, ArgumentUtils.getValues(namedArguments));225        scenarioCaseModel.setExplicitArguments(arguments);226        setCaseDescription(testClass, method, namedArguments);227    }228    private void readConfiguration(Class<?> testClass) {229        configuration = ConfigurationUtil.getConfiguration(testClass);230        initializeDependentOnConfiguration();231    }232    private void readAnnotations(233            Class<?> testClass,234            Method method235    ) {236        String scenarioDescription = descriptionFactory.create(currentScenarioState.getCurrentStage(), method);237        scenarioStarted(scenarioDescription);238        if (method.isAnnotationPresent(ExtendedDescription.class)) {239            scenarioModel.setExtendedDescription(method.getAnnotation(ExtendedDescription.class)240                                                       .value());241        }242        if (method.isAnnotationPresent(NotImplementedYet.class) || method.isAnnotationPresent(Pending.class)) {243            scenarioCaseModel.setStatus(ExecutionStatus.SCENARIO_PENDING);244        }245        if (scenarioCaseModel.isFirstCase()) {246            addTags(testClass.getAnnotations());247            addTags(method.getAnnotations());248        }249    }250    private void setCaseDescription(251            Class<?> testClass,252            Method method,253            List<NamedArgument> namedArguments254    ) {255        CaseDescription caseDescription = caseDescriptionFactory.create(method, testClass, scenarioCaseModel, namedArguments);256        if (caseDescription != null) {257            String description = caseDescriptionFactory.create(caseDescription, scenarioCaseModel.getExplicitArguments());258            scenarioCaseModel.setDescription(description);259        }260    }261    public void addTags(Annotation... annotations) {262        for (Annotation annotation : annotations) {263            addTags(annotationTagExtractor.extract(annotation));264        }265    }266    private void addTags(List<Tag> tags) {267        if (!tags.isEmpty()) {268            if (reportModel != null) {269                this.reportModel.addTags(tags);270            }271            if (scenarioModel != null) {272                this.scenarioModel.addTags(tags);273            }274        }275    }276    @Override277    public void scenarioFinished() {278        AssertionUtil.assertTrue(scenarioStartedNanos > 0, "Scenario has no start time");279        long durationInNanos = System.nanoTime() - scenarioStartedNanos;280        scenarioCaseModel.setDurationInNanos(durationInNanos);281        scenarioModel.addDurationInNanos(durationInNanos);282        reportModel.addScenarioModelOrMergeWithExistingOne(scenarioModel);283    }284    @Override285    public void attachmentAdded(Attachment attachment) {286        currentStep.setAttachment(attachment);287    }288    @Override289    public void extendedDescriptionUpdated(String extendedDescription) {290        currentStep.setExtendedDescription(extendedDescription);291    }292    @Override293    public void sectionAdded(String sectionTitle) {294        StepModel stepModel = new StepModel();295        stepModel.setName(sectionTitle);296        stepModel.addWords(new Word(sectionTitle));297        stepModel.setIsSectionTitle(true);298        getCurrentScenarioCase().addStep(stepModel);299    }300    @Override301    public void tagAdded(302            Class<? extends Annotation> annotationClass,303            String... values304    ) {305        TagConfiguration tagConfig = annotationTagExtractor.toTagConfiguration(annotationClass);306        List<Tag> tags = AnnotationTagUtils.toTags(tagConfig, null);307        if (!tags.isEmpty()) {308            if (values.length > 0) {309                addTags(AnnotationTagUtils.getExplodedTags(Iterables.getOnlyElement(tags), values, null, tagConfig));310            } else {311                addTags(tags);312            }313        }314    }315    public void setReportModel(ReportModel reportModel) {316        this.reportModel = reportModel;317    }318    public ReportModel getReportModel() {319        return reportModel;320    }321    public ScenarioModel getScenarioModel() {322        return scenarioModel;323    }324    public ScenarioCaseModel getScenarioCaseModel() {325        return scenarioCaseModel;326    }327}...

Source:MockScenarioExecutor.java

2import java.lang.reflect.Constructor;3import java.lang.reflect.Field;4import java.lang.reflect.InvocationTargetException;5import org.mockito.MockitoAnnotations;6import com.tngtech.jgiven.annotation.ScenarioStage;7import com.tngtech.jgiven.impl.ScenarioExecutor;8import com.tngtech.jgiven.impl.intercept.StageInterceptorInternal;9import com.tngtech.jgiven.impl.intercept.StepInterceptor;10import com.tngtech.jgiven.impl.util.FieldCache;11import com.tngtech.jgiven.impl.util.ReflectionUtil;12import xyz.multicatch.mockgiven.core.scenario.creator.ByteBuddyStageClassCreator;13public class MockScenarioExecutor extends ScenarioExecutor {14    private final ByteBuddyStageClassCreator byteBuddyStageClassCreator = new ByteBuddyStageClassCreator();15    @SuppressWarnings("unchecked")16    public <T> T assertInterception(17            Class<T> type,18            Object constructorParam19    ) {20        try {21            Class<? extends T> interceptableAssertion = byteBuddyStageClassCreator.createStageClass(type);22            Constructor<?>[] constructors = interceptableAssertion.getDeclaredConstructors();23            T result = null;24            for (Constructor constructor : constructors) {25                if (constructor.getParameterCount() == 1) {26                    result = (T) constructor.newInstance(constructorParam);27                }28            }29            setStepInterceptor(result, methodInterceptor);30            stages.put(type, createStageState(result));31            return result;32        } catch (Error e) {33            throw e;34        } catch (Exception e) {35            throw new RuntimeException("Error while trying to create an instance of class " + type, e);36        }37    }38    protected StageState createStageState(Object instance) throws IllegalAccessException, InvocationTargetException, InstantiationException {39        Constructor<?> constructor = StageState.class.getDeclaredConstructors()[0];40        constructor.setAccessible(true);41        return (StageState) constructor.newInstance(instance);42    }43    protected <T> void setStepInterceptor(44            T result,45            StepInterceptor stepInterceptor46    ) {47        ((StageInterceptorInternal) result).__jgiven_setStepInterceptor(stepInterceptor);48    }49    @SuppressWarnings("unchecked")50    public void injectStages(Object stage) {51        for (Field field : FieldCache.get(stage.getClass())52                                     .getFieldsWithAnnotation(ScenarioStage.class)) {53            Object steps = addStage(field.getType());54            ReflectionUtil.setField(field, stage, steps, ", annotated with @ScenarioStage");55        }56        MockitoAnnotations.initMocks(stage);57    }58}

Source:WhenFeiertagAction.java

1package de.limago.zeiterfassung.services.feiertage.test.stages;2import java.util.List;3import org.springframework.beans.factory.annotation.Autowired;4import com.tngtech.jgiven.Stage;5import com.tngtech.jgiven.annotation.ProvidedScenarioState;6import com.tngtech.jgiven.integration.spring.JGivenStage;7import de.limago.zeiterfassung.services.feiertage.Bundesland;8import de.limago.zeiterfassung.services.feiertage.Feiertag;9import de.limago.zeiterfassung.services.feiertage.FeiertagServiceImpl;10@JGivenStage11public class WhenFeiertagAction extends Stage<WhenFeiertagAction>{12	13	@Autowired14	private FeiertagServiceImpl objectUnderTest;15	@ProvidedScenarioState16	private int jahr;17	18	@ProvidedScenarioState19	private Bundesland bundesland;20	21	@ProvidedScenarioState22	private List<Feiertag> feiertage;23	24	public void calculate_holidays() throws Exception{25		feiertage = objectUnderTest.berechneFeiertageFuerJahrUndBundesland(jahr, bundesland);26	}27}

Scenario

Using AI Code Generation

1package com.tngtech.jgiven.example;2import com.tngtech.jgiven.Stage;3import com.tngtech.jgiven.annotation.ScenarioState;4import com.tngtech.jgiven.annotation.ScenarioStage;5import com.tngtech.jgiven.impl.Scenario;6import com.tngtech.jgiven.junit.SimpleScenarioTest;7public class SimpleScenarioTestExample extends SimpleScenarioTest<SimpleScenarioTestExample.SimpleTestStage> {8    SimpleTestStage testStage;9    public void testMethod() throws Exception {10        testStage.given().something();11        testStage.when().something_happens();12        testStage.then().something_should_happen();13        Scenario scenario = new Scenario();14        scenario.given().something();15        scenario.when().something_happens();16        scenario.then().something_should_happen();17    }18    public static class SimpleTestStage extends Stage<SimpleTestStage> {19        String aString;20        public SimpleTestStage something() {21            aString = "something";22            return self();23        }24        public SimpleTestStage something_happens() {25            aString = aString + " happens";26            return self();27        }28        public SimpleTestStage something_should_happen() {29            aString = aString + " should happen";30            return self();31        }32    }33}34package com.tngtech.jgiven.example;35import com.tngtech.jgiven.Stage;36import com.tngtech.jgiven.annotation.ScenarioState;37import com.tngtech.jgiven.annotation.ScenarioStage;38import com.tngtech.jgiven.impl.Scenario;39import com.tngtech.jgiven.junit.SimpleScenarioTest;40public class SimpleScenarioTestExample extends SimpleScenarioTest<SimpleScenarioTestExample.SimpleTestStage> {41    SimpleTestStage testStage;42    public void testMethod() throws Exception {43        testStage.given().something();44        testStage.when().something_happens();45        testStage.then().something_should_happen();46        Scenario scenario = new Scenario();47        scenario.given().something();48        scenario.when().something_happens();49        scenario.then().something_should_happen();50    }51    public static class SimpleTestStage extends Stage<SimpleTestStage> {52        String aString;53        public SimpleTestStage something() {

Scenario

Using AI Code Generation

1import com.tngtech.jgiven.impl.Scenario;2public class Test {3    public static void main(String[] args) {4        Scenario scenario = Scenario.createScenario();5        System.out.println(scenario);6    }7}8The Scenario class has a static method createScenario() which returns an instance of Scenario class. This method is used to create Scenario object. The createScenario() method has the following signature:9public static Scenario createScenario()10The Scenario class also has a method called withTitle() which is used to set the title of the scenario. The withTitle() method has the following signature:11public Scenario withTitle(String title)12The Scenario class also has a method called withDescription() which is used to set the description of the scenario. The withDescription() method has the following signature:13public Scenario withDescription(String description)14The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:15public Scenario withTags(String... tags)16The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:17public Scenario withTags(List<String> tags)18The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:19public Scenario withTags(Iterable<String> tags)20The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:21public Scenario withTags(Iterable<String> tags)22The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:23public Scenario withTags(Iterable<String> tags)24The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:25public Scenario withTags(Iterable<String> tags)26The Scenario class also has a method called withTags() which is used to set the tags of the scenario. The withTags() method has the following signature:27public Scenario withTags(Iterable<String> tags)28The Scenario class also has a method called withTags() which is used to set the tags

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.