mirror of
https://github.com/microsoft/vscode.git
synced 2026-04-24 18:49:00 +01:00
Add another server built on top of our own automation framework (#262984)
* Add another server built on top of our own automation framework It's a big PR but a lot of this is boiler plate. It's just essentially wrapping our Automation framework in a bunch of tools. * Lay the foundation for multiplexing
This commit is contained in:
Tyler James Leonhardt
committed by
GitHub
GitHub
parent
7db6be89a1
commit
a7cdeedd57
379
test/mcp/src/application.ts
Normal file
379
test/mcp/src/application.ts
Normal file
@@ -0,0 +1,379 @@
|
||||
/*---------------------------------------------------------------------------------------------
|
||||
* Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
* Licensed under the MIT License. See License.txt in the project root for license information.
|
||||
*--------------------------------------------------------------------------------------------*/
|
||||
|
||||
import * as playwright from 'playwright';
|
||||
import { getDevElectronPath, Quality, ConsoleLogger, FileLogger, Logger, MultiLogger, getBuildElectronPath, getBuildVersion, measureAndLog } from '../../automation';
|
||||
import * as path from 'path';
|
||||
import * as fs from 'fs';
|
||||
import * as cp from 'child_process';
|
||||
import * as os from 'os';
|
||||
import * as vscodetest from '@vscode/test-electron';
|
||||
import { createApp, retry } from './utils';
|
||||
import * as minimist from 'minimist';
|
||||
|
||||
const rootPath = path.join(__dirname, '..', '..', '..');
|
||||
|
||||
const [, , ...args] = process.argv;
|
||||
const opts = minimist(args, {
|
||||
string: [
|
||||
'browser',
|
||||
'build',
|
||||
'stable-build',
|
||||
'wait-time',
|
||||
'test-repo',
|
||||
'electronArgs'
|
||||
],
|
||||
boolean: [
|
||||
'verbose',
|
||||
'remote',
|
||||
'web',
|
||||
'headless',
|
||||
'tracing'
|
||||
],
|
||||
default: {
|
||||
verbose: false
|
||||
}
|
||||
}) as {
|
||||
verbose?: boolean;
|
||||
remote?: boolean;
|
||||
headless?: boolean;
|
||||
web?: boolean;
|
||||
tracing?: boolean;
|
||||
build?: string;
|
||||
'stable-build'?: string;
|
||||
browser?: 'chromium' | 'webkit' | 'firefox' | 'chromium-msedge' | 'chromium-chrome' | undefined;
|
||||
electronArgs?: string;
|
||||
};
|
||||
|
||||
const logsRootPath = (() => {
|
||||
const logsParentPath = path.join(rootPath, '.build', 'logs');
|
||||
|
||||
let logsName: string;
|
||||
if (opts.web) {
|
||||
logsName = 'smoke-tests-browser';
|
||||
} else if (opts.remote) {
|
||||
logsName = 'smoke-tests-remote';
|
||||
} else {
|
||||
logsName = 'smoke-tests-electron';
|
||||
}
|
||||
|
||||
return path.join(logsParentPath, logsName);
|
||||
})();
|
||||
|
||||
const crashesRootPath = (() => {
|
||||
const crashesParentPath = path.join(rootPath, '.build', 'crashes');
|
||||
|
||||
let crashesName: string;
|
||||
if (opts.web) {
|
||||
crashesName = 'smoke-tests-browser';
|
||||
} else if (opts.remote) {
|
||||
crashesName = 'smoke-tests-remote';
|
||||
} else {
|
||||
crashesName = 'smoke-tests-electron';
|
||||
}
|
||||
|
||||
return path.join(crashesParentPath, crashesName);
|
||||
})();
|
||||
|
||||
const logger = createLogger();
|
||||
|
||||
function createLogger(): Logger {
|
||||
const loggers: Logger[] = [];
|
||||
|
||||
// Log to console if verbose
|
||||
if (opts.verbose) {
|
||||
loggers.push(new ConsoleLogger());
|
||||
}
|
||||
|
||||
// Prepare logs rot path
|
||||
fs.rmSync(logsRootPath, { recursive: true, force: true, maxRetries: 3 });
|
||||
fs.mkdirSync(logsRootPath, { recursive: true });
|
||||
|
||||
// Always log to log file
|
||||
loggers.push(new FileLogger(path.join(logsRootPath, 'smoke-test-runner.log')));
|
||||
|
||||
return new MultiLogger(loggers);
|
||||
}
|
||||
|
||||
const testDataPath = path.join(os.tmpdir(), 'vscsmoke');
|
||||
if (fs.existsSync(testDataPath)) {
|
||||
fs.rmSync(testDataPath, { recursive: true, force: true, maxRetries: 10 });
|
||||
}
|
||||
fs.mkdirSync(testDataPath, { recursive: true });
|
||||
process.once('exit', () => {
|
||||
try {
|
||||
fs.rmSync(testDataPath, { recursive: true, force: true, maxRetries: 10 });
|
||||
} catch {
|
||||
// noop
|
||||
}
|
||||
});
|
||||
|
||||
function getTestTypeSuffix(): string {
|
||||
if (opts.web) {
|
||||
return 'browser';
|
||||
} else if (opts.remote) {
|
||||
return 'remote';
|
||||
} else {
|
||||
return 'electron';
|
||||
}
|
||||
}
|
||||
|
||||
const testRepoUrl = 'https://github.com/microsoft/vscode-smoketest-express';
|
||||
const workspacePath = path.join(testDataPath, `vscode-smoketest-express-${getTestTypeSuffix()}`);
|
||||
const extensionsPath = path.join(testDataPath, 'extensions-dir');
|
||||
fs.mkdirSync(extensionsPath, { recursive: true });
|
||||
|
||||
function fail(errorMessage): void {
|
||||
logger.log(errorMessage);
|
||||
if (!opts.verbose) {
|
||||
console.error(errorMessage);
|
||||
}
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
let quality: Quality;
|
||||
let version: string | undefined;
|
||||
|
||||
function parseVersion(version: string): { major: number; minor: number; patch: number } {
|
||||
const [, major, minor, patch] = /^(\d+)\.(\d+)\.(\d+)/.exec(version)!;
|
||||
return { major: parseInt(major), minor: parseInt(minor), patch: parseInt(patch) };
|
||||
}
|
||||
|
||||
function parseQuality(): Quality {
|
||||
if (process.env.VSCODE_DEV === '1') {
|
||||
return Quality.Dev;
|
||||
}
|
||||
|
||||
const quality = process.env.VSCODE_QUALITY ?? '';
|
||||
|
||||
switch (quality) {
|
||||
case 'stable':
|
||||
return Quality.Stable;
|
||||
case 'insider':
|
||||
return Quality.Insiders;
|
||||
case 'exploration':
|
||||
return Quality.Exploration;
|
||||
case 'oss':
|
||||
return Quality.OSS;
|
||||
default:
|
||||
return Quality.Dev;
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// #### Electron ####
|
||||
//
|
||||
if (!opts.web) {
|
||||
let testCodePath = opts.build;
|
||||
let electronPath: string | undefined;
|
||||
|
||||
if (testCodePath) {
|
||||
electronPath = getBuildElectronPath(testCodePath);
|
||||
version = getBuildVersion(testCodePath);
|
||||
} else {
|
||||
testCodePath = getDevElectronPath();
|
||||
electronPath = testCodePath;
|
||||
process.env.VSCODE_REPOSITORY = rootPath;
|
||||
process.env.VSCODE_DEV = '1';
|
||||
process.env.VSCODE_CLI = '1';
|
||||
}
|
||||
|
||||
if (!fs.existsSync(electronPath || '')) {
|
||||
fail(`Cannot find VSCode at ${electronPath}. Please run VSCode once first (scripts/code.sh, scripts\\code.bat) and try again.`);
|
||||
}
|
||||
|
||||
quality = parseQuality();
|
||||
|
||||
if (opts.remote) {
|
||||
logger.log(`Running desktop remote smoke tests against ${electronPath}`);
|
||||
} else {
|
||||
logger.log(`Running desktop smoke tests against ${electronPath}`);
|
||||
}
|
||||
}
|
||||
|
||||
//
|
||||
// #### Web Smoke Tests ####
|
||||
//
|
||||
else {
|
||||
const testCodeServerPath = opts.build || process.env.VSCODE_REMOTE_SERVER_PATH;
|
||||
|
||||
if (typeof testCodeServerPath === 'string') {
|
||||
if (!fs.existsSync(testCodeServerPath)) {
|
||||
fail(`Cannot find Code server at ${testCodeServerPath}.`);
|
||||
} else {
|
||||
logger.log(`Running web smoke tests against ${testCodeServerPath}`);
|
||||
}
|
||||
}
|
||||
|
||||
if (!testCodeServerPath) {
|
||||
process.env.VSCODE_REPOSITORY = rootPath;
|
||||
process.env.VSCODE_DEV = '1';
|
||||
process.env.VSCODE_CLI = '1';
|
||||
|
||||
logger.log(`Running web smoke out of sources`);
|
||||
}
|
||||
|
||||
quality = parseQuality();
|
||||
}
|
||||
|
||||
logger.log(`VS Code product quality: ${quality}.`);
|
||||
|
||||
const userDataDir = path.join(testDataPath, 'd');
|
||||
|
||||
async function setupRepository(): Promise<void> {
|
||||
if (opts['test-repo']) {
|
||||
logger.log('Copying test project repository:', opts['test-repo']);
|
||||
fs.rmSync(workspacePath, { recursive: true, force: true, maxRetries: 10 });
|
||||
// not platform friendly
|
||||
if (process.platform === 'win32') {
|
||||
cp.execSync(`xcopy /E "${opts['test-repo']}" "${workspacePath}"\\*`);
|
||||
} else {
|
||||
cp.execSync(`cp -R "${opts['test-repo']}" "${workspacePath}"`);
|
||||
}
|
||||
} else {
|
||||
if (!fs.existsSync(workspacePath)) {
|
||||
logger.log('Cloning test project repository...');
|
||||
const res = cp.spawnSync('git', ['clone', testRepoUrl, workspacePath], { stdio: 'inherit' });
|
||||
if (!fs.existsSync(workspacePath)) {
|
||||
throw new Error(`Clone operation failed: ${res.stderr.toString()}`);
|
||||
}
|
||||
} else {
|
||||
logger.log('Cleaning test project repository...');
|
||||
cp.spawnSync('git', ['fetch'], { cwd: workspacePath, stdio: 'inherit' });
|
||||
cp.spawnSync('git', ['reset', '--hard', 'FETCH_HEAD'], { cwd: workspacePath, stdio: 'inherit' });
|
||||
cp.spawnSync('git', ['clean', '-xdf'], { cwd: workspacePath, stdio: 'inherit' });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function ensureStableCode(): Promise<void> {
|
||||
let stableCodePath = opts['stable-build'];
|
||||
if (!stableCodePath) {
|
||||
const current = parseVersion(version!);
|
||||
const versionsReq = await retry(() => measureAndLog(() => fetch('https://update.code.visualstudio.com/api/releases/stable'), 'versionReq', logger), 1000, 20);
|
||||
|
||||
if (!versionsReq.ok) {
|
||||
throw new Error('Could not fetch releases from update server');
|
||||
}
|
||||
|
||||
const versions: string[] = await measureAndLog(() => versionsReq.json(), 'versionReq.json()', logger);
|
||||
const stableVersion = versions.find(raw => {
|
||||
const version = parseVersion(raw);
|
||||
return version.major < current.major || (version.major === current.major && version.minor < current.minor);
|
||||
});
|
||||
|
||||
if (!stableVersion) {
|
||||
throw new Error(`Could not find suitable stable version for ${version}`);
|
||||
}
|
||||
|
||||
logger.log(`Found VS Code v${version}, downloading previous VS Code version ${stableVersion}...`);
|
||||
|
||||
let lastProgressMessage: string | undefined = undefined;
|
||||
let lastProgressReportedAt = 0;
|
||||
const stableCodeDestination = path.join(testDataPath, 's');
|
||||
const stableCodeExecutable = await retry(() => measureAndLog(() => vscodetest.download({
|
||||
cachePath: stableCodeDestination,
|
||||
version: stableVersion,
|
||||
extractSync: true,
|
||||
reporter: {
|
||||
report: report => {
|
||||
let progressMessage = `download stable code progress: ${report.stage}`;
|
||||
const now = Date.now();
|
||||
if (progressMessage !== lastProgressMessage || now - lastProgressReportedAt > 10000) {
|
||||
lastProgressMessage = progressMessage;
|
||||
lastProgressReportedAt = now;
|
||||
|
||||
if (report.stage === 'downloading') {
|
||||
progressMessage += ` (${report.bytesSoFar}/${report.totalBytes})`;
|
||||
}
|
||||
|
||||
logger.log(progressMessage);
|
||||
}
|
||||
},
|
||||
error: error => logger.log(`download stable code error: ${error}`)
|
||||
}
|
||||
}), 'download stable code', logger), 1000, 3, () => new Promise<void>((resolve, reject) => {
|
||||
fs.rm(stableCodeDestination, { recursive: true, force: true, maxRetries: 10 }, error => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
}));
|
||||
|
||||
if (process.platform === 'darwin') {
|
||||
// Visual Studio Code.app/Contents/MacOS/Electron
|
||||
stableCodePath = path.dirname(path.dirname(path.dirname(stableCodeExecutable)));
|
||||
} else {
|
||||
// VSCode/Code.exe (Windows) | VSCode/code (Linux)
|
||||
stableCodePath = path.dirname(stableCodeExecutable);
|
||||
}
|
||||
|
||||
opts['stable-version'] = parseVersion(stableVersion);
|
||||
}
|
||||
|
||||
if (!fs.existsSync(stableCodePath)) {
|
||||
throw new Error(`Cannot find Stable VSCode at ${stableCodePath}.`);
|
||||
}
|
||||
|
||||
logger.log(`Using stable build ${stableCodePath} for migration tests`);
|
||||
|
||||
opts['stable-build'] = stableCodePath;
|
||||
}
|
||||
|
||||
async function setup(): Promise<void> {
|
||||
logger.log('Test data path:', testDataPath);
|
||||
logger.log('Preparing smoketest setup...');
|
||||
|
||||
if (!opts.web && !opts.remote && opts.build) {
|
||||
// only enabled when running with --build and not in web or remote
|
||||
await measureAndLog(() => ensureStableCode(), 'ensureStableCode', logger);
|
||||
}
|
||||
await measureAndLog(() => setupRepository(), 'setupRepository', logger);
|
||||
|
||||
logger.log('Smoketest setup done!\n');
|
||||
}
|
||||
|
||||
export async function getApplication() {
|
||||
const testCodePath = getDevElectronPath();
|
||||
const electronPath = testCodePath;
|
||||
if (!fs.existsSync(electronPath || '')) {
|
||||
throw new Error(`Cannot find VSCode at ${electronPath}. Please run VSCode once first (scripts/code.sh, scripts\\code.bat) and try again.`);
|
||||
}
|
||||
process.env.VSCODE_REPOSITORY = rootPath;
|
||||
process.env.VSCODE_DEV = '1';
|
||||
process.env.VSCODE_CLI = '1';
|
||||
delete process.env.ELECTRON_RUN_AS_NODE; // Ensure we run as Node.js
|
||||
const quality = Quality.Dev;
|
||||
|
||||
await setup();
|
||||
const application = createApp({
|
||||
// Pass the alpha version of Playwright down... This is a hack since Playwright MCP
|
||||
// doesn't play nice with Playwright Test: https://github.com/microsoft/playwright-mcp/issues/917
|
||||
playwright: playwright as any,
|
||||
quality,
|
||||
version: parseVersion(version ?? '0.0.0'),
|
||||
codePath: opts.build,
|
||||
workspacePath,
|
||||
userDataDir,
|
||||
extensionsPath,
|
||||
logger,
|
||||
logsPath: path.join(logsRootPath, 'suite_unknown'),
|
||||
crashesPath: path.join(crashesRootPath, 'suite_unknown'),
|
||||
verbose: opts.verbose,
|
||||
remote: opts.remote,
|
||||
web: opts.web,
|
||||
tracing: opts.tracing,
|
||||
headless: opts.headless,
|
||||
browser: opts.browser,
|
||||
extraArgs: (opts.electronArgs || '').split(' ').map(arg => arg.trim()).filter(arg => !!arg),
|
||||
});
|
||||
await application.start();
|
||||
application.code.driver.browserContext.on('close', async () => {
|
||||
fs.rmSync(testDataPath, { recursive: true, force: true, maxRetries: 10 });
|
||||
});
|
||||
return application;
|
||||
}
|
||||
Reference in New Issue
Block a user