strapi/playwright.base.config.js
Vincent (Wen Yu) Ge 0791cd2736
Fix report generation and upload (#23231)
* Fix report generation and upload

* revert pointless empty line change
2025-04-07 12:28:49 +02:00

137 lines
3.7 KiB
JavaScript

// @ts-check
const path = require('path');
const { devices } = require('@playwright/test');
const { parseType } = require('@strapi/utils');
const getEnvNum = (envVar, defaultValue) => {
if (envVar !== undefined && envVar !== null) {
return Number(envVar);
}
return defaultValue;
};
const getEnvString = (envVar, defaultValue) => {
if (envVar?.trim().length) {
return envVar;
}
return defaultValue;
};
const getEnvBool = (envVar, defaultValue) => {
if (!envVar || envVar === '') {
return defaultValue;
}
return parseType({ type: 'boolean', value: envVar.toLowerCase() });
};
/**
* @typedef ConfigOptions
* @type {{ port: number; testDir: string; appDir: string; reportFileName: string }}
*/
/**
* @see https://playwright.dev/docs/test-configuration
* @type {(options: ConfigOptions) => import('@playwright/test').PlaywrightTestConfig}
*/
const createConfig = ({ port, testDir, appDir, reportFileName }) => ({
testDir,
/* default timeout for a jest test */
timeout: getEnvNum(process.env.PLAYWRIGHT_TIMEOUT, 90 * 1000),
expect: {
/**
* Maximum time expect() should wait for the condition to be met.
* For example in `await expect(locator).toHaveText();`
*/
timeout: getEnvNum(process.env.PLAYWRIGHT_EXPECT_TIMEOUT, 10 * 1000),
},
/* Run tests in files in parallel */
fullyParallel: false,
/* Fail the build on CI if you accidentally left test.only in the source code. */
forbidOnly: !!process.env.CI,
/* Retry on CI only */
retries: process.env.CI ? 3 : 1,
/* Opt out of parallel tests on CI. */
workers: 1,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: [
['html'],
// Junit reporter for Trunk flaky test CI upload
[
'junit',
{
outputFile: path.join(
getEnvString(process.env.PLAYWRIGHT_OUTPUT_DIR, '../../junit-reports/'),
reportFileName
),
},
],
],
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: {
/* Base URL to use in actions like `await page.goto('/')`. */
baseURL: `http://127.0.0.1:${port}`,
/** Set timezone for consistency across any machine*/
timezoneId: 'Europe/Paris',
/* Default time each action such as `click()` can take */
actionTimeout: getEnvNum(process.env.PLAYWRIGHT_ACTION_TIMEOUT, 10 * 1000),
// Only record trace when retrying a test to optimize test performance
trace: process.env.CI ? 'on-first-retry' : 'retain-on-failure',
video: getEnvBool(process.env.PLAYWRIGHT_VIDEO, false)
? {
mode: 'on-first-retry', // Only save videos when retrying a test
size: {
width: 1280,
height: 720,
},
}
: 'off',
},
/* Configure projects for major browsers */
projects: [
{
name: 'chromium',
use: {
...devices['Desktop Chrome'],
},
},
{
name: 'firefox',
use: {
...devices['Desktop Firefox'],
},
},
{
name: 'webkit',
use: {
...devices['Desktop Safari'],
},
},
],
/* Folder for test artifacts such as screenshots, videos, traces, etc.
* Must be outside the project itself or develop mode will restart when files are written
* */
outputDir: getEnvString(process.env.PLAYWRIGHT_OUTPUT_DIR, '../test-results/'),
/* Run your local dev server before starting the tests */
webServer: {
command: `cd ${appDir} && npm run develop -- --no-watch-admin`,
url: `http://127.0.0.1:${port}`,
/* default Strapi server startup timeout to 160s */
timeout: getEnvNum(process.env.PLAYWRIGHT_WEBSERVER_TIMEOUT, 160 * 1000),
reuseExistingServer: true,
stdout: 'pipe',
},
});
module.exports = { createConfig };