Initial Visual Studio Code unit tests

As promised in #1439 this is an initial attempt at unit testing the
VSCode extension. There are two separate parts to this: getting the test
framework working and unit testing the code in #1439.

The test framework nearly intact from the VSCode extension generator.
The main thing missing was `test/index.ts` which acts as an entry point
for Mocha. This was simply copied back in. I also needed to open the
test VSCode instance inside a workspace as our file URI generation
depends on a workspace being open.

There are two ways to run the test framework:

1. Opening the extension's source in VSCode, pressing F5 and selecting
   the "Extensions Test" debug target.

2. Closing all copies of VSCode and running `npm test`. This is started
   from the command line but actually opens a temporary VSCode window to
   host the tests.

This doesn't attempt to wire this up to CI. That requires running a
headless X11 server which is a bit daunting. I'll assess the difficulty
of that in a follow-up branch. This PR is at least helpful for local
development without having to induce errors on a Rust project.

For the actual tests this uses snapshots of `rustc` output from a real
Rust project captured from the command line. Except for extracting the
`message` object and reformatting they're copied verbatim into fixture
JSON files.

Only four different types of diagnostics are tested but they represent
the main combinations of code actions and related information possible.
They can be considered the happy path tests; as we encounter
corner-cases we can introduce new tests fixtures.
This commit is contained in:
Ryan Cumming 2019-06-26 20:14:18 +10:00
parent afd18dbcb8
commit f82ceca0bd
11 changed files with 765 additions and 61 deletions

View file

@ -2,12 +2,17 @@ import * as child_process from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import * as vscode from 'vscode';
import { Server } from '../server';
import { terminate } from '../utils/processes';
import {
mapRustDiagnosticToVsCode,
RustDiagnostic
} from '../utils/rust_diagnostics';
import {
areCodeActionsEqual,
areDiagnosticsEqual
} from '../utils/vscode_diagnostics';
import { LineBuffer } from './line_buffer';
import { StatusDisplay } from './watch_status';
@ -184,67 +189,6 @@ export class CargoWatchProvider
this.statusDisplay.hide();
}
function areDiagnosticsEqual(
left: vscode.Diagnostic,
right: vscode.Diagnostic
): boolean {
return (
left.source === right.source &&
left.severity === right.severity &&
left.range.isEqual(right.range) &&
left.message === right.message
);
}
function areCodeActionsEqual(
left: vscode.CodeAction,
right: vscode.CodeAction
): boolean {
if (
left.kind !== right.kind ||
left.title !== right.title ||
!left.edit ||
!right.edit
) {
return false;
}
const leftEditEntries = left.edit.entries();
const rightEditEntries = right.edit.entries();
if (leftEditEntries.length !== rightEditEntries.length) {
return false;
}
for (let i = 0; i < leftEditEntries.length; i++) {
const [leftUri, leftEdits] = leftEditEntries[i];
const [rightUri, rightEdits] = rightEditEntries[i];
if (leftUri.toString() !== rightUri.toString()) {
return false;
}
if (leftEdits.length !== rightEdits.length) {
return false;
}
for (let j = 0; j < leftEdits.length; j++) {
const leftEdit = leftEdits[j];
const rightEdit = rightEdits[j];
if (!leftEdit.range.isEqual(rightEdit.range)) {
return false;
}
if (leftEdit.newText !== rightEdit.newText) {
return false;
}
}
}
return true;
}
interface CargoArtifact {
reason: string;
package_id: string;