Initial Groovy setup

.github/workflows/run-tests.yml

@@ -157,6 +157,10 @@ jobs:
             millargs: "'example.androidlib.__.shared.daemon'"
             setup-android: true
 
+          - java-version: 17
+            millargs: "'example.groovylib.__.shared.daemon'"
+            setup-android: true
+
           - java-version: 17
             millargs: "'example.thirdparty[android-compose-samples].packaged.daemon'"
             setup-android: true

core/api/daemon/src/mill/api/daemon/internal/GroovyModuleApi.scala

@@ -0,0 +1,4 @@
+package mill.api.daemon.internal
+
+@mill.api.daemon.experimental
+trait GroovyModuleApi extends JavaModuleApi

core/api/daemon/src/mill/api/daemon/internal/bsp/BspModuleApi.scala

@@ -23,6 +23,7 @@ object BspModuleApi {
     val Java = "java"
     val Scala = "scala"
     val Kotlin = "kotlin"
+    val Groovy = "groovy"
   }
 
   /** Used to define the [[BspBuildTarget.tags]] field. */

core/eval/src/mill/eval/ScriptModuleInit.scala

@@ -53,6 +53,7 @@ class ScriptModuleInit extends ((String, Evaluator) => Seq[Result[ExternalModule
           case "java" => Result.Success("mill.script.JavaModule")
           case "kt" => Result.Success("mill.script.KotlinModule")
           case "scala" => Result.Success("mill.script.ScalaModule")
+          case "groovy" => Result.Success("mill.script.GroovyModule")
           case _ =>
             Result.Failure(
               s"Script ${scriptFile.relativeTo(mill.api.BuildCtx.workspaceRoot)} has no `extends` clause configured and is of an unknown extension `${scriptFile.ext}`"

example/groovylib/basic/1-script/Foo.groovy

@@ -0,0 +1,11 @@
+class Foo {
+
+    static void main(String[] args) {
+        if(args == null || args.length != 1){
+            println "Specify exactly one parameter for greeting"
+            System.exit(1)
+        }
+
+        println "Hello ${args[0]}"
+    }
+}

example/groovylib/basic/1-script/build.mill

@@ -0,0 +1,32 @@
+//// SNIPPET:FILE
+/** See Also: Foo.groovy */
+//// SNIPPET:END
+
+//// SNIPPET:CMD
+/** Usage
+> ./mill Foo.groovy bar
+Compiling 1 Groovy sources to...
+Hello bar
+*/
+//// SNIPPET:END
+//// SNIPPET:MORE
+
+/** Usage
+> ./mill Foo.groovy:run bar
+Hello bar
+*/
+
+//// SNIPPET:END
+
+//// SNIPPET:RESOLVE
+/** Usage
+
+> ./mill resolve Foo.groovy:_
+Foo.groovy:run
+Foo.groovy:runMain
+Foo.groovy:compile
+Foo.groovy:assembly
+...
+
+*/
+//// SNIPPET:END

example/groovylib/basic/11-declarative/build.mill

@@ -0,0 +1,49 @@
+// This is a basic Mill build for a single `GroovyModule`, with one
+// third-party dependency and a test suite using the JUnit framework.
+//
+// This example project uses two third-party dependencies
+// - Groovy-Cli-Commons for CLI argument parsing
+// - Groovy-Xml for HTML templating and escaping
+// and uses them to wrap a given input string in HTML templates with proper escaping.
+//
+
+/** See Also: build.mill.yaml */
+/** See Also: test/package.mill.yaml */
+
+/** Usage
+
+> ./mill resolve _ # List what tasks are available to run
+assembly
+...
+compile
+...
+run
+...
+test
+
+*/
+
+/** Usage
+> ./mill run --text hello
+<h1>hello</h1>
+*/
+
+/** Usage
+> ./mill test
+Running Test Class foo.FooTest
+Test foo.FooTest#generate html created properly() finished...
+Test foo.FooTest#generated html is properly escaped() finished...
+Test foo.FooTest finished...
+
+*/
+
+/** Usage
+> ./mill assembly # bundle classfiles and libraries into a jar for deployment
+
+> ./mill show assembly # show the output of the assembly task
+".../out/assembly.dest/out.jar"
+
+> java -jar ./out/assembly.dest/out.jar --text hello
+<h1>hello</h1>
+
+*/

example/groovylib/basic/11-declarative/build.mill.yaml

@@ -0,0 +1,6 @@
+extends: [mill.groovylib.GroovyModule]
+groovyVersion: 5.0.1
+mvnDeps:
+  - org.apache.groovy:groovy-cli-commons
+  - org.apache.groovy:groovy-xml
+mainClass: foo.Foo

example/groovylib/basic/11-declarative/src/foo/Foo.groovy

@@ -0,0 +1,32 @@
+package foo
+
+import groovy.xml.MarkupBuilder
+import groovy.cli.commons.CliBuilder
+
+class Foo {
+    static String generateHtml(String text) {
+        def writer = new StringWriter()
+        new MarkupBuilder(writer).h1 {
+            mkp.yield text
+        }
+        writer.toString()
+    }
+
+    static void main(String[] args) {
+        def cli = new CliBuilder(usage:'help')
+        cli.t(longOpt:'text', args: 1, 'Passes text to the HTML generation')
+        def options = cli.parse(args)
+
+        if (!options) {
+            return
+        }
+
+        if (options.h) {
+            cli.usage()
+            return
+        }
+
+        String textToProcess = options.t ?: "hello from main"
+        println generateHtml(textToProcess)
+    }
+}

example/groovylib/basic/11-declarative/test/package.mill.yaml

@@ -0,0 +1,4 @@
+extends: [build.GroovyTests, mill.javalib.TestModule.Junit5]
+jupiterVersion: 5.13.4
+mvnDeps:
+  - org.apache.groovy:groovy-test

example/groovylib/basic/11-declarative/test/src/foo/FooTest.groovy

@@ -0,0 +1,15 @@
+package foo
+
+import org.junit.jupiter.api.Test
+
+class FooTest {
+    @Test
+    void "generate html created properly"() {
+        assert Foo.generateHtml("hello") == "<h1>hello</h1>"
+    }
+
+    @Test
+    void "generated html is properly escaped"() {
+        assert Foo.generateHtml("<hello>") == "<h1>&lt;hello&gt;</h1>"
+    }
+}

example/groovylib/basic/3-simple/build.mill

@@ -0,0 +1,59 @@
+//// SNIPPET:BUILD
+
+package build
+import mill.*, groovylib.*
+
+object foo extends GroovyModule {
+  def groovyVersion = "5.0.1"
+
+  def mvnDeps = Seq(
+    mvn"org.apache.groovy:groovy-cli-commons", // BOM already loaded by module
+    mvn"org.apache.groovy:groovy-xml" // BOM already loaded by module
+  )
+
+  def mainClass = Some("foo.Foo")
+
+  object test extends GroovyTests with TestModule.Junit5 {
+    def jupiterVersion = "5.13.4"
+
+    def mvnDeps = Seq(
+      mvn"org.apache.groovy:groovy-test" // BOM already loaded by module
+    )
+  }
+}
+
+// This is a basic Mill build for a single `GroovyModule`, with one
+// third-party dependency and a test suite using the JUnit framework.
+//// SNIPPET:TREE
+// ----
+// build.mill
+// foo/
+//     src/
+//         foo/Foo.groovy
+//     resources/
+//         ...
+//     test/
+//         src/
+//             foo/FooTest.groovy
+// out/foo/
+//     compile.json
+//     compile.dest/
+//     ...
+//     test/
+//         compile.json
+//         compile.dest/
+//         ...
+// ----
+//
+// NOTE: The default Mill source folder layout `foo/src/` differs from that of Maven/Gradle's
+// `foo/src/main/groovy`. If you wish to use the Maven source folder layout, e.g. for migrating
+// an existing codebase, you should use
+// xref:#_maven_compatible_modules[Maven-Compatible Modules]
+//
+//// SNIPPET:DEPENDENCIES
+//
+// This example project uses two third-party dependencies
+// - Groovy-Cli-Commons for CLI argument parsing
+// - Groovy-Xml for HTML templating and escaping
+// and uses them to wrap a given input string in HTML templates with proper escaping.
+//

example/groovylib/basic/3-simple/foo/src/foo/Foo.groovy

@@ -0,0 +1,32 @@
+package foo
+
+import groovy.xml.MarkupBuilder
+import groovy.cli.commons.CliBuilder
+
+class Foo {
+    static String generateHtml(String text) {
+        def writer = new StringWriter()
+        new MarkupBuilder(writer).h1 {
+            mkp.yield text
+        }
+        writer.toString()
+    }
+
+    static void main(String[] args) {
+        def cli = new CliBuilder(usage:'help')
+        cli.t(longOpt:'text', args: 1, 'Passes text to the HTML generation')
+        def options = cli.parse(args)
+
+        if (!options) {
+            return
+        }
+
+        if (options.h) {
+            cli.usage()
+            return
+        }
+
+        String textToProcess = options.t ?: "hello from main"
+        println generateHtml(textToProcess)
+    }
+}

example/groovylib/basic/3-simple/foo/test/src/foo/FooTest.groovy

@@ -0,0 +1,15 @@
+package foo
+
+import org.junit.jupiter.api.Test
+
+class FooTest {
+    @Test
+    void "generate html created properly"() {
+        assert Foo.generateHtml("hello") == "<h1>hello</h1>"
+    }
+
+    @Test
+    void "generated html is properly escaped"() {
+        assert Foo.generateHtml("<hello>") == "<h1>&lt;hello&gt;</h1>"
+    }
+}

example/groovylib/basic/4-module-deps/bar/src/bar/Bar.groovy

@@ -0,0 +1,13 @@
+package bar
+
+import groovy.xml.MarkupBuilder
+
+class Bar {
+    static String generateHtml(String text) {
+        def writer = new StringWriter()
+        new MarkupBuilder(writer).h1 {
+            mkp.yield text
+        }
+        writer.toString()
+    }
+}

example/groovylib/basic/4-module-deps/bar/test/src/bar/BarTests.groovy

@@ -0,0 +1,15 @@
+package bar
+
+import org.junit.jupiter.api.Test
+
+class BarTest {
+    @Test
+    void "generate html created properly"() {
+        assert Bar.generateHtml("hello") == "<h1>hello</h1>"
+    }
+
+    @Test
+    void "generated html is properly escaped"() {
+        assert Bar.generateHtml("<hello>") == "<h1>&lt;hello&gt;</h1>"
+    }
+}

example/groovylib/basic/4-module-deps/build.mill

@@ -0,0 +1,53 @@
+package build
+import mill.*, groovylib.*
+
+object foo extends GroovyModule {
+
+  def groovyVersion = "5.0.1"
+
+  def moduleDeps = Seq(build.bar)
+  def mvnDeps = Seq(
+    mvn"org.apache.groovy:groovy-cli-commons" // BOM already loaded by module
+  )
+}
+
+object bar extends GroovyModule {
+
+  def groovyVersion = "5.0.1"
+
+  def mvnDeps = Seq(
+    mvn"org.apache.groovy:groovy-xml" // BOM already loaded by module
+  )
+
+  object test extends GroovyTests with TestModule.Junit5 {}
+}
+//// SNIPPET:TREE
+// ----
+// build.mill
+// foo/
+//     src/
+//         foo/Foo.groovy
+//     test/
+//         src/
+//             foo/FooTests.groovy
+// bar/
+//     src/
+//         bar/Bar.groovy
+//     test/
+//         src/
+//             bar/BarTests.groovy
+// out/
+//     foo/
+//         compile.json
+//         compile.dest/
+//         ...
+//     bar/
+//         compile.json
+//         compile.dest/
+//         ...
+//         test/
+//             compile.json
+//             compile.dest/
+//             ...
+// ----
+//