add new option testRunnerDataDir (#68)

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## 0.0.37
+ * new option `--testRunnerDataDir` to set the temporary folder for storing the VS Code builds used for running the tests
+
+
 ## 0.0.28
  * new option `--coi` to enable cross origin isolation.
 

README.md

@@ -83,6 +83,7 @@ CLI options:
 | --open-devtools | If set, opens the dev tools in the browser. |
 | --verbose | If set, prints out more information when running the server. |
 | --printServerLog | If set, prints the server access log. |
+| --testRunnerDataDir | If set, the temporary folder for storing the VS Code builds used for running the tests |
 | folderPath |  A local folder to open VS Code on. The folder content will be available as a virtual file system and opened as workspace. |
 
 Corresponding options are available in the API.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "scripts": {
     "install-extensions": "yarn --cwd=fs-provider && yarn --cwd=sample",
     "compile": "tsc -p ./ && yarn compile-fs-provider",
@@ -30,7 +30,7 @@
     "koa-mount": "^4.0.0",
     "koa-static": "^5.0.0",
     "minimist": "^1.2.8",
-    "playwright": "^1.32.0",
+    "playwright": "^1.32.1",
     "vscode-uri": "^3.0.7",
     "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.1",
@@ -39,19 +39,19 @@
     "get-stream": "6.0.1"
   },
   "devDependencies": {
-    "@types/koa": "^2.13.5",
+    "@types/koa": "^2.13.6",
     "@types/koa-morgan": "^1.0.5",
     "@types/koa-mount": "^4.0.2",
     "@types/koa-static": "^4.0.2",
     "@types/koa__router": "^12.0.0",
     "@types/minimist": "^1.2.2",
     "@types/node": "16.x",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
     "@types/decompress": "^4.2.4",
-    "eslint": "^8.36.0",
+    "eslint": "^8.37.0",
     "eslint-plugin-header": "^3.1.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.2"
   },
   "license": "MIT",
   "author": "Visual Studio Code Team",

src/index.ts

@@ -144,6 +144,11 @@ export interface Options {
 	 * The host name to start the server on. Defaults to `localhost`
 	 */
 	host?: string;
+
+	/**
+	 * The temporary folder for storing the VS Code builds used for running the tests. Defaults to `$CURRENT_WORKING_DIR/.vscode-test-web`.
+	 */
+	testRunnerDataDir?: string;
 }
 
 export interface Disposable {
@@ -214,7 +219,8 @@ async function getBuild(options: Options): Promise<Static | Sources> {
 		};
 	}
 	const quality = options.quality || options.version;
-	return await downloadAndUnzipVSCode(quality === 'stable' ? 'stable' : 'insider');
+	const testRunnerDataDir = options.testRunnerDataDir ?? path.resolve(process.cwd(), '.vscode-test-web')
+	return await downloadAndUnzipVSCode(quality === 'stable' ? 'stable' : 'insider', testRunnerDataDir);
 }
 
 export async function open(options: Options): Promise<Disposable> {
@@ -506,6 +512,7 @@ interface CommandLineOptions {
 	coi?: boolean;
 	esm?: boolean;
 	help?: boolean;
+	testRunnerDataDir?: string;
 }
 
 function showHelp() {
@@ -528,6 +535,7 @@ function showHelp() {
 	console.log(`  --open-devtools: If set, opens the dev tools. [Optional]`);
 	console.log(`  --verbose: If set, prints out more information when running the server. [Optional]`);
 	console.log(`  --printServerLog: If set, prints the server access log. [Optional]`);
+	console.log(`  --testRunnerDataDir: If set, the temporary folder for storing the VS Code builds used for running the tests. [Optional, defaults to '$CURRENT_WORKING_DIR/.vscode-test-web']`);
 	console.log(`  folderPath. A local folder to open VS Code on. The folder content will be available as a virtual file system. [Optional]`);
 }
 
@@ -544,7 +552,7 @@ async function cliMain(): Promise<void> {
 	console.log(`${manifest.name}: ${manifest.version}`);
 
 	const options: minimist.Opts = {
-		string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port'],
+		string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browser', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'extensionId', 'sourcesPath', 'host', 'port', 'testRunnerDataDir'],
 		boolean: ['open-devtools', 'headless', 'hideServerLog', 'printServerLog', 'help', 'verbose', 'coi', 'esm'],
 		unknown: arg => {
 			if (arg.startsWith('-')) {
@@ -577,6 +585,7 @@ async function cliMain(): Promise<void> {
 	const host = validateStringOrUndefined(args, 'host');
 	const coi = validateBooleanOrUndefined(args, 'coi');
 	const esm = validateBooleanOrUndefined(args, 'esm');
+	const testRunnerDataDir = validateStringOrUndefined(args, 'testRunnerDataDir');
 
 	const waitForDebugger = validatePortNumber(args.waitForDebugger);
 
@@ -615,7 +624,8 @@ async function cliMain(): Promise<void> {
 			esm,
 			coi,
 			host,
-			port
+			port,
+			testRunnerDataDir
 		}).catch(e => {
 			console.log('Error running tests:', e);
 			process.exit(1);
@@ -639,7 +649,8 @@ async function cliMain(): Promise<void> {
 			esm,
 			coi,
 			host,
-			port
+			port,
+			testRunnerDataDir
 		})
 	}
 }

src/server/download.ts

@@ -21,10 +21,6 @@ interface DownloadInfo {
 	version: string;
 }
 
-const extensionRoot = process.cwd();
-const vscodeTestDir = path.resolve(extensionRoot, '.vscode-test-web');
-
-
 async function getLatestVersion(quality: 'stable' | 'insider'): Promise<DownloadInfo> {
 	const update: DownloadInfo = await fetchJSON(`https://update.code.visualstudio.com/api/update/web-standalone/${quality}/latest`);
 	return update;
@@ -87,7 +83,7 @@ async function unzip(source: string, destination: string, message: string) {
 	process.stdout.write(`${reset}${message}: complete\n`);
 }
 
-export async function downloadAndUnzipVSCode(quality: 'stable' | 'insider'): Promise<Static> {
+export async function downloadAndUnzipVSCode(quality: 'stable' | 'insider', vscodeTestDir: string): Promise<Static> {
 	const info = await getLatestVersion(quality);
 
 	const folderName = `vscode-web-${quality}-${info.version}`;
@@ -105,7 +101,7 @@ export async function downloadAndUnzipVSCode(quality: 'stable' | 'insider'): Pro
 
 	const productName = `VS Code ${quality === 'stable' ? 'Stable' : 'Insiders'}`;
 
-	const tmpArchiveName = `vscode-web-${quality}-${info.version}-tmp`;
+	const tmpArchiveName = path.join(vscodeTestDir, `vscode-web-${quality}-${info.version}-tmp`);
 	try {
 		await download(info.url, tmpArchiveName, `Downloading ${productName}`);
 		await unzip(tmpArchiveName, downloadedPath, `Unpacking ${productName}`);