How to use getCurrentScenarioCase method of com.tngtech.jgiven.impl.ScenarioModelBuilder class

Best JGiven code snippet using com.tngtech.jgiven.impl.ScenarioModelBuilder.getCurrentScenarioCase

Source:ScenarioModelBuilder.java

...96    private void addStepMethod(Method paramMethod, List<NamedArgument> arguments, InvocationMode mode,97                               boolean hasNestedSteps) {98        StepModel stepModel = createStepModel(paramMethod, arguments, mode);99        if (parentSteps.empty()) {100            getCurrentScenarioCase().addStep(stepModel);101        } else {102            parentSteps.peek().addNestedStep(stepModel);103        }104        if (hasNestedSteps) {105            parentSteps.push(stepModel);106            discrepancyOnLayer.push(0);107        }108        currentStep = stepModel;109    }110    StepModel createStepModel(Method paramMethod, List<NamedArgument> arguments, InvocationMode mode) {111        StepModel stepModel = new StepModel();112        stepModel.setName(getDescription(paramMethod));113        ExtendedDescription extendedDescriptionAnnotation = paramMethod.getAnnotation(ExtendedDescription.class);114        if (extendedDescriptionAnnotation != null) {115            stepModel.setExtendedDescription(extendedDescriptionAnnotation.value());116        }117        List<NamedArgument> nonHiddenArguments =118            filterHiddenArguments(arguments, paramMethod.getParameterAnnotations());119        ParameterFormattingUtil parameterFormattingUtil = new ParameterFormattingUtil(configuration);120        List<ObjectFormatter<?>> formatters =121            parameterFormattingUtil.getFormatter(paramMethod.getParameterTypes(), getNames(arguments),122                paramMethod.getParameterAnnotations());123        new StepFormatter(stepModel.getName(), nonHiddenArguments, formatters).buildFormattedWords()124            .forEach(sentenceBuilder::addWord);125        stepModel.setWords(sentenceBuilder.getWords());126        sentenceBuilder.clear();127        stepModel.setStatus(mode.toStepStatus());128        return stepModel;129    }130    private List<NamedArgument> filterHiddenArguments(List<NamedArgument> arguments,131                                                      Annotation[][] parameterAnnotations) {132        List<NamedArgument> result = Lists.newArrayList();133        for (int i = 0; i < parameterAnnotations.length; i++) {134            if (!AnnotationUtil.isHidden(parameterAnnotations[i])) {135                result.add(arguments.get(i));136            }137        }138        return result;139    }140    @Override141    public void introWordAdded(String value) {142        sentenceBuilder.addIntroWord(value);143    }144    private void addToSentence(String value, boolean joinToPreviousWord, boolean joinToNextWord) {145        if (!sentenceBuilder.hasWords() && currentStep != null && joinToPreviousWord) {146            currentStep.getLastWord().addSuffix(value);147        } else {148            sentenceBuilder.addWord(value, joinToPreviousWord, joinToNextWord);149        }150    }151    private void addStepComment(List<NamedArgument> arguments) {152        if (arguments == null || arguments.size() != 1) {153            throw new JGivenWrongUsageException("A step comment method must have exactly one parameter.");154        }155        if (!(arguments.get(0).getValue() instanceof String)) {156            throw new JGivenWrongUsageException("The step comment method parameter must be a string.");157        }158        if (currentStep == null) {159            throw new JGivenWrongUsageException("A step comment must be added after the corresponding step, "160                + "but no step has been executed yet.");161        }162        stepCommentUpdated((String) arguments.get(0).getValue());163    }164    @Override165    public void stepCommentUpdated(String comment) {166        currentStep.setComment(comment);167    }168    private ScenarioCaseModel getCurrentScenarioCase() {169        if (scenarioCaseModel == null) {170            scenarioStarted("A Scenario");171        }172        return scenarioCaseModel;173    }174    private void incrementDiscrepancy() {175        int discrepancyOnCurrentLayer = discrepancyOnLayer.pop();176        discrepancyOnCurrentLayer++;177        discrepancyOnLayer.push(discrepancyOnCurrentLayer);178    }179    private void decrementDiscrepancy() {180        if (discrepancyOnLayer.peek() > 0) {181            int discrepancyOnCurrentLayer = discrepancyOnLayer.pop();182            discrepancyOnCurrentLayer--;183            discrepancyOnLayer.push(discrepancyOnCurrentLayer);184        }185    }186    @Override187    public void stepMethodInvoked(Method method, List<NamedArgument> arguments, InvocationMode mode,188                                  boolean hasNestedSteps) {189        if (method.isAnnotationPresent(IntroWord.class)) {190            introWordAdded(getDescription(method));191            incrementDiscrepancy();192        } else if (method.isAnnotationPresent(FillerWord.class)) {193            FillerWord fillerWord = method.getAnnotation(FillerWord.class);194            addToSentence(getDescription(method), fillerWord.joinToPreviousWord(), fillerWord.joinToNextWord());195            incrementDiscrepancy();196        } else if (method.isAnnotationPresent(StepComment.class)) {197            addStepComment(arguments);198            incrementDiscrepancy();199        } else {200            addTags(method.getAnnotations());201            addTags(method.getDeclaringClass().getAnnotations());202            addStepMethod(method, arguments, mode, hasNestedSteps);203        }204    }205    public void setMethodName(String methodName) {206        scenarioModel.setTestMethodName(methodName);207    }208    public void setArguments(List<String> arguments) {209        scenarioCaseModel.setExplicitArguments(arguments);210    }211    public void setParameterNames(List<String> parameterNames) {212        scenarioModel.setExplicitParameters(removeUnderlines(parameterNames));213    }214    private static List<String> removeUnderlines(List<String> parameterNames) {215        List<String> result = Lists.newArrayListWithCapacity(parameterNames.size());216        for (String paramName : parameterNames) {217            result.add(WordUtil.fromSnakeCase(paramName));218        }219        return result;220    }221    private String getDescription(Method paramMethod) {222        if (paramMethod.isAnnotationPresent(Hidden.class)) {223            return "";224        }225        Description description = paramMethod.getAnnotation(Description.class);226        if (description != null) {227            return description.value();228        }229        As as = paramMethod.getAnnotation(As.class);230        AsProvider provider = as != null231            ? ReflectionUtil.newInstance(as.provider())232            : new DefaultAsProvider();233        return provider.as(as, paramMethod);234    }235    public void setStatus(ExecutionStatus status) {236        scenarioCaseModel.setStatus(status);237    }238    private void setException(Throwable throwable) {239        scenarioCaseModel.setErrorMessage(throwable.getClass().getName() + ": " + throwable.getMessage());240        scenarioCaseModel.setStackTrace(getStackTrace(throwable, FILTER_STACK_TRACE));241    }242    private List<String> getStackTrace(Throwable exception, boolean filterStackTrace) {243        StackTraceElement[] stackTraceElements = exception.getStackTrace();244        ArrayList<String> stackTrace = new ArrayList<>(stackTraceElements.length);245        outer:246        for (StackTraceElement element : stackTraceElements) {247            if (filterStackTrace) {248                for (String filter : STACK_TRACE_FILTER) {249                    if (element.getClassName().contains(filter)) {250                        continue outer;251                    }252                }253            }254            stackTrace.add(element.toString());255        }256        return stackTrace;257    }258    @Override259    public void stepMethodFailed(Throwable t) {260        if (currentStep != null) {261            currentStep.setStatus(StepStatus.FAILED);262        }263    }264    @Override265    public void stepMethodFinished(long durationInNanos, boolean hasNestedSteps) {266        if (hasNestedSteps && !parentSteps.isEmpty()) {267            currentStep = parentSteps.peek();268        }269        if (currentStep != null) {270            if (discrepancyOnLayer.empty() || discrepancyOnLayer.peek() == 0) {271                currentStep.setDurationInNanos(durationInNanos);272            }273            if (hasNestedSteps) {274                if (currentStep.getStatus() != StepStatus.FAILED) {275                    currentStep.setStatus(getStatusFromNestedSteps(currentStep.getNestedSteps()));276                }277                parentSteps.pop();278                discrepancyOnLayer.pop();279            }280        }281        if (!hasNestedSteps && !parentSteps.isEmpty()) {282            currentStep = parentSteps.peek();283        }284        decrementDiscrepancy();285    }286    private StepStatus getStatusFromNestedSteps(List<StepModel> nestedSteps) {287        StepStatus status = StepStatus.PASSED;288        for (StepModel nestedModel : nestedSteps) {289            StepStatus nestedStatus = nestedModel.getStatus();290            switch (nestedStatus) {291                case FAILED:292                    return StepStatus.FAILED;293                case PENDING:294                    status = StepStatus.PENDING;295                    break;296                default:297            }298        }299        return status;300    }301    @Override302    public void scenarioFailed(Throwable e) {303        setStatus(ExecutionStatus.FAILED);304        setException(e);305    }306    private void setCaseDescription(Class<?> testClass, Method method, List<NamedArgument> namedArguments) {307        CaseAs annotation = null;308        if (method.isAnnotationPresent(CaseAs.class)) {309            annotation = method.getAnnotation(CaseAs.class);310        } else if (testClass.isAnnotationPresent(CaseAs.class)) {311            annotation = testClass.getAnnotation(CaseAs.class);312        }313        if (annotation != null) {314            CaseAsProvider caseDescriptionProvider = ReflectionUtil.newInstance(annotation.provider());315            String value = annotation.value();316            List<?> values;317            if (annotation.formatValues()) {318                values = scenarioCaseModel.getExplicitArguments();319            } else {320                values = getValues(namedArguments);321            }322            String caseDescription = caseDescriptionProvider.as(value, scenarioModel.getExplicitParameters(), values);323            scenarioCaseModel.setDescription(caseDescription);324        }325    }326    private List<Object> getValues(List<NamedArgument> namedArguments) {327        List<Object> result = Lists.newArrayList();328        for (NamedArgument a : namedArguments) {329            result.add(a.value);330        }331        return result;332    }333    private List<String> getNames(List<NamedArgument> namedArguments) {334        List<String> result = Lists.newArrayList();335        for (NamedArgument a : namedArguments) {336            result.add(a.name);337        }338        return result;339    }340    private void readConfiguration(Class<?> testClass) {341        configuration = ConfigurationUtil.getConfiguration(testClass);342    }343    private void readAnnotations(Class<?> testClass, Method method) {344        String scenarioDescription = method.getName();345        if (method.isAnnotationPresent(Description.class)) {346            scenarioDescription = method.getAnnotation(Description.class).value();347        } else if (method.isAnnotationPresent(As.class)) {348            As as = method.getAnnotation(As.class);349            AsProvider provider = ReflectionUtil.newInstance(as.provider());350            scenarioDescription = provider.as(as, method);351        }352        scenarioStarted(scenarioDescription);353        if (method.isAnnotationPresent(ExtendedDescription.class)) {354            scenarioModel.setExtendedDescription(method.getAnnotation(ExtendedDescription.class).value());355        }356        if (method.isAnnotationPresent(Pending.class)357            || method.getDeclaringClass().isAnnotationPresent(Pending.class)) {358            scenarioCaseModel.setStatus(ExecutionStatus.SCENARIO_PENDING);359        }360        if (scenarioCaseModel.getCaseNr() == 1) {361            addTags(testClass.getAnnotations());362            addTags(method.getAnnotations());363        }364    }365    @Override366    public void scenarioFinished() {367        AssertionUtil.assertTrue(scenarioStartedNanos > 0, "Scenario has no start time");368        long durationInNanos = System.nanoTime() - scenarioStartedNanos;369        scenarioCaseModel.setDurationInNanos(durationInNanos);370        scenarioModel.addDurationInNanos(durationInNanos);371        reportModel.addScenarioModelOrMergeWithExistingOne(scenarioModel);372    }373    @Override374    public void attachmentAdded(Attachment attachment) {375        currentStep.addAttachment(attachment);376    }377    @Override378    public void extendedDescriptionUpdated(String extendedDescription) {379        currentStep.setExtendedDescription(extendedDescription);380    }381    @Override382    public void stepNameUpdated(String newStepName) {383        List<Word> newWords = Lists.newArrayList();384        for (Word word : currentStep.getWords()) {385            if (word.isIntroWord()) {386                newWords.add(word);387            }388        }389        newWords.add(new Word(newStepName));390        currentStep.setWords(newWords);391        currentStep.setName(newStepName);392    }393    @Override394    public void sectionAdded(String sectionTitle) {395        StepModel stepModel = new StepModel();396        stepModel.setName(sectionTitle);397        stepModel.addWords(new Word(sectionTitle));398        stepModel.setIsSectionTitle(true);399        getCurrentScenarioCase().addStep(stepModel);400    }401    @Override402    public void tagAdded(Class<? extends Annotation> annotationClass, String... values) {403        addTags(tagCreator.toTags(annotationClass, values));404    }405    private void addTags(Annotation... annotations) {406        for (Annotation annotation : annotations) {407            addTags(tagCreator.toTags(annotation));408        }409    }410    private void addTags(ResolvedTags tags) {411        if (tags.isEmpty()) {412            return;413        }...

Source:MockScenarioModelBuilder.java

...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            }...

getCurrentScenarioCase

Using AI Code Generation

1package com.jgiven.examples;2import com.tngtech.jgiven.Stage;3import com.tngtech.jgiven.annotation.ExpectedScenarioState;4import com.tngtech.jgiven.annotation.ProvidedScenarioState;5import com.tngtech.jgiven.annotation.ScenarioState;6import com.tngtech.jgiven.annotation.ScenarioRule;7import com.tngtech.jgiven.junit.ScenarioTest;8import com.tngtech.jgiven.report.model.ScenarioCaseModel;9import com.tngtech.jgiven.report.model.ScenarioModel;10import org.junit.Rule;11import org.junit.Test;12import java.util.List;13import static org.assertj.core.api.Assertions.assertThat;14public class ScenarioCaseTest extends ScenarioTest<GivenStage, WhenStage, ThenStage> {15    public void my_first_scenario() {16        given().a_$_given_stat

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.