-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue #7728: Update AbstractChecks to log DetailAST - CustomImportOrder
- Loading branch information
1 parent
7a71e8a
commit 8d10bc0
Showing
13 changed files
with
484 additions
and
223 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionCustomImportOrderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
| // checkstyle: Checks Java source code for adherence to a set of rules. | ||
| // Copyright (C) 2001-2020 the original author or authors. | ||
| // | ||
| // This library is free software; you can redistribute it and/or | ||
| // modify it under the terms of the GNU Lesser General Public | ||
| // License as published by the Free Software Foundation; either | ||
| // version 2.1 of the License, or (at your option) any later version. | ||
| // | ||
| // This library is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| // Lesser General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Lesser General Public | ||
| // License along with this library; if not, write to the Free Software | ||
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| package org.checkstyle.suppressionxpathfilter; | ||
|
|
||
| import java.io.File; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.puppycrawl.tools.checkstyle.DefaultConfiguration; | ||
| import com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck; | ||
|
|
||
| public class XpathRegressionCustomImportOrderTest extends AbstractXpathTestSupport { | ||
|
|
||
| private final String checkName = CustomImportOrderCheck.class.getSimpleName(); | ||
|
|
||
| @Override | ||
| protected String getCheckName() { | ||
| return checkName; | ||
| } | ||
|
|
||
| @Test | ||
| public void testOne() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderOne.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", "STATIC###STANDARD_JAVA_PACKAGE"); | ||
| moduleConfig.addAttribute("sortImportsInGroupAlphabetically", "true"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "4:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_LEX, "java.lang.Math.PI", | ||
| "java.util.Arrays.sort"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/STATIC_IMPORT[./DOT/IDENT[@text='PI']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| @Test | ||
| public void testTwo() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderTwo.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", "STATIC###STANDARD_JAVA_PACKAGE"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "5:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_LINE_SEPARATOR, "java.io.File"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/IMPORT[./DOT/IDENT[@text='File']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| @Test | ||
| public void testThree() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderThree.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", "STATIC###STANDARD_JAVA_PACKAGE"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "5:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_SEPARATED_IN_GROUP, "java.lang.Math.PI"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/STATIC_IMPORT[./DOT/IDENT[@text='PI']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFour() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderFour.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", "STATIC###STANDARD_JAVA_PACKAGE"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "5:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_NONGROUP_IMPORT, | ||
| "com.puppycrawl.tools.checkstyle.api.DetailAST"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/IMPORT[./DOT/IDENT[@text='DetailAST']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFive() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderFive.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", "STATIC###STANDARD_JAVA_PACKAGE"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "7:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_NONGROUP_EXPECTED, "STATIC", | ||
| "java.lang.Math.PI"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/STATIC_IMPORT[./DOT/IDENT[@text='PI']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSix() throws Exception { | ||
| final File fileToProcess = | ||
| new File(getPath("SuppressionXpathRegressionCustomImportOrderSix.java")); | ||
|
|
||
| final DefaultConfiguration moduleConfig = | ||
| createModuleConfig(CustomImportOrderCheck.class); | ||
| moduleConfig.addAttribute("customImportOrderRules", | ||
| "STATIC###STANDARD_JAVA_PACKAGE###THIRD_PARTY_PACKAGE"); | ||
|
|
||
| final String[] expectedViolation = { | ||
| "6:1: " + getCheckMessage(CustomImportOrderCheck.class, | ||
| CustomImportOrderCheck.MSG_ORDER, "THIRD_PARTY_PACKAGE", | ||
| "STANDARD_JAVA_PACKAGE", | ||
| "com.puppycrawl.tools.checkstyle.api.DetailAST"), | ||
| }; | ||
|
|
||
| final List<String> expectedXpathQueries = Collections.singletonList( | ||
| "/IMPORT[./DOT/IDENT[@text='DetailAST']]" | ||
| ); | ||
|
|
||
| runVerifications(moduleConfig, fileToProcess, expectedViolation, | ||
| expectedXpathQueries); | ||
| } | ||
|
|
||
| } |
13 changes: 13 additions & 0 deletions
13
...ressionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderFive.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import static java.lang.Math.PI; // warn | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderFive { | ||
| // code | ||
| } |
14 changes: 14 additions & 0 deletions
14
...ressionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderFour.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
| import static java.lang.Math.PI; | ||
| import com.puppycrawl.tools.checkstyle.api.DetailAST; // warn | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderFour { | ||
| // code | ||
| } |
13 changes: 13 additions & 0 deletions
13
...pressionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderOne.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
| import static java.lang.Math.PI; // warn | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderOne { | ||
| // code | ||
| } |
15 changes: 15 additions & 0 deletions
15
...pressionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderSix.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
| import static java.lang.Math.PI; | ||
|
|
||
| import com.puppycrawl.tools.checkstyle.api.DetailAST; // warn | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderSix { | ||
| // code | ||
| } |
14 changes: 14 additions & 0 deletions
14
...essionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderThree.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
|
|
||
| import static java.lang.Math.PI; // warn | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderThree { | ||
| // code | ||
| } |
12 changes: 12 additions & 0 deletions
12
...pressionxpathfilter/customimportorder/SuppressionXpathRegressionCustomImportOrderTwo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package org.checkstyle.suppressionxpathfilter.customimportorder; | ||
|
|
||
| import static java.util.Arrays.sort; | ||
| import static java.lang.Math.PI; | ||
| import java.io.File; // warn | ||
| import java.io.FileInputStream; | ||
| import java.util.HashMap; | ||
| import java.util.Scanner; | ||
|
|
||
| public class SuppressionXpathRegressionCustomImportOrderTwo { | ||
| // code | ||
| } |
Oops, something went wrong.