upstream-mattermost/e2e-tests/playwright/playwright.config.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import {defineConfig, devices} from '@playwright/test';

import {
    assertUpgradeFromFreshStart,
    assertUpgradeToRequiresPriorFromRun,
    duration,
    isUpgradeFromProjectSelected,
    isUpgradeToPhaseProjectSelected,
    logUpgradeFromServerImage,
    logUpgradeToServerImage,
    testConfig,
} from '@mattermost/playwright-lib';

if (isUpgradeFromProjectSelected()) {
    assertUpgradeFromFreshStart();
    logUpgradeFromServerImage();
}

if (isUpgradeToPhaseProjectSelected()) {
    assertUpgradeToRequiresPriorFromRun();
    logUpgradeToServerImage();
}

const chromeUse = {
    browserName: 'chromium' as const,
    permissions: ['notifications', 'clipboard-read', 'clipboard-write'] as string[],
    viewport: {width: 1280, height: 1024},
};

export default defineConfig({
    globalSetup: './global_setup.ts',
    forbidOnly: testConfig.isCI,
    outputDir: './results/output',
    retries: testConfig.isCI ? 1 : 0,
    testDir: 'specs',
    timeout: duration.one_min,
    workers: testConfig.workers,
    expect: {
        timeout: duration.ten_sec,
        toHaveScreenshot: {
            threshold: 0.4,
            maxDiffPixelRatio: 0.0001,
            animations: 'disabled',
        },
        toMatchAriaSnapshot: {
            pathTemplate: '{testDir}/{testFilePath}-snapshots-a11y/{arg}{ext}',
        },
    },
    use: {
        baseURL: testConfig.baseURL,
        ignoreHTTPSErrors: true,
        headless: testConfig.headless,
        locale: 'en-US',
        launchOptions: {
            args: ['--use-fake-device-for-media-stream', '--use-fake-ui-for-media-stream'],
            firefoxUserPrefs: {
                'media.navigator.streams.fake': true,
                'permissions.default.microphone': 1,
                'permissions.default.camera': 1,
            },
            slowMo: testConfig.slowMo,
        },
        screenshot: 'only-on-failure',
        timezoneId: new Intl.DateTimeFormat().resolvedOptions().timeZone,
        trace: 'retain-on-failure',
        video: 'retain-on-failure',
        actionTimeout: duration.half_min,
    },
    projects: [
        {name: 'setup', testMatch: /test_setup\.ts/},
        {
            name: 'ipad',
            use: {
                browserName: 'chromium',
                ...devices['iPad Pro 11'],
                permissions: ['notifications', 'clipboard-read', 'clipboard-write'],
            },
            dependencies: ['setup'],
        },
        {
            name: 'chrome',
            use: chromeUse,
            dependencies: ['setup'],
        },
        {
            name: 'firefox',
            use: {
                browserName: 'firefox',
                permissions: ['notifications'],
                viewport: {width: 1280, height: 1024},
            },
            dependencies: ['setup'],
        },
        // Upgrade-path specs live under upgrade-specs/ (outside testDir) so Test System IO
        // dispatch-begin does not register them in the full Playwright queue.
        {
            name: 'upgrade-from',
            testDir: 'upgrade-specs/from',
            dependencies: ['setup'],
            fullyParallel: false,
            workers: 1,
        },
        {name: 'upgrade-swap-to', testDir: 'upgrade-specs', testMatch: /upgrade_swap_to\.ts/},
        {
            name: 'upgrade-to',
            testDir: 'upgrade-specs/to',
            dependencies: ['upgrade-swap-to'],
            fullyParallel: false,
            workers: 1,
        },
    ],
    reporter: [
        ...(testConfig.isCI ? [['blob', {outputDir: './results/blob-report'}] as const] : []),
        ['html', {open: 'never', outputFolder: './results/reporter'}],
        ['json', {outputFile: './results/reporter/results.json'}],
        ['junit', {outputFile: './results/reporter/results.xml'}],
        ['list'],
    ],
});