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

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

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

Source:ScenarioModelBuilder.java

...92                method.getParameterAnnotations());93        setArguments(parameterFormattingUtil.toStringList(formatter, getValues(namedArguments)));94        setCaseDescription(testClass, method, namedArguments);95    }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) {...

Source:MockScenarioModelBuilder.java

...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()) {...

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.