Add support for debugging grading process (#295)

* Add enableDebug to GraderConfiguration

* Work on support for jvm debugging

* Update copyrights

Author: alexstaeding

core/src/main/kotlin/org/sourcegrade/jagr/core/CommonModule.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -88,7 +88,7 @@ class CommonModule(private val configuration: LaunchConfiguration) : AbstractMod
         with(Multibinder.newSetBinder(binder(), RuntimeTester::class.java)) {
             addBinding().to(JavaRuntimeTester::class.java)
         }
-        bind(RuntimeInvoker::class.java).toInstance(configuration.runtimeInvoker)
+        bind(RuntimeInvoker::class.java).toInstance(configuration.runtimeInvokerFactory.create(configuration.logger))
         bind(SerializerFactory.Locator::class.java).to(SerializationFactoryLocatorImpl::class.java)
         bind(SubmissionExporter.Eclipse::class.java).to(EclipseSubmissionExporter::class.java)
         bind(SubmissionExporter.Gradle::class.java).to(GradleSubmissionExporter::class.java)

launcher/gradle-plugin/src/main/kotlin/org/sourcegrade/jagr/gradle/extension/GraderConfiguration.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -30,6 +30,7 @@ import org.gradle.kotlin.dsl.getByType
 import org.gradle.kotlin.dsl.property
 import org.sourcegrade.jagr.launcher.env.Config
 import org.sourcegrade.jagr.launcher.env.Jagr
+import org.sourcegrade.jagr.launcher.env.copyExecutor
 import org.sourcegrade.jagr.launcher.env.copyTimeout
 import org.sourcegrade.jagr.launcher.env.copyTransformers
 
@@ -131,4 +132,13 @@ abstract class GraderConfiguration(
     fun disableTimeouts() = mutateConfig {
         copyTransformers { copyTimeout { copy(enabled = false) } }
     }
+
+    fun enableDebug(port: Int = 5005) = mutateConfig {
+        copyExecutor {
+            copy(
+                jvmArgs = jvmArgs +
+                    "-agentlib:jdwp=transport=dt_socket,server=n,address=localhost:$port,suspend=y",
+            )
+        }
+    }
 }

launcher/gradle-plugin/src/main/kotlin/org/sourcegrade/jagr/gradle/task/grader/GradleLaunchConfiguration.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -37,5 +37,8 @@ internal class GradleLaunchConfiguration(
             "log4j2-console-only.xml",
         ).getLogger("jagr")
     }
-    override val runtimeInvoker: RuntimeInvoker = RuntimeJarInvoker(jagrJar, config.executor.jvmArgs)
+
+    override val runtimeInvokerFactory: RuntimeInvoker.Factory = RuntimeInvoker.Factory { jagr ->
+        RuntimeJarInvoker(jagr, jagrJar, config.executor.jvmArgs)
+    }
 }

launcher/src/main/kotlin/org/sourcegrade/jagr/launcher/env/LaunchConfiguration.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -30,7 +30,7 @@ import java.io.File
 interface LaunchConfiguration {
     val config: Config
     val logger: Logger
-    val runtimeInvoker: RuntimeInvoker
+    val runtimeInvokerFactory: RuntimeInvoker.Factory
 
     object Standard : LaunchConfiguration {
         override val config: Config by lazy {
@@ -57,6 +57,6 @@ interface LaunchConfiguration {
         override val logger: Logger by lazy {
             LogManager.getLogger("Jagr")
         }
-        override val runtimeInvoker: RuntimeInvoker = RuntimeJarInvoker()
+        override val runtimeInvokerFactory: RuntimeInvoker.Factory = RuntimeInvoker.Factory { jagr -> RuntimeJarInvoker(jagr) }
     }
 }

launcher/src/main/kotlin/org/sourcegrade/jagr/launcher/env/SystemResourceJagrFactory.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -19,7 +19,6 @@
 
 package org.sourcegrade.jagr.launcher.env
 
-import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.json.Json
 
 object SystemResourceJagrFactory : Jagr.Factory {

launcher/src/main/kotlin/org/sourcegrade/jagr/launcher/executor/RuntimeInvoker.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -19,7 +19,13 @@
 
 package org.sourcegrade.jagr.launcher.executor
 
+import org.apache.logging.log4j.Logger
+
 interface RuntimeInvoker {
     // TODO: For now use Process, later use a custom interface to abstract communication
     fun createRuntime(): Process
+
+    fun interface Factory {
+        fun create(logger: Logger): RuntimeInvoker
+    }
 }

launcher/src/main/kotlin/org/sourcegrade/jagr/launcher/executor/RuntimeJarInvoker.kt

@@ -1,7 +1,7 @@
 /*
  *   Jagr - SourceGrade.org
- *   Copyright (C) 2021-2022 Alexander Staeding
- *   Copyright (C) 2021-2022 Contributors
+ *   Copyright (C) 2021-2025 Alexander Städing
+ *   Copyright (C) 2021-2025 Contributors
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Affero General Public License as published by
@@ -19,11 +19,13 @@
 
 package org.sourcegrade.jagr.launcher.executor
 
+import org.apache.logging.log4j.Logger
 import java.nio.file.Path
 import java.nio.file.Paths
 import kotlin.io.path.pathString
 
 class RuntimeJarInvoker(
+    private val logger: Logger,
     private val jagrLocation: Path = Paths.get(RuntimeJarInvoker::class.java.protectionDomain.codeSource.location.toURI()),
     private val jvmArgs: List<String> = emptyList(),
 ) : RuntimeInvoker {
@@ -37,5 +39,8 @@ class RuntimeJarInvoker(
         add("--child")
     }
 
-    override fun createRuntime(): Process = ProcessBuilder().command(commands).start()
+    override fun createRuntime(): Process {
+        logger.info("Starting process $commands")
+        return ProcessBuilder().command(commands).start()
+    }
 }