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

How to use ConfigOptionParser class of com.tngtech.jgiven.report.config package

Best JGiven code snippet using com.tngtech.jgiven.report.config.ConfigOptionParser

Source:AbstractReportConfig.java

...19    private File sourceDir;20    private File targetDir;21    private Boolean excludeEmptyScenarios;22    public AbstractReportConfig( String... args ) {23        Map<String, Object> configMap = new ConfigOptionParser().generate( configOptions, args );24        setTitle( (String) configMap.get( "title" ) );25        setSourceDir( (File) configMap.get( "sourceDir" ) );26        setTargetDir( (File) configMap.get( "targetDir" ) );27        setExcludeEmptyScenarios( (Boolean) configMap.get( "excludeEmptyScenarios" ) );28        useConfigMap( configMap );29    }30    public AbstractReportConfig() {31        setTitle( "JGiven Report" );32        setSourceDir( new File( "." ) );33        setTargetDir( new File( "." ) );34        setExcludeEmptyScenarios( false );35    }36    private List<ConfigOption> createConfigOptions() {37        List<ConfigOption> configOptions = new ArrayList<ConfigOption>();38        ConfigOption sourceDir = new ConfigOptionBuilder( "sourceDir" )39                .setCommandLineOptionWithArgument(40                        new CommandLineOptionBuilder( "--sourceDir" ).setArgumentDelimiter( "=" ).setShortPrefix( "--dir" )41                                .setVisualPlaceholder( "path" ).build(),42                        new ToFile() )43                .setDescription( "the source directory where the JGiven JSON files are located (default: .)" )44                .setDefaultWith( new File( "." ) )45                .build();46        ConfigOption targetDir = new ConfigOptionBuilder( "targetDir" )47                .setCommandLineOptionWithArgument(48                        new CommandLineOptionBuilder( "--targetDir" ).setArgumentDelimiter( "=" ).setShortPrefix( "--todir" )49                                .setVisualPlaceholder( "path" ).build(),50                        new ToFile() )51                .setDescription( "the directory to generate the report to (default: .)" )52                .setDefaultWith( new File( "." ) )53                .build();54        ConfigOption title = new ConfigOptionBuilder( "title" )55                .setCommandLineOptionWithArgument(56                        new CommandLineOptionBuilder( "--title" ).setArgumentDelimiter( "=" ).setVisualPlaceholder( "string" ).build(),57                        new ToString() )58                .setDescription( "the title of the report (default: JGiven Report)" )59                .setDefaultWith( "JGiven Report" )60                .build();61        ConfigOption excludeEmptyScenarios = new ConfigOptionBuilder( "excludeEmptyScenarios" )62                .setCommandLineOptionWithArgument(63                        new CommandLineOptionBuilder( "--exclude-empty-scenarios" ).setArgumentDelimiter( "=" )64                                .setVisualPlaceholder( "boolean" ).build(),65                        new ToBoolean() )66                .setDescription( "(default: false)" )67                .setDefaultWith( false )68                .build();69        configOptions.addAll( Arrays.asList( sourceDir, targetDir, title, excludeEmptyScenarios ) );70        additionalConfigOptions( configOptions );71        return configOptions;72    }73    public String getTitle() {74        return title;75    }76    public void setTitle( String title ) {77        this.title = title;78    }79    public File getSourceDir() {80        return sourceDir;81    }82    public void setSourceDir( File sourceDir ) {83        this.sourceDir = sourceDir;84    }85    public File getTargetDir() {86        return targetDir;87    }88    public void setTargetDir( File targetDir ) {89        this.targetDir = targetDir;90    }91    public Boolean getExcludeEmptyScenarios() {92        return excludeEmptyScenarios;93    }94    public void setExcludeEmptyScenarios( Boolean excludeEmptyScenarios ) {95        this.excludeEmptyScenarios = excludeEmptyScenarios;96    }97    public CompleteReportModel getReportModel() {98        return new ReportModelReader( this ).readDirectory();99    }100    public void printUsageAndExit() {101        new ConfigOptionParser().printUsageAndExit( configOptions );102    }103    /**104     *105     * Every flag should be defined except the optional ones without a default (like --help)106     *107     * @param configMap the config map with a mapping of Strings to castable objects108     */109    public abstract void useConfigMap( Map<String, Object> configMap );110    /**111     *112     * This is used to create new {@link ConfigOption} for the {@link AbstractReportConfig} by appending them to the list113     *114     * @param configOptions config options list, add new options here115     */...

Source:ReportGenerator.java

