mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Improve docs around different test suites (#1959)

Browse Source
This commit is contained in:
Charis Kyriakou
2023-01-12 15:15:24 +00:00
committed by GitHub
parent 8b661c7a6d
commit 09c60ecfc8
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -95,10 +95,13 @@ More information about Storybook can be found inside the **Overview** page once
We have several types of tests: We have several types of tests:
* Unit tests: these live in the `tests/pure-tests/` directory * Unit tests: these live in the `tests/unit-tests/` directory
* View tests: these live in `src/view/variant-analysis/__tests__/` * View tests: these live in `src/view/variant-analysis/__tests__/`
* VSCode integration tests: these live in `test/vscode-tests/no-workspace` and `test/vscode-tests/minimal-workspace` * VSCode integration tests:
* `test/vscode-tests/no-workspace` tests: These are intended to cover functionality that is meant to work before you even have a workspace open.
* `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.
* CLI integration tests: these live in `test/vscode-tests/cli-integration` * CLI integration tests: these live in `test/vscode-tests/cli-integration`
* These tests are intendended to be cover functionality that is related to the integration between the CodeQL CLI and the extension.
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. 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.