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 BaseMojo
Plugin for filling empty gherkin tables with generated combinations
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class de.gematik.BaseMojo
apiErrors, GENERATED_COMBINE_ITEMS_DIRFields inherited from interface org.apache.maven.plugin.Mojo
ROLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Collection<File>static voidappendError(String error, CombineMojo.ErrorType type) voidexecute()voidexecute(CombineConfiguration config) static CombineMojostatic org.apache.maven.plugin.logging.LogPrefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the reportPrefix that is added to all version filter tags in the feature file to categorize them under in the reportThe plugin will look for this property to determine the version of an item, may be set to an arbitrary string, default is "version"static voidvoidsetBreakIfMinimalTableError(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 rowvoidThe 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 reachedvoidsetTemplateSources(List<String> templateSources) 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, setTruststorePwMethods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
EMPTY_EXAMPLES_TABLE_TAG
- See Also:
-
WIP_TAG
- See Also:
-
TEST_RESOURCES_DIR
- See Also:
-
WARN_MESSAGE
- See Also:
-
MINIMAL_TABLE_ERROR_HEADER
- See Also:
-
-
Constructor Details
-
CombineMojo
-
-
Method Details
-
execute
public void execute() -
execute
public void execute(CombineConfiguration config) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
stripEnding
-
allFiles
-
getPluginLog
public static org.apache.maven.plugin.logging.Log getPluginLog() -
appendError
-
resetError
public static void resetError() -
setOutputDir
Path to the directory where the rendered templates got stored -
setTemplateSources
Path to the directory of the templates -
setEnding
The specific ending of the templates -
setEmptyExamplesTags
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
Prefix that is added to all plugin specific tags (except version filters!) in the feature file to categorize them under in the report -
setVersionFilterTagCategory
Prefix that is added to all version filter tags in the feature file to categorize them under in the report -
setVersionProperty
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
List of tags that are added to each processed examples table -
setSkipTags
List of tags that are skipped by this plugin -
setFilterConfiguration
Filter Configuration -
setProjectFilters
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
In what formats should the counted executions be exported -
getInstance
-
setInstance
-
getTableSizeErrorLog
-
getMinimalTableErrorLog
-
getPropertyErrorLog
-
getWarningsLog
-
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
Prefix that is added to all version filter tags in the feature file to categorize them under in the report -
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"
-