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

How to use getFormatter method of com.tngtech.jgiven.impl.format.ParameterFormattingUtil class

Best JGiven code snippet using com.tngtech.jgiven.impl.format.ParameterFormattingUtil.getFormatter

Source:ScenarioModelBuilder.java

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

Source:ParameterFormattingUtil.java

...34        ObjectFormatter<?> formatting = getFormatting( annotations, Sets.<Class<?>>newHashSet(), null, parameterName );35        if( formatting != null ) {36            return formatting;37        }38        Formatter<T> formatter = (Formatter<T>) configuration.getFormatter( parameterType );39        if( formatter != null ) {40            return new StepFormatter.TypeBasedFormatting<T>( formatter, annotations );41        }42        return DEFAULT_FORMATTING;43    }44    /**45     * Recursively searches for formatting annotations.46     *47     * @param visitedTypes used to prevent an endless loop48     * @param parameterName49     */50    private StepFormatter.Formatting<?, ?> getFormatting( Annotation[] annotations, Set<Class<?>> visitedTypes,51            Annotation originalAnnotation, String parameterName ) {52        List<StepFormatter.Formatting<?, ?>> foundFormatting = Lists.newArrayList();53        Table tableAnnotation = null;54        for( Annotation annotation : annotations ) {55            try {56                if( annotation instanceof Format ) {57                    Format arg = (Format) annotation;58                    foundFormatting.add( new StepFormatter.ArgumentFormatting( ReflectionUtil.newInstance( arg.value() ), arg.args() ) );59                } else if( annotation instanceof Table ) {60                    tableAnnotation = (Table) annotation;61                } else if( annotation instanceof AnnotationFormat ) {62                    AnnotationFormat arg = (AnnotationFormat) annotation;63                    foundFormatting.add( new StepFormatter.ArgumentFormatting(64                        new StepFormatter.AnnotationBasedFormatter( arg.value().newInstance(), originalAnnotation ) ) );65                } else {66                    Class<? extends Annotation> annotationType = annotation.annotationType();67                    if( !visitedTypes.contains( annotationType ) ) {68                        visitedTypes.add( annotationType );69                        StepFormatter.Formatting<?, ?> formatting = getFormatting( annotationType.getAnnotations(), visitedTypes,70                            annotation, parameterName );71                        if( formatting != null ) {72                            foundFormatting.add( formatting );73                        }74                    }75                }76            } catch( Exception e ) {77                throw Throwables.propagate( e );78            }79        }80        if( foundFormatting.size() > 1 ) {81            Formatting<?, ?> innerFormatting = Iterables.getLast( foundFormatting );82            foundFormatting.remove( innerFormatting );83            ChainedFormatting<?> chainedFormatting = new StepFormatter.ChainedFormatting<Object>( (ObjectFormatter<Object>) innerFormatting );84            for( StepFormatter.Formatting<?, ?> formatting : Lists.reverse( foundFormatting ) ) {85                chainedFormatting.addFormatting( (StepFormatter.Formatting<?, String>) formatting );86            }87            foundFormatting.clear();88            foundFormatting.add( chainedFormatting );89        }90        if( tableAnnotation != null ) {91            ObjectFormatter<?> objectFormatter = foundFormatting.isEmpty()92                    ? DefaultFormatter.INSTANCE93                    : foundFormatting.get( 0 );94            return getTableFormatting( annotations, parameterName, tableAnnotation, objectFormatter );95        }96        if( foundFormatting.isEmpty() ) {97            return null;98        }99        return foundFormatting.get( 0 );100    }101    private StepFormatter.Formatting<?, ?> getTableFormatting( Annotation[] annotations, String parameterName, Table annotation,102            ObjectFormatter<?> objectFormatter ) {103        Table tableAnnotation = annotation;104        TableFormatterFactory factory = createTableFormatterFactory( parameterName, tableAnnotation );105        TableFormatter tableFormatter = factory.create( configuration, objectFormatter );106        return new StepFormatter.TableFormatting( tableFormatter, tableAnnotation, parameterName, annotations );107    }108    private TableFormatterFactory createTableFormatterFactory( String parameterName, Table tableAnnotation ) {109        Class<? extends TableFormatterFactory> formatterFactoryClass = tableAnnotation.formatter();110        try {111            return ReflectionUtil.newInstance( formatterFactoryClass );112        } catch( Exception e ) {113            throw new JGivenWrongUsageException(114                "Could not create an instance of " + formatterFactoryClass.getName()115                        + " which was specified at the @Table annotation for parameter '" + parameterName116                        + "'. Most likely this was due to a missing default constructor",117                TableFormatterFactory.class, e );118        }119    }120    public List<String> toStringList( List<ObjectFormatter<?>> formatter, List<?> arguments ) {121        List<String> result = Lists.newArrayList();122        for( int i = 0; i < arguments.size(); i++ ) {123            ObjectFormatter<?> formatting = DEFAULT_FORMATTING;124            if( i < formatter.size() && formatter.get( i ) != null ) {125                formatting = formatter.get( i );126            }127            result.add( formatUsingFormatterOrDefault( formatting, arguments.get( i ) ) );128        }129        return result;130    }131    private <T> String formatUsingFormatterOrDefault( ObjectFormatter<T> formatting, Object o ) {132        return formatting.format( (T) o );133    }134    public List<ObjectFormatter<?>> getFormatter( Class<?>[] parameterTypes, List<String> parameterNames,135            Annotation[][] parameterAnnotations ) {136        List<ObjectFormatter<?>> res = Lists.newArrayList();137        for( int i = 0; i < parameterTypes.length; i++ ) {138            Annotation[] annotations = parameterAnnotations[i];139            if( !AnnotationUtil.isHidden( annotations ) ) {140                String parameterName = i < parameterNames.size() ? parameterNames.get( i ) : "param" + i;141                res.add( this.getFormatting( parameterTypes[i], parameterName, annotations ) );142            }143        }144        return res;145    }146}...

Source:ParameterFormatterFactory.java

...26                                          .toArray(Class<?>[]::new);27        Annotation[][] parameterAnnotations = Arrays.stream(parameters)28                                                    .map(Parameter::getAnnotations)29                                                    .toArray(Annotation[][]::new);30        return parameterFormattingUtil.getFormatter(parameterTypes,31                ArgumentUtils.getNames(namedArguments),32                parameterAnnotations33        );34    }35    static StepFormatter.Formatting<?, ?> createDefault() {36        return DEFAULT_FORMATTING;37    }38}...

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.