Issue #13809: Kill mutation in CommonUtil

checkstyle · Nov 12, 2023 · d52eb5d · d52eb5d
1 parent 334760d
commit d52eb5d
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 31 deletions.
diff --git a/config/pitest-suppressions/pitest-common-suppressions.xml b/config/pitest-suppressions/pitest-common-suppressions.xml
@@ -5,8 +5,8 @@
     <mutatedClass>com.puppycrawl.tools.checkstyle.Checker</mutatedClass>
     <mutatedMethod>acceptFileStarted</mutatedMethod>
     <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.ArgumentPropagationMutator</mutator>
-    <description>replaced call to com/puppycrawl/tools/checkstyle/utils/CommonUtil::relativizeAndNormalizePath with argument</description>
-    <lineContent>final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);</lineContent>
+    <description>replaced call to com/puppycrawl/tools/checkstyle/utils/CommonUtil::relativizePath with argument</description>
+    <lineContent>final String stripped = CommonUtil.relativizePath(basedir, fileName);</lineContent>
   </mutation>
 
   <mutation unstable="false">

diff --git a/config/pitest-suppressions/pitest-utils-suppressions.xml b/config/pitest-suppressions/pitest-utils-suppressions.xml
@@ -9,24 +9,6 @@
     <lineContent>&amp;&amp; parent.getParent().getType() == memberType</lineContent>
   </mutation>
 
-  <mutation unstable="false">
-    <sourceFile>CommonUtil.java</sourceFile>
-    <mutatedClass>com.puppycrawl.tools.checkstyle.utils.CommonUtil</mutatedClass>
-    <mutatedMethod>relativizeAndNormalizePath</mutatedMethod>
-    <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.NakedReceiverMutator</mutator>
-    <description>replaced call to java/nio/file/Path::normalize with receiver</description>
-    <lineContent>final Path pathAbsolute = Paths.get(path).normalize();</lineContent>
-  </mutation>
-
-  <mutation unstable="false">
-    <sourceFile>CommonUtil.java</sourceFile>
-    <mutatedClass>com.puppycrawl.tools.checkstyle.utils.CommonUtil</mutatedClass>
-    <mutatedMethod>relativizeAndNormalizePath</mutatedMethod>
-    <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.NakedReceiverMutator</mutator>
-    <description>replaced call to java/nio/file/Path::normalize with receiver</description>
-    <lineContent>final Path pathBase = Paths.get(baseDirectory).normalize();</lineContent>
-  </mutation>
-
   <mutation unstable="false">
     <sourceFile>ModuleReflectionUtil.java</sourceFile>
     <mutatedClass>com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil</mutatedClass>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java b/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java
@@ -375,7 +375,7 @@ private SortedSet<Violation> processFile(File file) throws CheckstyleException {
      * @return {@code true} if the file is accepted.
      */
     private boolean acceptFileStarted(String fileName) {
-        final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);
+        final String stripped = CommonUtil.relativizePath(basedir, fileName);
         return beforeExecutionFileFilters.accept(stripped);
     }
 
@@ -387,7 +387,7 @@ private boolean acceptFileStarted(String fileName) {
      */
     @Override
     public void fireFileStarted(String fileName) {
-        final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);
+        final String stripped = CommonUtil.relativizePath(basedir, fileName);
         final AuditEvent event = new AuditEvent(this, stripped);
         for (final AuditListener listener : listeners) {
             listener.fileStarted(event);
@@ -402,7 +402,7 @@ public void fireFileStarted(String fileName) {
      */
     @Override
     public void fireErrors(String fileName, SortedSet<Violation> errors) {
-        final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);
+        final String stripped = CommonUtil.relativizePath(basedir, fileName);
         boolean hasNonFilteredViolations = false;
         for (final Violation element : errors) {
             final AuditEvent event = new AuditEvent(this, stripped, element);
@@ -426,7 +426,7 @@ public void fireErrors(String fileName, SortedSet<Violation> errors) {
      */
     @Override
     public void fireFileFinished(String fileName) {
-        final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);
+        final String stripped = CommonUtil.relativizePath(basedir, fileName);
         final AuditEvent event = new AuditEvent(this, stripped);
         for (final AuditListener listener : listeners) {
             listener.fileFinished(event);

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/utils/CommonUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/utils/CommonUtil.java
@@ -246,7 +246,7 @@ public static String baseClassName(String type) {
     }
 
     /**
-     * Constructs a normalized relative path between base directory and a given path.
+     * Constructs a relative path between base directory and a given path.
      *
      * @param baseDirectory
      *            the base path to which given path is relativized
@@ -255,14 +255,14 @@ public static String baseClassName(String type) {
      * @return the relative normalized path between base directory and
      *     path or path if base directory is null.
      */
-    public static String relativizeAndNormalizePath(final String baseDirectory, final String path) {
+    public static String relativizePath(final String baseDirectory, final String path) {
         final String resultPath;
         if (baseDirectory == null) {
             resultPath = path;
         }
         else {
-            final Path pathAbsolute = Paths.get(path).normalize();
-            final Path pathBase = Paths.get(baseDirectory).normalize();
+            final Path pathAbsolute = Paths.get(path);
+            final Path pathBase = Paths.get(baseDirectory);
             resultPath = pathBase.relativize(pathAbsolute).toString();
         }
         return resultPath;

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/utils/CommonUtilTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/utils/CommonUtilTest.java
@@ -201,7 +201,7 @@ public void testBaseClassNameForSimpleName() {
 
     @Test
     public void testRelativeNormalizedPath() {
-        final String relativePath = CommonUtil.relativizeAndNormalizePath("/home", "/home/test");
+        final String relativePath = CommonUtil.relativizePath("/home", "/home/test");
 
         assertWithMessage("Invalid relative path")
             .that(relativePath)
@@ -210,7 +210,7 @@ public void testRelativeNormalizedPath() {
 
     @Test
     public void testRelativeNormalizedPathWithNullBaseDirectory() {
-        final String relativePath = CommonUtil.relativizeAndNormalizePath(null, "/tmp");
+        final String relativePath = CommonUtil.relativizePath(null, "/tmp");
 
         assertWithMessage("Invalid relative path")
             .that(relativePath)
@@ -223,7 +223,7 @@ public void testRelativeNormalizedPathWithDenormalizedBaseDirectory() throws IOE
         final String absoluteFilePath = sampleAbsolutePath + "/SampleFile.java";
         final String basePath = sampleAbsolutePath + PATH_DENORMALIZER;
 
-        final String relativePath = CommonUtil.relativizeAndNormalizePath(basePath,
+        final String relativePath = CommonUtil.relativizePath(basePath,
             absoluteFilePath);
 
         assertWithMessage("Invalid relative path")