e2ed/autotests/hooks/isTestSkipped.ts

E2E testing framework over Playwright

import {getFullPackConfig} from '../utils/getFullPackConfig';

import type {IsTestSkipped} from 'autotests/configurator';

/**
 * This hook is used to determine if a given test should be skipped.
 * Skipped tests are displayed in the HTML report with the corresponding "skipped" status,
 * and with skip reason.
 */
export const isTestSkipped: IsTestSkipped = (testStaticOptions) => {
  // As with all hooks, you can replace it with your own implementation.
  const {options} = testStaticOptions;
  const {skipTests = []} = getFullPackConfig();

  if ('skipAll' in skipTests) {
    return {isSkipped: true, reason: skipTests.reason};
  }

  const group = skipTests.find(({testIds}) => testIds.includes(options.meta.testId));

  if (group) {
    return {isSkipped: true, reason: group.reason};
  }

  return {isSkipped: false};
};