Skip to content

Commit 09c60ec

Browse files
authored
Improve docs around different test suites (#1959)
1 parent 8b661c7 commit 09c60ec

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,13 @@ More information about Storybook can be found inside the **Overview** page once
9595

9696
We have several types of tests:
9797

98-
* Unit tests: these live in the `tests/pure-tests/` directory
98+
* Unit tests: these live in the `tests/unit-tests/` directory
9999
* View tests: these live in `src/view/variant-analysis/__tests__/`
100-
* VSCode integration tests: these live in `test/vscode-tests/no-workspace` and `test/vscode-tests/minimal-workspace`
100+
* VSCode integration tests:
101+
* `test/vscode-tests/no-workspace` tests: These are intended to cover functionality that is meant to work before you even have a workspace open.
102+
* `test/vscode-tests/minimal-workspace` tests: These are intended to cover functionality that need a workspace but don't require the full extension to be activated.
101103
* CLI integration tests: these live in `test/vscode-tests/cli-integration`
104+
* These tests are intendended to be cover functionality that is related to the integration between the CodeQL CLI and the extension.
102105

103106
The CLI integration tests require an instance of the CodeQL CLI to run so they will require some extra setup steps. When adding new tests to our test suite, please be mindful of whether they need to be in the cli-integration folder. If the tests don't depend on the CLI, they are better suited to being a VSCode integration test.
104107

0 commit comments

Comments
 (0)