Issue checkstyle#13809: Kill mutation in PackageObjectFactory-2

Kevin222004 · Nov 5, 2023 · 53898c3 · 53898c3
1 parent 6de140e
commit 53898c3
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 12 deletions.
diff --git a/config/checkstyle-input-suppressions.xml b/config/checkstyle-input-suppressions.xml
@@ -75,6 +75,10 @@
           files="[\\/]packageobjectfactory[\\/]foo[\\/]FooCheck.java"/>
   <suppress id="noCheckstyleInInputs"
           files="[\\/]packageobjectfactory[\\/]foo[\\/]FooCheck.java"/>
+  <suppress id="noCheckstyleInInputs"
+          files="[\\/]packageobjectfactory[\\/]abc[\\/]FooCheck.java"/>
+  <suppress id="noCheckstyleInInputs"
+          files="[\\/]packageobjectfactory[\\/]zoo[\\/]FooCheck.java"/>
   <suppress id="noCheckstyleInInputs"
           files="[\\/]meta[\\/]javadocmetadatascraper[\\/]InputJavadocMetadataScraperAbstractSuperCheck.java"/>
   <suppress id="noCheckstyleInInputs"

diff --git a/config/pitest-suppressions/pitest-common-suppressions.xml b/config/pitest-suppressions/pitest-common-suppressions.xml
@@ -45,15 +45,6 @@
     <lineContent>this.args = null;</lineContent>
   </mutation>
 
-  <mutation unstable="false">
-    <sourceFile>PackageObjectFactory.java</sourceFile>
-    <mutatedClass>com.puppycrawl.tools.checkstyle.PackageObjectFactory</mutatedClass>
-    <mutatedMethod>createObjectFromFullModuleNames</mutatedMethod>
-    <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.NakedReceiverMutator</mutator>
-    <description>replaced call to java/util/stream/Stream::sorted with receiver</description>
-    <lineContent>.sorted()</lineContent>
-  </mutation>
-
   <mutation unstable="false">
     <sourceFile>SarifLogger.java</sourceFile>
     <mutatedClass>com.puppycrawl.tools.checkstyle.SarifLogger</mutatedClass>

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/PackageObjectFactoryTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/PackageObjectFactoryTest.java
@@ -544,6 +544,35 @@ public void testCreateModuleWithTryInAllRegisteredPackages() {
 
     }
 
+    @Test
+    public void testExceptionMessage() {
+        final String barPackage = BASE_PACKAGE + ".packageobjectfactory.bar";
+        final String fooPackage = BASE_PACKAGE + ".packageobjectfactory.foo";
+        final String zooPackage = BASE_PACKAGE + ".packageobjectfactory.zoo";
+        final String abcPackage = BASE_PACKAGE + ".packageobjectfactory.abc";
+        final ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
+        final PackageObjectFactory objectFactory = new PackageObjectFactory(
+                new HashSet<>(Arrays.asList(abcPackage, barPackage,
+                        fooPackage, zooPackage)), classLoader);
+        final String name = "FooCheck";
+        try {
+            objectFactory.createModule(name);
+            assertWithMessage("Exception is expected").fail();
+        }
+        catch (CheckstyleException ex) {
+            final String optionalNames = abcPackage + PACKAGE_SEPARATOR + name
+                    + STRING_SEPARATOR + barPackage + PACKAGE_SEPARATOR + name
+                    + STRING_SEPARATOR + fooPackage + PACKAGE_SEPARATOR + name
+                    + STRING_SEPARATOR + zooPackage + PACKAGE_SEPARATOR + name;
+            final LocalizedMessage exceptionMessage = new LocalizedMessage(
+                    Definitions.CHECKSTYLE_BUNDLE, getClass(),
+                    AMBIGUOUS_MODULE_NAME_EXCEPTION_MESSAGE, name, optionalNames);
+            assertWithMessage("Invalid exception message")
+                .that(ex.getMessage())
+                .isEqualTo(exceptionMessage.getMessage());
+        }
+    }
+
     private static final class FailConstructorFileSet extends AbstractFileSetCheck {
 
         private FailConstructorFileSet() {

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/AllTestsTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/AllTestsTest.java
@@ -144,9 +144,7 @@ private static void verifyInputFile(Map<String, List<String>> allTests, File fil
             }
 
             // until https://github.com/checkstyle/checkstyle/issues/5105
-            if (!path.contains(File.separatorChar + "grammar" + File.separatorChar)
-                    && !path.contains(File.separatorChar + "foo" + File.separatorChar)
-                    && !path.contains(File.separatorChar + "bar" + File.separatorChar)) {
+            if (shouldSkipFileProcessing(path)) {
                 String fileName = file.getName();
                 final boolean skipFileNaming = shouldSkipInputFileNameCheck(path, fileName);
 
@@ -204,6 +202,20 @@ && checkInputMatchCorrectFileStructure(classes, folderPath, skipFileNaming,
                 .isTrue();
     }
 
+    /**
+     * Checks if the file processing should be skipped based on the path.
+     *
+     * @param path The path to check for skip conditions.
+     * @return true if file processing should be skipped, false otherwise.
+     */
+    private static boolean shouldSkipFileProcessing(String path) {
+        return !path.contains(File.separatorChar + "grammar" + File.separatorChar)
+                && !path.contains(File.separatorChar + "foo" + File.separatorChar)
+                && !path.contains(File.separatorChar + "bar" + File.separatorChar)
+                && !path.contains(File.separator + "abc" + File.separatorChar)
+                && !path.contains(File.separator + "zoo" + File.separatorChar);
+    }
+
     private static void verifyHasProductionFile(Map<String, List<String>> allTests, File file) {
         if (file.isFile()) {
             final String fileName = file.getName().replace("Test.java", ".java");

diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/packageobjectfactory/abc/FooCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/packageobjectfactory/abc/FooCheck.java
@@ -0,0 +1,20 @@
+package com.puppycrawl.tools.checkstyle.packageobjectfactory.abc;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+
+public class FooCheck extends AbstractCheck {
+    @Override
+    public int[] getDefaultTokens() {
+        return new int[] {0};
+    }
+
+    @Override
+    public int[] getAcceptableTokens() {
+        return getDefaultTokens();
+    }
+
+    @Override
+    public int[] getRequiredTokens() {
+        return getDefaultTokens();
+    }
+}
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/packageobjectfactory/zoo/FooCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/packageobjectfactory/zoo/FooCheck.java
@@ -0,0 +1,20 @@
+package com.puppycrawl.tools.checkstyle.packageobjectfactory.zoo;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+
+public class FooCheck extends AbstractCheck {
+    @Override
+    public int[] getDefaultTokens() {
+        return new int[] {0};
+    }
+
+    @Override
+    public int[] getAcceptableTokens() {
+        return getDefaultTokens();
+    }
+
+    @Override
+    public int[] getRequiredTokens() {
+        return getDefaultTokens();
+    }
+}