Add debugger launch test #989
Conversation
| } | ||
|
|
||
| // By default, VS Code always saves all open files when launching a debugging session. This is a problem for tests | ||
| // because it attempts to save an untitled test file and then we get stuck in the save file dialog with no way of |
There was a problem hiding this comment.
Which file is the untitled one here?
There was a problem hiding this comment.
It's a new untitled file that gets created when we run tests.
src/test/suite/debugger.test.ts
Outdated
| .getConfiguration("debug") | ||
| .update("saveBeforeStart", currentSaveBeforeStart, true, true); | ||
| }); | ||
| }).timeout(30000); |
There was a problem hiding this comment.
This is a long test to read through, I wonder if we can extract out behaviour into helper methods?
There was a problem hiding this comment.
We can definitely do it, but since it's not used anywhere else I'm now sure what to extract. Do you have a suggestion?
vinistock
force-pushed
the
vs/add_debugger_launch_test
branch
8 times, most recently
from
6a2a3ae
to
48913b0
Compare
vinistock
force-pushed
the
vs/add_debugger_launch_test
branch
10 times, most recently
from
a1cc3c3
to
aec5297
Compare
| import { Workspace } from "./workspace"; | ||
|
|
||
| class TerminalLogger { |
There was a problem hiding this comment.
This terminal logger is so that we can see logs from the debug server when a test fails
| try { | ||
| sockets = execSync(cmd, { | ||
| cwd: workspaceFolder.uri.fsPath, | ||
| const result = await asyncExec("bundle exec rdbg --util=list-socks", { |
There was a problem hiding this comment.
Just switching to asyncExec instead of synchronous.
| @@ -192,16 +209,19 @@ export class Debugger | |||
| const configuration = session.configuration; | |||
| const workspaceFolder = configuration.targetFolder; | |||
| const cwd = workspaceFolder.path; | |||
| const port = | |||
There was a problem hiding this comment.
Using UNIX sockets doesn't work on Windows, but we can easily spawn the debugger with a port.
| @@ -253,7 +277,7 @@ export class Debugger | |||
| // If the Ruby debug exits with an exit code > 1, then an error might've occurred. The reason we don't use only | |||
| // code zero here is because debug actually exits with 1 if the user cancels the debug session, which is not | |||
| // actually an error | |||
| this.debugProcess.on("exit", (code) => { | |||
| this.debugProcess.on("close", (code) => { | |||
There was a problem hiding this comment.
The exit event actually happens before the stdin, stdout and stderr pipes are closed. If we raise an error on exit, we never capture the backtrace of the server printed to stderr.
But if we use the close event, then everything gets printed and it's significantly easier to understand why the debug server failed to start.
vinistock
force-pushed
the
vs/add_debugger_launch_test
branch
from
aec5297
to
ecffd1c
Compare
Motivation
We had a few debugger related issues recently, so we need to continue on our quest to improve our test coverage of the extension. This PR adds a launch test for the debugger that actually spawns it, so that we can catch more issues on CI.
Implementation
The test performs all of the necessary setup, like creating a Gemfile and activating Ruby. The it attempts to launch the debugger with a simple
1 + 1Ruby program, waits for the debugger to finish and performs clean up.I also bumped our Ruby version to 3.3.0.