SuppressionXpathFilter in Checkstyle 10.9.3 sun_checks10.xml file is not ignoring what's specified in my xpath-suppressions.xml file #13032

schenkjd · 2023-04-26T18:51:28Z

schenkjd
Apr 26, 2023

Hello, I have read the documentation from: https://checkstyle.sourceforge.io/config_filters.html#SuppressionFilter and https://checkstyle.sourceforge.io/cmdline.html and https://www.w3schools.com/xml/xpath_axes.asp.

I am using Java 17 and Checkstyle 10.9.3 (downloaded from https://github.com/checkstyle/checkstyle/releases/tag/checkstyle-10.9.3).

docs/mvToFpa% javac PlantView.java

docs/mvToFpa% cat PlantView.java

import java.awt.BorderLayout;

public class PlantView extends javax.swing.JDialog {
    /**
     * Constructs a new dialog for modifying a plant.
     */
    public PlantView() {
        int varIWantIdentified = 5567;
        String lineIWantIdentified = "00000000000000000000000000000000000000000000000000000000000000000000000000000000";
        initComponents();
    }

    // BEGIN GENERATED CODE
    /**
     * This method is called from within the constructor to initialize the form. WARNING: Do NOT
     * modify this code. The content of this method is always regenerated by the Form Editor.
     */
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {
        String longLineToSuppress = "11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111";
        int var1 = 1;
        String longLineSuppress = "22222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222";
        System.err.println("Just adding some fluff.");
        BorderLayout bl = new BorderLayout(351, 234);
    }
    // </editor-fold>//GEN-END:initComponents
    // Variables declaration - do not modify//GEN-BEGIN:variables
    // End of variables declaration//GEN-END:variables
}

docs/mvToFpa% cat xpath-suppressions.xml

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
    "-//Checkstyle//DTD SuppressionXpathFilter Experimental Configuration 1.2//EN"
    "https://checkstyle.org/dtds/suppressions_1_2_xpath_experimental.dtd">

<suppressions>
  <suppress-xpath checks=".*" query="//METHOD_DEF[./IDENT[@text='initComponents']]/descendant-or-self::node()"/>
  <!-- <suppress-xpath checks="LineLength" query="//METHOD_DEF[./IDENT[@text='initComponents']]/descendant-or-self::node()"/>
  <suppress-xpath checks="MagicNumber" query="//METHOD_DEF[./IDENT[@text='initComponents']]/descendant-or-self::node()"/> -->
</suppressions>

docs/mvToFpa% cat sun_checks10.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
  <!--
      If you set the basedir property below, then all reported file
      names will be relative to the specified directory. See
      https://checkstyle.org/config.html#Checker
  -->

  <!-- <property name="basedir" value="${basedir}"/> -->
  <property name="basedir" value="/home/schenkjd/ws/fpa/main/hg/fpa"/>
  <property name="severity" value="error"/>

  <property name="fileExtensions" value="java, properties, xml"/>

  <!-- Excludes all 'module-info.java' files              -->
  <!-- See https://checkstyle.org/config_filefilters.html -->
  <module name="BeforeExecutionExclusionFileFilter">
    <property name="fileNamePattern" value="module\-info\.java$"/>
  </module>

  <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
  <!-- <module name="SuppressionFilter">
    <property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
              default="checkstyle-suppressions.xml" />
    <property name="optional" value="true"/>
  </module> -->

  <!-- Checks that a package-info.java file exists for each package.     -->
  <!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
  <module name="JavadocPackage"/>

  <!-- Checks whether files end with a new line.                        -->
  <!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
  <module name="NewlineAtEndOfFile"/>

  <!-- Checks that property files contain the same keys.         -->
  <!-- See https://checkstyle.org/config_misc.html#Translation -->
  <module name="Translation"/>

  <!-- Checks for Size Violations.                    -->
  <!-- See https://checkstyle.org/config_sizes.html -->
  <module name="FileLength"/>
  <!-- <module name="LineLength">
    <property name="fileExtensions" value="java"/>
  </module>  -->

  <!-- Westinghouse NF-SD Overrides -->
  <module name="LineLength">
    <property name="fileExtensions" value="java"/>
    <property name="ignorePattern" value="^import.*"/>
    <property name="max" value="100"/>
  </module>  

  <!-- Checks for whitespace                               -->
  <!-- See https://checkstyle.org/config_whitespace.html -->
  <module name="FileTabCharacter"/>

  <!-- Miscellaneous other checks.                   -->
  <!-- See https://checkstyle.org/config_misc.html -->
  <module name="RegexpSingleline">
    <property name="format" value="\s+$"/>
    <property name="minimum" value="0"/>
    <property name="maximum" value="0"/>
    <property name="message" value="Line has trailing spaces."/>
  </module>

  <!-- Checks for Headers                                -->
  <!-- See https://checkstyle.org/config_header.html   -->
  <!-- <module name="Header"> -->
  <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
  <!--   <property name="fileExtensions" value="java"/> -->
  <!-- </module> -->

  <!-- <module name="SuppressionFilter">
    <property name="file" value="/home/schenkjd/ws/fpa/main/hg/fpa/docs/mvToFpa/suppressions.xml"/>
    <property name="optional" value="false"/>
  </module>  -->

  <module name="TreeWalker">
 
    <module name="SuppressionXpathFilter">
        <property name="file" value="/home/schenkjd/ws/fpa/main/hg/fpa/docs/mvToFpa/xpath-suppressions.xml"/>
        <property name="optional" value="true"/>
    </module> 

    <!-- <module name="SuppressionXpathSingleFilter">
       <property name="checks" value=".*"/>
       <property name="query" value="//METHOD_DEF[@text='initComponents']/descendant-or-self::node()"/>
    </module> -->

    <!-- Checks for Javadoc comments.                     -->
    <!-- See https://checkstyle.org/config_javadoc.html -->
    <module name="InvalidJavadocPosition"/>

    <!-- Westinghouse-specific JavadocMethod -->
    <module name="JavadocMethod"> 
      <property name="accessModifiers" value="public"/>
    </module>
    <!-- <module name="JavadocMethod"/>  -->

    <module name="JavadocType"/>

    <!-- Westinghouse-specific JavadocVariable -->
    <module name="JavadocVariable">
      <property name="scope" value="public"/>
    </module>

    <!-- <module name="JavadocVariable"/> -->
    <module name="JavadocStyle"/>
    <module name="MissingJavadocMethod"/>

    <!-- Checks for Naming Conventions.                  -->
    <!-- See https://checkstyle.org/config_naming.html -->
    <module name="ConstantName"/>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="MemberName"/>
    <module name="MethodName"/>
    <module name="PackageName"/>
    <module name="ParameterName"/>
    <module name="StaticVariableName"/>
    <module name="TypeName"/>

    <!-- Checks for imports                              -->
    <!-- See https://checkstyle.org/config_imports.html -->
    <module name="AvoidStarImport"/>
    <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
    <module name="RedundantImport"/>
    <module name="UnusedImports">
      <property name="processJavadoc" value="false"/>
    </module>

    <!-- Checks for Size Violations.                    -->
    <!-- See https://checkstyle.org/config_sizes.html -->
    <module name="MethodLength"/>
    <module name="ParameterNumber"/>

    <!-- Checks for whitespace                               -->
    <!-- See https://checkstyle.org/config_whitespace.html -->
    <module name="EmptyForIteratorPad"/>
    <module name="GenericWhitespace"/>
    <module name="MethodParamPad"/>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="OperatorWrap"/>
    <module name="ParenPad"/>
    <module name="TypecastParenPad"/>
    <module name="WhitespaceAfter"/>
    <module name="WhitespaceAround"/>

    <!-- Modifier Checks                                    -->
    <!-- See https://checkstyle.org/config_modifiers.html -->
    <module name="ModifierOrder"/>
    <module name="RedundantModifier"/>

    <!-- Checks for blocks. You know, those {}'s         -->
    <!-- See https://checkstyle.org/config_blocks.html -->
    <module name="AvoidNestedBlocks"/>
    <module name="EmptyBlock"/>
    <module name="LeftCurly"/>
    <module name="NeedBraces"/>
    <module name="RightCurly"/>

    <!-- Checks for common coding problems               -->
    <!-- See https://checkstyle.org/config_coding.html -->
    <module name="EmptyStatement"/>
    <module name="EqualsHashCode"/>
    <module name="HiddenField"/>
    <module name="IllegalInstantiation"/>
    <module name="InnerAssignment"/>
    <module name="MagicNumber"/>
    <module name="MissingSwitchDefault"/>
    <module name="MultipleVariableDeclarations"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>

    <!-- Checks for class design                         -->
    <!-- See https://checkstyle.org/config_design.html -->
    <module name="DesignForExtension"/>
    <module name="FinalClass"/>
    <module name="HideUtilityClassConstructor"/>
    <module name="InterfaceIsType"/>
    <module name="VisibilityModifier"/>

    <!-- Miscellaneous other checks.                   -->
    <!-- See https://checkstyle.org/config_misc.html -->
    <module name="ArrayTypeStyle"/>
    <module name="FinalParameters"/>
    <module name="TodoComment"/>
    <module name="UpperEll"/>
  </module>
</module>

docs/mvToFpa% /opt/java/jdk-17.0.6/bin/java -jar /opt/checkstyle-10.9.3/checkstyle-10.9.3-all.jar -c sun_checks10.xml -o PlantViewChecks.txt PlantView.java
Checkstyle ends with 5 errors.

docs/mvToFpa% cat PlantViewChecks.txt

Starting audit...
[ERROR] docs/mvToFpa/PlantView.java:1: Missing package-info.java file. [JavadocPackage]
[ERROR] docs/mvToFpa/PlantView.java:11:34: '5567' is a magic number. [MagicNumber]
[ERROR] docs/mvToFpa/PlantView.java:12: Line is longer than 100 characters (found 120). [LineLength]
[ERROR] docs/mvToFpa/PlantView.java:23: Line is longer than 100 characters (found 134). [LineLength]
[ERROR] docs/mvToFpa/PlantView.java:25: Line is longer than 100 characters (found 132). [LineLength]
Audit done.

Expected:
First three errors.
Suppression of last two errors that are in ‘initComponents’.

Answered by romani

Apr 28, 2023

Actually I think I will just use @Suppress Warnings("all"). That seems to be the best bet and I have it working now.

It is good. We have bunch of way to do suppression, choose what you like most or suites you.

Instead of "all" you can specify name of Check to be explicit.

You can try to use this Check https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/sizes/LineLengthExtendedCheck.java it is AST based.

View full answer

romani · 2023-04-27T13:15:15Z

romani
Apr 27, 2023
Maintainer

if you need to suppress all violations in code block that is generated it might be easiler to use this filter:
https://checkstyle.org/config_filters.html#SuppressionCommentFilter_Examples

hmm your xpath looks like matching:

java -jar checkstyle-10.9.2-all.jar Test.java \
  -b "//METHOD_DEF[./IDENT[@text='initComponents']]/descendant-or-self::node()" \
 | grep longLineToSuppress
        |       |   |--IDENT -> longLineToSuppress [20:15]

problem is that LineLength is not child of Treewalker so filters of tree walker are not applicable.
https://checkstyle.org/config_sizes.html#LineLength_Parent_Module
So all Xpath filters are not going to help you, as Check operates on plain text file, without parcing java code to AST.

Use https://checkstyle.org/config_filters.html#SuppressionCommentFilter and make offCommentFormat=GEN-BEGIN to be

2 replies

schenkjd Apr 27, 2023
Author

It looks like there might have been part of the reply not included, as the end says: "to be ...". Was there supposed to be more?

I appreciate the reply however it does not help. As you say, LineLength is not a child of TreeWalker and documentation of
SuppressCommentFilter says: "SuppressionCommentFilter can suppress Checks that have Treewalker as parent module."

I do not mind using the comment filter, even though I'd have to add it to 57 files, but I do not see how it will help. Is there no way to simply ignore a method?

Actually I think I will just use @SuppressWarnings("all"). That seems to be the best bet and I have it working now.

Following is using "SuppressionCommentFilter" but as expected, LineLengths are still "caught" in the 'initComponents' method.

docs/mvToFpa% cat PlantView.java
import java.awt.BorderLayout;

/**

@author
/
public class PlantView extends javax.swing.JDialog {
/*
- Constructs a new dialog for modifying a plant.
  */
  public PlantView() {
  int varIWantIdentified = 5567;
  String lineIWantIdentified = "00000000000000000000000000000000000000000000000000000000000000000000000000000000";
  initComponents();
  }
// BEGIN GENERATED CODE
/**
- This method is called from within the constructor to initialize the form. WARNING: Do NOT
- modify this code. The content of this method is always regenerated by the Form Editor.
  */
  // //GEN-BEGIN:initComponents
  //CHECKSTYLE:OFF
  private void initComponents() {
  String longLineToSuppress = "11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111";
  int var1 = 1;
  String longLineSuppress = "22222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222222";
  System.err.println("Just adding some fluff.");
  BorderLayout bl = new BorderLayout(351, 234);
  }
  //CHECKSTYLE:ON
  // //GEN-END:initComponents
  // Variables declaration - do not modify//GEN-BEGIN:variables
  // End of variables declaration//GEN-END:variables
  }

