playwright.config.ts

import { PlaywrightTestConfig, devices, expect } from "@playwright/test";
import dotenv from "dotenv";

dotenv.config();

const config: PlaywrightTestConfig = {
  globalSetup: "./global-setup",
  globalTeardown: "./global-teardown",
  projects: [
    {
      name: "projectA",
      use: { ...devices.use, browserName: "chromium" },
    },
    {
      name: "flakey",
      testMatch: /flakey.fail.ts/,
      use: {
        ...devices.use,
        browserName: "chromium",
      },
    },
  ],

  use: {
    baseURL: process.env.APP_URL,
    browserName: "chromium",
    headless: true,
    permissions: ["clipboard-read"],
    // userAgent: "some custom ua",
    navigationTimeout: 10000,
    actionTimeout: 5000,
    launchOptions: {
      args: [
        "--disable-dev-shm-usage",
        "--no-sandbox",
        "--disable-setuid-sandbox",
        "--disable-gpu",
      ],
    },
    screenshot: "on",
    viewport: { width: 1280, height: 720 },
    ignoreHTTPSErrors: true,
    video: "on",
    trace: "on",
    // extraHTTPHeaders: { playwright: "yes" },
    testIdAttribute: "data-qa",
  },
  testDir: "./tests",
  snapshotPathTemplate:
    "{testDir}/.screenshots/{testFilePath}/{platform}-{projectName}{arg}{ext}",
  retries: 1,
  workers: 2,
  // grep: /@happy|@smoke/,
  reporter: process.env.CI
    ? [
        [
          "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
          {
            channels: ["slack-testing"], // provide one or more Slack channels
            sendResults: "always", // "always" , "on-failure", "off"
          },
        ],
        ["dot"],
        ["list"],
        ["html"],
        ["playwright-json-summary-reporter"],
        ["blob"],
        ["@currents/playwright"],
      ]
    : [
        ["list"],
        ["html", { open: "never" }],
        ["playwright-json-summary-reporter"],
        ["blob"],
      ],
  forbidOnly: !!process.env.CI, //This will fail if 'test.only' is committed to repo
};

expect.extend({
  toBeString(received: string) {
    const check = typeof received == "string";

    if (check) {
      return {
        message: () => "passed",
        pass: true,
      };
    } else {
      return {
        message: () =>
          `toBeString() assertion failed.\nYou expected '${received}' to be a string but it's a ${typeof received}\n`,
        pass: false,
      };
    }
  },
});

expect.extend({
  toBeOneOfValues(received: any, array: any[]) {
    const check = array.includes(received);

    if (check) {
      return {
        message: () => "passed",
        pass: true,
      };
    } else {
      return {
        message: () =>
          `toBeOneOfValues() assertion failed.\nYou expected [${array}] to include '${received}'\n`,
        pass: false,
      };
    }
  },
});

expect.extend({
  toBeValidDate(received: string) {
    const pass =
      Date.parse(received) && typeof received === "string" ? true : false;
    if (pass) {
      return {
        message: () => "passed",
        pass: true,
      };
    } else {
      return {
        message: () =>
          `toBeValidDate() assertion failed.\nYou expected '${received}' to be a valid date.\n`,
        pass: false,
      };
    }
  },
});

export default config;