|
| 1 | +import path from "path"; |
| 2 | +import assert from "assert"; |
| 3 | +import fs from "fs"; |
| 4 | +import os from "os"; |
| 5 | + |
| 6 | +import sinon from "sinon"; |
| 7 | +import * as vscode from "vscode"; |
| 8 | +import { beforeEach, afterEach, before, after } from "mocha"; |
| 9 | + |
| 10 | +import { RubyLsp } from "../../rubyLsp"; |
| 11 | +import { RUBY_VERSION } from "../rubyVersion"; |
| 12 | + |
| 13 | +import { FAKE_TELEMETRY } from "./fakeTelemetry"; |
| 14 | +import { ensureRubyInstallationPaths } from "./testHelpers"; |
| 15 | + |
| 16 | +suite("Ruby LSP", () => { |
| 17 | + const context = { |
| 18 | + extensionMode: vscode.ExtensionMode.Test, |
| 19 | + subscriptions: [], |
| 20 | + workspaceState: { |
| 21 | + get: (_name: string) => undefined, |
| 22 | + update: (_name: string, _value: any) => Promise.resolve(), |
| 23 | + }, |
| 24 | + extensionUri: vscode.Uri.file( |
| 25 | + path.dirname(path.dirname(path.dirname(__dirname))), |
| 26 | + ), |
| 27 | + } as unknown as vscode.ExtensionContext; |
| 28 | + let workspacePath: string; |
| 29 | + let workspaceUri: vscode.Uri; |
| 30 | + let workspaceFolder: vscode.WorkspaceFolder; |
| 31 | + const originalSaveBeforeStart = vscode.workspace |
| 32 | + .getConfiguration("debug") |
| 33 | + .get("saveBeforeStart"); |
| 34 | + |
| 35 | + before(async () => { |
| 36 | + await vscode.workspace |
| 37 | + .getConfiguration("debug") |
| 38 | + .update("saveBeforeStart", "none", true); |
| 39 | + }); |
| 40 | + |
| 41 | + after(async () => { |
| 42 | + await vscode.workspace |
| 43 | + .getConfiguration("debug") |
| 44 | + .update("saveBeforeStart", originalSaveBeforeStart, true); |
| 45 | + }); |
| 46 | + |
| 47 | + beforeEach(() => { |
| 48 | + workspacePath = fs.mkdtempSync( |
| 49 | + path.join(os.tmpdir(), "ruby-lsp-integration-test-"), |
| 50 | + ); |
| 51 | + workspaceUri = vscode.Uri.file(workspacePath); |
| 52 | + workspaceFolder = { |
| 53 | + uri: workspaceUri, |
| 54 | + name: path.basename(workspacePath), |
| 55 | + index: 0, |
| 56 | + }; |
| 57 | + }); |
| 58 | + |
| 59 | + afterEach(() => { |
| 60 | + fs.rmSync(workspacePath, { recursive: true, force: true }); |
| 61 | + }); |
| 62 | + |
| 63 | + test("launching debugger in a project with local Bundler settings and composed bundle", async () => { |
| 64 | + fs.writeFileSync(path.join(workspacePath, "test.rb"), "1 + 1"); |
| 65 | + fs.writeFileSync(path.join(workspacePath, ".ruby-version"), RUBY_VERSION); |
| 66 | + fs.writeFileSync( |
| 67 | + path.join(workspacePath, "Gemfile"), |
| 68 | + 'source "https://rubygems.org"\n', |
| 69 | + ); |
| 70 | + fs.writeFileSync( |
| 71 | + path.join(workspacePath, "Gemfile.lock"), |
| 72 | + [ |
| 73 | + "GEM", |
| 74 | + " remote: https://rubygems.org/", |
| 75 | + " specs:", |
| 76 | + "", |
| 77 | + "PLATFORMS", |
| 78 | + " arm64-darwin-23", |
| 79 | + " ruby", |
| 80 | + "", |
| 81 | + "DEPENDENCIES", |
| 82 | + "", |
| 83 | + "BUNDLED WITH", |
| 84 | + " 2.5.16", |
| 85 | + ].join("\n"), |
| 86 | + ); |
| 87 | + fs.mkdirSync(path.join(workspacePath, ".bundle")); |
| 88 | + fs.writeFileSync( |
| 89 | + path.join(workspacePath, ".bundle", "config"), |
| 90 | + `BUNDLE_PATH: ${path.join("vendor", "bundle")}`, |
| 91 | + ); |
| 92 | + |
| 93 | + await ensureRubyInstallationPaths(); |
| 94 | + |
| 95 | + const rubyLsp = new RubyLsp(context, FAKE_TELEMETRY); |
| 96 | + |
| 97 | + try { |
| 98 | + await rubyLsp.activate(workspaceFolder); |
| 99 | + } catch (error: any) { |
| 100 | + assert.fail( |
| 101 | + `Failed to activate Ruby LSP: ${error.message}\n\n${error.stack}`, |
| 102 | + ); |
| 103 | + } |
| 104 | + |
| 105 | + const stub = sinon.stub(vscode.window, "activeTextEditor").get(() => { |
| 106 | + return { |
| 107 | + document: { |
| 108 | + uri: vscode.Uri.file(path.join(workspacePath, "test.rb")), |
| 109 | + }, |
| 110 | + } as vscode.TextEditor; |
| 111 | + }); |
| 112 | + |
| 113 | + const getWorkspaceStub = sinon |
| 114 | + .stub(vscode.workspace, "getWorkspaceFolder") |
| 115 | + .returns(workspaceFolder); |
| 116 | + |
| 117 | + try { |
| 118 | + await vscode.debug.startDebugging(workspaceFolder, { |
| 119 | + type: "ruby_lsp", |
| 120 | + name: "Debug", |
| 121 | + request: "launch", |
| 122 | + program: `ruby ${path.join(workspacePath, "test.rb")}`, |
| 123 | + }); |
| 124 | + } catch (error: any) { |
| 125 | + assert.fail(`Failed to launch debugger: ${error.message}`); |
| 126 | + } |
| 127 | + |
| 128 | + // The debugger might take a bit of time to disconnect from the editor. We need to perform cleanup when we receive |
| 129 | + // the termination callback or else we try to dispose of the debugger client too early, but we need to wait for that |
| 130 | + // so that we can clean up stubs otherwise they leak into other tests. |
| 131 | + await new Promise<void>((resolve) => { |
| 132 | + vscode.debug.onDidTerminateDebugSession((_session) => { |
| 133 | + stub.restore(); |
| 134 | + getWorkspaceStub.restore(); |
| 135 | + |
| 136 | + context.subscriptions.forEach((subscription) => { |
| 137 | + if (!("logLevel" in subscription)) { |
| 138 | + subscription.dispose(); |
| 139 | + } |
| 140 | + }); |
| 141 | + |
| 142 | + resolve(); |
| 143 | + }); |
| 144 | + }); |
| 145 | + }).timeout(90000); |
| 146 | +}); |
0 commit comments