integration-tests

Running Integration Tests

Integration tests in VS Code are split into two categories:

1. Node.js integration tests - files ending in .integrationTest.ts under src/. These run in Electron via the same Mocha runner as unit tests.
2. Extension host tests - tests embedded in built-in extensions under extensions/ (API tests, Git tests, TypeScript tests, etc.). These launch a full VS Code instance with --extensionDevelopmentPath.

Scripts

• macOS / Linux: ./scripts/test-integration.sh [options]
• Windows: .\scripts\test-integration.bat [options]

When run without filters, both scripts execute all node.js integration tests followed by all extension host tests. They do not run the deterministic Agent Host E2E suites: those run with ./scripts/test-agent-host-e2e.sh (or .\scripts\test-agent-host-e2e.bat, or pnpm run test-agent-host-e2e), which runs each suite in its own isolated test process, in parallel. GitHub CI runs them in parallel with the integration tests, in the separate Linux / Agent-Host-E2E job on Linux and the Windows / Agent-Host-E2E (shard 1/3) through Windows / Agent-Host-E2E (shard 3/3) jobs on Windows, and as a separate step before 🧪 Run integration tests (Electron) on macOS; ADO runs them as the integration-agent-host-e2e test ID in a separate Agent Host E2E Tests (Electron) job, not in the Integration Tests (Electron) job (integration-electron). See src/vs/platform/agentHost/test/node/e2e/README.md. --run still accepts a single Agent Host E2E file.

When run with --run or --runGlob (without --suite), only the node.js integration tests are run and the filter is applied. Extension host tests are skipped since these filters are node.js-specific.

When run with --grep alone (no --run, --runGlob, or --suite), all tests are run -- both node.js integration tests and all extension host suites -- with the grep pattern forwarded to every test runner.

When run with --suite, only the matching extension host test suites are run. Node.js integration tests are skipped. Combine --suite with --grep to filter individual tests within the selected suites.

Options

--build - Run against build output

Selects the out-build/ directory instead of out/ for node.js integration tests and the shared VS Code modules used by the standalone JSON suite. This does not compile either output tree; the JSON extension tests still require compile-extension:json-language-features-client to generate client/out/.

./scripts/test-integration.sh --suite json --build

--run <file> - Run tests from a specific file

Accepts a source file path (starting with src/). Works identically to scripts/test.sh --run.

./scripts/test-integration.sh --run src/vs/workbench/services/search/test/node/search.integrationTest.ts

--runGlob <pattern> (aliases: --glob, --runGrep) - Select test files by path

Selects which test files to load by matching compiled .js file paths against a glob pattern. Overrides the default **/*.integrationTest.js glob. Only applies to node.js integration tests (extension host tests are skipped).

./scripts/test-integration.sh --runGlob "**/search/**/*.integrationTest.js"

--grep <pattern> (aliases: -g, -f) - Filter test cases by name

Filters which test cases run by matching against their test titles (e.g. describe/test names). When used alone, the grep is applied to both node.js integration tests and all extension host suites. When combined with --suite, only the matched suites run with the grep.

./scripts/test-integration.sh --grep "TextSearchProvider"

--suite <pattern> - Run specific extension host test suites

Runs only the extension host test suites whose name matches the pattern. Supports comma-separated values and shell glob patterns (on macOS/Linux). Node.js integration tests are skipped.

Available suite names: api-folder, api-workspace, colorize, terminal-suggest, typescript, markdown, emmet, git, git-base, ipynb, notebook-renderers, configuration-editing, github-authentication, copilot, css, html, json.

The css, html, and json suites are standalone extension tests that run in Electron's Node.js mode without opening a workbench. They share the same suite selection and grep filtering as extension host tests.

# Run only Git extension tests
./scripts/test-integration.sh --suite git

# Run API folder and workspace tests (glob, macOS/Linux only)
./scripts/test-integration.sh --suite 'api*'

# Run multiple specific suites
./scripts/test-integration.sh --suite 'git,emmet,typescript'

# Filter tests within a suite by name
./scripts/test-integration.sh --suite api-folder --grep 'should open'

--only-node-tests, --only-extension-host-tests - Run one part

Runs only the node.js integration tests, or only the extension host tests (all suites, including css, html and json). --grep still applies to both. --only-node-tests cannot be combined with --suite, and --only-extension-host-tests cannot be combined with --run or --runGlob.

GitHub pull request CI runs the two parts as separate steps. 🧪 Run integration tests (Electron) runs the node.js integration tests and reruns failed tests (--rerun-failed-files 2). 🧪 Run extension host integration tests (Electron) runs the extension host suites, which are not rerun; it also runs after the integration tests or Agent Host E2E failed. The Azure Pipelines product build runs both parts in one step with --rerun-failed-files 2, which only reruns the failed node.js integration tests.

./scripts/test-integration.sh --only-node-tests --rerun-failed-files 2
./scripts/test-integration.sh --only-extension-host-tests

INTEGRATION_TEST_PARALLEL=<lanes> - Run extension host suites in parallel

Most of an extension host suite is starting VS Code, so with this environment variable, scripts/test-integration.sh and scripts/test-remote-integration.sh (macOS/Linux) run up to <lanes> suites at the same time, the longest first, each with its own user data and logs folders. Unless VSCODE_SKIP_PRELAUNCH is set, Electron, the compiled sources and the built-in extensions are prepared once before the suites start, instead of at each launch. Each suite's output is printed when it finishes, and the run fails at the end when any suite failed. Without it, the suites run one after another and the first failure stops the run. The Linux and macOS PR jobs set it to 2 (see scripts/integration-test-suites.sh). The API tests wait a fixed time for tools to register and for browser pages to respond, and another instance competing for the CPU delays them past that time, so they run first, with no other suite at the same time (run_group_alone api).

INTEGRATION_TEST_PARALLEL=2 ./scripts/test-integration.sh --only-extension-host-tests

--help, -h - Show help

./scripts/test-integration.sh --help

Other options

All other options (e.g. --timeout, --coverage, --reporter) are forwarded to the underlying scripts/test.sh runner for node.js integration tests. These extra options are not forwarded to extension host suites when using --suite.

Examples

# Run all integration tests (node.js + extension host)
./scripts/test-integration.sh

# Run a single integration test file
./scripts/test-integration.sh --run src/vs/workbench/services/search/test/node/search.integrationTest.ts

# Run integration tests matching a grep pattern
./scripts/test-integration.sh --grep "TextSearchProvider"

# Run integration tests under a specific area
./scripts/test-integration.sh --runGlob "**/workbench/**/*.integrationTest.js"

# Run only Git extension host tests
./scripts/test-integration.sh --suite git

# Run API folder + workspace extension tests (glob)
./scripts/test-integration.sh --suite 'api*'

# Run multiple extension test suites
./scripts/test-integration.sh --suite 'git,typescript,emmet'

# Grep for specific tests in the API folder suite
./scripts/test-integration.sh --suite api-folder --grep 'should open'

# Combine file and grep
./scripts/test-integration.sh --run src/vs/workbench/services/search/test/node/search.integrationTest.ts --grep "should search"

Compilation requirement

Tests run against compiled JavaScript output. Ensure the VS Code - Build watch task is running or that compilation has completed before running tests.

Distinction from unit tests

• Unit tests (.test.ts) → use scripts/test.sh or the runTests tool
• Integration tests (.integrationTest.ts and extension tests) → use scripts/test-integration.sh

Do not mix these up: scripts/test.sh will not find integration test files unless you explicitly pass --runGlob **/*.integrationTest.js, and scripts/test-integration.sh is not intended for .test.ts files.