diff options
author | Ryan Cumming <[email protected]> | 2019-06-26 11:14:18 +0100 |
---|---|---|
committer | Ryan Cumming <[email protected]> | 2019-06-26 11:31:36 +0100 |
commit | f82ceca0bd8de2a2b0b51c96c5c1678351a7a20a (patch) | |
tree | 89e70d9965f973615dc0dfe978db002d82bf7e25 /editors/code/src/test/index.ts | |
parent | afd18dbcb8147cb83de408b7da310ee187faf3df (diff) |
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.
Diffstat (limited to 'editors/code/src/test/index.ts')
-rw-r--r-- | editors/code/src/test/index.ts | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/editors/code/src/test/index.ts b/editors/code/src/test/index.ts new file mode 100644 index 000000000..6e565c254 --- /dev/null +++ b/editors/code/src/test/index.ts | |||
@@ -0,0 +1,22 @@ | |||
1 | // | ||
2 | // PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING | ||
3 | // | ||
4 | // This file is providing the test runner to use when running extension tests. | ||
5 | // By default the test runner in use is Mocha based. | ||
6 | // | ||
7 | // You can provide your own test runner if you want to override it by exporting | ||
8 | // a function run(testRoot: string, clb: (error:Error) => void) that the extension | ||
9 | // host can call to run the tests. The test runner is expected to use console.log | ||
10 | // to report the results back to the caller. When the tests are finished, return | ||
11 | // a possible error to the callback or null if none. | ||
12 | |||
13 | import * as testRunner from 'vscode/lib/testrunner'; | ||
14 | |||
15 | // You can directly control Mocha options by uncommenting the following lines | ||
16 | // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info | ||
17 | testRunner.configure({ | ||
18 | ui: 'bdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.) | ||
19 | useColors: true // colored output from test results | ||
20 | }); | ||
21 | |||
22 | module.exports = testRunner; | ||