1package com.tngtech.jgiven.report;2import com.tngtech.jgiven.report.config.ConfigOptionParser;3import org.slf4j.Logger;4import org.slf4j.LoggerFactory;5import com.tngtech.jgiven.exception.JGivenInstallationException;6import com.tngtech.jgiven.exception.JGivenInternalDefectException;7import com.tngtech.jgiven.report.asciidoc.AsciiDocReportGenerator;8import com.tngtech.jgiven.report.text.PlainTextReportGenerator;9import java.util.Arrays;10/**11 *  This is an interface to create a report based on command line flags12 */13public class ReportGenerator {14    private static final Logger log = LoggerFactory.getLogger( ReportGenerator.class );15    /**16     * to create a custom report, extend this enum with the name of your choice17     */18    public enum Format {19        HTML( "html" ),20        TEXT( "text" ),21        ASCIIDOC( "asciidoc" ),22        HTML5( "html5" );23        private final String text;24        Format( String text ) {25            this.text = text;26        }27        public static Format fromStringOrNull( String value ) {28            return Arrays.stream(Format.values())29                    .filter(format -> format.text.equalsIgnoreCase((value)))30                    .findFirst()31                    .orElse(null);32        }33    }34    /**35     * Starts the respective report (default is HTML5)36     */37    public void generate( String... args ) {38        Format format = ConfigOptionParser.getFormat( args );39        switch( format ) {40            case ASCIIDOC:41                new AsciiDocReportGenerator().generateFromCommandLine( args );42                break;43            case TEXT:44                new PlainTextReportGenerator().generateFromCommandLine( args );45                break;46            case HTML:47            case HTML5:48            default:49                ReportGenerator.generateHtml5Report().generateFromCommandLine( args );50                break;51        }52    }...

Source:StringConverter.java

...3/**4 * Interface to create converter function to specify the to map the incoming command line argument to the object5 * See {@link AbstractReportGenerator#populateConfigOptions()} for example definitions of {@link com.tngtech.jgiven.report.config.ConfigOption}6 *7 * If the conversion is not possible, return null. The {@link com.tngtech.jgiven.report.config.ConfigOptionParser} terminates gracefully8 */9public interface StringConverter {10    Object apply (String input);11}...

ConfigOptionParser

Using AI Code Generation

1import com.tngtech.jgiven.report.config.ConfigOptionParser;2import com.tngtech.jgiven.report.config.ReportConfig;3import com.tngtech.jgiven.report.config.ReportConfig.ConfigOption;4public class ConfigOptionParserTest {5    public static void main(String[] args) {6        ReportConfig reportConfig = new ReportConfig();7        ConfigOptionParser parser = new ConfigOptionParser(reportConfig);8        parser.parseOption(ConfigOption.HTML_TITLE, "My Title");9        System.out.println(reportConfig.getHtmlTitle());10    }11}

ConfigOptionParser

Using AI Code Generation

1import com.tngtech.jgiven.report.config.ConfigOptionParser;2import com.tngtech.jgiven.report.config.ConfigOption;3import com.tngtech.jgiven.report.config.ConfigOptionParserException;4import java.util.Map;5import java.util.HashMap;6import java.util.List;7import java.util.ArrayList;8import java.util.Iterator;9import java.util.Set;10import java.util.HashSet;11import java.util.Arrays;12import java.util.Collection;13import java.util.Collections;14import java.util.regex.Matcher;15import java.util.regex.Pattern;16import java.util.regex.PatternSyntaxException;17import java.util.regex.MatchResult;

ConfigOptionParser

Using AI Code Generation

1import com.tngtech.jgiven.report.config.ConfigOptionParser;2import com.tngtech.jgiven.report.config.ReportConfig;3import com.tngtech.jgiven.report.config.ReportConfigOption;4public class JGivenReportConfig {5    public static void main(String[] args) {6        ReportConfig reportConfig = new ConfigOptionParser().parse(args);7        System.out.println(reportConfig);8    }9}10import com.tngtech.jgiven.report.config.ConfigOptionParser;11import com.tngtech.jgiven.report.config.ReportConfig;12import com.tngtech.jgiven.report.config.ReportConfigOption;13public class JGivenReportConfig {14    public static void main(String[] args) {15        ReportConfig reportConfig = new ConfigOptionParser().parse(args);16        System.out.println(reportConfig);17    }18}19import com.tngtech.jgiven.report.config.ConfigOptionParser;20import com.tngtech.jgiven.report.config.ReportConfig;21import com.tngtech.jgiven.report.config.ReportConfigOption;22public class JGivenReportConfig {23    public static void main(String[] args) {24        ReportConfig reportConfig = new ConfigOptionParser().parse(args);25        System.out.println(reportConfig);26    }27}28import com.tngtech.jgiven.report.config.ConfigOptionParser;29import com.tngtech.jgiven.report.config.ReportConfig;30import com.tngtech.jgiven.report.config.ReportConfigOption;31public class JGivenReportConfig {32    public static void main(String[] args) {33        ReportConfig reportConfig = new ConfigOptionParser().parse(args);34        System.out.println(reportConfig);35    }36}37import com.tngtech.jgiven.report.config.ConfigOptionParser;38import com.tngtech.jgiven.report.config.ReportConfig;39import com.tngtech.jgiven.report.config.ReportConfigOption;40public class JGivenReportConfig {41    public static void main(String[] args) {42        ReportConfig reportConfig = new ConfigOptionParser().parse(args);43        System.out.println(reportConfig);44    }

ConfigOptionParser

Using AI Code Generation

1package com.tngtech.jgiven.report;2import java.io.File;3import java.util.List;4import com.tngtech.jgiven.report.config.ConfigOptionParser;5import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOption;6import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOptionParserException;7public class Main {8    public static void main( String[] args ) throws Exception {9        ConfigOptionParser parser = new ConfigOptionParser();10        parser.addOption( "sourceDir", "s", "source directory" );11        parser.addOption( "targetDir", "t", "target directory" );12        parser.addOption( "format", "f", "report format" );13        parser.addOption( "tags", "a", "tags to include" );14        parser.addOption( "excludeTags", "e", "tags to exclude" );15        parser.addOption( "includeScenarios", "i", "scenarios to include" );16        parser.addOption( "excludeScenarios", "x", "scenarios to exclude" );17        parser.addOption( "title", "l", "title of the report" );18        parser.addOption( "language", "g", "language of the report" );19        parser.addOption( "encoding", "c", "encoding of the report" );20        parser.addOption( "includeTagsInFilter", "b", "include tags in filter" );21        parser.addOption( "excludeTagsInFilter", "y", "exclude tags in filter" );22        parser.addOption( "includeScenariosInFilter", "j", "include scenarios in filter" );23        parser.addOption( "excludeScenariosInFilter", "z", "exclude scenarios in filter" );24        parser.addOption( "description", "d", "description of the report" );25        parser.addOption( "css", "k", "css file" );26        parser.addOption( "js", "m", "js file" );27        parser.addOption( "reportName", "n", "report name" );28        parser.addOption( "configFile", "o", "config file" );29        parser.addOption( "help", "h", "show help" );30        try {31            parser.parse( args );32        } catch( ConfigOptionParserException e ) {33            System.out.println( e.getMessage() );

ConfigOptionParser

Using AI Code Generation

1import com.tngtech.jgiven.report.config.ConfigOptionParser;2import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOption;3import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOptionType;4public class ConfigOptionParserExample {5    public static void main(String[] args) {6        ConfigOptionParser parser = new ConfigOptionParser();7        ConfigOption option1 = parser.addOption("option1", "option1 description", ConfigOptionType.STRING, "default value");8        ConfigOption option2 = parser.addOption("option2", "option2 description", ConfigOptionType.BOOLEAN, "true");9        parser.parse(args);10        System.out.println(option1.getValue());11        System.out.println(option2.getValue());12    }13}14import com.tngtech.jgiven.report.config.ConfigOptionParser;15import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOption;16import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOptionType;17public class ConfigOptionParserExample {18    public static void main(String[] args) {19        ConfigOptionParser parser = new ConfigOptionParser();20        ConfigOption option1 = parser.addOption("option1", "option1 description", ConfigOptionType.STRING, "default value");21        ConfigOption option2 = parser.addOption("option2", "option2 description", ConfigOptionType.BOOLEAN, "true");22        parser.parse(args);23        System.out.println(option1.getValue());24        System.out.println(option2.getValue());25    }26}27import com.tngtech.jgiven.report.config.ConfigOptionParser;28import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOption;29import com.tngtech.jgiven.report.config.ConfigOptionParser.ConfigOptionType;30public class ConfigOptionParserExample {31    public static void main(String[] args)

ConfigOptionParser

Using AI Code Generation

1package com.tngtech.jgiven.report.config;2import java.io.File;3import java.util.List;4import java.util.Map;5import java.util.Properties;6import com.beust.jcommander.Parameter;7import com.beust.jcommander.converters.FileConverter;8import com.beust.jcommander.converters.IntegerConverter;9import com.beust.jcommander.converters.StringConverter;10import com.google.common.base.Splitter;11import com.google.common.collect.Lists;12import com.google.common.collect.Maps;13public class ConfigOptionParser extends ConfigOption {14    @Parameter(names = { "--config", "-c" }, description = "Path to the configuration file", converter = FileConverter.class)15    private File configFile;16    @Parameter(names = { "--output-directory", "-o" }, description = "Directory where the report is generated", converter = FileConverter.class)17    private File outputDirectory;18    @Parameter(names = { "--report-name", "-n" }, description = "Name of the report")19    private String reportName;20    @Parameter(names = { "--report-title", "-t" }, description = "Title of the report")21    private String reportTitle;22    @Parameter(names = { "--report-subtitle", "-s" }, description = "Subtitle of the report")23    private String reportSubtitle;24    @Parameter(names = { "--report-description", "-d" }, description = "Description of the report")25    private String reportDescription;26    @Parameter(names = { "--scenarios", "-sc" }, description = "Comma separated list of scenarios to include")27    private String scenarios;28    @Parameter(names = { "--tags", "-tag" }, description = "Comma separated list of tags to include")29    private String tags;30    @Parameter(names = { "--exclude-tags", "-x" }, description = "Comma separated list of tags to exclude")31    private String excludeTags;32    @Parameter(names = { "--classes", "-cl" }, description = "Comma separated list of classes to include")33    private String classes;34    @Parameter(names = { "--exclude-classes", "-ecl" }, description = "Comma separated list of classes to exclude")35    private String excludeClasses;36    @Parameter(names = { "--methods", "-m" }, description = "Comma separated list of methods to include")37    private String methods;38    @Parameter(names = { "--exclude-methods", "-em" }, description = "Comma separated

ConfigOptionParser

Using AI Code Generation

1import com.tngtech.jgiven.report.config.ConfigOptionParser;2import com.tngtech.jgiven.report.config.ConfigOption;3import com.tngtech.jgiven.report.config.ConfigOptionParser;4public class ConfigOptionParserExample {5    public static void main(String[] args) {6        ConfigOptionParser parser = new ConfigOptionParser();7        parser.addOption(new ConfigOption("myOption", "myDefaultValue"));8        parser.parse(args);9        String myOptionValue = parser.getValue("myOption");10        System.out.println("Value of myOption is " + myOptionValue);11    }12}

ConfigOptionParser

Using AI Code Generation

1package com.tngtech.jgiven.report.config;2import java.io.File;3import java.io.IOException;4import java.nio.file.Files;5import java.nio.file.Path;6import java.nio.file.Paths;7import java.util.Arrays;8import java.util.Map;9import java.util.stream.Collectors;10import java.util.stream.Stream;11import com.beust.jcommander.ParameterException;12public class ConfigOptionParser {13    private static final String DEFAULT_REPORT_NAME = "report";14    private static final String DEFAULT_REPORT_FORMAT = "html";15    private static final String DEFAULT_REPORT_OUTPUT_DIR = "target/jgiven-reports";16    private static final String DEFAULT_REPORT_TAGS = "";17    private final ConfigOption configOption;18    public ConfigOptionParser() {19        configOption = new ConfigOption();20    }21    public ConfigOption getConfigOption() {22        return configOption;23    }24    public void parse(String[] args) {25        try {26            configOption.parse(args);27        } catch (ParameterException e) {28            System.out.println(e.getMessage());29            System.out.println();30            configOption.usage();31            System.exit(-1);32        }33        if (configOption.isHelp()) {34            configOption.usage();35            System.exit(0);36        }37        if (configOption.isVersion()) {38            System.out.println("JGiven " + ConfigOptionParser.class.getPackage().getImplementationVersion());39            System.exit(0);40        }41        if (configOption.getReportOutputDir() == null) {42            configOption.setReportOutputDir(DEFAULT_REPORT_OUTPUT_DIR);43        }44        if (configOption.getReportName() == null) {45            configOption.setReportName(DEFAULT_REPORT_NAME);46        }47        if (configOption.getReportFormat() == null) {48            configOption.setReportFormat(DEFAULT_REPORT_FORMAT);49        }50        if (configOption.getReportTags() == null) {51            configOption.setReportTags(DEFAULT_REPORT_TAGS);52        }53        if (configOption.getReportTags().isEmpty()) {54            configOption.setReportTags(DEFAULT_REPORT_TAGS);55        } else {56            configOption.setReportTags(Arrays.stream(configOption.getReportTags().split(","))57                    .filter(tag -> !tag.trim().isEmpty())58                    .collect(Collectors.joining(",")));59        }60        if (configOption.getReportClasspath() != null) {61            configOption.setReportClasspath(Arrays.stream(configOption.getReportClasspath().split(File.pathSeparator))

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.