Skip to content

Commit 812205c

Browse files
committed
Clarify that test cases are for MRVA
1 parent a839206 commit 812205c

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

extensions/ql-vscode/docs/test-plan.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ choose to go through some of the Optional Test Cases.
2020

2121
- Flip the `codeQL.canary` flag. This will enable MRVA in the extension.
2222

23-
### Test Case 1: Running a problem path query and viewing results
23+
### Test Case 1: MRVA - Running a problem path query and viewing results
2424

2525
1. Open the [UnsafeJQueryPlugin query](https://github.com/github/codeql/blob/main/javascript/ql/src/Security/CWE-079/UnsafeJQueryPlugin.ql).
2626
2. Run it against the following repo list:
@@ -44,7 +44,7 @@ choose to go through some of the Optional Test Cases.
4444
- Check that the repository filter box works
4545
- Click links to files/locations on GitHub.
4646

47-
### Test Case 2: Running a problem query and viewing results
47+
### Test Case 2: MRVA - Running a problem query and viewing results
4848

4949
1. Open the [ReDoS query](https://github.com/github/codeql/blob/main/javascript/ql/src/Performance/ReDoS.ql).
5050
2. Run it against the "Top 10" repositories.
@@ -59,7 +59,7 @@ choose to go through some of the Optional Test Cases.
5959
- Check that the results are rendered with an alert message and a highlighted code snippet:
6060
![highlighted-code-snippet](images/highlighted-code-snippet.png)
6161

62-
### Test Case 3: Running a non-problem query and viewing results
62+
### Test Case 3: MRVA - Running a non-problem query and viewing results
6363

6464
1. Open the [FunLinesOfCode query](https://github.com/github/codeql/blob/main/cpp/ql/src/Metrics/Functions/FunLinesOfCode.ql).
6565
2. Run it against a single repository (e.g. `google/brotli`).
@@ -68,7 +68,7 @@ choose to go through some of the Optional Test Cases.
6868
- Check that the results show up in a table:
6969
![results-table](images/results-table.png)
7070

71-
### Test Case 4: Interacting with query history
71+
### Test Case 4: MRVA - Interacting with query history
7272

7373
1. Click a history item (for MRVA):
7474
- Check that exporting results works
@@ -79,14 +79,14 @@ choose to go through some of the Optional Test Cases.
7979
3. Open variant analysis on GitHub
8080
- Check that the correct workflow is opened
8181

82-
### Test Case 5: Cancelling a variant analysis run
82+
### Test Case 5: MRVA - Cancelling a variant analysis run
8383

8484
When running one of the above queries, try cancelling one from within VS Code:
8585
- Check that the query is cancelled and the query history item is updated.
8686
- Check that the workflow run is also cancelled.
8787
- Check that any available results are visible in VS Code.
8888

89-
### Test Case 6: Change to a different colour theme
89+
### Test Case 6: MRVA - Change to a different colour theme
9090

9191
When running one of the above queries, try changing to a different colour theme
9292
and check that everything looks sensible. Are there any components that are not showing up?

0 commit comments

Comments
 (0)