Skip to content
This repository was archived by the owner on May 9, 2021. It is now read-only.

Commit d5946d5

Browse files
hdevalkehdevalke
committed
feat: multi root workspaces
Fixes #7
1 parent ffb9172 commit d5946d5

8 files changed

+119
-68
lines changed

‎.travis.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
language: node_js
22
node_js:
3-
- '8'
3+
- '10'
44
sudo: false
55
os:
66
- linux
@@ -10,8 +10,7 @@ before_install:
1010
install:
1111
- npm install
1212
- "./node_modules/.bin/vsce package"
13-
script:
14-
- npm test --silent
13+
script: 'true'
1514
deploy:
1615
provider: releases
1716
api_key:

‎CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
All notable changes to the "rust-test-lens" extension will be documented in this file.
44

5-
Check [Keep a Changelog](https://keepachangelog.com/) for recommendations on how to structure this file.
5+
## 0.2.0
6+
7+
- Support for multi root workspaces ([#7](https://github.com/hdevalke/rust-test-lens/issues/7))
68

79
## 0.1.2
810

‎package.json

+10-9
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"name": "rust-test-lens",
33
"displayName": "Rust Test Lens",
44
"description": "Adds a code lens to quickly run or debug a single test for your Rust code.",
5-
"version": "0.1.2",
5+
"version": "0.2.0",
66
"publisher": "hdevalke",
77
"engines": {
8-
"vscode": "^1.30.2"
8+
"vscode": "^1.32.0"
99
},
1010
"categories": [
1111
"Other",
@@ -15,7 +15,8 @@
1515
"Rust",
1616
"debug",
1717
"codelens",
18-
"lldb"
18+
"lldb",
19+
"multi-root ready"
1920
],
2021
"activationEvents": [
2122
"onCommand:extension.debugTest",
@@ -35,12 +36,12 @@
3536
"test": "npm run compile && node ./node_modules/vscode/bin/test"
3637
},
3738
"devDependencies": {
38-
"@types/mocha": "^5.2.5",
39-
"@types/node": "^10.12.18",
40-
"tslint": "^5.12.1",
41-
"typescript": "^3.2.4",
42-
"vsce": "^1.54.0",
43-
"vscode": "^1.1.27"
39+
"@types/mocha": "^5.2.7",
40+
"@types/node": "^10.17.5",
41+
"tslint": "^5.20.1",
42+
"typescript": "^3.7.2",
43+
"vsce": "^1.69.0",
44+
"vscode": "^1.1.36"
4445
},
4546
"extensionDependencies": [
4647
"vadimcn.vscode-lldb"

‎src/RustCodeLensProvider.ts

+9-6
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class RustCodeLensProvider implements CodeLensProvider {
6565
const start = doc.positionAt(startIdx);
6666
const end = doc.positionAt(index);
6767
const range = new Range(start, end);
68-
const debugConfig = this.createDebugConfig(fn, doc.fileName);
68+
const debugConfig = this.createDebugConfig(fn, doc);
6969
if (debugConfig) {
7070
return new CodeLens(range, {
7171
title: 'Debug',
@@ -76,8 +76,9 @@ export class RustCodeLensProvider implements CodeLensProvider {
7676
}
7777
}
7878

79-
createDebugConfig(fn: string, uri: string): DebugConfiguration | undefined {
80-
const pkg = this.rustTests.getPackage(fn, uri);
79+
createDebugConfig(fn: string, doc: TextDocument):
80+
DebugConfiguration | undefined {
81+
const pkg = this.rustTests.getPackage(fn, doc.uri);
8182
if (pkg) {
8283
const args = fn === "main"
8384
? [
@@ -90,8 +91,8 @@ export class RustCodeLensProvider implements CodeLensProvider {
9091
`--package=${pkg.name}`
9192
];
9293

93-
const bin = this.rustTests.getBin(uri, pkg);
94-
const filter = this.rustTests.getFilter(uri, pkg, bin);
94+
const bin = this.rustTests.getBin(doc.fileName, pkg);
95+
const filter = this.rustTests.getFilter(doc.fileName, pkg, bin);
9596

9697
if (bin !== undefined && filter.kind === "bin") {
9798
args.push(`--bin=${bin}`);
@@ -100,10 +101,12 @@ export class RustCodeLensProvider implements CodeLensProvider {
100101
args.push(`--example=${bin}`);
101102
}
102103

104+
args.push(`--manifest-path=${pkg.manifest_path}`);
105+
103106
return {
104107
type: "lldb",
105108
request: "launch",
106-
name: `Debug ${fn} in ${basename(uri)}`,
109+
name: `Debug ${fn} in ${basename(doc.fileName)}`,
107110
cargo: {
108111
args: args,
109112
filter: filter,

‎src/RustTests.ts

+25-10
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,51 @@
11
'use strict';
22
import { Metadata, Package } from "./cargo";
33
import { basename, dirname } from "path";
4+
import { WorkspaceFolder, workspace, Uri } from "vscode";
45

56
export interface Filter {
67
kind: undefined | string;
78
name: undefined | string;
89
}
910

1011
export class RustTests {
11-
private readonly testMap: Map<string, Package> = new Map<string, Package>();
12-
constructor(private metadata: Metadata) {
12+
13+
private readonly testMap: Map<WorkspaceFolder, Map<string, Package>> =
14+
new Map<WorkspaceFolder, Map<string, Package>>();
15+
16+
constructor(private metadata_map: Map<WorkspaceFolder, Metadata>) {
1317
// sort packages by manifest path length to match the longest path.
14-
metadata.packages.sort((a, b) => {
18+
metadata_map.forEach((metadata) => metadata.packages.sort((a, b) => {
1519
return b.manifest_path.length - a.manifest_path.length;
16-
});
20+
}));
1721
}
1822
/**
1923
* Get the package based on the function name.
2024
* @param fn function name
2125
*/
22-
getPackage(fn: string, uri: string): Package | undefined {
23-
let pkg = this.testMap.get(`${uri}::${fn}`);
26+
getPackage(fn: string, uri: Uri): Package | undefined {
27+
const cws = workspace.getWorkspaceFolder(uri);
28+
if (cws === undefined) {
29+
return undefined;
30+
}
31+
let pkg_map = this.testMap.get(cws);
32+
if (pkg_map === undefined) {
33+
pkg_map = new Map<string, Package>();
34+
this.testMap.set(cws, pkg_map);
35+
}
36+
const fsPath = uri.fsPath;
37+
let pkg = pkg_map.get(`${fsPath}::${fn}`);
2438
if (!pkg) {
25-
if (this.metadata) {
26-
for (pkg of this.metadata.packages) {
39+
const metadata = this.metadata_map.get(cws);
40+
if (metadata) {
41+
for (pkg of metadata.packages) {
2742
let pkg_dir = dirname(pkg.manifest_path);
28-
if (uri.startsWith(pkg_dir)) {
43+
if (fsPath.startsWith(pkg_dir)) {
2944
break;
3045
}
3146
}
3247
if (pkg) {
33-
this.testMap.set(`${uri}::${fn}`, pkg);
48+
pkg_map.set(`${uri}::${fn}`, pkg);
3449
}
3550
}
3651
}

‎src/cargo.ts

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
'use strict';
22
// Helper function and interfaces to work with cargo metadata.
3-
import { workspace } from "vscode";
3+
import { WorkspaceFolder } from "vscode";
44
import { spawn, SpawnOptions } from "child_process";
55

66
export interface Target {
@@ -27,35 +27,36 @@ export interface Metadata {
2727

2828
type StrSink = (data: string) => void;
2929

30-
export async function metadata(onStdErr?: StrSink,
30+
export async function metadata(cws?: WorkspaceFolder, onStdErr?: StrSink,
3131
retry = false): Promise<Metadata> {
3232
let meta = "";
3333
const cargoArgs = [
3434
"metadata",
3535
"--no-deps",
3636
"--format-version=1"];
37-
return runCargo(cargoArgs, data => meta += data, onStdErr)
37+
return runCargo(cws, cargoArgs, data => meta += data, onStdErr)
3838
.then(_ => JSON.parse(meta))
3939
.catch((reason) => {
4040
if (onStdErr) {
41-
onStdErr(`Couldn't get metadata: ${reason}.
42-
Cargo command run: cargo ${cargoArgs.join(' ')}
41+
onStdErr(`Couldn't get metadata: ${reason}.
42+
Cargo command run: cargo ${cargoArgs.join(' ')}
4343
Metadata read so far: ${meta}`);
4444
}
4545
if (retry) {
46-
return metadata(onStdErr);
46+
return metadata(cws, onStdErr);
4747
} else {
4848
return Promise.reject(reason);
4949
}
5050
});
5151
}
5252

53-
async function runCargo(args?: ReadonlyArray<string>, onStdOut?: StrSink,
54-
onStdErr?: StrSink): Promise<number> {
53+
async function runCargo(workspaceFolder?: WorkspaceFolder,
54+
args?: ReadonlyArray<string>, onStdOut?: StrSink,
55+
onStdErr?: StrSink): Promise<number> {
5556
return new Promise<number>((resolve, reject) => {
56-
const workspaceFolders = workspace.workspaceFolders;
57+
const cwd = workspaceFolder ? workspaceFolder.uri.fsPath : undefined;
5758
const options: SpawnOptions = {
58-
cwd: workspaceFolders ? workspaceFolders[0].uri.fsPath : undefined,
59+
cwd,
5960
stdio: ['ignore', 'pipe', 'pipe'],
6061
};
6162

‎src/extension.ts

+36-21
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,54 @@
22
import {
33
commands, EventEmitter, ExtensionContext, languages, window, debug,
44
OutputChannel,
5-
workspace
5+
workspace,
6+
WorkspaceFolder
67
} from 'vscode';
78
import { RustCodeLensProvider } from './RustCodeLensProvider';
89
import { RustTests } from './RustTests';
9-
import { metadata } from './cargo';
10+
import { metadata, Metadata } from './cargo';
11+
import * as fs from "fs";
12+
import * as path from "path";
1013

1114
const onDidChange: EventEmitter<void> = new EventEmitter<void>();
1215
export const outputChannel: OutputChannel =
1316
window.createOutputChannel('Rust Test Output');
1417

1518
// this method is called when your extension is activated
1619
// your extension is activated the very first time the command is executed
17-
export function activate(context: ExtensionContext) {
20+
export async function activate(context: ExtensionContext) {
1821
const config = workspace.getConfiguration("rust-test-lens");
1922
if (config.get("enabled", true)) {
20-
metadata(err => outputChannel.append(err), true)
21-
.then(meta => {
22-
const rustTests: RustTests = new RustTests(meta);
23-
const codeLensProvider = new RustCodeLensProvider(onDidChange,
24-
rustTests);
25-
context.subscriptions.push(languages.registerCodeLensProvider(
26-
{ scheme: 'file', language: 'rust' }, codeLensProvider));
27-
});
28-
29-
let disposable = commands.registerCommand('extension.debugTest',
30-
(debugConfig) => {
31-
const dbgConfigJson = JSON.stringify(debugConfig, null, 2);
32-
outputChannel.appendLine(`Debugging: ${dbgConfigJson}`);
33-
debug.startDebugging(undefined, debugConfig)
34-
.then((r) => console.log("Result", r));
35-
});
36-
37-
context.subscriptions.push(disposable);
23+
if (workspace.workspaceFolders) {
24+
const metaMap = new Map<WorkspaceFolder, Metadata>();
25+
for (const ws of workspace.workspaceFolders) {
26+
if (fs.existsSync(path.join(ws.uri.fsPath, "Cargo.toml"))) {
27+
let meta = await metadata(ws,
28+
err => outputChannel.append(err), true);
29+
metaMap.set(ws, meta);
30+
}
31+
}
32+
if (metaMap.size !== 0) {
33+
const rustTests: RustTests = new RustTests(metaMap);
34+
const codeLensProvider =
35+
new RustCodeLensProvider(onDidChange, rustTests);
36+
context.subscriptions.push(
37+
languages.registerCodeLensProvider(
38+
{ scheme: 'file', language: 'rust' },
39+
codeLensProvider));
40+
let disposable = commands.registerCommand('extension.debugTest',
41+
(debugConfig) => {
42+
const json = JSON.stringify(debugConfig, null, 2);
43+
outputChannel.appendLine(`Debugging: ${json}`);
44+
debug.startDebugging(undefined, debugConfig)
45+
.then((r) => console.log("Result", r));
46+
});
47+
context.subscriptions.push(disposable);
48+
}
49+
}
50+
else {
51+
outputChannel.append("Only workspaces with a `./Cargo.toml` file are supported.");
52+
}
3853
}
3954
}
4055

‎src/test/RustTests.test.ts

+23-8
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,17 @@ import * as assert from 'assert';
22

33
import { Metadata } from '../cargo';
44
import { RustTests } from '../RustTests';
5+
import { WorkspaceFolder, Uri } from 'vscode';
56

6-
suite("RustTests Tests", function () {
7-
7+
/// skipping tests
8+
/// have to migrate to vscode-test
9+
/// https://code.visualstudio.com/api/working-with-extensions/testing-extension#migrating-from-vscode
10+
suite.skip("RustTests Tests", function () {
11+
const workspaceFolder : WorkspaceFolder = {
12+
uri: Uri.file('./root_crate'),
13+
name: 'name',
14+
index: 0
15+
};
816
const metadata: Metadata = {
917
packages: [{
1018
name: "other_sub_crate",
@@ -38,28 +46,35 @@ suite("RustTests Tests", function () {
3846
};
3947

4048
test("getPackage root test", function () {
41-
let rustTests = new RustTests(metadata);
42-
let pkg = rustTests.getPackage("test_in_root", "./root_crate/test.rs");
49+
let map = new Map<WorkspaceFolder, Metadata>();
50+
map.set(workspaceFolder, metadata);
51+
let rustTests = new RustTests(map);
52+
let pkg = rustTests.getPackage("test_in_root",
53+
Uri.file("./root_crate/test.rs"));
4354
if (pkg === undefined) {
4455
assert.fail("A package should be found");
4556
} else {
4657
assert.equal("root_crate", pkg.name);
4758
}
4859
});
4960
test("getPackage sub_crate test", function () {
50-
let rustTests = new RustTests(metadata);
61+
let map = new Map<WorkspaceFolder, Metadata>();
62+
map.set(workspaceFolder, metadata);
63+
let rustTests = new RustTests(map);
5164
let pkg = rustTests.getPackage("test_in_sub_crate",
52-
"./root_crate/sub_crate/test.rs");
65+
Uri.file("./root_crate/sub_crate/test.rs"));
5366
if (pkg === undefined) {
5467
assert.fail("A package should be found");
5568
} else {
5669
assert.equal("sub_crate", pkg.name);
5770
}
5871
});
5972
test("getPackage other_sub_crate test", function () {
60-
let rustTests = new RustTests(metadata);
73+
let map = new Map<WorkspaceFolder, Metadata>();
74+
map.set(workspaceFolder, metadata);
75+
let rustTests = new RustTests(map);
6176
let pkg = rustTests.getPackage("test_in_other_sub_crate",
62-
"./root_crate/other_sub_crate/test.rs");
77+
Uri.file("./root_crate/other_sub_crate/test.rs"));
6378
if (pkg === undefined) {
6479
assert.fail("A package should be found");
6580
} else {

0 commit comments

Comments
 (0)