GitXplorerGitXplorer
m

vscode-test

public
249 stars
60 forks
18 issues

Commits

List of commits on branch main.
Verified
61b49aa9ae258bda2ccb0952e0f5527a61b4c489

chore(deps): bump nanoid from 3.3.7 to 3.3.8 (#296)

ddependabot[bot] committed a month ago
Verified
4d0a13470bde1b5a3c36c96853b87162642cd699

fix: vscode-test requires an internet connection (#295)

cconnor4312 committed a month ago
Verified
b36c86295f4a8eeac139fd064ba8dca12324024c

chore: bump dependencies (#293)

rrzhao271 committed 2 months ago
Verified
7782381327b61271036c9bfd09be98b39e11c734

chore(deps): bump micromatch from 4.0.7 to 4.0.8 (#284)

ddependabot[bot] committed 2 months ago
Verified
b70840e352a99214093a1628931ce82cbc2f482a

chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /sample (#292)

ddependabot[bot] committed 2 months ago
Verified
1396fccd0abe98dc634fb9318f50ad8548c7aa90

Merge pull request #291 from microsoft/dependabot/npm_and_yarn/cross-spawn-7.0.6

cconnor4312 committed 2 months ago

README

The README file for this repository.

vscode-test

Test Status Badge

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 opencode@microsoft.com with any additional questions or comments.