Merge pull request #311 from Shopify/improve-debugger-integration

Support debugging individual Prism tests in VS Code
Shopify · Oct 29, 2024 · 6ff11c3 · 6ff11c3
2 parents f1e5aea + bab4eb4
commit 6ff11c3
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 2 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,7 +1,9 @@
 {
   "recommendations": [
     // C++ intellisense with clangd.
-    "llvm-vs-code-extensions.vscode-clangd"
+    "llvm-vs-code-extensions.vscode-clangd",
+    // TODO: remove this before upstreaming
+    "vadimcn.vscode-lldb",
   ],
   "unwantedRecommendations": [
     // Microsoft C++ intellisense (doesn't work properly with Sorbet)

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -22,6 +22,26 @@
                     "ignoreFailures": false
                 }
             ]
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug Prism test in LLDB",
+            "program": "${workspaceFolder}/bazel-bin/test/test_PosTests/prism_regression/${input:test_name}.runfiles/com_stripe_ruby_typer/test/pipeline_test_runner",
+            "args": ["--single_test=${workspaceFolder}/test/prism_regression/${input:test_name}.rb", "--parser=prism"],
+            // See .vscode/tasks.json for the task that sets the `BAZEL_EXEC_ROOT` environment variable.
+            "preLaunchTask": "Prepare tests debugging",
+            "stopOnEntry": false,
+            "sourceMap": {
+                "${env:BAZEL_EXEC_ROOT}": "${workspaceFolder}",
+            },
+        },
+    ],
+    "inputs": [
+        {
+            "id": "test_name",
+            "type": "promptString",
+            "description": "Enter the test name, e.g. case for running test/prism_regression/case.rb",
         }
     ]
-}
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -69,6 +69,23 @@
                 "reveal": "always"
             }
         },
+        // This task:
+        // - Runs tests to generate the pipeline_test_runner files, which are needed by the LLDB
+        //   debugger to execute the tests.
+        // - Sets the `BAZEL_EXEC_ROOT` environment variable, which is used by the LLDB
+        //   debugger to find the source files.
+        {
+            "label": "Prepare tests debugging",
+            "type": "shell",
+            "command": "export BAZEL_EXEC_ROOT=$(./bazel info execution_root)",
+            // We need to run tests first to get the pipeline_test_runner files generated
+            // Just building Sorbet with Prism doesn't generate them.
+            "dependsOn": ["Run all Prism tests"],
+            "hide": true,
+            "presentation": {
+                "reveal": "never",
+            }
+        }
     ],
     "inputs": [
         {