summaryrefslogtreecommitdiff
path: root/debugger-tests/src/com/android/tools/debuggertests/Engine.kt
blob: 54b8d61cad2079cd508a9815458baf464df184ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.debuggertests

import com.sun.jdi.LocalVariable
import com.sun.jdi.Location
import com.sun.jdi.event.BreakpointEvent
import com.sun.jdi.event.Event
import java.io.Closeable

private const val BREAKPOINT_CLASS = "BreakpointKt"
private const val BREAKPOINT_LINE = 20

/** A simple test engine */
internal abstract class Engine : Closeable {

  protected abstract suspend fun createDebugger(): Debugger

  /**
   * Executes a single test.
   * 1. Starts a [Debugger]
   * 2. Sets a breakpoint at Breakpoint.breakpoint()
   * 3. Resumes the program each time it hits a breakpoint
   * 4. On each breakpoint, emits information about the frame into a string
   */
  suspend fun runTest(): String {
    val debugger = createDebugger()
    debugger.start()
    debugger.setBreakpoint(BREAKPOINT_CLASS, BREAKPOINT_LINE)
    val actual = buildString {
      while (true) {
        val breakpoint = debugger.resume<Event>() as? BreakpointEvent ?: break
        val frame = breakpoint.thread().frames()[1]
        val location = frame.location()
        append("Breakpoint: ${location.sourceName()}:${location.lineNumber()}\n")
        append("========================================================\n")
        frame.visibleVariables().map { variable ->
          val scope =
            "[%d-%d]".format(
              variable.getStartScope().codeIndex(),
              variable.getEndScope().codeIndex()
            )
          val line =
            "%-2d %-10s: %-20s: %s\n".format(
              variable.getSlot(),
              scope,
              variable.name(),
              variable.typeName()
            )
          append(line)
        }
        append('\n')
      }
    }
    return actual
  }

  enum class EngineType(private val factory: (String) -> Engine) {
    SIMPLE(::SimpleEngine),
    JVM(::JvmEngine),
    ;

    fun getEngine(testName: String) = factory(testName)
  }
}

private fun LocalVariable.getStartScope(): Location = getFieldValue("scopeStart")

private fun LocalVariable.getEndScope(): Location = getFieldValue("scopeEnd")

private fun LocalVariable.getSlot(): Int = getFieldValue("slot")

private inline fun <reified T> Any.getFieldValue(name: String): T {
  val field = javaClass.getDeclaredField(name).apply { isAccessible = true }
  return field.get(this) as T
}