]> git.lizzy.rs Git - rust.git/commit
Initial Visual Studio Code unit tests
authorRyan Cumming <etaoins@gmail.com>
Wed, 26 Jun 2019 10:14:18 +0000 (20:14 +1000)
committerRyan Cumming <etaoins@gmail.com>
Wed, 26 Jun 2019 10:31:36 +0000 (20:31 +1000)
commitf82ceca0bd8de2a2b0b51c96c5c1678351a7a20a
tree89e70d9965f973615dc0dfe978db002d82bf7e25
parentafd18dbcb8147cb83de408b7da310ee187faf3df
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.
editors/code/.vscode/launch.json
editors/code/package.json
editors/code/src/commands/cargo_watch.ts
editors/code/src/test/fixtures/rust-diagnostics/clippy/trivially_copy_pass_by_ref.json [new file with mode: 0644]
editors/code/src/test/fixtures/rust-diagnostics/error/E0053.json [new file with mode: 0644]
editors/code/src/test/fixtures/rust-diagnostics/error/E0061.json [new file with mode: 0644]
editors/code/src/test/fixtures/rust-diagnostics/warning/unused_variables.json [new file with mode: 0644]
editors/code/src/test/index.ts [new file with mode: 0644]
editors/code/src/test/rust_diagnostics.test.ts [new file with mode: 0644]
editors/code/src/test/vscode_diagnostics.test.ts [new file with mode: 0644]
editors/code/src/utils/vscode_diagnostics.ts [new file with mode: 0644]