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

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

import {Page, ViewportSize} from '@playwright/test';
import * as dotenv from 'dotenv';

import {appsPluginId, callsPluginId} from '@e2e-support/constant';

dotenv.config();

export type TestArgs = {
    page: Page;
    browserName: string;
    viewport?: ViewportSize | null;
};

export type TestConfig = {
    // Server
    baseURL: string;
    adminUsername: string;
    adminPassword: string;
    adminEmail: string;
    ensurePluginsInstalled: string[];
    resetBeforeTest: boolean;
    haClusterEnabled: boolean;
    haClusterNodeCount: number;
    haClusterName: string;
    // CI
    isCI: boolean;
    // Playwright
    headless: boolean;
    slowMo: number;
    workers: number;
    // Visual tests
    snapshotEnabled: boolean;
    percyEnabled: boolean;
    percyToken?: string;
};

// All process.env should be defined here
const config: TestConfig = {
    // Server
    baseURL: process.env.PW_BASE_URL || 'http://localhost:8065',
    adminUsername: process.env.PW_ADMIN_USERNAME || 'sysadmin',
    adminPassword: process.env.PW_ADMIN_PASSWORD || 'Sys@dmin-sample1',
    adminEmail: process.env.PW_ADMIN_EMAIL || 'sysadmin@sample.mattermost.com',
    ensurePluginsInstalled:
        typeof process.env?.PW_ENSURE_PLUGINS_INSTALLED === 'string'
            ? process.env.PW_ENSURE_PLUGINS_INSTALLED.split(',')
            : [appsPluginId, callsPluginId],
    haClusterEnabled: parseBool(process.env.PW_HA_CLUSTER_ENABLED, false),
    haClusterNodeCount: parseNumber(process.env.PW_HA_CLUSTER_NODE_COUNT, 2),
    haClusterName: process.env.PW_HA_CLUSTER_NAME || 'mm_dev_cluster',
    resetBeforeTest: parseBool(process.env.PW_RESET_BEFORE_TEST, false),
    // CI
    isCI: !!process.env.CI,
    // Playwright
    headless: parseBool(process.env.PW_HEADLESS, true),
    slowMo: parseNumber(process.env.PW_SLOWMO, 0),
    workers: parseNumber(process.env.PW_WORKERS, 1),
    // Visual tests
    snapshotEnabled: parseBool(process.env.PW_SNAPSHOT_ENABLE, false),
    percyEnabled: parseBool(process.env.PW_PERCY_ENABLE, false),
    percyToken: process.env.PERCY_TOKEN,
};

function parseBool(actualValue: string | undefined, defaultValue: boolean) {
    return actualValue ? actualValue === 'true' : defaultValue;
}

function parseNumber(actualValue: string | undefined, defaultValue: number) {
    return actualValue ? parseInt(actualValue, 10) : defaultValue;
}

export default config;