@microsoft/azdata-test

azdata-test

This module helps you test Azure Data Studio extensions by providing a test runner as well as various stubs and mocks.

This is a fork of the vscode-test package.

Supported:

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

Stubs and Mocks

This package provides a set of basic stubs and mocks to help test various parts of the Azure Data Studio extensibility layer which are difficult or repetitive for extensions to implement themselves.

These are located in the lib/mocks and lib/stubs folders.

Usage

and Travis CI configuration.

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 .ads-test/ads-1.36.1
		 */
		await downloadAndUnzipAzureDataStudio('1.36.1')

		/**
		 * Manually download Azure Data Studio 1.35.0 release for testing.
		 */
		const azureDataStudioExecutablePath = await downloadAndUnzipAzureDataStudio('1.35.0')
		await runTests({
			azureDataStudioExecutablePath,
			extensionDevelopmentPath,
			extensionTestsPath,
			launchArgs: [testWorkspace]
		})

		/**
		 * Install Python extension
		 */
		const cliPath = resolveCliPathFromAzureDataStudioExecutablePath(azureDataStudioExecutablePath)
		cp.spawnSync(cliPath, ['--install-extension', 'ms-python.python'], {
			encoding: 'utf-8',
			stdio: 'inherit'
		})

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

	} catch (err) {
		console.error('Failed to run tests')
		process.exit(1)
	}
}

go()

Required Package Versions

To use this package you will need to match the @types/mocha, @types/azudata and @types/vscode package versions in your extension, otherwise you are likely to get compile errors.

Development

• yarn install
• Make necessary changes in lib
• yarn compile (or yarn watch)

Releasing

Release a new version of the extension by:

1. Ensuring all changes are merged in and the package version is updated
2. Create a new Github Release and tag targeting the main branch
3. The CD pipeline will then run and automatically attach the built tgz to the release, go to it and download that file
4. Run npm publish <path to tarball>

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.