Package com.qulice.checkstyle

Class ProhibitFieldsInTestClassesCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.qulice.checkstyle.ProhibitFieldsInTestClassesCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
public final class ProhibitFieldsInTestClassesCheck extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
Checks that test classes do not declare instance fields, since such fields couple tests together through shared state.

Only files whose names match the configured pattern (by default *Test.java, *IT.java, *ITCase.java) are inspected. Within those files, only instance fields declared on the top-level type are flagged, unless the field carries at least one annotation (e.g. @Rule, @ClassRule, @Parameter, @TempDir, @Mock). Static fields are ignored, because they represent compile-time constants or shared fixtures rather than per-test state. Fields declared on nested helper types (stubs, fakes, recorders) are not flagged, because they belong to the helper, not to the test class.

See also Unit Test Scaffolding.

Since:
0.24

  • Nested Class Summary

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

    com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProhibitFieldsInTestClassesCheck()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    getAcceptableTokens()
     
    int[]
    getDefaultTokens()
     
    int[]
    getRequiredTokens()
     
    void
    setIncludeFileNamePattern(String regex)
    Restrict the check to files matching the given pattern.
    void
    visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
     

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

    beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, 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.AbstractAutomaticBean

    configure, contextualize, getConfiguration, setupChild

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProhibitFieldsInTestClassesCheck

      public ProhibitFieldsInTestClassesCheck()

  • Method Details

    • setIncludeFileNamePattern

      public void setIncludeFileNamePattern(String regex)
      Restrict the check to files matching the given pattern.
      Parameters:
      regex - Regex of file names to include

    • 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

    • visitToken

      public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
      Overrides:
      visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck