playwright.config.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (C) 2024 Posit Software, PBC. All rights reserved.
 *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
 *--------------------------------------------------------------------------------------------*/

import { defineConfig, ReporterDescription } from '@playwright/test';
import { CustomTestOptions } from './test/e2e/tests/_test.setup';
import * as fs from 'fs';

process.env.PW_TEST = '1';
const jsonOut = process.env.PW_JSON_FILE || 'test-results/results.json';
const githubSummaryReport = process.env.GH_SUMMARY_REPORT === 'true' ? [['@midleman/github-actions-reporter', {}] as const] : [];
// Custom reporter is enabled by default.
// Disable with: ENABLE_CUSTOM_REPORTER=false (or "false", 0, "0", no, "no")
// YAML booleans are converted to strings by GitHub Actions, so both work.
const disableCustomReporter = process.env.ENABLE_CUSTOM_REPORTER?.toLowerCase() ?? '';
const customReporter = ['false', '0', 'no'].includes(disableCustomReporter)
	? []
	: [['@midleman/playwright-reporter',
		{
			repoName: 'positron',
			mode: 'prod'
		},
	] as const];

/**
 * See https://playwright.dev/docs/test-configuration.
 */
const projectName = process.env.PW_PROJECT_NAME || 'default';

const baseIgnore = [
	'example.test.ts',
	'**/workbench/**',
	'**/remote-ssh/**',
	'**/assistant-eval/**',
	'**/release-screenshots/**',
];

let reporter: ReporterDescription[];
if (process.env.CI) {
	reporter = [
		...githubSummaryReport,
		...customReporter,
		['json', { outputFile: jsonOut }],
		['list'], ['html'], ['blob'],
	];
} else {
	reporter = [['list']];
	if (!process.env.CLAUDE_CODE) {
		reporter.push(['html', { open: 'on-failure' }]);
	}
}

