Rejig RAM directory naming, add ability to dump tree view of workspaces

Author: ascopes

java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces/Workspace.java

@@ -17,6 +17,7 @@
 
 import io.github.ascopes.jct.filemanagers.JctFileManager;
 import io.github.ascopes.jct.filemanagers.ModuleLocation;
+import java.io.IOException;
 import java.io.UncheckedIOException;
 import java.nio.file.Path;
 import java.util.List;
@@ -109,6 +110,17 @@ public interface Workspace extends AutoCloseable {
   @Override
   void close();
 
+  /**
+   * Dump a visual representation of this workspace to the given appendable.
+   *
+   * <p>This provides a utility method for debugging.
+   *
+   * @param appendable the appendable to write to.
+   * @throws UncheckedIOException if an IO error occurs when writing to the appendable.
+   * @since 5.0.0
+   */
+  void dump(Appendable appendable);
+
   /**
    * Determine if the workspace is closed or not.
    *

java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces/impl/RamDirectoryImpl.java

@@ -85,10 +85,10 @@ public static RamDirectoryImpl newRamDirectory(String name) {
     assertValidRootName(name);
 
     // MemoryFileSystem needs unique FS names to work correctly, so use a UUID to enforce this.
-
-    var uniqueName = name + "-" + UUID.randomUUID();
-    var fileSystem = MemoryFileSystemProvider.getInstance().createFileSystem(uniqueName);
-    var path = fileSystem.getRootDirectories().iterator().next().resolve(uniqueName);
+    var fileSystem = MemoryFileSystemProvider.getInstance()
+        .createFileSystem(UUID.randomUUID().toString());
+    var path = fileSystem.getRootDirectories().iterator().next()
+        .resolve(name);
 
     // Ensure the base directory exists.
     uncheckedIo(() -> Files.createDirectories(path));

java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces/impl/WorkspaceImpl.java

@@ -20,12 +20,18 @@
 
 import io.github.ascopes.jct.ex.JctIllegalInputException;
 import io.github.ascopes.jct.filemanagers.ModuleLocation;
+import io.github.ascopes.jct.utils.IoExceptionUtils;
+import io.github.ascopes.jct.utils.ToStringBuilder;
 import io.github.ascopes.jct.workspaces.ManagedDirectory;
 import io.github.ascopes.jct.workspaces.PathRoot;
 import io.github.ascopes.jct.workspaces.PathStrategy;
 import io.github.ascopes.jct.workspaces.Workspace;
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -47,18 +53,20 @@
 public final class WorkspaceImpl implements Workspace {
 
   private volatile boolean closed;
+  private final String id;
   private final PathStrategy pathStrategy;
-  private final Map<Location, List<PathRoot>> paths;
+  private final Map<Location, List<PathRoot>> locations;
 
   /**
    * Initialise this workspace.
    *
    * @param pathStrategy the path strategy to use for creating source and target paths.
    */
   public WorkspaceImpl(PathStrategy pathStrategy) {
+    id = UUID.randomUUID().toString();
     closed = false;
     this.pathStrategy = requireNonNull(pathStrategy, "pathStrategy");
-    paths = new HashMap<>();
+    locations = new HashMap<>();
   }
 
   @Override
@@ -67,7 +75,7 @@ public void close() {
       // Close everything in a best-effort fashion.
       var exceptions = new ArrayList<Throwable>();
 
-      for (var list : paths.values()) {
+      for (var list : locations.values()) {
         for (var path : list) {
           if (path instanceof AbstractManagedDirectory dir) {
             try {
@@ -90,6 +98,64 @@ public void close() {
     }
   }
 
+  @Override
+  public void dump(Appendable appendable) {
+    IoExceptionUtils.uncheckedIo(() -> {
+      appendable.append(toString()).append("\n");
+      for (var location : locations.keySet().stream().sorted().toList()) {
+        appendable.append("  Location ").append(location.toString()).append(": \n");
+
+        for (var pathRoot : locations.get(location)) {
+          appendable.append("    - ").append(pathRoot.getUri().toString()).append(" contents:\n");
+
+          var baseIndent = 8;
+          var basePath = pathRoot.getPath();
+
+          Files.walkFileTree(basePath, new SimpleFileVisitor<>() {
+            private int indent = 0;
+
+            @Override
+            public FileVisitResult preVisitDirectory(
+                Path dir,
+                BasicFileAttributes attrs
+            ) throws IOException {
+              if (!dir.equals(basePath)) {
+                appendIndent();
+                appendable.append(dir.getFileName().toString()).append("/\n");
+                indent += 2;
+              }
+
+              return FileVisitResult.CONTINUE;
+            }
+
+            @Override
+            public FileVisitResult postVisitDirectory(Path dir, IOException exc) {
+              indent -= 2;
+              return FileVisitResult.CONTINUE;
+            }
+
+            @Override
+            public FileVisitResult visitFile(
+                Path file,
+                BasicFileAttributes attrs
+            ) throws IOException {
+              appendIndent();
+              appendable.append(file.getFileName().toString()).append("\n");
+              return FileVisitResult.CONTINUE;
+            }
+
+            private void appendIndent() throws IOException {
+              appendable.append(" ".repeat(baseIndent))
+                  .append("·".repeat(indent));
+            }
+          });
+        }
+
+        appendable.append("\n");
+      }
+    });
+  }
+
   @Override
   public boolean isClosed() {
     return closed;
@@ -109,7 +175,7 @@ public void addPackage(Location location, Path path) {
     }
 
     var dir = new WrappingDirectoryImpl(path);
-    paths.computeIfAbsent(location, unused -> new ArrayList<>()).add(dir);
+    locations.computeIfAbsent(location, unused -> new ArrayList<>()).add(dir);
   }
 
   @Override
@@ -139,13 +205,12 @@ public ManagedDirectory createPackage(Location location) {
       throw new JctIllegalInputException("Location must not be module-oriented");
     }
 
-    // Needs to be unique, and JIMFS cannot hold a file system name containing stuff like
-    // underscores.
+    // Needs to be unique.
     var fsName = location.getName().replaceAll("[^A-Za-z0-9]", "")
         + UUID.randomUUID();
 
     var dir = pathStrategy.newInstance(fsName);
-    paths.computeIfAbsent(location, unused -> new ArrayList<>()).add(dir);
+    locations.computeIfAbsent(location, unused -> new ArrayList<>()).add(dir);
     return dir;
   }
 
@@ -170,9 +235,9 @@ public ManagedDirectory createModule(Location location, String moduleName) {
   @Override
   public Map<Location, List<? extends PathRoot>> getAllPaths() {
     // Create an immutable copy.
-    var pathsCopy = new HashMap<Location, List<PathRoot>>();
-    paths.forEach((location, list) -> pathsCopy.put(location, List.copyOf(list)));
-    return unmodifiableMap(pathsCopy);
+    var locationsCopy = new HashMap<Location, List<PathRoot>>();
+    locations.forEach((location, list) -> locationsCopy.put(location, List.copyOf(list)));
+    return unmodifiableMap(locationsCopy);
   }
 
   @Override
@@ -205,7 +270,7 @@ public Map<String, List<? extends PathRoot>> getModules(Location location) {
 
     var results = new HashMap<String, List<PathRoot>>();
 
-    paths.forEach((pathLocation, pathRoots) -> {
+    locations.forEach((pathLocation, pathRoots) -> {
       if (pathLocation instanceof ModuleLocation modulePathLocation) {
         if (modulePathLocation.getParent().equals(location)) {
           results.computeIfAbsent(modulePathLocation.getModuleName(), name -> new ArrayList<>())
@@ -233,9 +298,19 @@ public List<? extends PathRoot> getPackages(Location location) {
       );
     }
 
-    var roots = paths.get(location);
+    var roots = locations.get(location);
     return roots == null
         ? List.of()
         : List.copyOf(roots);
   }
+
+  @Override
+  public String toString() {
+    return new ToStringBuilder(this)
+        .attribute("id", id)
+        .attribute("pathStrategy", pathStrategy)
+        .attribute("closed", closed)
+        .attribute("numberOfLocations", locations.size())
+        .toString();
+  }
 }

java-compiler-testing/src/test/java/io/github/ascopes/jct/integration/compilation/BasicModuleCompilationIntegrationTest.java

@@ -48,6 +48,8 @@ void helloWorldRamDisk(JctCompiler compiler) {
       assertThatCompilation(compilation)
           .isSuccessfulWithoutWarnings();
 
+      workspace.dump(System.out);
+
       assertThatCompilation(compilation)
           .classOutputPackages()
           .fileExists("com", "example", "HelloWorld.class")
@@ -72,6 +74,8 @@ void helloWorldUsingTempDirectory(JctCompiler compiler) {
       // When
       var compilation = compiler.compile(workspace);
 
+      workspace.dump(System.out);
+
       // Then
       assertThatCompilation(compilation)
           .isSuccessfulWithoutWarnings();