e2e-playwright-boilerplate/playwright.config.js at develop · hexdee606/e2e-playwright-boilerplate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// @ts-check
/**
 * @fileOverview Playwright Test Configuration
 * @version 1.0.0
 * @author hexdee606
 * @description This configuration file sets up the Playwright testing framework, defining various options such as timeouts, reporters, and project settings.
 */

import {defineConfig} from "@playwright/test";
import {resolve} from "path"
import {platform, arch} from "os"
import "./resources/config/globalEnv.config";
import {defineBddConfig} from "playwright-bdd"

let timeouts = {
    expect_timeout: 2 * 60 * 1000, // set the expect timeout (2 minutes)
    action_timeout: 5 * 1000, // Set a timeout for actions (5 seconds)
    navigation_timeout: 60 * 1000, // Set a maximum timeout for navigation (1 minute)
    slowMo: 2 * 1000 // Slow down actions by this amount (2 seconds)
};

defineBddConfig({
    features: resolve(__dirname, './src/tests/**/features/**/*.feature'),      // Path to feature files
    steps: resolve(__dirname, './src/tests/**/step_definitions/**/*_steps.js'),// Path to step definitions
    statefulPoms: true,                                                     // Enable stateful POMs (Page Object Models)
    outputDir: resolve(__dirname, './src/features-gen'),                    // Output directory for generated files
    verbose: verbose
});

export default defineConfig({
    expect: {
        timeout: timeouts.expect_timeout // Use the timeout from the timeouts object
    },
    workers: 4, // Number of concurrent workers to run tests
    retries: 0, // Number of times to retry failed tests
    reportSlowTests: null, // Configuration for reporting slow tests (null disables this feature)
    reporter: [
        ["list", {printSteps: true}], // Use a list reporter that prints test steps
        ["allure-playwright", {                                             // Allure reporter settings
            details: true,                                                  // Enable detailed logging
            suiteTitle: true,                                               // Enable suite title in reports
            resultsDir: resolve(__dirname, "./resources/test-results/allure-results"),    // Directory for Allure results
            outputFolder: resolve(__dirname, "./resources/test-results/allure-results"),  // Output folder for Allure reports
            environmentInfo: {
                Framework: "Playwright",                                    // Framework used for testing
                OS: platform(),                                             // Operating system of the test execution environment
                Architecture: arch(),                                       // Architecture of the test execution environment
                Node_Version: process.version,                              // Node.js version being used
            },
        }]
    ],
    testDir: "./src/features-gen", // Directory where test files are located
    use: {
        browserName: "chromium", // The browser to run tests on, can be "firefox" or "webkit" as well
        defaultBrowserType: "chromium", // Default browser type for tests
        headless: true, // Default headless mode, modify if needed
        baseURL: envConf.frontend.url, // Base URL for tests
        trace: "retain-on-failure", // Retain trace files only for tests that fail
        video: "retain-on-failure", // Keep video recordings only for tests that fail
        screenshot: "only-on-failure", // Capture screenshots only for tests that fail
        actionTimeout: timeouts.action_timeout, // Set a timeout for actions
        navigationTimeout: timeouts.navigation_timeout, // Set a maximum timeout for navigation
        launchOptions: {
            downloadsPath: "./resources/downloads", // Path to store downloaded files
            chromiumSandbox: false, // Disable the Chromium sandbox (use with caution)
            args: [
                '--start-maximized',
                '--disable-infobars',
                '--disable-popup-blocking',
                '--no-sandbox',
                '--disable-dev-shm-usage',
                '--disable-extensions',
                '--incognito',
                '--enable-automation',
                '--disable-gpu',
                '--allow-file-access-from-files',
                '--enable-logging',
                '--v=1',
            ],
            slowMo: timeouts.slowMo, // Slow down actions by this amount
        },
        contextOptions: {
            permissions: ["storage-access"],
            viewport: {width: 1920, height: 1080} // Set to null for full-screen mode; default is {width: 1920, height: 1080} for standard testing
        },
    },
    projects: [
        {
            name: "suit1",
            grep: /@suit1/,
            outputDir: "./resources/test-results/suit1",
            fullyParallel: false,
        },
        {
            name: "suit2",
            grep: /@suit2/,
            outputDir: "./resources/test-results/suit2",
            fullyParallel: false,
        },
        {
            name: "suit3",
            grep: /@suit3/,
            outputDir: "./resources/test-results/suit3",
            fullyParallel: false,
        },
        {
            name: "suit4",
            grep: /@suit4/,
            outputDir: "./resources/test-results/suit4",
            fullyParallel: false,
        }
    ],
});