- r Replaced all calls to getAbsolutePath() with FileUtils.getResolvedPath(file)

ScottBob · JayBazuzi · isidore · ScottBob · commit 2ae7a5bba70b · 2025-04-17T16:23:00.000-05:00
Co-authored-by: Jay Bazuzi &lt;jay@bazuzi.com&gt;
Co-authored-by: Llewellyn Falco &lt;llewellyn.falco@gmail.com&gt;
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/ApprovedFileLogTest.java b/approvaltests-tests/src/test/java/org/approvaltests/ApprovedFileLogTest.java
@@ -22,10 +22,10 @@ void testLogging()
     ApprovalNamer approvalNamer = Approvals.createApprovalNamer();
     File approvedFile = approvalNamer.getApprovedFile(".txt");
     String prelog = FileUtils.readFile(file);
-    assertFalse(prelog.contains(approvedFile.getAbsolutePath()));
+    assertFalse(prelog.contains(FileUtils.getResolvedPath(approvedFile)));
     Approvals.verify("anything");
     String postlog = FileUtils.readFile(file);
-    assertTrue(postlog.contains(approvedFile.getAbsolutePath()));
+    assertTrue(postlog.contains(FileUtils.getResolvedPath(approvedFile)));
   }
   @Test
   void testTempDirectoryGetsGitIgnore()
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/DirectoryOutputTest.java b/approvaltests-tests/src/test/java/org/approvaltests/DirectoryOutputTest.java
@@ -21,8 +21,7 @@ private void createFilesFor(File directory, int numberOfFiles)
   {
     for (int i = 1; i < numberOfFiles + 1; i++)
     {
-      String fileName = directory.getAbsolutePath() + File.separator + "File" + i + ".txt";
-      File file = new File(fileName);
+      File file = new File(directory, "File" + i + ".txt");
       FileUtils.writeFile(file, "Text" + i);
     }
   }
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/machine_specific_tests/reporters/GenericDiffReporterTest.java b/approvaltests-tests/src/test/java/org/approvaltests/machine_specific_tests/reporters/GenericDiffReporterTest.java
@@ -1,6 +1,7 @@
 package org.approvaltests.machine_specific_tests.reporters;
 
 import com.spun.util.ClassUtils;
+import com.spun.util.io.FileUtils;
 import org.approvaltests.Approvals;
 import org.approvaltests.machine_specific_tests.MachineSpecificTest;
 import org.approvaltests.reporters.GenericDiffReporter;
@@ -30,8 +31,8 @@ public void testWinMerge()
   private void approveGenericReporter(String a, String b, GenericDiffReporter reporter)
   {
     File directory = ClassUtils.getSourceDirectory(getClass());
-    String aPath = directory.getAbsolutePath() + File.separator + a;
-    String bPath = directory.getAbsolutePath() + File.separator + b;
+    String aPath = FileUtils.getResolvedPath(new File(directory, a));
+    String bPath = FileUtils.getResolvedPath(new File(directory, b));
     Approvals.verify(new QueryableDiffReporterHarness(reporter, aPath, bPath));
   }
 }
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/reporters/GenericDiffReporterTest.java b/approvaltests-tests/src/test/java/org/approvaltests/reporters/GenericDiffReporterTest.java
@@ -2,6 +2,7 @@
 
 import com.spun.util.ClassUtils;
 import com.spun.util.SystemUtils;
+import com.spun.util.io.FileUtils;
 import org.approvaltests.Approvals;
 import org.approvaltests.combinations.CombinationApprovals;
 import org.approvaltests.reporters.macosx.P4MergeReporter;
@@ -66,8 +67,8 @@ public String getFileName(String name, Boolean isWindows)
   private void approveGenericReporter(String a, String b, GenericDiffReporter reporter)
   {
     File directory = ClassUtils.getSourceDirectory(getClass());
-    String aPath = directory.getAbsolutePath() + File.separator + a;
-    String bPath = directory.getAbsolutePath() + File.separator + b;
+    String aPath = FileUtils.getResolvedPath(new File(directory, a));
+    String bPath = FileUtils.getResolvedPath(new File(directory, b));
     Approvals.verify(new QueryableDiffReporterHarness(reporter, aPath, bPath));
   }
   @Test
