Skip to content

Commit 992d8dd

Browse files
Update MRVA tests in test-plan.md
1 parent ab9dd6a commit 992d8dd

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/test-plan.md

Lines changed: 16 additions & 12 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
### Test Case 1: MRVA - Running a problem path query and viewing results
2222

23-
1. Open the [UnsafeJQueryPlugin query](https://github.com/github/codeql/blob/main/javascript/ql/src/Security/CWE-079/UnsafeJQueryPlugin.ql).
23+
1. Open the [javascript UnsafeJQueryPlugin query](https://github.com/github/codeql/blob/main/javascript/ql/src/Security/CWE-079/UnsafeJQueryPlugin.ql).
2424
2. Run a MRVA against the following repo list:
2525

2626
```json
@@ -49,35 +49,39 @@ choose to go through some of the Optional Test Cases.
4949

5050
### Test Case 2: MRVA - Running a problem query and viewing results
5151

52-
1. Open the [ReDoS query](https://github.com/github/codeql/blob/main/javascript/ql/src/Performance/ReDoS.ql).
52+
1. Open the [javascript ReDoS query](https://github.com/github/codeql/blob/main/javascript/ql/src/Performance/ReDoS.ql).
5353
2. Run a MRVA against the "Top 10" repositories.
54-
3. Check that there is a notification message.
54+
3. Check that a notification message pops up and the results view is opened.
5555
4. Check the query history. It should:
5656
- Show that an item has been added to the query history
5757
- The item should be marked as "in progress".
58-
5. Once the query starts:
59-
- Check that a notification is shown with a link to the results view
58+
5. Once the query completes:
6059
- Check that the results are rendered with an alert message and a highlighted code snippet:
61-
![highlighted-code-snippet](images/highlighted-code-snippet.png)
60+
61+
![highlighted-code-snippet](images/highlighted-code-snippet.png)
6262

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

65-
1. Open the [FunLinesOfCode query](https://github.com/github/codeql/blob/main/cpp/ql/src/Metrics/Functions/FunLinesOfCode.ql).
65+
1. Open the [cpp FunLinesOfCode query](https://github.com/github/codeql/blob/main/cpp/ql/src/Metrics/Functions/FunLinesOfCode.ql).
6666
2. Run a MRVA against a single repository (e.g. `google/brotli`).
67-
3. Once the query starts:
68-
- Open the query results
67+
3. Check that a notification message pops up and the results view is opened.
68+
4. Check the query history. It should:
69+
- Show that an item has been added to the query history
70+
- The item should be marked as "in progress".
71+
5. Once the query completes:
6972
- Check that the results show up in a table:
70-
![results-table](images/results-table.png)
73+
74+
![results-table](images/results-table.png)
7175

7276
### Test Case 4: MRVA - Interacting with query history
7377

7478
1. Click a history item (for MRVA):
7579
- Check that exporting results works
7680
- Check that sorting results works
7781
- Check that copying repo lists works
78-
2. Open the query results directory:
82+
2. Click "Open Results Directory":
7983
- Check that the correct directory is opened and there are results in it
80-
3. View logs
84+
3. Click "View Logs":
8185
- Check that the correct workflow is opened
8286

8387
### Test Case 5: MRVA - Canceling a variant analysis run

0 commit comments

Comments
 (0)