Pass whether Lincheck is in the trace debugger mode to the plugin (#562)

Author: dmitrii-artuhov

src/jvm/main/org/jetbrains/kotlinx/lincheck/IdeaPlugin.kt

@@ -15,6 +15,7 @@ import sun.nio.ch.lincheck.*
 import org.jetbrains.kotlinx.lincheck.runner.*
 import org.jetbrains.kotlinx.lincheck.strategy.*
 import org.jetbrains.kotlinx.lincheck.strategy.managed.*
+import org.jetbrains.kotlinx.lincheck.strategy.managed.ExecutionMode.GENERAL_PURPOSE_MODEL_CHECKER
 import org.jetbrains.kotlinx.lincheck.strategy.managed.modelchecking.*
 import org.jetbrains.kotlinx.lincheck.execution.ExecutionResult
 import org.jetbrains.kotlinx.lincheck.execution.ExecutionScenario
@@ -39,7 +40,7 @@ const val MINIMAL_PLUGIN_VERSION = "0.11"
  * @param version current Lincheck version.
  * @param minimalPluginVersion minimal compatible plugin version.
  * @param exceptions representation of the exceptions with their stacktrace occurred during the execution.
- * @param isGeneralPurposeModelChecking indicates if lincheck is running in the GPMC mode
+ * @param executionMode indicates the mode in which lincheck is running current test (see [ManagedStrategy.executionMode])
  */
 @Suppress("UNUSED_PARAMETER")
 fun testFailed(
@@ -48,7 +49,7 @@ fun testFailed(
     version: String?,
     minimalPluginVersion: String,
     exceptions: Array<String>,
-    isGeneralPurposeModelChecking: Boolean,
+    executionMode: String
 ) {}
 
 
@@ -159,7 +160,7 @@ internal fun ManagedStrategy.runReplayIfPluginEnabled(failure: LincheckFailure)
             version = lincheckVersion,
             minimalPluginVersion = MINIMAL_PLUGIN_VERSION,
             exceptions = exceptionsRepresentation,
-            isGeneralPurposeModelChecking = isGeneralPurposeModelChecking,
+            executionMode = executionMode.id
         )
         // Replay execution while it's needed.
         do {
@@ -348,7 +349,7 @@ private data class ExceptionProcessingResult(
  *   Used to collect the data about the test instance, object numbers, threads, and continuations.
  */
 private fun visualize(strategy: ManagedStrategy) = runCatching {
-    if (strategy.isGeneralPurposeModelChecking) return@runCatching
+    if (strategy.executionMode == GENERAL_PURPOSE_MODEL_CHECKER) return@runCatching
 
     val runner = strategy.runner as ParallelThreadsRunner
     val allThreads = strategy.getRegisteredThreads()

src/jvm/main/org/jetbrains/kotlinx/lincheck/strategy/managed/ManagedStrategy.kt

@@ -52,7 +52,12 @@ abstract class ManagedStrategy(
     private val testCfg: ManagedCTestConfiguration,
 ) : Strategy(scenario), EventTracker {
 
-    val isGeneralPurposeModelChecking = testClass == GeneralPurposeModelCheckingWrapper::class.java
+    val executionMode: ExecutionMode =
+        when {
+            testClass == GeneralPurposeModelCheckingWrapper::class.java -> ExecutionMode.GENERAL_PURPOSE_MODEL_CHECKER
+            isInTraceDebuggerMode -> ExecutionMode.TRACE_DEBUGGER
+            else -> ExecutionMode.DATA_STRUCTURES
+        }
 
     // The flag to enable IntelliJ IDEA plugin mode
     var inIdeaPluginReplayMode: Boolean = false
@@ -2082,6 +2087,17 @@ private val BlockingReason.obstructionFreedomViolationMessage: String get() = wh
     is BlockingReason.Suspended    -> OBSTRUCTION_FREEDOM_SUSPEND_VIOLATION_MESSAGE
 }
 
+/**
+ * @param id specifies the string literal that will be parsed on the plugin side,
+ * thus, it should never be changed unconsciously. The plugin will use this values
+ * to determine what kind of UI to show to the user.
+ */
+enum class ExecutionMode(val id: String) {
+    DATA_STRUCTURES("DATA_STRUCTURES"),
+    GENERAL_PURPOSE_MODEL_CHECKER("GENERAL_PURPOSE_MODEL_CHECKER"),
+    TRACE_DEBUGGER("TRACE_DEBUGGER")
+}
+
 private const val OBSTRUCTION_FREEDOM_SPINLOCK_VIOLATION_MESSAGE =
     "The algorithm should be non-blocking, but an active lock is detected"