Improve error messages provided by FileUtils

Author: ascopes

java-compiler-testing/src/main/java/io/github/ascopes/jct/utils/FileUtils.java

@@ -111,15 +111,21 @@ public static void assertValidRootName(@Nullable String name) {
     Objects.requireNonNull(name, "name");
 
     if (name.isBlank()) {
-      throw new IllegalArgumentException("Directory name cannot be blank");
+      throw new IllegalArgumentException(
+          "Directory name cannot be blank: " + StringUtils.quoted(name)
+      );
     }
 
     if (!name.equals(name.trim())) {
-      throw new IllegalArgumentException("Directory name cannot begin or end in spaces");
+      throw new IllegalArgumentException(
+          "Directory name cannot begin or end in spaces: " + StringUtils.quoted(name)
+      );
     }
 
     if (name.contains("/") || name.contains("\\") || name.contains("..")) {
-      throw new IllegalArgumentException("Invalid file name provided");
+      throw new IllegalArgumentException(
+          "Invalid file name provided: " + StringUtils.quoted(name)
+      );
     }
   }
 
@@ -132,7 +138,7 @@ public static void assertValidRootName(@Nullable String name) {
    */
   public static String pathToBinaryName(Path path) {
     if (path.isAbsolute()) {
-      throw new IllegalArgumentException("Path cannot be absolute (got " + path + ")");
+      throw new IllegalArgumentException("Path cannot be absolute: " + StringUtils.quoted(path));
     }
 
     var count = path.getNameCount();

java-compiler-testing/src/test/java/io/github/ascopes/jct/tests/unit/utils/FileUtilsTest.java

@@ -40,6 +40,7 @@
 
 import io.github.ascopes.jct.tests.helpers.UtilityClassTestTemplate;
 import io.github.ascopes.jct.utils.FileUtils;
+import io.github.ascopes.jct.utils.StringUtils;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URI;
@@ -120,7 +121,7 @@ void resolvePathRecursivelyResolvesThePathRecursively(
       String rootString,
       String partsString,
       String expectString
-  ) throws IOException {
+  ) {
     // Given
     try (var fs = someTemporaryFileSystem()) {
       var root = fs.getFileSystem().getPath(rootString);
@@ -165,7 +166,7 @@ void assertValidRootNameFailsForInvalidRootNames(String rootName, String expecte
     // Then
     assertThatThrownBy(() -> assertValidRootName(rootName))
         .isInstanceOf(IllegalArgumentException.class)
-        .hasMessage(expectedError);
+        .hasMessage(expectedError + ": " + StringUtils.quoted(rootName));
   }
 
   @DisplayName("pathToBinaryName throws an IllegalArgumentException for absolute paths")
@@ -179,7 +180,7 @@ void pathToBinaryNameThrowsIllegalArgumentExceptionForAbsolutePaths() {
     // Then
     assertThatThrownBy(() -> pathToBinaryName(path))
         .isInstanceOf(IllegalArgumentException.class)
-        .hasMessage("Path cannot be absolute (got /foo/bar/baz)");
+        .hasMessage("Path cannot be absolute: \"/foo/bar/baz\"");
   }
 
   @DisplayName("pathToBinaryName converts relative paths as expected")
@@ -192,8 +193,7 @@ void pathToBinaryNameThrowsIllegalArgumentExceptionForAbsolutePaths() {
       "org/example/foo/bar/Baz$Bork, org.example.foo.bar.Baz$Bork",
   })
   @ParameterizedTest(name = "pathToBinaryName(\"{0}\") should return \"{1}\"")
-  void pathToBinaryNameConvertsRelativePathsAsExpected(String input, String expected)
-      throws IOException {
+  void pathToBinaryNameConvertsRelativePathsAsExpected(String input, String expected) {
 
     try (var fs = someTemporaryFileSystem()) {
       // Given
@@ -262,7 +262,7 @@ void binaryNameToPathShouldReturnTheExpectedOutput(
       String binaryName,
       Kind kind,
       String expected
-  ) throws IOException {
+  ) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var directoryPath = fs.getFileSystem().getPath(directory);
@@ -293,7 +293,7 @@ void packageNameToPathShouldReturnTheExpectedOutput(
       String directory,
       String packageName,
       String expected
-  ) throws IOException {
+  ) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var directoryPath = fs.getFileSystem().getPath(directory);
@@ -325,7 +325,7 @@ void simpleClassNameToPathShouldReturnTheExpectedOutput(
       String className,
       Kind kind,
       String expected
-  ) throws IOException {
+  ) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var packageDirectoryPath = fs.getFileSystem().getPath(packageDirectory);
@@ -364,7 +364,7 @@ void resourceNameToPathShouldReturnTheExpectedOutput(
       String packageName,
       String relativeName,
       String expected
-  ) throws IOException {
+  ) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var directoryPath = fs.getFileSystem().getPath(directory);
@@ -391,7 +391,7 @@ void relativeResourceNameToPathShouldReturnTheExpectedOutput(
       String fragment,
       String[] fragments,
       String expected
-  ) throws IOException {
+  ) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var directoryPath = fs.getFileSystem().getPath(directory);
@@ -437,7 +437,7 @@ void relativeResourceNameToPathShouldReturnTheExpectedOutput(
       "'', OTHER",
   })
   @ParameterizedTest(name = "pathToKind(\"{0}\") should return Kind.{1}")
-  void pathToKindReturnsTheExpectedOutput(String pathName, Kind expectedKind) throws IOException {
+  void pathToKindReturnsTheExpectedOutput(String pathName, Kind expectedKind) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var path = fs.getFileSystem().getPath(pathName);
@@ -460,8 +460,7 @@ void pathToKindReturnsTheExpectedOutput(String pathName, Kind expectedKind) thro
   @ParameterizedTest(
       name = "fileWithAnyKind([{0}])'s predicate should return false for non-existing path \"{1}\""
   )
-  void fileWithAnyKindShouldFailIfThePathDoesNotExist(Kind kind, String pathName)
-      throws IOException {
+  void fileWithAnyKindShouldFailIfThePathDoesNotExist(Kind kind, String pathName) {
     try (var fs = someTemporaryFileSystem()) {
       // Given
       var path = fs.getFileSystem().getPath(pathName);