playwright.config.ts

/**
 * ---------------------------------------------------------------------
 *
 * GLPI - Gestionnaire Libre de Parc Informatique
 *
 * http://glpi-project.org
 *
 * @copyright 2015-2026 Teclib' and contributors.
 * @licence   https://www.gnu.org/licenses/gpl-3.0.html
 *
 * ---------------------------------------------------------------------
 *
 * LICENSE
 *
 * This file is part of GLPI.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * ---------------------------------------------------------------------
 */

import { defineConfig, devices } from '@playwright/test';
import { config } from 'dotenv' ;
import { globSync } from 'glob';
import { Config } from './tests/e2e/utils/Config';

// Load .env file so it is available everywhere.
config({path: './tests/e2e/.env.local', quiet: true});
config({path: './tests/e2e/.env', quiet: true});

/**
 * Playwright configuration file
 *
 * See:
 * - https://playwright.dev/docs/test-configuration.
 * - https://playwright.dev/docs/api/class-testconfig
 */
export default defineConfig({
    // Directory that will be recursively scanned for test files.
    // See: https://playwright.dev/docs/api/class-testconfig#test-config-test-dir
    testDir: './tests/e2e/specs',

    // Run tests in files in parallel
    // See: https://playwright.dev/docs/api/class-testconfig#test-config-fully-parallel
    fullyParallel: true,

    // Fail the build on CI if you accidentally left test.only in the source code.
    // See: https://playwright.dev/docs/api/class-testconfig#test-config-forbid-only
    forbidOnly: !!process.env.CI,

    // Retry on CI only
    // See: https://playwright.dev/docs/api/class-testconfig#test-config-retries
    retries: process.env.CI ? 2 : 0,

    // Reporter to use.
    // See:
    // - https://playwright.dev/docs/test-reporters
    // - https://playwright.dev/docs/api/class-testconfig#test-config-reporter
    reporter: process.env.CI ? [
        // Blob reporter for merging sharded reports
        // See: https://playwright.dev/docs/test-sharding#merging-reports-from-multiple-shards
        ['blob'],
        // Easier to read in the terminal output of the CI itself
        ['dot'],
    ] : [
        // Generate html report in given folder
        ['html', {
            // Disable the report being opened automatically on failure.
            // You can enable it with the PLAYWRIGHT_HTML_OPEN=on-failure env
            // variable if needed.
            open: 'never',
            outputFolder: 'tests/e2e/results',
        }],
    ],

    // 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('/')`
        // See: https://playwright.dev/docs/api/class-testoptions#test-options-base-url
        baseURL: Config.getBaseUrl(),

        // Collect trace when retrying the failed test.
        // See: https://playwright.dev/docs/trace-viewer */
        trace: 'on-first-retry',
    },

    // Folder for test artifacts such as screenshots, videos, traces, etc.
    // See: https://playwright.dev/docs/api/class-testconfig#test-config-output-dir
    // Note: must be different than the `outputFolder` folder specified in the HTML
    // reporter.
    outputDir: 'tests/e2e/output',

    // Test projets, for now we run all our tests in a single projet that uses
    // chromium.
    // See: https://playwright.dev/docs/test-projects
    projects: [
        {
            name: 'chromium',
            use: {
                ...devices['Desktop Chrome'],
                viewport: {
                    width: 1920,
                    height: 1080,
                },
            },
        },
        // Dynamically create a project for each plugin that contains Playwright specs.
        ...globSync('plugins/*/tests/e2e/**/*.spec.ts')
            .map((spec_path) => spec_path.split('/')[1])
            .filter((plugin, index, plugins) => plugins.indexOf(plugin) === index)
            .map((plugin) => ({
                name: `plugin:${plugin}`,
                testDir: `./plugins/${plugin}/tests/e2e/specs`,
                use: {
                    ...devices['Desktop Chrome'],
                    viewport: {
                        width: 1920,
                        height: 1080,
                    },
                },
            })),
    ],
});