diff --git a/approvaltests-util/src/main/java/com/spun/util/Asserts.java b/approvaltests-util/src/main/java/com/spun/util/Asserts.java
@@ -1,5 +1,6 @@
 package com.spun.util;
 
+import com.spun.util.io.FileUtils;
 import java.io.File;
 
 public class Asserts
@@ -19,13 +20,13 @@ public static void assertFileDoesNotExist(String label, String fileName)
   {
     File file = new File(fileName);
     if (file.exists())
-    { throw new IllegalStateException(label + " file " + file.getAbsolutePath() + " already exists"); }
+    { throw new IllegalStateException(label + " file " + FileUtils.getResolvedPath(file) + " already exists"); }
   }
   public static void assertFileExists(String label, String fileName)
   {
     File file = new File(fileName);
     if (!file.exists())
-    { throw new IllegalStateException(label + " file " + file.getAbsolutePath() + " does not exist"); }
+    { throw new IllegalStateException(label + " file " + FileUtils.getResolvedPath(file) + " does not exist"); }
   }
   public static void equals(String label, double expected, double actual, double percission)
   {
diff --git a/approvaltests-util/src/main/java/com/spun/util/io/FileUtils.java b/approvaltests-util/src/main/java/com/spun/util/io/FileUtils.java
@@ -238,7 +238,7 @@ public static String readFile(File file, boolean ensureTrailingNewline)
     try
     {
       if (!file.exists())
-      { throw new RuntimeException("Invalid file '" + file.getAbsolutePath() + "'"); }
+      { throw new RuntimeException("Invalid file '" + getResolvedPath(file) + "'"); }
       CharsetDecoder decoder = StandardCharsets.UTF_8.newDecoder();
       decoder.onMalformedInput(CodingErrorAction.IGNORE);
       Reader reader = new InputStreamReader(Files.newInputStream(file.toPath()), decoder);
@@ -460,12 +460,15 @@ public static Stream<Path> walkPath(String channelsPath, int maxDepth)
       throw ObjectUtils.throwAsError(e);
     }
   }
-
-    public static String getResolvedPath(File file) {
-      try {
-        return file.getCanonicalFile().getAbsolutePath();
-      } catch (IOException e) {
-        throw ObjectUtils.throwAsError(e);
-      }
+  public static String getResolvedPath(File file)
+  {
+    try
+    {
+      return file.getCanonicalFile().getAbsolutePath();
     }
+    catch (IOException e)
+    {
+      throw ObjectUtils.throwAsError(e);
+    }
+  }
 }
diff --git a/approvaltests-util/src/main/java/com/spun/util/io/XMLUtils.java b/approvaltests-util/src/main/java/com/spun/util/io/XMLUtils.java
@@ -30,10 +30,10 @@ public static String locateFile(String fileLocation, String[] backupPaths)
       String tfileLocation = backupPaths[i] + File.separator + fileLocation;
       File file = new File(tfileLocation);
       if (file.exists())
