org.apache.rat.testhelpers.data.AbstractTestDataProvider

org.apache.rat.testhelpers.data.OptionTestDataProvider

public class OptionTestDataProvider extends AbstractTestDataProvider

Generates a list of TestData for options. Use of this interface ensures consistent testing across the UIs. Each method tests an option from OptionCollectionParser that must be implemented in the UI.

Field Summary

Fields inherited from class org.apache.rat.testhelpers.data.AbstractTestDataProvider
NO_OPTIONS
Constructor Summary

Constructors

Constructor

Description

OptionTestDataProvider()
Method Summary

Modifier and Type

Method

Description

protected void

configTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.CONFIGURATION tests.

protected void

configurationNoDefaultsTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.CONFIGURATION_NO_DEFAULTS tests.

protected void

counterMaxTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.COUNTER_MAX tests.

protected void

counterMinTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.COUNTER_MIN tests.

protected void

dryRunTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.DRY_RUN tests.

protected void

editCopyrightTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EDIT_COPYRIGHT tests.

protected void

editLicenseTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EDIT_ADD tests.

protected void

editOverwriteTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EDIT_OVERWRITE tests.

Map<String,TestData>

getUITestMap(UIOptionCollection<?> optionCollection)

Generates the map of UI TestData indexed by testName.

protected void

