Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

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

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

Source:ScenarioModelBuilder.java

...80    }81    @Override82    public void scenarioStarted(Class<?> testClass, Method method, List<NamedArgument> namedArguments) {83        readConfiguration(testClass);84        readAnnotations(testClass, method);85        scenarioModel.setClassName(testClass.getName());86        setParameterNames(getNames(namedArguments));87        // must come at last88        setMethodName(method.getName());89        ParameterFormattingUtil parameterFormattingUtil = new ParameterFormattingUtil(configuration);90        List<ObjectFormatter<?>> formatter =91            parameterFormattingUtil.getFormatter(method.getParameterTypes(), getNames(namedArguments),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) {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)) {...

Source:MockScenarioModelBuilder.java

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

readAnnotations

Using AI Code Generation

1package com.tngtech.jgiven.impl;2import com.tngtech.jgiven.annotation.As;3import com.tngtech.jgiven.annotation.CaseAs;4import com.tngtech.jgiven.annotation.CasesAs;5import com.tngtech.jgiven.annotation.Hidden;6import com.tngtech.jgiven.annotation.Ignored;7import com.tngtech.jgiven.annotation.IsTag;8import com.tngtech.jgiven.annotation.Quoted;9import com.tngtech.jgiven.annotation.ScenarioState;10import com.tngtech.jgiven.annotation.Table;11import com.tngtech.jgiven.annotation.TableHeader;12import com.tngtech.jgiven.annotation.TableRow;13import com.tngtech.jgiven.annotation.TableRows;14import com.tngtech.jgiven.annotation.TableValue;15import com.tngtech.jgiven.annotation.Tag;16import com.tngtech.jgiven.annotation.Tags;17import com.tngtech.jgiven.annotation.TestDescription;18import com.tngtech.jgiven.annotation.UndefinedStep;19import com.tngtech.jgiven.annotation.UseAsName;20import com.tngtech.jgiven.annotation.Var;21import com.tngtech.jgiven.annotation.Variables;22import com.tngtech.jgiven.config.AbstractJGivenConfiguration;23import com.tngtech.jgiven.config.Configuration;24import com.tngtech.jgiven.config.JGivenConfiguration;25import com.tngtech.jgiven.config.JGivenConfigurationBuilder;26import com.tngtech.jgiven.config.JGivenConfigurationProvider;27import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategy;28import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyService;29import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyServiceLoader;30import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategySystemProperty;31import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfig;32import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigFile;33import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigFileLocation;34import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigFileLocationProperty;35import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigFileProperty;36import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigProperty;37import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigPropertyFile;38import com.tngtech.jgiven.config.JGivenConfigurationProviderStrategyUserConfigPropertyFileLocation;39import com.tng

readAnnotations

Using AI Code Generation

1import com.tngtech.jgiven.impl.ScenarioModelBuilder;2import com.tngtech.jgiven.impl.util.AnnotationUtil;3import java.lang.reflect.Method;4import java.util.List;5public class 1 {6    public static void main(String[] args) throws Exception {7        String path = "com.tngtech.jgiven.impl.ScenarioModelBuilder";8        Class<?> clazz = Class.forName(path);9        Method method = clazz.getDeclaredMethod("readAnnotations", Class.class);10        method.setAccessible(true);11        List<AnnotationUtil.AnnotationInfo> list = (List<AnnotationUtil.AnnotationInfo>) method.invoke(null, clazz);12        for (AnnotationUtil.AnnotationInfo info : list) {13            System.out.println(info.annotation);14        }15    }16}17@com.tngtech.jgiven.annotation.ScenarioStage()18@org.springframework.stereotype.Component()

readAnnotations

Using AI Code Generation

1import com.tngtech.jgiven.impl.ScenarioModelBuilder;2import com.tngtech.jgiven.report.model.ScenarioModel;3import java.io.File;4import java.io.IOException;5import java.nio.file.Files;6import java.nio.file.Path;7import java.nio.file.Paths;8public class ReadAnnotationsFromAFile {9    public static void main(String[] args) throws IOException {10        Path path = Paths.get("C:\\Users\\jyoti\\Desktop\\1.java");11        byte[] bytes = Files.readAllBytes(path);12        String content = new String(bytes);13        ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();14        ScenarioModel scenarioModel = scenarioModelBuilder.readAnnotations(content);15        System.out.println(scenarioModel.getScenarioCaseModels());16    }17}18[ScenarioCaseModel [description=, tags=[], steps=[StepModel [description=Given I have a file with name "test.txt", arguments=[], argumentsAsString=[], parameterNames=[], parameterTypes=[], method=public void com.tngtech.jgiven.impl.ScenarioModelBuilderTest.given_I_have_a_file_with_name(java.lang.String), exception=null, duration=0, status=SUCCESS, parameterValues=[], parameterValueStrings=[]], StepModel [description=When I read the file, arguments=[], argumentsAsString=[], parameterNames=[], parameterTypes=[], method=public void com.tngtech.jgiven.impl.ScenarioModelBuilderTest.when_I_read_the_file(), exception=null, duration=0, status=SUCCESS, parameterValues=[], parameterValueStrings=[]], StepModel [description=Then the content should be "Hello World", arguments=[], argumentsAsString=[], parameterNames=[], parameterTypes=[], method=public void com.tngtech.jgiven.impl.ScenarioModelBuilderTest.then_the_content_should_be(java.lang.String), exception=null, duration=0, status=SUCCESS, parameterValues=[], parameterValueStrings=[]]]]]

readAnnotations

Using AI Code Generation

1package com.tngtech.jgiven.impl;2import java.io.File;3import java.io.IOException;4import java.lang.annotation.Annotation;5import java.lang.reflect.Method;6import java.util.List;7import java.util.Map;8import org.apache.bcel.classfile.AnnotationEntry;9import org.apache.bcel.classfile.ClassParser;10import org.apache.bcel.classfile.Constant;11import org.apache.bcel.classfile.ConstantUtf8;12import org.apache.bcel.classfile.Field;13import org.apache.bcel.classfile.JavaClass;14import org.apache.bcel.classfile.Method;15import org.apache.bcel.classfile.ParameterAnnotationEntry;16import org.apache.bcel.classfile.ParameterAnnotationEntry;17import org.apache.bcel.classfile.annotation.AnnotationElementValue;18import org.apache.bcel.classfile.annotation.AnnotationEntry;19import org.apache.bcel.classfile.annotation.ElementValue;20import org.apache.bcel.classfile.annotation.ElementValuePair;21import org.apache.bcel.classfile.annotation.SimpleElementValue;22import org.apache.bcel.generic.Type;23import org.apache.bcel.util.ClassPath;24import org.apache.bcel.util.SyntheticRepository;25import com.google.common.base.Optional;26import com.google.common.collect.Lists;27import com.google.common.collect.Maps;28import com.tngtech.jgiven.annotation.As;29import com.tngtech.jgiven.annotation.ExpectedScenarioState;30import com.tngtech.jgiven.annotation.Format;31import com.tngtech.jgiven.annotation.Hidden;32import com.tngtech.jgiven.annotation.IsTag;33import com.tngtech.jgiven.annotation.IsTag;34import com.tngtech.jgiven.annotation.Quoted;35import com.tngtech.jgiven.annotation.Quoted;36import com.tngtech.jgiven.annotation.ScenarioState;37import com.tngtech.jgive

readAnnotations

Using AI Code Generation

1import com.tngtech.jgiven.annotation.ScenarioState;2import com.tngtech.jgiven.annotation.ScenarioStage;3import com.tngtech.jgiven.annotation.ScenarioState.Resolution;4import com.tngtech.jgiven.annotation.ScenarioState.Value;5import com.tngtech.jgiven.attachment.Attachment;6import com.tngtech.jgiven.attachment.MediaType;7import com.tngtech.jgiven.attachment.ThrowableAttachment;8import com.tngtech.jgiven.attachment.ThrowableAttachmentBuilder;9import com.tngtech.jgiven.config.AbstractJGivenConfiguration;10import com.tngtech.jgiven.config.Configuration;11import com.tngtech.jgiven.config.DefaultConfiguration;12import com.tngtech.jgiven.config.DefaultConfigurationProvider;13import com.tngtech.jgiven.config.JGivenConfiguration;14import com.tngt

readAnnotations

Using AI Code Generation

1package com.tngtech.jgiven.impl;2import java.io.File;3import java.io.IOException;4import java.util.List;5import org.eclipse.jdt.core.dom.CompilationUnit;6import org.eclipse.jdt.core.dom.FieldDeclaration;7import org.eclipse.jdt.core.dom.TypeDeclaration;8import org.eclipse.jdt.core.dom.VariableDeclarationFragment;9import com.tngtech.jgiven.annotation.ScenarioState;10public class ScenarioModelBuilderTest {11    public static void main(String[] args) throws IOException {12        File file = new File("src/test/java/com/tngtech/jgiven/impl/ScenarioModelBuilderTest.java");13        ScenarioModelBuilder builder = new ScenarioModelBuilder();14        CompilationUnit cu = builder.parseCompilationUnit(file);15        TypeDeclaration type = (TypeDeclaration) cu.types().get(0);16        FieldDeclaration[] fields = type.getFields();17        for (FieldDeclaration field : fields) {18            VariableDeclarationFragment frag = (VariableDeclarationFragment) field.fragments().get(0);19            List<ScenarioState> annotations = builder.readAnnotations(frag, ScenarioState.class);20            if (!annotations.isEmpty()) {21                System.out.println("Found scenario state: " + frag.getName());22            }23        }24    }25}

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.