Skip to content

Commit ce57329

Browse files
committed
Clarify test plan
1 parent c6494d6 commit ce57329

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/test-plan.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Run one of the above MRVAs, but cancel it from within VS Code:
151151

152152
1. Create a model pack with mock data
153153
1. Make sure you have `"codeQL.runningQueries.useExtensionPacks": "all"` enabled in the VSCode settings.
154-
1. Create a new directory `test-model-pack` anywhere in the workspace.
154+
1. Create a new directory `test-model-pack` anywhere in the CodeQL Workspace. (If you have a `github/codeql` checkout open in VS Code, you can create the directory under the `shared` directory, which is already included in the `codeql-workspace.yml` file.)
155155
1. Create a `qlpack.yml` file in that directory with the following contents:
156156

157157
```yaml
@@ -195,7 +195,9 @@ Run one of the above MRVAs, but cancel it from within VS Code:
195195
#### Test Case 1: Opening the model editor
196196

197197
1. Download the `sofastack/sofa-jraft` java database from GitHub.
198-
2. Open the Model Editor with the "CodeQL: Open CodeQL Model Editor" command from the command palette.
198+
1. Select the database in the CodeQL extension.
199+
1. Select "Add Database Source to Workspace" from the context menu of the database. This step is needed for the Model Editor to display the "Open source" link.
200+
1. Open the Model Editor with the "CodeQL: Open CodeQL Model Editor" command from the command palette.
199201
- Check that the editor loads and shows methods to model.
200202
- Check that methods are grouped per library (e.g. `rocksdbjni@7.7.3` or `asm@6.0`)
201203
- Check that the "Open source" link works (if you have the database source).

0 commit comments

Comments
 (0)