adding more test cases and fixing classloader issue during groovy compile which also fixed spock not being executed

Author: lostiniceland

libs/groovylib/package.mill

@@ -1,6 +1,5 @@
 package build.libs.groovylib
 
-// imports
 import mill.*
 import mill.contrib.buildinfo.BuildInfo
 import mill.scalalib.*
@@ -20,10 +19,7 @@ object `package` extends MillPublishScalaModule with BuildInfo {
 
   trait MillGroovyModule extends MillPublishScalaModule {
     override def javacOptions = super.javacOptions() ++ {
-      val release =
-        if (scala.util.Properties.isJavaAtLeast(11)) Seq("-release", "8")
-        else Seq("-source", "1.8", "-target", "1.8")
-      release ++ Seq("-encoding", "UTF-8", "-deprecation")
+      Seq("-release", "8", "-encoding", "UTF-8", "-deprecation")
     }
   }
 

libs/groovylib/src/mill/groovylib/GroovyModule.scala

@@ -26,9 +26,8 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
    */
   def groovyLanguageVersion: T[String] = Task { groovyVersion().split("[.]").take(2).mkString(".") }
 
-  override def bomMvnDeps: T[Seq[Dep]] = super.bomMvnDeps() ++ Seq(
-    mvn"org.apache.groovy:groovy-bom:${groovyVersion()}"
-  )
+  override def bomMvnDeps: T[Seq[Dep]] = super.bomMvnDeps() ++
+    Seq(mvn"org.apache.groovy:groovy-bom:${groovyVersion()}")
 
   /**
    * All individual source files fed into the compiler.
@@ -58,12 +57,15 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
    * Defaults to add the groovy dependency matching the [[groovyVersion]].
    */
   override def mandatoryMvnDeps: T[Seq[Dep]] = Task {
-    super.mandatoryMvnDeps() ++ Seq(
-      mvn"org.apache.groovy:groovy:${groovyVersion()}"
-    )
+    super.mandatoryMvnDeps()
+    ++
+      groovyCompilerMvnDeps()
+//    Seq(
+//      mvn"org.apache.groovy:groovy:${groovyVersion()}"
+//    )
   }
 
-  private def jvmWorkerRef: ModuleRef[JvmWorkerModule] = jvmWorker
+  def jvmWorkerRef: ModuleRef[JvmWorkerModule] = jvmWorker
 
   override def checkGradleModules: T[Boolean] = true
 
@@ -89,7 +91,8 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
   def groovyCompilerMvnDeps: T[Seq[Dep]] = Task {
     val gv = groovyVersion()
 
-    val compilerDep = mvn"org.apache.groovy:groovy:$gv"
+    val compilerDep = mvn"org.apache.groovy:groovy-all:$gv"
+//    val annotationDep = mvn"org.codehaus.groovy:groovy-all-annotations:$gv"
 
     Seq(compilerDep)
   }
@@ -104,9 +107,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
    */
   def groovyCompilerPluginJars: T[Seq[PathRef]] = Task {
     val jars = defaultResolver().classpath(
-      groovycPluginMvnDeps()
-        // Don't resolve transitive jars
-        .map(d => d.exclude("*" -> "*")),
+      allMvnDeps(),
       resolutionParamsMapOpt = None
     )
     jars.toSeq
@@ -122,6 +123,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
   /**
    * The actual Groovy compile task (used by [[compile]] and [[groovycHelp]]).
    */
+  // TODO joint compilation: generate groovy-stubs -> compile java -> compile groovy -> delete stubs (or keep for debugging)
   protected def groovyCompileTask(): Task[CompilationResult] =
     Task.Anon {
       val ctx = Task.ctx()
@@ -152,7 +154,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
           javaHome = javaHome().map(_.path),
           javacOptions = javacOptions(),
           compileProblemReporter = ctx.reporter(hashCode),
-          reportOldProblems = internalReportOldProblems()
+          reportOldProblems = zincReportCachedProblems()
         )
       }
 
@@ -189,18 +191,6 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
       }
     }
 
-  /**
-   * Additional Groovy compiler options to be used by [[compile]].
-   */
-  def groovycOptions: T[Seq[String]] = Task { Seq.empty[String] }
-
-  /**
-   * Aggregation of all the options passed to the Groovy compiler.
-   * In most cases, instead of overriding this target you want to override `groovycOptions` instead.
-   */
-  def allGroovycOptions: T[Seq[String]] = Task {
-    groovycOptions()
-  }
 
   private[groovylib] def internalCompileJavaFiles(
       worker: JvmWorkerApi,
@@ -228,8 +218,6 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
     )
   }
 
-  private[groovylib] def internalReportOldProblems: Task[Boolean] = zincReportCachedProblems
-
   @internal
   override def bspBuildTarget: BspBuildTarget = super.bspBuildTarget.copy(
     languageIds = Seq(
@@ -254,16 +242,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
 
     override def groovyLanguageVersion: T[String] = outer.groovyLanguageVersion()
     override def groovyVersion: T[String] = Task { outer.groovyVersion() }
-    override def groovycPluginMvnDeps: T[Seq[Dep]] =
-      Task { outer.groovycPluginMvnDeps() }
-      // TODO: make Xfriend-path an explicit setting
-    override def groovycOptions: T[Seq[String]] = Task {
-      // FIXME
-      outer.groovycOptions().filterNot(_.startsWith("-Xcommon-sources")) ++
-        Seq(s"-Xfriend-paths=${outer.compile().classes.path.toString()}")
-    }
+    override def bomMvnDeps: T[Seq[Dep]] = outer.bomMvnDeps()
+    override def mandatoryMvnDeps: Task.Simple[Seq[Dep]] = outer.mandatoryMvnDeps
   }
-
 }
-
-// TODO maybe an StandaloneGroovyTestsModule

libs/groovylib/src/mill/groovylib/GroovyWorkerManager.scala

@@ -17,6 +17,7 @@ object GroovyWorkerManager extends ExternalModule {
   }
 
   def get(toolsClassLoader: ClassLoader)(implicit ctx: TaskCtx): GroovyWorker = {
+    // TODO why not use ServiceLoader...investigate
     val className =
       classOf[GroovyWorker].getPackage().getName().split("\\.").dropRight(1).mkString(
         "."

libs/groovylib/test/resources/hello-groovy/joint-compile/src/GroovyGreeter.groovy

@@ -0,0 +1,20 @@
+package jointcompile
+
+import jointCompile.JavaPrinter
+
+class GroovyGreeter{
+
+    private final String toGreet;
+    private final JavaPrinter printer;
+
+    GroovyGreeter(String toGreet){
+        this.toGreet = toGreet
+        this.printer = new JavaPrinter()
+    }
+
+
+    void greet(){
+        printer.print("Hello $toGreet");
+    }
+
+}

libs/groovylib/test/resources/hello-groovy/joint-compile/src/JavaMain.java

@@ -0,0 +1,12 @@
+package jointcompile;
+
+import jointcompile.GroovyGreeter;
+
+
+public class JavaMain {
+
+  public static void main(String[] args) {
+    var greeter = new GroovyGreeter("JointCompile");
+    greeter.greet();
+  }
+}

libs/groovylib/test/resources/hello-groovy/joint-compile/src/JavaPrinter.java

@@ -0,0 +1,7 @@
+package jointcompile;
+
+public class JavaPrinter {
+  public void print(String s) {
+    System.out.println(s);
+  }
+}

libs/groovylib/test/resources/hello-groovy/main/script/src/HelloScript.groovy

@@ -1,8 +1,7 @@
 
-println "This is a Groovy Script"
 println getHelloString()
 
 static String getHelloString() {
-    return "Hello, world!"
+    return "Hello, Scripting!"
 }
 

libs/groovylib/test/src/mill/groovylib/HelloGroovyTests.scala

@@ -35,16 +35,18 @@ object HelloGroovyTests extends TestSuite {
 
     }
 
+    object `joint-compile` extends GroovyModule {
+      override def groovyVersion: T[String] = groovy4Version
+    }
+
     trait Test extends GroovyModule {
 
       override def mainClass = Some("hello.Hello")
 
       object test extends GroovyTests with TestModule.Junit5 {
-
         override def depManagement = Seq(
           mvn"org.junit.jupiter:junit-jupiter-engine:5.13.4"
         )
-
         override def jupiterVersion = "5.13.4"
         override def junitPlatformVersion = "1.13.4"
       }
@@ -100,14 +102,6 @@ object HelloGroovyTests extends TestSuite {
 
     test("compile & run Groovy module") {
       testEval().scoped { eval =>
-        val Right(compiler) = eval.apply(m.groovyCompilerMvnDeps): @unchecked
-
-        assert(
-          compiler.value.map(_.dep.module)
-            .map(m => m.organization.value -> m.name.value)
-            .contains("org.apache.groovy" -> "groovy")
-        )
-
         val Right(result) = eval.apply(m.compile): @unchecked
 
         assert(
@@ -134,16 +128,15 @@ object HelloGroovyTests extends TestSuite {
       }
     }
 
-//    test("compiling & running a statically compiled Groovy") {
-//      testEval().scoped { eval =>
-//        val Right(_) = eval.apply(m.staticcompile.showMvnDepsTree()): @unchecked
-//        val Right(result) = eval.apply(m.staticcompile.compile): @unchecked
-//        assert(
-//          os.walk(result.value.classes.path).exists(_.last == "HelloStatic.class")
-//        )
-//        val Right(_) = eval.apply(m.staticcompile.run()): @unchecked
-//      }
-//    }
+    test("compiling & running a statically compiled Groovy") {
+      testEval().scoped { eval =>
+        val Right(result) = eval.apply(m.staticcompile.compile): @unchecked
+        assert(
+          os.walk(result.value.classes.path).exists(_.last == "HelloStatic.class")
+        )
+        val Right(_) = eval.apply(m.staticcompile.run()): @unchecked
+      }
+    }
 
     test("compile & run test-only Maven JUnit5 test") {
       testEval().scoped { eval =>
@@ -161,25 +154,22 @@ object HelloGroovyTests extends TestSuite {
       }
     }
 
-//    test("compile Spock test") {
-//      testEval().scoped { eval =>
-//
-//        val Right(result1) = eval.apply(m.spock.compile): @unchecked
-//        assert(
-//          os.walk(result1.value.classes.path).exists(_.last == "SpockTest.class")
-//        )
-//      }
-//    }
-
-//    test("run Spock test") {
-//      testEval().scoped { eval =>
-//
-//        val Right(discovered) = eval.apply(m.spock.discoveredTestClasses): @unchecked
-//        assert(discovered.value == Seq("hello.spock.SpockTest"))
-//
-//        val Right(_) = eval.apply(m.spock.testForked()): @unchecked
-//      }
-//    }
+    test("compile & run Spock test") {
+      testEval().scoped { eval =>
+
+        val Right(result1) = eval.apply(m.spock.compile): @unchecked
+        assert(
+          os.walk(result1.value.classes.path).exists(_.last == "SpockTest.class")
+        )
+
+        val Right(discovered) = eval.apply(m.spock.discoveredTestClasses): @unchecked
+        assert(discovered.value == Seq("hello.spock.SpockTest"))
+
+        val Right(_) = eval.apply(m.spock.testForked()): @unchecked
+      }
+    }
+
+
 
   }
 }

libs/groovylib/worker/src/mill/groovylib/worker/impl/GroovyWorkerImpl.scala

@@ -1,5 +1,6 @@
 package mill.groovylib.worker.impl
 
+import groovy.lang.GroovyClassLoader
 import mill.api.Result
 import mill.api.TaskCtx
 import mill.javalib.api.CompilationResult
@@ -22,22 +23,28 @@ class GroovyWorkerImpl extends GroovyWorker {
     val config = new CompilerConfiguration()
     config.setTargetDirectory(outputDir.toIO)
     config.setClasspathList(classpath.map(_.toIO.getAbsolutePath).asJava)
+    // TODO
+//    config.setDisabledGlobalASTTransformations()
+//    config.setJointCompilationOptions()
+//    config.setSourceEncoding()
+
+    // we need to set the classloader for groovy to use the worker classloader
+    val parentCl: ClassLoader = this.getClass.getClassLoader
+    // config in the GroovyClassLoader is needed when the CL itself is compiling classes
+    val gcl = new GroovyClassLoader(parentCl, config)
+    // config for actual compilation
+    val unit = new CompilationUnit(config, null, gcl)
 
-    val unit = new CompilationUnit(config)
-
-    // Add source files to compile
     sourceFiles.foreach { sourceFile =>
       unit.addSource(sourceFile.toIO)
     }
 
-    return Try {
+    Try {
       unit.compile(Phases.OUTPUT)
-
       CompilationResult(outputDir, mill.api.PathRef(outputDir))
     }.fold(
       exception => Result.Failure(s"Groovy compilation failed: ${exception.getMessage}"),
       result => Result.Success(result)
     )
   }
-
 }