com.github.sevntu.checkstyle.checks.design

Class CheckstyleTestMakeupCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.github.sevntu.checkstyle.checks.design.CheckstyleTestMakeupCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class CheckstyleTestMakeupCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck

Custom check to ensure Checkstyle tests are designed correctly.

Rationale: This check was made to ensure tests follow a specific design implementation so 3rd party utilities like the regression utility can parse the tests for information used in creating regression reports.

Check have following options:

• createMethodRegexp - Regular expression for matching a create configuration method by name. This is the name of the method that starts creating a custom module configuration to be used for verifying results for regression purposes. Default value is create(Root|Module)Config|getModuleConfig.
• verifyMethodRegexp - Regular expression for matching a verify method by name. This is the name of the method that verifies the execution results of the custom configuration created for regression. As such, it should accept the custom configuration as a parameter. Default value is verify(Warns|Suppressed)?.

To configure the check to report incorrectly made checkstyle tests:

 <module name="CheckstyleTestMakeup"/>
 

Since:

1.25.0

Author:

Richard Veach

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY_CONFIG_NOT_ASSIGNED Violations message.
static String	MSG_KEY_CONFIG_NOT_ASSIGNED_PROPERLY Violations message.
static String	MSG_KEY_CONFIG_NOT_ASSIGNED_WITH Violations message.
static String	MSG_KEY_CONFIG_NOT_FOUND Violations message.
static String	MSG_KEY_UNKNOWN_PROPERTY Violations message.

Constructor Summary

Constructors

Constructor and Description
CheckstyleTestMakeupCheck()

Method Summary

Modifier and Type	Method and Description
void	beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
void	setCreateMethodRegexp(Pattern createMethodRegexp) Setter for createMethodRegexp.
void	setVerifyMethodRegexp(Pattern verifyMethodRegexp) Setter for verifyMethodRegexp.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_KEY_CONFIG_NOT_ASSIGNED

public static final String MSG_KEY_CONFIG_NOT_ASSIGNED

Violations message.

See Also:

Constant Field Values

MSG_KEY_CONFIG_NOT_ASSIGNED_WITH

public static final String MSG_KEY_CONFIG_NOT_ASSIGNED_WITH

Violations message.

See Also:

Constant Field Values

MSG_KEY_CONFIG_NOT_ASSIGNED_PROPERLY

public static final String MSG_KEY_CONFIG_NOT_ASSIGNED_PROPERLY

Violations message.

See Also:

Constant Field Values

MSG_KEY_UNKNOWN_PROPERTY

public static final String MSG_KEY_UNKNOWN_PROPERTY

Violations message.

See Also:

Constant Field Values

MSG_KEY_CONFIG_NOT_FOUND

public static final String MSG_KEY_CONFIG_NOT_FOUND

Violations message.

See Also:

Constant Field Values

Constructor Detail

CheckstyleTestMakeupCheck

public CheckstyleTestMakeupCheck()

Method Detail

setCreateMethodRegexp

public void setCreateMethodRegexp(Pattern createMethodRegexp)

Setter for createMethodRegexp.

Parameters:

createMethodRegexp - The value to set.

setVerifyMethodRegexp

public void setVerifyMethodRegexp(Pattern verifyMethodRegexp)

Setter for verifyMethodRegexp.

Parameters:

verifyMethodRegexp - The value to set.

getDefaultTokens

public int[] getDefaultTokens()

Specified by:

getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getAcceptableTokens

public int[] getAcceptableTokens()

Specified by:

getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getRequiredTokens

public int[] getRequiredTokens()

Specified by:

getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree

public void beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)

Overrides:

beginTree in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

Overrides:

visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

leaveToken

public void leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

Overrides:

leaveToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck