Skip to content

Commit 8c5704d

Browse files
committed
docs: clarify Layer 2 after/ directory validation behavior
Address review comment: distinguish file-based tests (which diff before/ to after/) from monitoring-based tests (which generally do not diff after/ contents).
1 parent a4b786e commit 8c5704d

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/public.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,10 +255,11 @@ dependencies:
255255

256256
## Further Reading
257257

258-
- [Tools Reference](./ql-mcp/tools.md) — Complete list of MCP tools
259-
- [Prompts Reference](./ql-mcp/prompts.md) — MCP prompts for CodeQL development workflows
260-
- [Resources Reference](./ql-mcp/resources.md) — MCP resources for CodeQL learning and reference
261258
- [Getting Started (developer)](./getting-started.md) — Building from source and advanced configuration
259+
- [Testing Reference](./testing.md) — Overview of this repo's release testing strategy
260+
- [MCP Tools Reference](./ql-mcp/tools.md) — Complete list of MCP tools
261+
- [MCP Prompts Reference](./ql-mcp/prompts.md) — MCP prompts for CodeQL development workflows
262+
- [MCP Resources Reference](./ql-mcp/resources.md) — MCP resources for CodeQL learning and reference
262263
- [VS Code MCP Server Documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) — Configuring MCP servers in VS Code
263264
- [Publishing and Using CodeQL Packs](https://docs.github.com/en/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs) — Managing CodeQL packs with the CodeQL CLI
264265
- [Model Context Protocol](https://modelcontextprotocol.io/) — The MCP specification

docs/testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Unit tests verify the TypeScript implementation of the MCP server.
2626
Integration tests exercise individual MCP tools against a live server instance using the custom MCP client.
2727

2828
- **Client**: `client/src/ql-mcp-client.js` — starts the MCP server, invokes tools, and validates results.
29-
- **Test data**: `client/integration-tests/primitives/tools/` — each test has `before/` and `after/` directories capturing expected state.
29+
- **Test data**: `client/integration-tests/primitives/tools/` — each test has `before/` and `after/` directories that define the initial fixture state and, for file-based tests, the expected final state.
3030
- **Run command**: `npm run test:integration:default -w client` (or `npm run test:client` from the repo root).
3131
- **Key properties**:
3232
- Tests are deterministic and repeatable.
3333
- No mocks — tests use real CodeQL databases and queries bundled under `server/ql/`.
34-
- The `before/monitoring-state.json` file supplies tool arguments; the `after/` directory captures expected output files.
34+
- The `before/monitoring-state.json` file supplies tool arguments. For file-based tests, the integration-test runner diffs filesystem state from `before/` to `after/`; for monitoring-based tests, `after/` artifacts are generally not diffed and are only interpreted for specific validations (for example, `codeql_query_run` interpreted output).
3535

3636
## Layer 3 — Agentic Validation
3737

0 commit comments

Comments
 (0)