From 4e2f61f3c5410351a9ef24accd5df240b1a441b6 Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Fri, 28 Oct 2022 05:35:35 -0700 Subject: [PATCH] Issue #11604: removal of ModuleReflectionUtil::isCheckstyleModule --- ...ices_should_be_free_of_cycles_suppressions | 28 +++++++++---------- .../utils/ModuleReflectionUtil.java | 19 ------------- .../checkstyle/internal/utils/CheckUtil.java | 2 +- .../utils/ModuleReflectionUtilTest.java | 25 ----------------- 4 files changed, 15 insertions(+), 59 deletions(-) diff --git a/config/archunit-store/slices_should_be_free_of_cycles_suppressions b/config/archunit-store/slices_should_be_free_of_cycles_suppressions index 08e79e572b6..5efc0530a6c 100644 --- a/config/archunit-store/slices_should_be_free_of_cycles_suppressions +++ b/config/archunit-store/slices_should_be_free_of_cycles_suppressions @@ -280,13 +280,13 @@ Cycle detected: Slice api -> \ - Method gets field in (ScopeUtil.java:57)\ - Static Initializer ()> references class object in (TokenUtil.java:60)\ - Method calls method in (ScopeUtil.java:73)\ + - Method references class object in (ModuleReflectionUtil.java:75)\ - Static Initializer ()> references class object in (JavadocUtil.java:79)\ - Method calls method in (BlockCommentPosition.java:85)\ - Method calls method in (BlockCommentPosition.java:88)\ - Method calls method in (ScopeUtil.java:88)\ - Method calls method in (BlockCommentPosition.java:89)\ - Method calls method in (BlockCommentPosition.java:92)\ - - Method references class object in (ModuleReflectionUtil.java:94)\ - Method calls method in (AnnotationUtil.java:95)\ - Method calls method in (CheckUtil.java:95)\ - Method calls method in (CheckUtil.java:96)\ @@ -298,6 +298,7 @@ Cycle detected: Slice api -> \ - Method calls method in (CheckUtil.java:103)\ - Method calls method in (CheckUtil.java:107)\ - Method calls method in (JavadocUtil.java:107)\ + - Method references class object in (ModuleReflectionUtil.java:107)\ - Method calls method in (ScopeUtil.java:107)\ - Method calls method in (CheckUtil.java:108)\ - Method gets field in (ScopeUtil.java:108)\ @@ -305,18 +306,19 @@ Cycle detected: Slice api -> \ - Method gets field in (ScopeUtil.java:111)\ - Method calls method in (JavadocUtil.java:114)\ - Method gets field in (ScopeUtil.java:114)\ + - Method references class object in (ModuleReflectionUtil.java:118)\ - Method gets field in (ScopeUtil.java:118)\ - Method calls method in (JavadocUtil.java:119)\ - Method calls method in (JavadocUtil.java:119)\ - Method gets field in (ScopeUtil.java:121)\ - Method calls method in (CheckUtil.java:122)\ - Method calls method in (CheckUtil.java:124)\ - - Method references class object in (ModuleReflectionUtil.java:126)\ + - Method references class object in (ModuleReflectionUtil.java:129)\ - Method calls method in (ScopeUtil.java:134)\ - Method calls method in (CheckUtil.java:135)\ - Method calls method in (ScopeUtil.java:136)\ - - Method references class object in (ModuleReflectionUtil.java:137)\ - Method calls method in (ScopeUtil.java:137)\ + - Method references class object in (ModuleReflectionUtil.java:140)\ - Method calls method in (ScopeUtil.java:140)\ - Method calls method in (AnnotationUtil.java:142)\ - Method gets field in (ScopeUtil.java:145)\ @@ -327,13 +329,12 @@ Cycle detected: Slice api -> \ - Method calls method in (AnnotationUtil.java:148)\ - Method calls method in (AnnotationUtil.java:148)\ - Method calls method in (CheckUtil.java:148)\ - - Method references class object in (ModuleReflectionUtil.java:148)\ - Method calls method in (AnnotationUtil.java:151)\ + - Method references class object in (ModuleReflectionUtil.java:151)\ - Method calls method in (XpathUtil.java:157)\ - - Method references class object in (ModuleReflectionUtil.java:159)\ + - Method references class object in (ModuleReflectionUtil.java:162)\ - Method calls method in (XpathUtil.java:167)\ - Method calls method in (XpathUtil.java:168)\ - - Method references class object in (ModuleReflectionUtil.java:170)\ - Method calls method in (BlockCommentPosition.java:171)\ - Method calls method in (BlockCommentPosition.java:172)\ - Method calls method in (JavadocUtil.java:173)\ @@ -341,7 +342,6 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocUtil.java:174)\ - Method calls method in (BlockCommentPosition.java:175)\ - Method calls method in (BlockCommentPosition.java:175)\ - - Method references class object in (ModuleReflectionUtil.java:181)\ - Method calls method in (AnnotationUtil.java:185)\ - Method calls method in (JavadocUtil.java:185)\ - Method calls method in (AnnotationUtil.java:186)\ @@ -1324,13 +1324,13 @@ Cycle detected: Slice api -> \ - Method gets field in (ScopeUtil.java:57)\ - Static Initializer ()> references class object in (TokenUtil.java:60)\ - Method calls method in (ScopeUtil.java:73)\ + - Method references class object in (ModuleReflectionUtil.java:75)\ - Static Initializer ()> references class object in (JavadocUtil.java:79)\ - Method calls method in (BlockCommentPosition.java:85)\ - Method calls method in (BlockCommentPosition.java:88)\ - Method calls method in (ScopeUtil.java:88)\ - Method calls method in (BlockCommentPosition.java:89)\ - Method calls method in (BlockCommentPosition.java:92)\ - - Method references class object in (ModuleReflectionUtil.java:94)\ - Method calls method in (AnnotationUtil.java:95)\ - Method calls method in (CheckUtil.java:95)\ - Method calls method in (CheckUtil.java:96)\ @@ -1342,6 +1342,7 @@ Cycle detected: Slice api -> \ - Method calls method in (CheckUtil.java:103)\ - Method calls method in (CheckUtil.java:107)\ - Method calls method in (JavadocUtil.java:107)\ + - Method references class object in (ModuleReflectionUtil.java:107)\ - Method calls method in (ScopeUtil.java:107)\ - Method calls method in (CheckUtil.java:108)\ - Method gets field in (ScopeUtil.java:108)\ @@ -1349,18 +1350,19 @@ Cycle detected: Slice api -> \ - Method gets field in (ScopeUtil.java:111)\ - Method calls method in (JavadocUtil.java:114)\ - Method gets field in (ScopeUtil.java:114)\ + - Method references class object in (ModuleReflectionUtil.java:118)\ - Method gets field in (ScopeUtil.java:118)\ - Method calls method in (JavadocUtil.java:119)\ - Method calls method in (JavadocUtil.java:119)\ - Method gets field in (ScopeUtil.java:121)\ - Method calls method in (CheckUtil.java:122)\ - Method calls method in (CheckUtil.java:124)\ - - Method references class object in (ModuleReflectionUtil.java:126)\ + - Method references class object in (ModuleReflectionUtil.java:129)\ - Method calls method in (ScopeUtil.java:134)\ - Method calls method in (CheckUtil.java:135)\ - Method calls method in (ScopeUtil.java:136)\ - - Method references class object in (ModuleReflectionUtil.java:137)\ - Method calls method in (ScopeUtil.java:137)\ + - Method references class object in (ModuleReflectionUtil.java:140)\ - Method calls method in (ScopeUtil.java:140)\ - Method calls method in (AnnotationUtil.java:142)\ - Method gets field in (ScopeUtil.java:145)\ @@ -1371,13 +1373,12 @@ Cycle detected: Slice api -> \ - Method calls method in (AnnotationUtil.java:148)\ - Method calls method in (AnnotationUtil.java:148)\ - Method calls method in (CheckUtil.java:148)\ - - Method references class object in (ModuleReflectionUtil.java:148)\ - Method calls method in (AnnotationUtil.java:151)\ + - Method references class object in (ModuleReflectionUtil.java:151)\ - Method calls method in (XpathUtil.java:157)\ - - Method references class object in (ModuleReflectionUtil.java:159)\ + - Method references class object in (ModuleReflectionUtil.java:162)\ - Method calls method in (XpathUtil.java:167)\ - Method calls method in (XpathUtil.java:168)\ - - Method references class object in (ModuleReflectionUtil.java:170)\ - Method calls method in (BlockCommentPosition.java:171)\ - Method calls method in (BlockCommentPosition.java:172)\ - Method calls method in (JavadocUtil.java:173)\ @@ -1385,7 +1386,6 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocUtil.java:174)\ - Method calls method in (BlockCommentPosition.java:175)\ - Method calls method in (BlockCommentPosition.java:175)\ - - Method references class object in (ModuleReflectionUtil.java:181)\ - Method calls method in (AnnotationUtil.java:185)\ - Method calls method in (JavadocUtil.java:185)\ - Method calls method in (AnnotationUtil.java:186)\ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtil.java index 882ee49589d..8a23e05a1d0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtil.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtil.java @@ -64,25 +64,6 @@ public static Set> getValidCheckstyleClasses( .collect(Collectors.toSet()); } - /** - * Checks whether a class may be considered as a checkstyle module. Checkstyle's modules are - * non-abstract classes, which are either checkstyle's checks, file sets, filters, file filters, - * {@code TreeWalker} filters, audit listener, or root module. - * - * @param clazz class to check. - * @return true if the class may be considered as the checkstyle module. - */ - public static boolean isCheckstyleModule(Class clazz) { - return isValidCheckstyleClass(clazz) - && (isCheckstyleTreeWalkerCheck(clazz) - || isFileSetModule(clazz) - || isFilterModule(clazz) - || isFileFilterModule(clazz) - || isTreeWalkerFilterModule(clazz) - || isAuditListener(clazz) - || isRootModule(clazz)); - } - /** * Checks whether a class extends 'AutomaticBean', is non-abstract, and has a default * constructor. diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/utils/CheckUtil.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/utils/CheckUtil.java index ae779e07be3..965b28548db 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/internal/utils/CheckUtil.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/internal/utils/CheckUtil.java @@ -181,7 +181,7 @@ private static Set> getCheckstyleModulesRecursive( final ClassPath classPath = ClassPath.from(loader); return classPath.getTopLevelClassesRecursive(packageName).stream() .map(ClassPath.ClassInfo::load) - .filter(ModuleReflectionUtil::isCheckstyleModule) + .filter(ModuleReflectionUtil::isValidCheckstyleClass) .filter(CheckUtil::isFromAllowedPackages) .collect(Collectors.toSet()); } diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java index 38c4640e6d0..e944c838ac8 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java @@ -50,31 +50,6 @@ public void testIsProperUtilsClass() throws ReflectiveOperationException { .isTrue(); } - @Test - public void testIsCheckstyleModule() { - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(CheckClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(FileSetModuleClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(FilterClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(TreeWalkerFilterClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(FileFilterModuleClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(AuditListenerClass.class)) - .isTrue(); - assertWithMessage("Should return true when checkstyle module is passed") - .that(ModuleReflectionUtil.isCheckstyleModule(RootModuleClass.class)) - .isTrue(); - } - @Test public void testIsValidCheckstyleClass() { assertWithMessage("Should return true when valid checkstyle class is passed")