@vscode/test-electron

What is @vscode/test-electron?

@vscode/test-electron is a package designed to help developers test their Visual Studio Code extensions in an Electron environment. It provides tools to run and debug extensions, ensuring they work correctly within the VS Code editor.

What are @vscode/test-electron's main functionalities?

Running Extension Tests

This feature allows developers to run tests for their VS Code extensions. The code sample demonstrates how to set up and execute tests using the `runTests` function, specifying paths to the extension and the test suite.

const { runTests } = require('@vscode/test-electron');

async function main() {
  try {
    const extensionDevelopmentPath = path.resolve(__dirname, '../my-extension');
    const extensionTestsPath = path.resolve(__dirname, './suite/index');

    await runTests({
      extensionDevelopmentPath,
      extensionTestsPath
    });
  } catch (err) {
    console.error('Failed to run tests');
    process.exit(1);
  }
}

main();

Debugging Extensions

This feature provides the ability to debug extensions by downloading a specific version of VS Code and running tests with debugging options. The code sample shows how to download VS Code, resolve the CLI path, and run tests with additional launch arguments for debugging.

const { downloadAndUnzipVSCode, resolveCliPathFromVSCodeExecutablePath, runTests } = require('@vscode/test-electron');

async function main() {
  const vscodeExecutablePath = await downloadAndUnzipVSCode('stable');
  const cliPath = resolveCliPathFromVSCodeExecutablePath(vscodeExecutablePath);

  // Run tests with additional debugging options
  await runTests({
    vscodeExecutablePath,
    extensionDevelopmentPath: path.resolve(__dirname, '../my-extension'),
    extensionTestsPath: path.resolve(__dirname, './suite/index'),
    launchArgs: ['--disable-extensions']
  });
}

main();

Other packages similar to @vscode/test-electron

vscode-test

vscode-test is another package for testing VS Code extensions. It offers similar functionalities to @vscode/test-electron, such as running and debugging extension tests. However, @vscode/test-electron is more focused on Electron environments, providing more specific tools for testing within the Electron-based VS Code.

vscode-extension-tester

vscode-extension-tester is a framework for testing VS Code extensions using Selenium WebDriver. It provides a different approach compared to @vscode/test-electron by focusing on UI testing and automation, whereas @vscode/test-electron is more about running and debugging tests in an Electron environment.

README

vscode-test

This module helps you test VS Code extensions. Note that new extensions may want to use the VS Code Test CLI, which leverages this module, for a richer editing and execution experience.

Supported:

• Node >= 16.x
• Windows >= Windows Server 2012+ / Win10+ (anything with Powershell >= 5.0)
• macOS
• Linux

Usage

See ./sample for a runnable sample, with Azure DevOps Pipelines and Github ACtions configuration.

import { runTests, runVSCodeCommand, downloadAndUnzipVSCode } from '@vscode/test-electron';

async function go() {
	try {
		const extensionDevelopmentPath = path.resolve(__dirname, '../../../');
		const extensionTestsPath = path.resolve(__dirname, './suite');

		/**
		 * Basic usage
		 */
		await runTests({
			extensionDevelopmentPath,
			extensionTestsPath,
		});

		const extensionTestsPath2 = path.resolve(__dirname, './suite2');
		const testWorkspace = path.resolve(__dirname, '../../../test-fixtures/fixture1');

		/**
		 * Running another test suite on a specific workspace
		 */
		await runTests({
			extensionDevelopmentPath,
			extensionTestsPath: extensionTestsPath2,
			launchArgs: [testWorkspace],
		});

		/**
		 * Use 1.36.1 release for testing
		 */
		await runTests({
			version: '1.36.1',
			extensionDevelopmentPath,
			extensionTestsPath,
			launchArgs: [testWorkspace],
		});

		/**
		 * Use Insiders release for testing
		 */
		await runTests({
			version: 'insiders',
			extensionDevelopmentPath,
			extensionTestsPath,
			launchArgs: [testWorkspace],
		});

		/**
		 * Noop, since 1.36.1 already downloaded to .vscode-test/vscode-1.36.1
		 */
		await downloadAndUnzipVSCode('1.36.1');

		/**
		 * Manually download VS Code 1.35.0 release for testing.
		 */
		const vscodeExecutablePath = await downloadAndUnzipVSCode('1.35.0');
		await runTests({
			vscodeExecutablePath,
			extensionDevelopmentPath,
			extensionTestsPath,
			launchArgs: [testWorkspace],
		});

		/**
		 * Install Python extension
		 */
		await runVSCodeCommand(['--install-extension', 'ms-python.python'], { version: '1.35.0' });

		/**
		 * - Add additional launch flags for VS Code
		 * - Pass custom environment variables to test runner
		 */
		await runTests({
			vscodeExecutablePath,
			extensionDevelopmentPath,
			extensionTestsPath,
			launchArgs: [
				testWorkspace,
				// This disables all extensions except the one being tested
				'--disable-extensions',
			],
			// Custom environment variables for extension test script
			extensionTestsEnv: { foo: 'bar' },
		});

		/**
		 * Use win64 instead of win32 for testing Windows
		 */
		if (process.platform === 'win32') {
			await runTests({
				extensionDevelopmentPath,
				extensionTestsPath,
				version: '1.40.0',
				platform: 'win32-x64-archive',
			});
		}
	} catch (err) {
		console.error('Failed to run tests');
		process.exit(1);
	}
}

go();

Development

• yarn install
• Make necessary changes in lib
• yarn compile (or yarn watch)
• In sample, run yarn install, yarn compile and yarn test to make sure integration test can run successfully

License

MIT

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Changelog

2.4.1 | 2024-07-05

• Throw a typed TestRunFailedError on failure instead of a string.