docs/mvToFpa% cat sun_checks10.xml

<!-- <module name="SuppressionXpathFilter">
    <property name="file" value="/home/schenkjd/ws/fpa/main/hg/fpa/docs/mvToFpa/xpath-suppressions.xml"/>
    <property name="optional" value="true"/>
</module>  -->

<!-- <module name="SuppressionXpathSingleFilter">
   <property name="checks" value=".*"/>
   <property name="query" value="//METHOD_DEF[@text='initComponents']/descendant-or-self::node()"/>
</module> -->

<!-- Checks for Javadoc comments.                     -->
<!-- See https://checkstyle.org/config_javadoc.html -->
<module name="InvalidJavadocPosition"/>

<!-- Westinghouse-specific JavadocMethod -->
<module name="JavadocMethod"> 
  <property name="accessModifiers" value="public"/>
</module>
<!-- <module name="JavadocMethod"/>  -->

<module name="JavadocType"/>

<!-- Westinghouse-specific JavadocVariable -->
<module name="JavadocVariable">
  <property name="scope" value="public"/>
</module>

<!-- <module name="JavadocVariable"/> -->
<module name="JavadocStyle"/>
<module name="MissingJavadocMethod"/>

<!-- Checks for Naming Conventions.                  -->
<!-- See https://checkstyle.org/config_naming.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>

