108 lines
3.5 KiB
TypeScript
108 lines
3.5 KiB
TypeScript
|
export interface TestOptions {
|
||
|
|
/**
|
||
|
|
* The VS Code executable being used for testing.
|
||
|
|
*
|
||
|
|
* If not passed, will use options.version for downloading a copy of
|
||
|
|
* VS Code for testing. If `version` is not specified either, will
|
||
|
|
* download and use latest stable release.
|
||
|
|
*/
|
||
|
|
vscodeExecutablePath?: string;
|
||
|
|
/**
|
||
|
|
* The VS Code version to download. Valid versions are:
|
||
|
|
* - `'insiders'`
|
||
|
|
* - `'1.32.0'`, `'1.31.1'`, etc
|
||
|
|
*
|
||
|
|
* Default to latest stable version.
|
||
|
|
*/
|
||
|
|
version?: string;
|
||
|
|
/**
|
||
|
|
* Absolute path to the extension root. Passed to `--extensionDevelopmentPath`.
|
||
|
|
* Must include a `package.json` Extension Manifest.
|
||
|
|
*/
|
||
|
|
extensionPath: string;
|
||
|
|
/**
|
||
|
|
* Absolute path to the test runner. Passed to `--extensionTestsPath`.
|
||
|
|
* Can be either a file path or a directory path that contains an `index.js`.
|
||
|
|
* Must export a `run` function of the following signature:
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* function run(testsRoot: string, cb: (error: any, failures?: number) => void): void;
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* When running integration test, the Extension Development Host will call this function
|
||
|
|
* that runs the test suite. The `cb` function should be called when the test suite finishes.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
testRunnerPath: string;
|
||
|
|
/**
|
||
|
|
* Environment variables being passed to the test runner.
|
||
|
|
*/
|
||
|
|
testRunnerEnv?: {
|
||
|
|
[key: string]: string | undefined;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Absolute path of the fixture workspace to launch for testing.
|
||
|
|
* Passed as the first argument to `code` executable and can be:
|
||
|
|
*
|
||
|
|
* - File path: Open file on test start
|
||
|
|
* - Folder path: Open folder on test start
|
||
|
|
* - Workspace file path: Open workspace on test start
|
||
|
|
*/
|
||
|
|
testWorkspace?: string;
|
||
|
|
/**
|
||
|
|
* A list of arguments appended to the default VS Code launch arguments below:
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* [
|
||
|
|
* options.testWorkspace,
|
||
|
|
* '--extensionDevelopmentPath=' + options.extPath,
|
||
|
|
* '--extensionTestsPath=' + options.testPath,
|
||
|
|
* '--locale=' + (options.locale || 'en')
|
||
|
|
* ];
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* See `code --help` for possible arguments.
|
||
|
|
*/
|
||
|
|
additionalLaunchArgs?: string[];
|
||
|
|
/**
|
||
|
|
* The locale to use (e.g. `en-US` or `zh-TW`).
|
||
|
|
* If not specified, it defaults to `en`.
|
||
|
|
*/
|
||
|
|
locale?: string;
|
||
|
|
}
|
||
|
|
export interface ExplicitTestOptions {
|
||
|
|
/**
|
||
|
|
* The VS Code executable being used for testing.
|
||
|
|
*
|
||
|
|
* If not passed, will use options.version for downloading a copy of
|
||
|
|
* VS Code for testing. If `version` is not specified either, will
|
||
|
|
* download and use latest stable release.
|
||
|
|
*/
|
||
|
|
vscodeExecutablePath?: string;
|
||
|
|
/**
|
||
|
|
* The VS Code version to download. Valid versions are:
|
||
|
|
* - `'insiders'`
|
||
|
|
* - `'1.32.0'`, `'1.31.1'`, etc
|
||
|
|
*
|
||
|
|
* Default to latest stable version.
|
||
|
|
*/
|
||
|
|
version?: string;
|
||
|
|
/**
|
||
|
|
* A list of arguments used for launching VS Code executable.
|
||
|
|
*
|
||
|
|
* You need to provide `--extensionDevelopmentPath` and `--extensionTestsPath` manually when
|
||
|
|
* using this option. If you want to open a specific workspace for testing, you need to pass
|
||
|
|
* the absolute path of the workspace as first item in this list.
|
||
|
|
*
|
||
|
|
* See `code --help` for possible arguments.
|
||
|
|
*/
|
||
|
|
launchArgs: string[];
|
||
|
|
/**
|
||
|
|
* Environment variables being passed to the test runner.
|
||
|
|
*/
|
||
|
|
testRunnerEnv?: {
|
||
|
|
[key: string]: string | undefined;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
export declare function runTests(options: TestOptions | ExplicitTestOptions): Promise<number>;
|