Skip to content

copilot-test-coverage.instructions.md

Latest commit

 

History

History
77 lines (58 loc) · 3.38 KB

copilot-test-coverage.instructions.md

File metadata and controls

77 lines (58 loc) · 3.38 KB
description Instructions for the Copilot coding agent when working on test-coverage issues.
applyTo test/unit-tests/**/*.ts,src/**/*.ts

Test Coverage Agent — Self-Audit Protocol

You are improving test coverage for microsoft/vscode-cmake-tools. This file contains mandatory protocol. Read all of it before writing code.

Step 1 — Orient before writing

  • Read every source file you will test in full
  • Read existing tests for that module (if any) in test/unit-tests/backend/
  • Identify every exported function, class, and branch condition
  • Do not write tests for private implementation details — test the public API
  • If a source file deeply depends on vscode APIs, skip it — note in the PR that it needs integration-test coverage

Step 2 — Write real tests, not stubs

Every test must:

  • Have a descriptive name: 'expandString handles undefined variable in preset context'
  • Assert exactly one logical behavior per test() block
  • Not depend on side effects from another test
  • Use assert.strictEqual / assert.deepStrictEqual over loose equality
  • For async code: await and assert the resolved value — never .then()

Step 3 — Run the full self-audit before opening the PR

# 1. Type-check test files
npx tsc -p test.tsconfig.json --noEmit

# 2. Lint
yarn lint

# 3. Run backend tests (this is the primary validation step)
yarn backendTests

# 4. Confirm coverage improved for the specific file
npx c8 --all --reporter=text --src=src \
  node ./node_modules/mocha/bin/_mocha \
    -u tdd --timeout 999999 --colors \
    -r ts-node/register \
    -r tsconfig-paths/register \
    "./test/unit-tests/backend/**/*.test.ts"

All steps must pass. If any fail, fix the failures before opening the PR.

Note: yarn unitTests requires a VS Code extension host and a display server. It cannot be run in headless agent environments. The CI workflow validates those separately — you only need to run yarn backendTests and yarn lint locally.

Step 4 — Coverage bar

Do not open the PR unless every file listed in the issue has either:

  • improved by ≥ 10 percentage points from the baseline in the issue, OR
  • reached ≥ 60% line coverage

Test quality rules specific to this repo

Rule Why
Test both useCMakePresets branches where the source branches on it Most bugs affect only one mode
Test both single-config and multi-config generator paths where relevant CMAKE_BUILD_TYPE vs --config are frequent bug sources
For src/expand.ts changes: test every macro type copilot-instructions.md explicitly mandates this
For src/diagnostics/: test each compiler family's parser diagnostics.test.ts is the largest test file — keep it comprehensive
Use @cmt/ path alias for imports from src/ Never use relative paths from outside src/
Never use console.log in test files Use the module logger or plain assert

PR requirements

  • Branch name: coverage/<module-name>-tests
  • Open as ready for review only after the self-audit checklist in the issue is fully checked
  • PR description must use the coverage template: copy the contents of .github/PULL_REQUEST_TEMPLATE/coverage.md into the PR body (or append ?template=coverage.md to the PR creation URL). Fill in the coverage-delta table and check every self-audit box.
  • CHANGELOG.md must have one entry under Improvements: