Package de.gematik.combine
Class CombineMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- de.gematik.BaseMojo
-
- de.gematik.combine.CombineMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo
@Mojo(name="prepare-combine", defaultPhase=GENERATE_TEST_SOURCES) public class CombineMojo extends BaseMojoPlugin for filling empty gherkin tables with generated combinations
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCombineMojo.ErrorType
-
Field Summary
Fields Modifier and Type Field Description static StringEMPTY_EXAMPLES_TABLE_TAGstatic StringMINIMAL_TABLE_ERROR_HEADERstatic StringTEST_RESOURCES_DIRstatic StringWARN_MESSAGEstatic StringWIP_TAG-
Fields inherited from class de.gematik.BaseMojo
apiErrors, GENERATED_COMBINE_ITEMS_DIR
-
-
Constructor Summary
Constructors Constructor Description CombineMojo(FileProcessor replacer)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Collection<File>allFiles(String dir, String ending)static voidappendError(String error, CombineMojo.ErrorType type)static voidcopyFiles(String from, String to, String ending)voidexecute()voidexecute(CombineConfiguration config)static CombineMojogetInstance()static List<String>getMinimalTableErrorLog()static org.apache.maven.plugin.logging.LoggetPluginLog()StringgetPluginTagCategory()Prefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the reportstatic List<String>getPropertyErrorLog()static List<String>getTableSizeErrorLog()StringgetVersionFilterTagCategory()Prefix that is added to all version filter tags in the feature file to categorize them under in the reportStringgetVersionProperty()The plugin will look for this property to determine the version of an item, may be set to an arbitrary string, default is "version"static List<String>getWarningsLog()static voidresetError()voidsetBreakIfMinimalTableError(boolean breakIfMinimalTableError)The plugin will throw exception if minimal table could not generate valid row for at least one valuevoidsetBreakIfTableToSmall(boolean breakIfTableToSmall)The plugin will throw exception it was not able to add at least one rowvoidsetCountExecutions(boolean countExecutions)Parameter to decide if executions should be counted and exported to filevoidsetCountExecutionsFormat(List<String> countExecutionsFormat)In what formats should the counted executions be exportedvoidsetDefaultExamplesTags(List<String> defaultExamplesTags)List of tags that are added to each processed examples tablevoidsetEmptyExamplesTags(List<String> emptyExamplesTags)The plugin will add these tags to all examples tables where it was not able to add at least one rowvoidsetEnding(String ending)The specific ending of the templatesvoidsetFilterConfiguration(FilterConfiguration filterConfiguration)Filter Configurationstatic voidsetInstance(CombineMojo instance)voidsetMinTableSize(int minTableSize)The plugin will throw exception it was not able to add at least one rowvoidsetOutputDir(String outputDir)Path to the directory where the rendered templates got storedvoidsetPluginTagCategory(String pluginTagCategory)Prefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the reportvoidsetProjectFilters(ProjectFilters projectFilters)Project FiltersvoidsetSkipComb(boolean skipComb)Parameter to decide if combine-execution should be runvoidsetSkipTags(List<String> skipTags)List of tags that are skipped by this pluginvoidsetSoftFilterToHardFilter(boolean softFilterToHardFilter)Parameter to decide if SoftFiler should be not considered if minimal table size not reachedvoidsetTemplateDir(String templateDir)Path to the directory of the templatesvoidsetVersionFilterTagCategory(String versionFilterTagCategory)Prefix that is added to all version filter tags in the feature file to categorize them under in the reportvoidsetVersionProperty(String versionProperty)The plugin will look for this property to determine the version of an item, may be set to an arbitrary string, default is "version"static FilestripEnding(File file, String ending)-
Methods inherited from class de.gematik.BaseMojo
getAcceptedResponseFamilies, getAllowedResponseCodes, getApiErrors, getClientCertStore, getClientCertStorePw, getCombineItemsFile, getProxyHost, getProxyPort, getTruststore, getTruststorePw, isBreakOnContextError, isBreakOnFailedRequest, isSkip, setAcceptedResponseFamilies, setAllowedResponseCodes, setBreakOnContextError, setBreakOnFailedRequest, setClientCertStore, setClientCertStorePw, setCombineItemsFile, setProxyHost, setProxyPort, setSkip, setTruststore, setTruststorePw
-
-
-
-
Field Detail
-
EMPTY_EXAMPLES_TABLE_TAG
public static final String EMPTY_EXAMPLES_TABLE_TAG
- See Also:
- Constant Field Values
-
WIP_TAG
public static final String WIP_TAG
- See Also:
- Constant Field Values
-
TEST_RESOURCES_DIR
public static final String TEST_RESOURCES_DIR
- See Also:
- Constant Field Values
-
WARN_MESSAGE
public static final String WARN_MESSAGE
- See Also:
- Constant Field Values
-
MINIMAL_TABLE_ERROR_HEADER
public static final String MINIMAL_TABLE_ERROR_HEADER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CombineMojo
@Inject public CombineMojo(FileProcessor replacer)
-
-
Method Detail
-
execute
public void execute()
-
execute
public void execute(CombineConfiguration config) throws org.apache.maven.plugin.MojoExecutionException
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
allFiles
public static Collection<File> allFiles(String dir, String ending)
-
getPluginLog
public static org.apache.maven.plugin.logging.Log getPluginLog()
-
appendError
public static void appendError(String error, CombineMojo.ErrorType type)
-
resetError
public static void resetError()
-
setOutputDir
public void setOutputDir(String outputDir)
Path to the directory where the rendered templates got stored
-
setTemplateDir
public void setTemplateDir(String templateDir)
Path to the directory of the templates
-
setEnding
public void setEnding(String ending)
The specific ending of the templates
-
setEmptyExamplesTags
public void setEmptyExamplesTags(List<String> emptyExamplesTags)
The plugin will add these tags to all examples tables where it was not able to add at least one row
-
setBreakIfTableToSmall
public void setBreakIfTableToSmall(boolean breakIfTableToSmall)
The plugin will throw exception it was not able to add at least one row
-
setMinTableSize
public void setMinTableSize(int minTableSize)
The plugin will throw exception it was not able to add at least one row
-
setBreakIfMinimalTableError
public void setBreakIfMinimalTableError(boolean breakIfMinimalTableError)
The plugin will throw exception if minimal table could not generate valid row for at least one value
-
setPluginTagCategory
public void setPluginTagCategory(String pluginTagCategory)
Prefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the report
-
setVersionFilterTagCategory
public void setVersionFilterTagCategory(String versionFilterTagCategory)
Prefix that is added to all version filter tags in the feature file to categorize them under in the report
-
setVersionProperty
public void setVersionProperty(String versionProperty)
The plugin will look for this property to determine the version of an item, may be set to an arbitrary string, default is "version"
-
setDefaultExamplesTags
public void setDefaultExamplesTags(List<String> defaultExamplesTags)
List of tags that are added to each processed examples table
-
setSkipTags
public void setSkipTags(List<String> skipTags)
List of tags that are skipped by this plugin
-
setFilterConfiguration
public void setFilterConfiguration(FilterConfiguration filterConfiguration)
Filter Configuration
-
setProjectFilters
public void setProjectFilters(ProjectFilters projectFilters)
Project Filters
-
setSkipComb
public void setSkipComb(boolean skipComb)
Parameter to decide if combine-execution should be run
-
setSoftFilterToHardFilter
public void setSoftFilterToHardFilter(boolean softFilterToHardFilter)
Parameter to decide if SoftFiler should be not considered if minimal table size not reached
-
setCountExecutions
public void setCountExecutions(boolean countExecutions)
Parameter to decide if executions should be counted and exported to file
-
setCountExecutionsFormat
public void setCountExecutionsFormat(List<String> countExecutionsFormat)
In what formats should the counted executions be exported
-
getInstance
public static CombineMojo getInstance()
-
setInstance
public static void setInstance(CombineMojo instance)
-
getPluginTagCategory
public String getPluginTagCategory()
Prefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the report
-
getVersionFilterTagCategory
public String getVersionFilterTagCategory()
Prefix that is added to all version filter tags in the feature file to categorize them under in the report
-
getVersionProperty
public String getVersionProperty()
The plugin will look for this property to determine the version of an item, may be set to an arbitrary string, default is "version"
-
-