GitXplorerGitXplorer
m

vscode-test

public
249 stars
60 forks
18 issues

Commits

List of commits on branch main.
Verified
d1766021cba444efded8ee44094175a50f50e948

chore(deps): bump cross-spawn from 7.0.3 to 7.0.6

ddependabot[bot] committed 2 months ago
Verified
0e1ed5e0d8f53376bd3632f45df2c81dc2ef7679

chore(deps): bump rollup from 4.21.3 to 4.22.4 (#287)

ddependabot[bot] committed 4 months ago
Verified
f6bf09d39a63a08bf8712e44f6ee1120c5424e4c

chore(deps): bump vite from 5.2.11 to 5.4.6 (#286)

ddependabot[bot] committed 4 months ago
Verified
c3437207f344daf53ca85ecf61d244521e90498a

fix: deleting old Insiders in electron not working (#283)

cconnor4312 committed 6 months ago
Verified
263c6f6a67d9966b21cdd753d7fe82d2e49ce2ac

fix bad yarn.lock, remove extraneous package-lock (#282)

cconnor4312 committed 6 months ago
Verified
618b67fffd1eb2315cb4b82fb33116c2fa6a80c9

2.4.1 (#280)

cconnor4312 committed 6 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.