export default defineConfig<CustomTestOptions>({
	captureGitInfo: { commit: true, diff: true },
	globalSetup: './test/e2e/tests/_global.setup.ts',
	testDir: './test/e2e',
	testMatch: '*.test.ts',
	testIgnore: process.env.ALLOW_PYREFLY === 'true'
		? baseIgnore
		: [...baseIgnore, '**/lsp/**'],
	fullyParallel: false, // Run individual tests w/in a spec in parallel
	forbidOnly: !!process.env.CI,
	retries: process.env.CI ? 1 : 0,
	workers: 3,
	timeout: 2 * 60 * 1000,
	reportSlowTests: {
		max: 10,
		threshold: 60 * 1000, // 1 minute
	},
	expect: {
		timeout: 15000,
	},
	reporter,


	/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
	use: {
		headless: false,
		trace: 'off', // we are manually handling tracing in _test.setup.ts
		actionTimeout: 15000,
		navigationTimeout: 15000,
	},

	projects: [
		{
			name: 'e2e-electron',
			testIgnore: process.env.ALLOW_PYREFLY === 'true'
				? [
					'example.test.ts',
					'**/workbench/**',
					'**/remote-ssh/**',
					// Note: assistant-eval NOT ignored here - runs on e2e-electron only
				]
				: [
					'example.test.ts',
					'**/workbench/**',
					'**/remote-ssh/**',
					'**/lsp/**',
					// Note: assistant-eval NOT ignored here - runs on e2e-electron only
				],
			use: {
				artifactDir: 'e2e-electron'
			},
			grepInvert: /@:web-only/
		},
		{
			name: 'e2e-chromium',
			use: {
				artifactDir: 'e2e-chromium',
				headless: false,
				browserName: 'chromium'
			},
			grep: /@:web/
		},
		{
			name: 'e2e-firefox',
			use: {
				artifactDir: 'e2e-firefox',
				headless: false,
				browserName: 'firefox'
			},
			grep: /@:cross-browser/
		},
		{
			name: 'e2e-windows',
			use: {
				artifactDir: 'e2e-windows',
			},
			grep: /@:win/,
			grepInvert: /@:web-only/
		},
		{
			name: 'e2e-webkit',
			use: {
				artifactDir: 'e2e-webkit',
				headless: false,
				browserName: 'webkit'
			},
			grep: /@:cross-browser/
		},
		{
			name: 'e2e-edge',
			use: {
				artifactDir: 'e2e-edge',
				headless: false,
				browserName: 'chromium',
				channel: 'msedge',
			},
			grep: /@:cross-browser/
		},
		{
			name: 'e2e-server',
			use: {
				artifactDir: 'e2e-server',
				headless: false,
				useExternalServer: true,
				externalServerUrl: 'http://localhost:8080/?tkn=dev-token',
				browserName: 'chromium'
			},
			grep: /@:web/
		},
		{
			name: 'e2e-macOS-ci',
			use: {
				artifactDir: 'e2e-macOS-ci',
			},
			grep: /@:win/,
			grepInvert: /@:web-only|@:interpreter/
		},
		{
			name: 'e2e-workbench',
			testIgnore: [
				'example.test.ts',
				'**/assistant-eval/**',
				'**/remote-ssh/**'
			],
			use: {
				artifactDir: 'e2e-workbench',
				headless: false,
				useExternalServer: true,
				externalServerUrl: 'http://localhost:8787',
				browserName: 'chromium',
			},
			grep: /@:workbench/
		},
		{
			name: 'e2e-remote-ssh',
			testIgnore: [
				'example.test.ts',
				'**/assistant-eval/**',
				'**/workbench/**',
			],
			use: {
				artifactDir: 'e2e-remote-ssh',
				headless: false,
				useExternalServer: false,
			},
			grep: /@:remote-ssh/
		},
		{
			name: 'e2e-jupyter',
			testIgnore: [
				'example.test.ts',
				'**/assistant-eval/**',
				'**/remote-ssh/**'
			],
			use: {
				artifactDir: 'e2e-jupyter',
				headless: false,
				useExternalServer: true,
				externalServerUrl: 'http://localhost:8888',
				browserName: 'chromium',
			},
			grep: /@:jupyter/
		},
		{
			name: 'release-screenshots',
			testDir: './test/e2e/release-screenshots',
			testMatch: '*.screenshot.ts',
			testIgnore: [],
			use: {
				artifactDir: 'release-screenshots',
			},
		},
	],
});

/**
 * Check if the current platform is openSUSE
 */
function isOpenSUSE(): boolean {
	try {
		const osRelease = fs.readFileSync('/etc/os-release', 'utf8').toLowerCase();
		const id = osRelease.match(/^id=(.*)$/m)?.[1]?.trim().replace(/^"|"$/g, '') ?? '';
		const idLike = osRelease.match(/^id_like=(.*)$/m)?.[1]?.trim().replace(/^"|"$/g, '') ?? '';

		return id.startsWith('opensuse') || id.includes('opensuse-leap') || idLike.includes('opensuse');
	} catch {
		return false;
	}
}

/**
 * Check if the current platform is SLES (SUSE Linux Enterprise Server)
 */
function isSLES(): boolean {
	try {
		const osRelease = fs.readFileSync('/etc/os-release', 'utf8').toLowerCase();
		const id = osRelease.match(/^id=(.*)$/m)?.[1]?.trim().replace(/^"|"$/g, '') ?? '';
		const idLike = osRelease.match(/^id_like=(.*)$/m)?.[1]?.trim().replace(/^"|"$/g, '') ?? '';

		return id === 'sles' || idLike.includes('sles');
	} catch {
		return false;
	}
}

// Set environment variable for tests to check
const IS_OPENSUSE = isOpenSUSE();
process.env.IS_OPENSUSE = IS_OPENSUSE ? 'true' : 'false';

const IS_SLES = isSLES();
process.env.IS_SLES = IS_SLES ? 'true' : 'false';