Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! 
How to use ConfigOption class of com.tngtech.jgiven.report.config package
Best JGiven code snippet using com.tngtech.jgiven.report.config.ConfigOption
Source:AbstractReportConfig.java 
...13 * For examples see {@link com.tngtech.jgiven.report.asciidoc.AsciiDocReportConfig}14 */15public abstract class AbstractReportConfig {16 private static final Logger log = LoggerFactory.getLogger( AbstractReportConfig.class );17 private List<ConfigOption> configOptions = createConfigOptions();18 private String title;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 */116 public abstract void additionalConfigOptions( List<ConfigOption> configOptions );117}...
Source:Html5ReportConfig.java
1package com.tngtech.jgiven.report.html5;2import com.tngtech.jgiven.report.AbstractReportConfig;3import com.tngtech.jgiven.report.config.CommandLineOptionBuilder;4import com.tngtech.jgiven.report.config.ConfigOption;5import com.tngtech.jgiven.report.config.ConfigOptionBuilder;6import com.tngtech.jgiven.report.config.converter.ToBoolean;7import com.tngtech.jgiven.report.config.converter.ToFile;8import org.slf4j.Logger;9import org.slf4j.LoggerFactory;10import java.util.Arrays;11import java.util.List;12import java.util.Map;13import java.io.File;14public class Html5ReportConfig extends AbstractReportConfig {15 private static final Logger log = LoggerFactory.getLogger( Html5ReportConfig.class );16 private File customCss;17 private File customJs;18 private boolean showThumbnails;19 Html5ReportConfig( String... args ) {20 super( args );21 }22 public Html5ReportConfig() {23 super();24 setShowThumbnails( true );25 }26 public void additionalConfigOptions( List<ConfigOption> configOptions ) {27 ConfigOption customCss = new ConfigOptionBuilder( "customcss" )28 .setCommandLineOptionWithArgument(29 new CommandLineOptionBuilder( "--customcss" ).setArgumentDelimiter( "=" ).setVisualPlaceholder( "path" ).build(),30 new ToFile() )31 .setOptional()32 .setDescription( "path to file" )33 .build();34 ConfigOption customJs = new ConfigOptionBuilder( "customjs" )35 .setCommandLineOptionWithArgument(36 new CommandLineOptionBuilder( "--customjs" ).setArgumentDelimiter( "=" ).setVisualPlaceholder( "path" ).build(),37 new ToFile() )38 .setOptional()39 .setDescription( "path to file" )40 .build();41 ConfigOption showThumbnails = new ConfigOptionBuilder( "showThumbnails" )42 .setCommandLineOptionWithArgument(43 new CommandLineOptionBuilder( "--show-thumbnails" ).setArgumentDelimiter( "=" ).setVisualPlaceholder( "boolean" )44 .build(),45 new ToBoolean() )46 .setDefaultWith( true )47 .setDescription( "(default: true)" )48 .build();49 configOptions.addAll( Arrays.asList( customCss, customJs, showThumbnails ) );50 }51 public void useConfigMap( Map<String, Object> configMap ) {52 if( configMap.containsKey( "customcss" ) ) {53 setCustomCss( (File) configMap.get( "customcss" ) );54 }55 if( configMap.containsKey( "customjs" ) ) {...
Source:PlainTextReportConfig.java
1package com.tngtech.jgiven.report.text;2import com.tngtech.jgiven.report.AbstractReportConfig;3import com.tngtech.jgiven.report.config.ConfigOption;4import java.util.List;5import java.util.Map;6public class PlainTextReportConfig extends AbstractReportConfig {7 public PlainTextReportConfig(String... args ) {8 super( args );9 }10 public PlainTextReportConfig() {11 super();12 }13 public void useConfigMap( Map<String, Object> configMap ) {14 }15 public void additionalConfigOptions( List<ConfigOption> configOptions ) {16 }17}...
ConfigOption
Using AI Code Generation
1package com.tngtech.jgiven.report.config;2import com.tngtech.jgiven.config.ConfigOption;3import com.tngtech.jgiven.report.ReportGenerator;4import com.tngtech.jgiven.report.ReportModel;5import com.tngtech.jgiven.report.json.JsonReportGenerator;6import com.tngtech.jgiven.report.model.ExecutionModel;7import com.tngtech.jgiven.report.model.ReportModelBuilder;8import com.tngtech.jgiven.report.text.PlainTextReportGenerator;9import com.tngtech.jgiven.report.text.TextReportGenerator;10import com.tngtech.jgiven.report.xml.XmlReportGenerator;11import com.tngtech.jgiven.report.xml.XmlReportModel;12import com.tngtech.jgiven.report.xml.XmlReportModelBuilder;13import com.tngtech.jgiven.report.xml.XmlReportModelBuilder.XmlReportModelBuilderException;14import java.io.File;15import java.io.IOException;16import java.util.ArrayList;17import java.util.List;18import java.util.Map;19public class ReportGeneratorConfig {20 public static final ConfigOption<String> REPORT_FORMAT = ConfigOption.of( "reportFormat", "html" );21 public static final ConfigOption<String> REPORT_DIRECTORY = ConfigOption.of( "reportDir", "target/jgiven-reports" );22 public static final ConfigOption<String> REPORT_NAME = ConfigOption.of( "reportName", "jgiven-report" );23 public static final ConfigOption<String> REPORT_DESCRIPTION = ConfigOption.of( "reportDescription", "" );24 public static final ConfigOption<String> REPORT_TITLE = ConfigOption.of( "reportTitle", "JGiven Report" );25 public static final ConfigOption<String> REPORT_TAGS = ConfigOption.of( "reportTags", "" );26 public static final ConfigOption<String> REPORT_TAGS_FILTER = ConfigOption.of( "reportTagsFilter", "" );27 public static final ConfigOption<String> REPORT_TAGS_FILTER_MODE = ConfigOption.of( "reportTagsFilterMode", "INCLUDE" );28 public static final ConfigOption<String> REPORT_TAGS_FILTER_MODE_INCLUDE = "INCLUDE";29 public static final ConfigOption<String> REPORT_TAGS_FILTER_MODE_EXCLUDE = "EXCLUDE";30 public static final ConfigOption<Boolean> REPORT_TAGS_FILTER_CASE_INSENSITIVE = ConfigOption.of( "reportTagsFilterCaseInsensitive", true );31 public static final ConfigOption<String> REPORT_TAGS_FILTER_SEPARATOR = ConfigOption.of( "reportTagsFilterSeparator", "," );
ConfigOption
Using AI Code Generation
1package com.tngtech.jgiven.report.config;2 import com.tngtech.jgiven.impl.util.AnnotationUtil;3 import com.tngtech.jgiven.report.config.ConfigOption;4 import com.tngtech.jgiven.report.config.ConfigOption.ConfigOptionBuilder;5 import com.tngtech.jgiven.report.config.ConfigOption.OptionType;6 import com.tngtech.jgiven.report.config.ConfigOption.OptionValueType;7 import com.tngtech.jgiven.report.config.ConfigOptionValidator;8 import com.tngtech.jgiven.report.config.ConfigReader;9 import com.tngtech.jgiven.report.config.DefaultConfigReader;10 import com.tngtech.jgiven.report.config.DefaultConfigValidator;11 import com.tngtech.jgiven.report.config.DefaultConfigWriter;12 import com.tngtech.jgiven.report.config.DefaultConfiguration;13 import com.tngtech.jgiven.report.config.Description;14 import com.tngtech.jgiven.report.config.Description.DescriptionBuilder;15 import com.tngtech.jgiven.report.config.Description.DescriptionType;16 import com.tngtech.jgiven.report.config.Description.DescriptionValueType;17 import com.tngtech.jgiven.report.config.DescriptionProvider;18 import com.tngtech.jgiven.report.config.DescriptionProvider.DescriptionProviderBuilder;19 import com.tngtech.jgiven.report.config.DescriptionProvider.DescriptionProviderType;20 import com.tngtech.jgiven.report.config.DescriptionProvider.DescriptionProviderValueType;21 import com.tngtech.jgiven.report.config.DescriptionProviderImpl;22 import com.tngtech.jgiven.report.config.DescriptionProviderImpl.DescriptionProviderImplBuilder;23 import com.tngtech.jgiven.report.config.DescriptionProviderImpl.DescriptionProviderImplType;24 import com.tngtech.jgiven.report.config.DescriptionProviderImpl.DescriptionProviderImplValueType;25 import com.tngtech.jgiven.report.config.DescriptionTypeProvider;26 import com.tngtech.jgiven.report.config.DescriptionTypeProvider.DescriptionTypeProviderBuilder;27 import com.tngtech.jgiven.report.config.DescriptionTypeProvider.DescriptionTypeProviderType;28 import com.tngtech.jgiven.report.config.DescriptionTypeProvider.DescriptionTypeProviderValueType;29 import com.tngtech.jgiven.report.config.DescriptionTypeProviderImpl;30 import com.tngtech.jgiven.report.config.DescriptionTypeProviderImpl.DescriptionTypeProviderImplBuilder;31 import com.tngtech.jgiven.report.config.DescriptionTypeProviderImpl.DescriptionTypeProviderImplType;32 import com.tngtech.jgiven.report.config.DescriptionTypeProviderImpl.DescriptionTypeProviderImplValueType;33 import com.tngtech.j
ConfigOption
Using AI Code Generation
1package com.tngtech.jgiven.report.config;2import com.tngtech.jgiven.report.ReportGeneratorConfiguration;3public class ConfigOption {4 private final String name;5 private final String description;6 private final String defaultValue;7 private final boolean isRequired;8 public ConfigOption(String name, String description, String defaultValue, boolean isRequired) {9 this.name = name;10 this.description = description;11 this.defaultValue = defaultValue;12 this.isRequired = isRequired;13 }14 public String getName() {15 return name;16 }17 public String getDescription() {18 return description;19 }20 public String getDefaultValue() {21 return defaultValue;22 }23 public boolean isRequired() {24 return isRequired;25 }26 public boolean isSet(ReportGeneratorConfiguration config) {27 return config.getOptions().containsKey(name);28 }29 public String getValue(ReportGeneratorConfiguration config) {30 return config.getOptions().get(name);31 }32}33package com.tngtech.jgiven.report;34import com.tngtech.jgiven.report.config.ConfigOption;35import java.util.List;36import java.util.Map;37public class ReportGeneratorConfiguration {38 private final Map<String, String> options;39 private final List<ConfigOption> configOptions;40 public ReportGeneratorConfiguration(Map<String, String> options, List<ConfigOption> configOptions) {41 this.options = options;42 this.configOptions = configOptions;43 }44 public Map<String, String> getOptions() {45 return options;46 }47 public List<ConfigOption> getConfigOptions() {48 return configOptions;49 }50}51package com.tngtech.jgiven.report;52import java.util.ArrayList;53import java.util.HashMap;54import java.util.List;55import java.util.Map;56public class ReportGeneratorConfigurationBuilder {57 private final Map<String, String> options = new HashMap<>();58 private final List<ConfigOption> configOptions = new ArrayList<>();59 public ReportGeneratorConfigurationBuilder addConfigOption(ConfigOption configOption) {60 configOptions.add(configOption);61 return this;62 }63 public ReportGeneratorConfigurationBuilder addOption(String name, String value) {64 options.put(name, value);65 return this;66 }
ConfigOption
Using AI Code Generation
1ConfigOption option = new ConfigOption();2option.setConfigValue("value");3ConfigOption option = new ConfigOption();4option.setConfigValue("value");5ConfigOption option = new ConfigOption();6option.setConfigValue("value");7ConfigOption option = new ConfigOption();8option.setConfigValue("value");9ConfigOption option = new ConfigOption();10option.setConfigValue("value");11ConfigOption option = new ConfigOption();12option.setConfigValue("value");13ConfigOption option = new ConfigOption();14option.setConfigValue("value");15ConfigOption option = new ConfigOption();16option.setConfigValue("value");17ConfigOption option = new ConfigOption();18option.setConfigValue("value");19ConfigOption option = new ConfigOption();20option.setConfigValue("value");21ConfigOption option = new ConfigOption();22option.setConfigValue("value");23ConfigOption option = new ConfigOption();24option.setConfigValue("value");25ConfigOption option = new ConfigOption();26option.setConfigValue("value");27ConfigOption option = new ConfigOption();28option.setConfigValue("value");
ConfigOption
Using AI Code Generation
1import java.io.IOException;2import java.util.ArrayList;3import java.util.List;4public class ConfigOptionExample {5 public static void main(String[] args) throws IOException {6 ConfigReader configReader = new DefaultConfigReader();7 List<ConfigOption> configOptions = new ArrayList<ConfigOption>();8 configOptions.add(ConfigOption.JGIVEN_REPORT_DIR);9 configOptions.add(ConfigOption.JGIVEN_REPORT_OUTPUT_DIR);10 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_CSS);11 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_JS);12 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FONTS);13 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_LOGO);14 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FAVICON);15 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_CSS_PATH);16 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_JS_PATH);17 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FONTS_PATH);18 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_LOGO_PATH);19 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FAVICON_PATH);20 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_CSS_FILE);21 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_JS_FILE);22 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FONTS_FILE);23 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_LOGO_FILE);24 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FAVICON_FILE);25 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_CSS_FILE_PATH);26 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_JS_FILE_PATH);27 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FONTS_FILE_PATH);28 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_LOGO_FILE_PATH);29 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_FAVICON_FILE_PATH);30 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_CSS_FILE_NAME);31 configOptions.add(ConfigOption.JGIVEN_REPORT_CUSTOM_JS_FILE_NAME);
ConfigOption
Using AI Code Generation
1import com.tngtech.jgiven.report.config.ConfigOption;2import com.tngtech.jgiven.report.config.PropertyFileConfigReader;3import java.io.File;4import java.io.IOException;5import java.util.Properties;6public class ConfigOptionExample {7 public static void main(String[] args) throws IOException {8 Properties properties = new Properties();9 properties.load(new File("jgiven.properties").toURI().toURL().openStream());10 PropertyFileConfigReader propertyFileConfigReader = new PropertyFileConfigReader(properties);11 ConfigOption configOption = new ConfigOption(propertyFileConfigReader);12 System.out.println(configOption.getReportDir());13 }14}
ConfigOption
Using AI Code Generation
1ConfigOption configOption = new ConfigOption();2configOption.setConfigOption("ReportDirectory", "C:\\Users\\Reports");3configOption.setConfigOption("ReportName", "JGivenReport");4configOption.setConfigOption("ReportTitle", "JGiven Report");5configOption.setConfigOption("ReportDescription", "JGiven Report");6configOption.setConfigOption("ReportVersion", "1.0");7configOption.setConfigOption("ReportAuthor", "JGiven");8configOption.setConfigOption("ReportAuthorEmail", "
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.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run JGiven automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used methods in ConfigOption
- getLongName
- setLongName
- getShortName
- setShortName
- getCommandLineOption
- setCommandLineOption
- getPropertyString
- setPropertyString
- getEnvString
- setEnvString
- getDescription
- setDescription
- isOptional
- setOptional
- isHasArgument
- setHasArgument
- hasDefault
- setHasDefault
- getValue
- setValue
- getConverter
- setConverter
- toObject
- getEnhancedDescription
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
