Merge pull request #1389 from wleczny/debug-option-for-run-command

wleczny · web-flow · commit 7013b86b349e · 2022-09-27T13:53:38.000+02:00
Enable debugging for run and test commands
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/SharedDebugOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/SharedDebugOptions.scala
@@ -0,0 +1,28 @@
+package scala.cli.commands
+
+import caseapp.*
+import caseapp.core.help.Help
+
+import scala.cli.commands.BloopExitOptions.parser
+
+// format: off
+final case class SharedDebugOptions(
+  @Group("Debug")
+  @HelpMessage("Turn debugging on")
+    debug: Boolean = false,
+  @Group("Debug")
+  @HelpMessage("Debug port (5005 by default)")
+    debugPort: Option[String] = None,
+  @Group("Debug")
+  @HelpMessage("Debug mode (attach by default)")
+  @ValueDescription("attach|a|listen|l")
+    debugMode: Option[String] = None
+)
+// format: on
+
+object SharedDebugOptions {
+  implicit lazy val parser: Parser[SharedDebugOptions] = Parser.derive
+  implicit lazy val help: Help[SharedDebugOptions]     = Help.derive
+  // Parser.Aux for using SharedDebugOptions with @Recurse in other options
+  implicit lazy val parserAux: Parser.Aux[SharedDebugOptions, parser.D] = parser
+}
diff --git a/modules/cli-options/src/main/scala/scala/cli/commands/SharedJvmOptions.scala b/modules/cli-options/src/main/scala/scala/cli/commands/SharedJvmOptions.scala
@@ -6,6 +6,8 @@ import com.github.plokhotnyuk.jsoniter_scala.macros._
 
 // format: off
 final case class SharedJvmOptions(
+  @Recurse
+    sharedDebug: SharedDebugOptions = SharedDebugOptions(),
 
   @Group("Java")
   @HelpMessage("Set the Java home directory")
diff --git a/modules/cli/src/main/scala/scala/cli/commands/BloopStart.scala b/modules/cli/src/main/scala/scala/cli/commands/BloopStart.scala
@@ -24,7 +24,7 @@ object BloopStart extends ScalaCommand[BloopStartOptions] {
   private def mkBloopRifleConfig(opts: BloopStartOptions): BloopRifleConfig = {
     import opts._
     val buildOptions = BuildOptions(
-      javaOptions = JvmUtils.javaOptions(jvm),
+      javaOptions = JvmUtils.javaOptions(jvm).orExit(logging.logger),
       internal = InternalOptions(
         cache = Some(coursier.coursierCache(logging.logger.coursierLogger("")))
       )
diff --git a/modules/cli/src/main/scala/scala/cli/commands/config/Config.scala b/modules/cli/src/main/scala/scala/cli/commands/config/Config.scala
@@ -58,7 +58,7 @@ object Config extends ScalaCommand[ConfigOptions] {
                 logger,
                 coursierCache,
                 () =>
-                  JvmUtils.javaOptions(options.jvm).javaHome(
+                  JvmUtils.javaOptions(options.jvm).orExit(logger).javaHome(
                     ArchiveCache().withCache(coursierCache),
                     coursierCache,
                     logger.verbosity
diff --git a/modules/cli/src/main/scala/scala/cli/commands/pgp/PgpExternalCommand.scala b/modules/cli/src/main/scala/scala/cli/commands/pgp/PgpExternalCommand.scala
@@ -89,7 +89,7 @@ abstract class PgpExternalCommand extends ExternalCommand {
       logger,
       allowExecve = true,
       () =>
-        JvmUtils.javaOptions(options.jvm).javaHome(
+        JvmUtils.javaOptions(options.jvm).orExit(logger).javaHome(
           ArchiveCache().withCache(cache),
           cache,
           logger.verbosity
diff --git a/modules/cli/src/main/scala/scala/cli/commands/pgp/PgpPush.scala b/modules/cli/src/main/scala/scala/cli/commands/pgp/PgpPush.scala
@@ -44,7 +44,7 @@ object PgpPush extends ScalaCommand[PgpPushOptions] {
       val keyContent = os.read(path)
 
       val javaCommand = () =>
-        JvmUtils.javaOptions(options.jvm).javaHome(
+        JvmUtils.javaOptions(options.jvm).orExit(logger).javaHome(
           ArchiveCache().withCache(coursierCache),
           coursierCache,
           logger.verbosity
diff --git a/modules/cli/src/main/scala/scala/cli/commands/publish/checks/PgpSecretKeyCheck.scala b/modules/cli/src/main/scala/scala/cli/commands/publish/checks/PgpSecretKeyCheck.scala
@@ -51,13 +51,14 @@ final case class PgpSecretKeyCheck(
     else
       Base64.getEncoder().encodeToString(input)
 
-  def javaCommand: () => String =
+  def javaCommand: Either[BuildException, () => String] = either {
     () =>
-      JvmUtils.javaOptions(options.sharedJvm).javaHome(
+      value(JvmUtils.javaOptions(options.sharedJvm)).javaHome(
         ArchiveCache().withCache(coursierCache),
         coursierCache,
         logger.verbosity
       ).value.javaCommand
+  }
 
   def defaultValue(): Either[BuildException, OptionCheck.DefaultValue] =
     either {
@@ -114,7 +115,7 @@ final case class PgpSecretKeyCheck(
                       password,
                       logger,
                       coursierCache,
-                      javaCommand
+                      value(javaCommand)
                     )
                   }
                   val pgpSecretBase64 = pgpSecret0.map(Base64.getEncoder.encodeToString)
@@ -150,7 +151,7 @@ final case class PgpSecretKeyCheck(
                 "[generated key]",
                 coursierCache,
                 logger,
-                javaCommand
+                value(javaCommand)
               )
             }
             val keyServers = value {
diff --git a/modules/cli/src/main/scala/scala/cli/commands/util/JvmUtils.scala b/modules/cli/src/main/scala/scala/cli/commands/util/JvmUtils.scala
@@ -3,12 +3,14 @@ package util
 
 import java.io.File
 
-import scala.build.options.JavaOptions
+import scala.build.EitherCps.{either, value}
+import scala.build.errors.{BuildException, UnrecognizedDebugModeError}
+import scala.build.options.{JavaOpt, JavaOptions, ShadowingSeq}
 import scala.build.{Os, Position, Positioned}
 import scala.util.Properties
 
 object JvmUtils {
-  def javaOptions(opts: SharedJvmOptions) = {
+  def javaOptions(opts: SharedJvmOptions): Either[BuildException, JavaOptions] = either {
     import opts._
 
     val (javacFilePlugins, javacPluginDeps) =
@@ -20,6 +22,28 @@ object JvmUtils {
           input.count(_ == ':') < 2
         }
 
+    val javaOptsSeq = {
+      val isDebug =
+        opts.sharedDebug.debug ||
+        opts.sharedDebug.debugMode.nonEmpty ||
+        opts.sharedDebug.debugPort.nonEmpty
+      if (isDebug) {
+        val server = value {
+          opts.sharedDebug.debugMode match {
+            case Some("attach") | Some("a") | None => Right("y")
+            case Some("listen") | Some("l")        => Right("n")
+            case Some(m)                           => Left(new UnrecognizedDebugModeError(m))
+          }
+        }
+        val port = opts.sharedDebug.debugPort.getOrElse("5005")
+        Seq(Positioned.none(
+          JavaOpt(s"-agentlib:jdwp=transport=dt_socket,server=$server,suspend=y,address=$port")
+        ))
+      }
+      else
+        Seq.empty
+    }
+
     JavaOptions(
       javaHomeOpt = javaHome.filter(_.nonEmpty).map(v =>
         Positioned(Seq(Position.CommandLine("--java-home")), os.Path(v, Os.pwd))
@@ -28,6 +52,7 @@ object JvmUtils {
       jvmIndexOpt = jvmIndex.filter(_.nonEmpty),
       jvmIndexOs = jvmIndexOs.map(_.trim).filter(_.nonEmpty),
       jvmIndexArch = jvmIndexArch.map(_.trim).filter(_.nonEmpty),
+      javaOpts = ShadowingSeq.from(javaOptsSeq),
       javacPluginDependencies = SharedOptionsUtil.parseDependencies(
         javacPluginDeps.map(Positioned.none(_)),
         ignoreErrors = false
diff --git a/modules/cli/src/main/scala/scala/cli/commands/util/SharedOptionsUtil.scala b/modules/cli/src/main/scala/scala/cli/commands/util/SharedOptionsUtil.scala
@@ -202,7 +202,7 @@ object SharedOptionsUtil extends CommandHelpers {
         ),
         scalaJsOptions = scalaJsOptions(js),
         scalaNativeOptions = scalaNativeOptions(native),
-        javaOptions = scala.cli.commands.util.JvmUtils.javaOptions(jvm),
+        javaOptions = value(scala.cli.commands.util.JvmUtils.javaOptions(jvm)),
         internalDependencies = bo.InternalDependenciesOptions(
           addStubsDependencyOpt = addStubs,
           addRunnerDependencyOpt = runner
diff --git a/modules/core/src/main/scala/scala/build/errors/UnrecognizedDebugModeError.scala b/modules/core/src/main/scala/scala/build/errors/UnrecognizedDebugModeError.scala
@@ -0,0 +1,5 @@
+package scala.build.errors
+
+final class UnrecognizedDebugModeError(mode: String) extends BuildException(
+      s"Unrecognized debug mode: $mode."
+    )
diff --git a/modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala
@@ -7,6 +7,7 @@ import java.nio.charset.Charset
 
 import scala.cli.integration.util.DockerServer
 import scala.io.Codec
+import scala.jdk.CollectionConverters._
 import scala.util.Properties
 
 abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
@@ -520,6 +521,39 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
     }
   }
 
+  test("Debugging") {
+    val inputs = TestInputs(
+      os.rel / "Foo.scala" ->
+        s"""object Foo {
+           |  def main(args: Array[String]): Unit = {
+           |    println("foo")
+           |  }
+           |}
+           |""".stripMargin
+    )
+    inputs.fromRoot { root =>
+      val out1 = os.proc(TestUtil.cli, "run", extraOptions, ".", "--debug", "--command")
+        .call(cwd = root).out.trim().lines.toList.asScala
+      val out2 = os.proc(
+        TestUtil.cli,
+        "run",
+        extraOptions,
+        ".",
+        "--debug-port",
+        "5006",
+        "--debug-mode",
+        "listen",
+        "--command"
+      ).call(cwd = root).out.trim().lines.toList.asScala
+
+      def debugString(server: String, port: String) =
+        s"-agentlib:jdwp=transport=dt_socket,server=$server,suspend=y,address=$port"
+
+      assert(out1.exists(_ == debugString("y", "5005")))
+      assert(out2.exists(_ == debugString("n", "5006")))
+    }
+  }
+
   test("Pass arguments") {
     val inputs = TestInputs(
       os.rel / "Test.scala" ->
diff --git a/website/docs/commands/run.md b/website/docs/commands/run.md
@@ -204,3 +204,21 @@ object HelloWorld extends App {
 docker run  -v $(pwd)/HelloWorld.scala:/HelloWorld.scala virtuslab/scala-cli /HelloWorld.scala
 # Hello world
 ```
+
+## Debugging
+
+It is possible to debug code by passing `--debug` flag.
+
+Additional debug options:
+* `--debug-mode` (attach by default)
+* `--debug-port` (5005 by default)
+
+Available debug modes:
+* Attach (`attach` | `att` | `a`)
+* Listen (`listen` | `lis` | `l`)
+
+Example debugging with scala-cli:
+
+```bash ignore
+scala-cli Foo.scala --debug --debug-mode l --debug-port 5006
+```
diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -135,6 +135,26 @@ Available in commands:
 
 [experimental] Run given command against all provided Scala versions and/or platforms
 
+## Debug options
+
+Available in commands:
+
+[`bloop`](./commands.md#bloop), [`bloop start`](./commands.md#bloop-start), [`bsp`](./commands.md#bsp), [`compile`](./commands.md#compile), [`config`](./commands.md#config), [`dependency-update`](./commands.md#dependency-update), [`doc`](./commands.md#doc), [`export`](./commands.md#export), [`fmt` , `format` , `scalafmt`](./commands.md#fmt), [`browse` , `metabrowse`](./commands.md#browse), [`package`](./commands.md#package), [`pgp push`](./commands.md#pgp-push), [`publish`](./commands.md#publish), [`publish local`](./commands.md#publish-local), [`publish setup`](./commands.md#publish-setup), [`repl` , `console`](./commands.md#repl), [`run`](./commands.md#run), [`setup-ide`](./commands.md#setup-ide), [`shebang`](./commands.md#shebang), [`test`](./commands.md#test)
+
+<!-- Automatically generated, DO NOT EDIT MANUALLY -->
+
+### `--debug`
+
+Turn debugging on
+
+### `--debug-port`
+
+Debug port (5005 by default)
+
+### `--debug-mode`
+
+Debug mode (attach by default)
+
 ## Dependency options
 
 Available in commands:
diff --git a/website/docs/reference/commands.md b/website/docs/reference/commands.md
diff --git a/website/docs/reference/scala-command/cli-options.md b/website/docs/reference/scala-command/cli-options.md
diff --git a/website/docs/reference/scala-command/commands.md b/website/docs/reference/scala-command/commands.md

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ object BloopStart extends ScalaCommand[BloopStartOptions] {`
`24`	`24`	`private def mkBloopRifleConfig(opts: BloopStartOptions): BloopRifleConfig = {`
`25`	`25`	`import opts._`
`26`	`26`	`val buildOptions = BuildOptions(`
`27`		`- javaOptions = JvmUtils.javaOptions(jvm),`
	`27`	`+ javaOptions = JvmUtils.javaOptions(jvm).orExit(logging.logger),`
`28`	`28`	`internal = InternalOptions(`
`29`	`29`	`cache = Some(coursier.coursierCache(logging.logger.coursierLogger("")))`
`30`	`30`	`)`