<!-- Checks for imports                              -->
<!-- See https://checkstyle.org/config_imports.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports">
  <property name="processJavadoc" value="false"/>
</module>

<!-- Checks for Size Violations.                    -->
<!-- See https://checkstyle.org/config_sizes.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>

<!-- Checks for whitespace                               -->
<!-- See https://checkstyle.org/config_whitespace.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>

<!-- Modifier Checks                                    -->
<!-- See https://checkstyle.org/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>

<!-- Checks for blocks. You know, those {}'s         -->
<!-- See https://checkstyle.org/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>

<!-- Checks for common coding problems               -->
<!-- See https://checkstyle.org/config_coding.html -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MagicNumber"/>
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design                         -->
<!-- See https://checkstyle.org/config_design.html -->
<module name="DesignForExtension"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier"/>

<!-- Miscellaneous other checks.                   -->
<!-- See https://checkstyle.org/config_misc.html -->
<module name="ArrayTypeStyle"/>
<module name="FinalParameters"/>
<module name="TodoComment"/>
<module name="UpperEll"/>

docs/mvToFpa% /opt/java/jdk-17.0.6/bin/java -jar /opt/checkstyle-10.9.3/checkstyle-10.9.3-all.jar -c sun_checks10.xml -o PlantViewChecks.txt PlantView.java
Checkstyle ends with 5 errors.
docs/mvToFpa% cat PlantViewChecks.txt
Starting audit...
[ERROR] docs/mvToFpa/PlantView.java:1: Missing package-info.java file. [JavadocPackage]
[ERROR] docs/mvToFpa/PlantView.java:11:34: '5567' is a magic number. [MagicNumber]
[ERROR] docs/mvToFpa/PlantView.java:12: Line is longer than 100 characters (found 120). [LineLength]
[ERROR] docs/mvToFpa/PlantView.java:24: Line is longer than 100 characters (found 134). [LineLength]
[ERROR] docs/mvToFpa/PlantView.java:26: Line is longer than 100 characters (found 132). [LineLength]
Audit done.

