Make tasty inspector receive tasty files directly

We add ways to load a list of tasty files and all tasty files in a jar.
This change is aligned with the changes in progress on the `-from-tasty` compilation.

We remove the old way to load tasty file by passing the class name.
Loading by name had some unintended consecuences that made this API fragile.
 - Loaded Scala 2 classes by mistake (no tasty)
 - Loaded java classes by mistake (no tasty)
 - Load the wrong version of the tasty file because the classpath contains an older/newer version of that class (different tasty)

Author: nicolasstucki

stdlib-bootstrapped-tasty-tests/test/BootstrappedStdLibTASYyTest.scala

@@ -108,7 +108,7 @@ object BootstrappedStdLibTASYyTest:
         ()
     }
     val classNames = scalaLibJarTastyClassNames.filterNot(blacklisted)
-    val hasErrors = inspector.inspect(scalaLibJarPath, classNames)
+    val hasErrors = inspector.inspectTastyFilesInJar(scalaLibJarPath)
     assert(!hasErrors, "Errors reported while loading from TASTy")
 
   def compileFromTasty(blacklisted: String => Boolean): Unit = {

tasty-inspector/src/scala/tasty/inspector/TastyInspector.scala

@@ -22,11 +22,37 @@ trait TastyInspector:
 
   /** Load and process TASTy files using TASTy reflect
    *
-   *  @param classpath Classpath where the classes are located
-   *  @param classes classes to be inspected
-   *  @return if an error was reported
+   *  @param tastyFiles List of paths of `.tasty` files
    */
-  def inspect(classpath: String, classes: List[String]): Boolean =
+  def inspectTastyFiles(tastyFiles: List[String]): Boolean =
+    inspectAllTastyFiles(tastyFiles, Nil, Nil)
+
+  /** Load and process TASTy files in a `jar` file using TASTy reflect
+   *
+   *  @param jars Path of `.jar` file
+   */
+  def inspectTastyFilesInJar(jar: String): Boolean =
+    inspectAllTastyFiles(Nil, List(jar), Nil)
+
+  /** Load and process TASTy files using TASTy reflect
+   *
+   *  @param tastyFiles List of paths of `.tasty` files
+   *  @param jars List of path of `.jar` files
+   *  @param dependenciesClasspath Classpath with extra dependencies needed to load class in the `.tasty` files
+   */
+  def inspectAllTastyFiles(tastyFiles: List[String], jars: List[String], dependenciesClasspath: List[String]): Boolean =
+    def checkFile(fileName: String, ext: String): Unit =
+      val file = dotty.tools.io.Path(fileName)
+      if file.extension != ext then
+        throw new IllegalArgumentException(s"File extension is not `.$ext`: $file")
+      else if !file.exists then
+        throw new IllegalArgumentException(s"File not found: ${file.toAbsolute}")
+    tastyFiles.foreach(checkFile(_, "tasty"))
+    jars.foreach(checkFile(_, "jar"))
+    val files = tastyFiles ::: jars
+    files.nonEmpty && inspectFiles(dependenciesClasspath, files)
+
+  private def inspectFiles(classpath: List[String], classes: List[String]): Boolean =
     if (classes.isEmpty)
       throw new IllegalArgumentException("Parameter classes should no be empty")
 
@@ -64,11 +90,12 @@ trait TastyInspector:
     end TastyInspectorPhase
 
     val currentClasspath = ClasspathFromClassloader(getClass.getClassLoader)
-    val args = "-from-tasty" :: "-Yretain-trees" :: "-classpath" :: s"$classpath$pathSeparator$currentClasspath" :: classes
+    val fullClasspath = (classpath :+ currentClasspath).mkString(pathSeparator)
+    val args = "-from-tasty" :: "-Yretain-trees" :: "-classpath" :: fullClasspath :: classes
     val reporter = (new InspectorDriver).process(args.toArray)
     reporter.hasErrors
 
-  end inspect
+  end inspectFiles
 
 
 end TastyInspector

tests/run-custom-args/tasty-inspector/i8163.scala

@@ -10,7 +10,13 @@ case class I8163() {
 
 object Test {
   def main(args: Array[String]): Unit = {
-    new TestInspector().inspect("", List("I8163"))
+    // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+    val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
+    val tastyFiles = allTastyFiles.filter(_.contains("I8163"))
+
+    new TestInspector().inspectTastyFiles(tastyFiles)
   }
 }
 

tests/run-custom-args/tasty-inspector/i8215.scala

@@ -4,8 +4,13 @@ import scala.tasty.inspector._
 @main def Test = {
   val inspector = new TastyInspector {
     protected def processCompilationUnit(using QuoteContext)(tree: qctx.reflect.Tree): Unit = {
-      println(tree.show)
+      tree.showExtractors // Make sure that tree is loaded and can be traveresed
     }
   }
-  inspector.inspect("", List("scala.tasty.Reflection"))
+
+   // Artefact of the current test infrastructure
+  // TODO improve infrastructure to avoid needing this code on each test
+  val libJarClasspath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(x => x.contains("scala3-library-bootstrapped") && x.endsWith(".jar")).get
+
+  inspector.inspectTastyFilesInJar(libJarClasspath)
 }

tests/run-custom-args/tasty-inspector/i8364.scala

@@ -2,13 +2,19 @@ import scala.quoted._
 import scala.tasty.inspector._
 
 @main def Test = {
+  // Artefact of the current test infrastructure
+  // TODO improve infrastructure to avoid needing this code on each test
+  val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+  val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
+  val tastyFiles = allTastyFiles.filter(_.contains("TraitParams"))
+
   // in dotty-example-project
   val inspector = new TastyInspector {
     protected def processCompilationUnit(using QuoteContext)(tree: qctx.reflect.Tree): Unit = {
       println(tree.show)
     }
   }
-  inspector.inspect("", List("TraitParams"))
+  inspector.inspectTastyFiles(tastyFiles)
 }
 
 object TraitParams {

tests/run-custom-args/tasty-inspector/i8389.scala

@@ -15,15 +15,20 @@ case object Bourbon extends Flavor
 
 object Test {
   def main(args: Array[String]): Unit = {
+    // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+    val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
+    val tastyFiles = allTastyFiles.filter(_.contains("TraitParams"))
 
     // Tasty Scala Class
     val inspect1 = new TestInspector_Children()
-    inspect1.inspect("", List("Vehicle"))
+    inspect1.inspectTastyFiles(allTastyFiles.filter(_.contains("Vehicle")))
     assert(inspect1.kids == List("Truck","Car","Plane"))
 
     // Java Class
     val inspect2 = new TestInspector_Children()
-    inspect2.inspect("", List("Flavor"))
+    inspect2.inspectTastyFiles(allTastyFiles.filter(_.contains("Flavor")))
     assert(inspect2.kids == List("Vanilla","Chocolate","Bourbon"))
   }
 }

tests/run-custom-args/tasty-inspector/i8460.scala

@@ -3,7 +3,13 @@ import scala.tasty.inspector._
 
 object Test {
   def main(args: Array[String]): Unit = {
-    new DocumentationInspector().inspect("", List("Foo"))
+      // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+    val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
+    val tastyFiles = allTastyFiles.filter(_.contains("Foo"))
+
+    new DocumentationInspector().inspectTastyFiles(tastyFiles)
   }
 }
 

tests/run-custom-args/tasty-inspector/i8558.scala

@@ -3,7 +3,13 @@ import scala.tasty.inspector._
 
 object Test {
   def main(args: Array[String]): Unit = {
-    new DBInspector().inspect("", List("Foo"))
+    // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+    val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
+    val tastyFiles = allTastyFiles.filter(_.contains("Foo"))
+
+    new DBInspector().inspectTastyFiles(tastyFiles)
   }
 }
 

tests/run-custom-args/tasty-inspector/tasty-documentation-inspector/Test.scala

@@ -11,9 +11,14 @@ import scala.util.Using
 import scala.tasty.interpreter.TastyInterpreter
 
 object Test {
+
   def main(args: Array[String]): Unit = {
+    // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val classpath = dotty.tools.dotc.util.ClasspathFromClassloader(this.getClass.getClassLoader).split(java.io.File.pathSeparator).find(_.contains("runWithCompiler")).get
+    val allTastyFiles = dotty.tools.io.Path(classpath).walkFilter(_.extension == "tasty").map(_.toString).toList
 
-    val actualOutput = interpret("")("IntepretedMain", "InterpretedBar")
+    val actualOutput = interpret("")(allTastyFiles.filter(x => x.contains("IntepretedMain") || x.contains("InterpretedBar")))
     val expectedOutput =
       """42
         |
@@ -88,7 +93,11 @@ object Test {
     val filePath = "tests" + File.separator + "run" + File.separator + testFileName
     dotty.tools.dotc.Main.process(Array("-classpath", System.getProperty("java.class.path"), "-d", out.toString, filePath), reproter)
 
-    val actualOutput = interpret(out.toString)("Test")
+    // Artefact of the current test infrastructure
+    // TODO improve infrastructure to avoid needing this code on each test
+    val allTastyFiles = dotty.tools.io.Path(out).walkFilter(_.extension == "tasty").map(_.toString).toList
+
+    val actualOutput = interpret(out.toString)(allTastyFiles.filter(_.endsWith("Test.tasty")))
 
     val checkFile = java.nio.file.Paths.get("tests/run/" + testFileName.stripSuffix(".scala") + ".check")
     if (java.nio.file.Files.exists(checkFile)) {
@@ -102,10 +111,10 @@ object Test {
     }
   }
 
-  def interpret(classpath: String*)(interpretedClasses: String*): String = {
+  def interpret(classpath: String*)(interpretedClasses: List[String]): String = {
     val ps = new ByteArrayOutputStream()
     try scala.Console.withOut(ps) {
-      new TastyInterpreter().inspect(classpath.mkString(java.io.File.pathSeparatorChar.toString), interpretedClasses.toList)
+      new TastyInterpreter().inspectAllTastyFiles(interpretedClasses.toList, Nil, classpath.toList)
     } catch {
       case e: Throwable => throw new Exception(ps.toString, e)
     }