Skip to content

Commit 5edbb1e

Browse files
Categorise test cases as mrva / local / general
1 parent bcd5818 commit 5edbb1e

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/test-plan.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ choose to go through some of the Optional Test Cases.
1818

1919
## Required Test Cases
2020

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

2325
1. Open the [javascript UnsafeJQueryPlugin query](https://github.com/github/codeql/blob/main/javascript/ql/src/Security/CWE-079/UnsafeJQueryPlugin.ql).
2426
2. Run a MRVA against the following repo list:
@@ -47,7 +49,7 @@ choose to go through some of the Optional Test Cases.
4749
6. Once the query completes:
4850
- Check that the query history item is updated to show the query status as "complete"
4951

50-
### Test Case 2: MRVA - Running a problem query and viewing results
52+
#### Test Case 2: Running a problem query and viewing results
5153

5254
1. Open the [javascript ReDoS query](https://github.com/github/codeql/blob/main/javascript/ql/src/Performance/ReDoS.ql).
5355
2. Run a MRVA against the "Top 10" repositories.
@@ -60,7 +62,7 @@ choose to go through some of the Optional Test Cases.
6062

6163
![highlighted-code-snippet](images/highlighted-code-snippet.png)
6264

63-
### Test Case 3: MRVA - Running a non-problem query and viewing results
65+
#### Test Case 3: Running a non-problem query and viewing results
6466

6567
1. Open the [cpp FunLinesOfCode query](https://github.com/github/codeql/blob/main/cpp/ql/src/Metrics/Functions/FunLinesOfCode.ql).
6668
2. Run a MRVA against a single repository (e.g. `google/brotli`).
@@ -73,7 +75,7 @@ choose to go through some of the Optional Test Cases.
7375

7476
![results-table](images/results-table.png)
7577

76-
### Test Case 4: MRVA - Interacting with query history
78+
#### Test Case 4: Interacting with query history
7779

7880
1. Click a history item (for MRVA):
7981
- Check that exporting results works
@@ -84,17 +86,19 @@ choose to go through some of the Optional Test Cases.
8486
3. Click "View Logs":
8587
- Check that the correct workflow is opened
8688

87-
### Test Case 5: MRVA - Canceling a variant analysis run
89+
#### Test Case 5: Canceling a variant analysis run
8890

8991
Run one of the above MRVAs, but cancel it from within VS Code:
9092

9193
- Check that the query is canceled and the query history item is updated.
9294
- Check that the workflow run is also canceled.
9395
- Check that any available results are visible in VS Code.
9496

95-
### Test Case 6: MRVA - Change to a different colour theme
97+
### General
98+
99+
#### Test case 1: Change to a different colour theme
96100

97-
Open one of the above MRVAs, try changing to a different colour theme and check that everything looks sensible.
101+
Open at least one of the above MRVAs and at least one local query, then try changing to a different colour theme and check that everything looks sensible.
98102
Are there any components that are not showing up?
99103

100104
## Optional Test Cases

0 commit comments

Comments
 (0)