-      { return file.getAbsolutePath(); }
+      { return FileUtils.getResolvedPath(file); }
     }
     throw new Error(String.format("Couldn't find '%s' from locations %s with current directory '%s'", fileLocation,
-        Arrays.asList(backupPaths), new File(".").getAbsolutePath()));
+        Arrays.asList(backupPaths), FileUtils.getResolvedPath(new File("."))));
   }
   public static HashMap<String, Object> parseProperties(String absoluteFileLocation, XMLNodeExtractor extractor)
   {
diff --git a/approvaltests-util/src/main/java/com/spun/util/parser/FileLocator.java b/approvaltests-util/src/main/java/com/spun/util/parser/FileLocator.java
@@ -1,5 +1,6 @@
 package com.spun.util.parser;
 
+import com.spun.util.io.FileUtils;
 import java.io.File;
 import java.util.Arrays;
 import java.util.HashMap;
diff --git a/approvaltests/src/main/java/org/approvaltests/approvers/FileApprover.java b/approvaltests/src/main/java/org/approvaltests/approvers/FileApprover.java
@@ -47,7 +47,7 @@ public static AutoCloseable registerErrorGenerator(Function2<String, String, Err
   }
   public VerifyResult approve()
   {
-    tracker.assertUnique(approved.getAbsolutePath());
+    tracker.assertUnique(FileUtils.getResolvedPath(approved));
     ApprovedFileLog.log(approved);
     FailedFileLog.touch();
     received = writer.writeReceivedFile(received);
@@ -58,13 +58,14 @@ public void cleanUpAfterSuccess(ApprovalFailureReporter reporter)
     received.delete();
     if (reporter instanceof ApprovalReporterWithCleanUp)
     {
-      ((ApprovalReporterWithCleanUp) reporter).cleanUp(received.getAbsolutePath(), approved.getAbsolutePath());
+      ((ApprovalReporterWithCleanUp) reporter).cleanUp(FileUtils.getResolvedPath(received),
+          FileUtils.getResolvedPath(approved));
     }
   }
   public VerifyResult reportFailure(ApprovalFailureReporter reporter)
   {
     FailedFileLog.log(received, approved);
-    reporter.report(received.getAbsolutePath(), approved.getAbsolutePath());
+    reporter.report(FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved));
     if (reporter instanceof ReporterWithApprovalPower)
     {
       ReporterWithApprovalPower reporterWithApprovalPower = (ReporterWithApprovalPower) reporter;
@@ -74,7 +75,7 @@ public VerifyResult reportFailure(ApprovalFailureReporter reporter)
   }
   public void fail()
   {
-    throw errorGenerator.call(received.getAbsolutePath(), approved.getAbsolutePath());
+    throw errorGenerator.call(FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved));
   }
   private static Error createError(String received, String approved)
   {
diff --git a/approvaltests/src/main/java/org/approvaltests/internal/logs/ApprovedFileLog.java b/approvaltests/src/main/java/org/approvaltests/internal/logs/ApprovedFileLog.java
@@ -15,12 +15,12 @@ public class ApprovedFileLog
   public static File get()
   {
     File file = new File(LoggingUtils.getTempDirectory() + "/.approved_files.log");
-    FileUtils.createIfNeeded(file.getAbsolutePath());
+    FileUtils.createIfNeeded(FileUtils.getResolvedPath(file));
     return file;
   }
   public static void log(File file)
   {
     File log = get();
-    FileUtils.appendToFile(log, file.getAbsolutePath() + "\n");
+    FileUtils.appendToFile(log, FileUtils.getResolvedPath(file) + "\n");
   }
 }
diff --git a/approvaltests/src/main/java/org/approvaltests/internal/logs/FailedFileLog.java b/approvaltests/src/main/java/org/approvaltests/internal/logs/FailedFileLog.java
@@ -19,14 +19,14 @@ private static void downloadApproveAllScriptIfMissing()
   public static File get()
   {
     File file = new File(LoggingUtils.getTempDirectory() + "/.failed_comparison.log");
-    FileUtils.createIfNeeded(file.getAbsolutePath());
+    FileUtils.createIfNeeded(FileUtils.getResolvedPath(file));
     return file;
   }
   public static void log(File received, File approved)
   {
     File log = get();
     FileUtils.appendToFile(log,
-        String.format("%s -> %s\n", received.getAbsolutePath(), approved.getAbsolutePath()));
+        String.format("%s -> %s\n", FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved)));
   }
   public static void touch()
   {
diff --git a/approvaltests/src/main/java/org/approvaltests/reporters/ReporterThatCreatesAnApprovalScript.java b/approvaltests/src/main/java/org/approvaltests/reporters/ReporterThatCreatesAnApprovalScript.java
@@ -28,19 +28,19 @@ private static void initializeFile()
     {
       initializeLinux();
     }
-    SimpleLogger.event("Created approval script:\n" + scriptFile.getAbsolutePath());
+    SimpleLogger.event("Created approval script:\n" + FileUtils.getResolvedPath(scriptFile));
   }
   private static void initializeLinux()
   {
     scriptFile = new File(LoggingUtils.getTempDirectory() + "/" + fileName + ".sh");
-    FileUtils.createIfNeeded(scriptFile.getAbsolutePath());
+    FileUtils.createIfNeeded(FileUtils.getResolvedPath(scriptFile));
     FileUtils.writeFile(scriptFile, "#!/bin/bash\n");
     scriptFile.setExecutable(true);
   }
   private static void initializeWindows()
   {
     scriptFile = new File(LoggingUtils.getTempDirectory() + "\\" + fileName + ".bat");
-    FileUtils.createIfNeeded(scriptFile.getAbsolutePath());
+    FileUtils.createIfNeeded(FileUtils.getResolvedPath(scriptFile));
     FileUtils.writeFile(scriptFile, "");
   }
   @Override