helpLicenses(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.HELP_LICENSES tests.

protected void

inputExcludeFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EXCLUDE_FILE tests.

protected void

inputExcludeParsedScmTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EXCLUDE_PARSE_SCM tests.

protected void

inputExcludeSizeTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EXCLUDE_SIZE tests.

protected void

inputExcludeStdTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EXCLUDE_STD tests.

protected void

inputExcludeTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.EXCLUDE tests.

protected void

inputIncludeFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.INCLUDE_FILE tests.

protected void

inputIncludeStdTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.INCLUDE_STD tests.

protected void

inputIncludeTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.INCLUDE tests.

protected void

inputSourceTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.SOURCE tests.

protected void

licenseFamiliesApprovedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.FAMILIES_APPROVED_FILE tests.

protected void

licenseFamiliesApprovedTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.FAMILIES_APPROVED tests.

protected void

licenseFamiliesDeniedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.FAMILIES_DENIED_FILE tests.

protected void

licenseFamiliesDeniedTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.FAMILIES_DENIED tests.

protected void

licensesApprovedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.LICENSES_APPROVED_FILE tests.

protected void

licensesApprovedTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.LICENSES_APPROVED tests.

protected void

licensesDeniedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.LICENSES_DENIED_FILE tests.

protected void

licensesDeniedTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.LICENSES_DENIED tests.

protected void

logLevelTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.LOG_LEVEL tests.

protected void

outputArchiveTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_ARCHIVE tests.

protected void

outputFamiliesTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_FAMILIES tests.

protected void

outputFileTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_FILE tests.

protected void

outputLicensesTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_LICENSES tests.

protected void

outputStandardTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_STANDARD tests.

protected void

outputStyleTest(Set<TestData> result, org.apache.commons.cli.Option option)

Execute an Arg.OUTPUT_STYLE tests.

Methods inherited from class org.apache.rat.testhelpers.data.AbstractTestDataProvider
getOptionTestMap, getOptionTests

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OptionTestDataProvider
  
  public OptionTestDataProvider()
Method Details
- getUITestMap
  
  public Map<String,TestData> getUITestMap(UIOptionCollection<?> optionCollection)
  
  Generates the map of UI TestData indexed by testName.
  
  Returns:
  
  the map of UI TestData indexed by testName.
- inputExcludeFileTest
  
  protected void inputExcludeFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EXCLUDE_FILE tests.
  
  Specified by:
  
  inputExcludeFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputExcludeTest
  
  protected void inputExcludeTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EXCLUDE tests.
  
  Specified by:
  
  inputExcludeTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputExcludeStdTest
  
  protected void inputExcludeStdTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EXCLUDE_STD tests.
  
  Specified by:
  
  inputExcludeStdTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputExcludeParsedScmTest
  
  protected void inputExcludeParsedScmTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EXCLUDE_PARSE_SCM tests.
  
  Specified by:
  
  inputExcludeParsedScmTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputExcludeSizeTest
  
  protected void inputExcludeSizeTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EXCLUDE_SIZE tests.
  
  Specified by:
  
  inputExcludeSizeTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputIncludeFileTest
  
  protected void inputIncludeFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.INCLUDE_FILE tests.
  
  Specified by:
  
  inputIncludeFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputIncludeTest
  
  protected void inputIncludeTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.INCLUDE tests.
  
  Specified by:
  
  inputIncludeTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputIncludeStdTest
  
  protected void inputIncludeStdTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.INCLUDE_STD tests.
  
  Specified by:
  
  inputIncludeStdTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- inputSourceTest
  
  protected void inputSourceTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.SOURCE tests.
  
  Specified by:
  
  inputSourceTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- helpLicenses
  
  protected void helpLicenses(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.HELP_LICENSES tests.
  
  Specified by:
  
  helpLicenses in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licensesApprovedFileTest
  
  protected void licensesApprovedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.LICENSES_APPROVED_FILE tests.
  
  Specified by:
  
  licensesApprovedFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licensesApprovedTest
  
  protected void licensesApprovedTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.LICENSES_APPROVED tests.
  
  Specified by:
  
  licensesApprovedTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licensesDeniedTest
  
  protected void licensesDeniedTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.LICENSES_DENIED tests.
  
  Specified by:
  
  licensesDeniedTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licensesDeniedFileTest
  
  protected void licensesDeniedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.LICENSES_DENIED_FILE tests.
  
  Specified by:
  
  licensesDeniedFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licenseFamiliesApprovedFileTest
  
  protected void licenseFamiliesApprovedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.FAMILIES_APPROVED_FILE tests.
  
  Specified by:
  
  licenseFamiliesApprovedFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licenseFamiliesApprovedTest
  
  protected void licenseFamiliesApprovedTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.FAMILIES_APPROVED tests.
  
  Specified by:
  
  licenseFamiliesApprovedTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licenseFamiliesDeniedFileTest
  
  protected void licenseFamiliesDeniedFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.FAMILIES_DENIED_FILE tests.
  
  Specified by:
  
  licenseFamiliesDeniedFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- licenseFamiliesDeniedTest
  
  protected void licenseFamiliesDeniedTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.FAMILIES_DENIED tests.
  
  Specified by:
  
  licenseFamiliesDeniedTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- counterMaxTest
  
  protected void counterMaxTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.COUNTER_MAX tests.
  
  Specified by:
  
  counterMaxTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- counterMinTest
  
  protected void counterMinTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.COUNTER_MIN tests.
  
  Specified by:
  
  counterMinTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- configTest
  
  protected void configTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.CONFIGURATION tests.
  
  Specified by:
  
  configTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- configurationNoDefaultsTest
  
  protected void configurationNoDefaultsTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.CONFIGURATION_NO_DEFAULTS tests.
  
  Specified by:
  
  configurationNoDefaultsTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- dryRunTest
  
  protected void dryRunTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.DRY_RUN tests.
  
  Specified by:
  
  dryRunTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- editCopyrightTest
  
  protected void editCopyrightTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EDIT_COPYRIGHT tests.
  
  Specified by:
  
  editCopyrightTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- editLicenseTest
  
  protected void editLicenseTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EDIT_ADD tests.
  
  Specified by:
  
  editLicenseTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- editOverwriteTest
  
  protected void editOverwriteTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.EDIT_OVERWRITE tests.
  
  Specified by:
  
  editOverwriteTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- logLevelTest
  
  protected void logLevelTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.LOG_LEVEL tests.
  
  Specified by:
  
  logLevelTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputArchiveTest
  
  protected void outputArchiveTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_ARCHIVE tests.
  
  Specified by:
  
  outputArchiveTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputFamiliesTest
  
  protected void outputFamiliesTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_FAMILIES tests.
  
  Specified by:
  
  outputFamiliesTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputFileTest
  
  protected void outputFileTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_FILE tests.
  
  Specified by:
  
  outputFileTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputLicensesTest
  
  protected void outputLicensesTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_LICENSES tests.
  
  Specified by:
  
  outputLicensesTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputStandardTest
  
  protected void outputStandardTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_STANDARD tests.
  
  Specified by:
  
  outputStandardTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.
- outputStyleTest
  
  protected void outputStyleTest(Set<TestData> result, org.apache.commons.cli.Option option)
  
  Description copied from class: AbstractTestDataProvider
  
  Execute an Arg.OUTPUT_STYLE tests.
  
  Specified by:
  
  outputStyleTest in class AbstractTestDataProvider
  
  Parameters:
  
  result - the set of configured tests.
  
  option - the specific option being tested.

Class OptionTestDataProvider

Field Summary

Fields inherited from class org.apache.rat.testhelpers.data.AbstractTestDataProvider

Constructor Summary

Method Summary

Methods inherited from class org.apache.rat.testhelpers.data.AbstractTestDataProvider

Methods inherited from class java.lang.Object

Constructor Details

OptionTestDataProvider

Method Details

getUITestMap

inputExcludeFileTest

inputExcludeTest

inputExcludeStdTest

inputExcludeParsedScmTest

inputExcludeSizeTest

inputIncludeFileTest

inputIncludeTest

inputIncludeStdTest

inputSourceTest

helpLicenses

licensesApprovedFileTest

licensesApprovedTest

licensesDeniedTest

licensesDeniedFileTest

licenseFamiliesApprovedFileTest

licenseFamiliesApprovedTest

licenseFamiliesDeniedFileTest

licenseFamiliesDeniedTest

counterMaxTest

counterMinTest

configTest

configurationNoDefaultsTest

dryRunTest

editCopyrightTest

editLicenseTest

editOverwriteTest

logLevelTest

outputArchiveTest

outputFamiliesTest

outputFileTest

outputLicensesTest

outputStandardTest

outputStyleTest