Expected: What I got, based on the information given
What I want: To ignore the entire method initComponents or to ignore LineLength in initComponents – is it possible?

romani Apr 28, 2023
Maintainer

Actually I think I will just use @Suppress Warnings("all"). That seems to be the best bet and I have it working now.

It is good. We have bunch of way to do suppression, choose what you like most or suites you.

Instead of "all" you can specify name of Check to be explicit.

You can try to use this Check https://github.com/sevntu-checkstyle/sevntu.checkstyle/blob/master/sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/sizes/LineLengthExtendedCheck.java it is AST based.

Answer selected by schenkjd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SuppressionXpathFilter in Checkstyle 10.9.3 sun_checks10.xml file is not ignoring what's specified in my xpath-suppressions.xml file #13032

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 1 comment 2 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

SuppressionXpathFilter in Checkstyle 10.9.3 sun_checks10.xml file is not ignoring what's specified in my xpath-suppressions.xml file #13032

schenkjd Apr 26, 2023

Replies: 1 comment · 2 replies

romani Apr 27, 2023 Maintainer

schenkjd Apr 27, 2023 Author

romani Apr 28, 2023 Maintainer

schenkjd
Apr 26, 2023

Replies: 1 comment 2 replies

romani
Apr 27, 2023
Maintainer

schenkjd Apr 27, 2023
Author

romani Apr 28, 2023
Maintainer