diff --git a/approvaltests/src/test/java/org/approvaltests/reporters/JUnitReporterTest.java b/approvaltests/src/test/java/org/approvaltests/reporters/JUnitReporterTest.java
@@ -1,6 +1,7 @@
 package org.approvaltests.reporters;
 
 import com.spun.util.ClassUtils;
+import com.spun.util.io.FileUtils;
 import org.approvaltests.Approvals;
 import org.approvaltests.core.ApprovalFailureReporter;
 import org.junit.jupiter.api.Test;
@@ -24,8 +25,8 @@ void testJUnit5()
   }
   private void verifyReporter(ApprovalFailureReporter reporter)
   {
-    String a = ClassUtils.getAdjacentFile(this.getClass(), "a.txt").getAbsolutePath();
-    String b = ClassUtils.getAdjacentFile(this.getClass(), "b.txt").getAbsolutePath();
+    String a = FileUtils.getResolvedPath(ClassUtils.getAdjacentFile(this.getClass(), "a.txt"));
+    String b = FileUtils.getResolvedPath(ClassUtils.getAdjacentFile(this.getClass(), "b.txt"));
     Approvals.verifyException(() -> {
       reporter.report(b, a);
     });

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,7 @@ private void createFilesFor(File directory, int numberOfFiles)`
`21`	`21`	`{`
`22`	`22`	`for (int i = 1; i < numberOfFiles + 1; i++)`
`23`	`23`	`{`
`24`		`- String fileName = directory.getAbsolutePath() + File.separator + "File" + i + ".txt";`
`25`		`- File file = new File(fileName);`
	`24`	`+ File file = new File(directory, "File" + i + ".txt");`
`26`	`25`	`FileUtils.writeFile(file, "Text" + i);`
`27`	`26`	`}`
`28`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package org.approvaltests.machine_specific_tests.reporters;`
`2`	`2`
`3`	`3`	`import com.spun.util.ClassUtils;`
	`4`	`+import com.spun.util.io.FileUtils;`
`4`	`5`	`import org.approvaltests.Approvals;`
`5`	`6`	`import org.approvaltests.machine_specific_tests.MachineSpecificTest;`
`6`	`7`	`import org.approvaltests.reporters.GenericDiffReporter;`
`@@ -30,8 +31,8 @@ public void testWinMerge()`
`30`	`31`	`private void approveGenericReporter(String a, String b, GenericDiffReporter reporter)`
`31`	`32`	`{`
`32`	`33`	`File directory = ClassUtils.getSourceDirectory(getClass());`
`33`		`- String aPath = directory.getAbsolutePath() + File.separator + a;`
`34`		`- String bPath = directory.getAbsolutePath() + File.separator + b;`
	`34`	`+ String aPath = FileUtils.getResolvedPath(new File(directory, a));`
	`35`	`+ String bPath = FileUtils.getResolvedPath(new File(directory, b));`
`35`	`36`	`Approvals.verify(new QueryableDiffReporterHarness(reporter, aPath, bPath));`
`36`	`37`	`}`
`37`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package com.spun.util;`
`2`	`2`
	`3`	`+import com.spun.util.io.FileUtils;`
`3`	`4`	`import java.io.File;`
`4`	`5`
`5`	`6`	`public class Asserts`
`@@ -19,13 +20,13 @@ public static void assertFileDoesNotExist(String label, String fileName)`
`19`	`20`	`{`
`20`	`21`	`File file = new File(fileName);`
`21`	`22`	`if (file.exists())`
`22`		`- { throw new IllegalStateException(label + " file " + file.getAbsolutePath() + " already exists"); }`
	`23`	`+ { throw new IllegalStateException(label + " file " + FileUtils.getResolvedPath(file) + " already exists"); }`
`23`	`24`	`}`
`24`	`25`	`public static void assertFileExists(String label, String fileName)`
`25`	`26`	`{`
`26`	`27`	`File file = new File(fileName);`
`27`	`28`	`if (!file.exists())`
`28`		`- { throw new IllegalStateException(label + " file " + file.getAbsolutePath() + " does not exist"); }`
	`29`	`+ { throw new IllegalStateException(label + " file " + FileUtils.getResolvedPath(file) + " does not exist"); }`
`29`	`30`	`}`
`30`	`31`	`public static void equals(String label, double expected, double actual, double percission)`
`31`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,10 @@ public static String locateFile(String fileLocation, String[] backupPaths)`
`30`	`30`	`String tfileLocation = backupPaths[i] + File.separator + fileLocation;`
`31`	`31`	`File file = new File(tfileLocation);`
`32`	`32`	`if (file.exists())`
`33`		`- { return file.getAbsolutePath(); }`
	`33`	`+ { return FileUtils.getResolvedPath(file); }`
`34`	`34`	`}`
`35`	`35`	`throw new Error(String.format("Couldn't find '%s' from locations %s with current directory '%s'", fileLocation,`
`36`		`- Arrays.asList(backupPaths), new File(".").getAbsolutePath()));`
	`36`	`+ Arrays.asList(backupPaths), FileUtils.getResolvedPath(new File("."))));`
`37`	`37`	`}`
`38`	`38`	`public static HashMap<String, Object> parseProperties(String absoluteFileLocation, XMLNodeExtractor extractor)`
`39`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public static AutoCloseable registerErrorGenerator(Function2<String, String, Err`
`47`	`47`	`}`
`48`	`48`	`public VerifyResult approve()`
`49`	`49`	`{`
`50`		`- tracker.assertUnique(approved.getAbsolutePath());`
	`50`	`+ tracker.assertUnique(FileUtils.getResolvedPath(approved));`
`51`	`51`	`ApprovedFileLog.log(approved);`
`52`	`52`	`FailedFileLog.touch();`
`53`	`53`	`received = writer.writeReceivedFile(received);`
`@@ -58,13 +58,14 @@ public void cleanUpAfterSuccess(ApprovalFailureReporter reporter)`
`58`	`58`	`received.delete();`
`59`	`59`	`if (reporter instanceof ApprovalReporterWithCleanUp)`
`60`	`60`	`{`
`61`		`- ((ApprovalReporterWithCleanUp) reporter).cleanUp(received.getAbsolutePath(), approved.getAbsolutePath());`
	`61`	`+ ((ApprovalReporterWithCleanUp) reporter).cleanUp(FileUtils.getResolvedPath(received),`
	`62`	`+ FileUtils.getResolvedPath(approved));`
`62`	`63`	`}`
`63`	`64`	`}`
`64`	`65`	`public VerifyResult reportFailure(ApprovalFailureReporter reporter)`
`65`	`66`	`{`
`66`	`67`	`FailedFileLog.log(received, approved);`
`67`		`- reporter.report(received.getAbsolutePath(), approved.getAbsolutePath());`
	`68`	`+ reporter.report(FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved));`
`68`	`69`	`if (reporter instanceof ReporterWithApprovalPower)`
`69`	`70`	`{`
`70`	`71`	`ReporterWithApprovalPower reporterWithApprovalPower = (ReporterWithApprovalPower) reporter;`
`@@ -74,7 +75,7 @@ public VerifyResult reportFailure(ApprovalFailureReporter reporter)`
`74`	`75`	`}`
`75`	`76`	`public void fail()`
`76`	`77`	`{`
`77`		`- throw errorGenerator.call(received.getAbsolutePath(), approved.getAbsolutePath());`
	`78`	`+ throw errorGenerator.call(FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved));`
`78`	`79`	`}`
`79`	`80`	`private static Error createError(String received, String approved)`
`80`	`81`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,12 @@ public class ApprovedFileLog`
`15`	`15`	`public static File get()`
`16`	`16`	`{`
`17`	`17`	`File file = new File(LoggingUtils.getTempDirectory() + "/.approved_files.log");`
`18`		`- FileUtils.createIfNeeded(file.getAbsolutePath());`
	`18`	`+ FileUtils.createIfNeeded(FileUtils.getResolvedPath(file));`
`19`	`19`	`return file;`
`20`	`20`	`}`
`21`	`21`	`public static void log(File file)`
`22`	`22`	`{`
`23`	`23`	`File log = get();`
`24`		`- FileUtils.appendToFile(log, file.getAbsolutePath() + "\n");`
	`24`	`+ FileUtils.appendToFile(log, FileUtils.getResolvedPath(file) + "\n");`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,14 +19,14 @@ private static void downloadApproveAllScriptIfMissing()`
`19`	`19`	`public static File get()`
`20`	`20`	`{`
`21`	`21`	`File file = new File(LoggingUtils.getTempDirectory() + "/.failed_comparison.log");`
`22`		`- FileUtils.createIfNeeded(file.getAbsolutePath());`
	`22`	`+ FileUtils.createIfNeeded(FileUtils.getResolvedPath(file));`
`23`	`23`	`return file;`
`24`	`24`	`}`
`25`	`25`	`public static void log(File received, File approved)`
`26`	`26`	`{`
`27`	`27`	`File log = get();`
`28`	`28`	`FileUtils.appendToFile(log,`
`29`		`- String.format("%s -> %s\n", received.getAbsolutePath(), approved.getAbsolutePath()));`
	`29`	`+ String.format("%s -> %s\n", FileUtils.getResolvedPath(received), FileUtils.getResolvedPath(approved)));`
`30`	`30`	`}`
`31`	`31`	`public static void touch()`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,19 +28,19 @@ private static void initializeFile()`
`28`	`28`	`{`
`29`	`29`	`initializeLinux();`
`30`	`30`	`}`
`31`		`- SimpleLogger.event("Created approval script:\n" + scriptFile.getAbsolutePath());`
	`31`	`+ SimpleLogger.event("Created approval script:\n" + FileUtils.getResolvedPath(scriptFile));`
`32`	`32`	`}`
`33`	`33`	`private static void initializeLinux()`
`34`	`34`	`{`
`35`	`35`	`scriptFile = new File(LoggingUtils.getTempDirectory() + "/" + fileName + ".sh");`
`36`		`- FileUtils.createIfNeeded(scriptFile.getAbsolutePath());`
	`36`	`+ FileUtils.createIfNeeded(FileUtils.getResolvedPath(scriptFile));`
`37`	`37`	`FileUtils.writeFile(scriptFile, "#!/bin/bash\n");`
`38`	`38`	`scriptFile.setExecutable(true);`
`39`	`39`	`}`
`40`	`40`	`private static void initializeWindows()`
`41`	`41`	`{`
`42`	`42`	`scriptFile = new File(LoggingUtils.getTempDirectory() + "\\" + fileName + ".bat");`
`43`		`- FileUtils.createIfNeeded(scriptFile.getAbsolutePath());`
	`43`	`+ FileUtils.createIfNeeded(FileUtils.getResolvedPath(scriptFile));`
`44`	`44`	`FileUtils.writeFile(scriptFile, "");`
`45`	`45`	`}`
`46`	`46`	`@Override`