如何在不影响生命周期的前提下排除Playwright项目级Setup/Teardown测试的报告统计？

问题背景 #

Playwright的项目级依赖和teardown机制支持范围化的环境准备、清理配置，示例代码如下：

projects: [
  {
    name: 'setup',
    testMatch: /.*\.setup\.ts/
  },
  {
    name: 'my-project',
    dependencies: ['setup'],
    teardown: 'teardown'
  },
  {
    name: 'teardown',
    testMatch: /.*\.teardown\.ts/
  }
]

但这类setup/teardown项目里的逻辑必须套在test()块中，才能保证生命周期的正确执行顺序。可这么做会把准备/清理步骤当成普通测试用例统计，带来一堆问题：

• 计入总测试数量
• 出现在HTML报告、CI仪表板、ReportPortal等各类报告里
• 除非手动过滤，否则没法和功能测试区分开
• 造成统计误导，比如显示“运行100个测试”，实际只有98个是正经功能测试

之前试过用IIFE替代test()块，但代码会在运行一开始就执行，完全不遵循配置好的生命周期顺序，根本行不通。

可行解决方案 #

方法1：为setup/teardown项目单独配置空报告器 #

这是最直接的办法，给setup和teardown项目单独设置空报告器，让它们的执行完全不被统计到报告里，同时不影响生命周期顺序：

projects: [
  {
    name: 'setup',
    testMatch: /.*\.setup\.ts/,
    reporter: [] // 不生成任何报告统计
  },
  {
    name: 'my-project',
    dependencies: ['setup'],
    teardown: 'teardown',
    reporter: [['html'], ['json']] // 正常生成功能测试报告
  },
  {
    name: 'teardown',
    testMatch: /.*\.teardown\.ts/,
    reporter: [] // 不生成任何报告统计
  }
]

方法2：给setup/teardown测试添加注解，过滤报告 #

在setup/teardown的test()块里添加自定义注解，然后在全局报告配置里过滤掉带该注解的测试：
首先在setup/teardown文件中标记测试：

import { test } from '@playwright/test';

test('setup environment', async ({}) => {
  // 这里写你的环境准备逻辑
}, {
  annotation: [{ type: 'skip-report', description: '仅用于环境准备的步骤' }]
});

然后在Playwright全局配置里，给报告器添加过滤规则：

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['html', { open: 'never' }],
    ['json', { outputFile: 'test-results.json' }],
    ['list', {
      // 过滤掉带skip-report注解的测试
      filter: (test) => !test.annotations.some(item => item.type === 'skip-report')
    }]
  ],
  // 其他配置项...
});

注：部分第三方报告工具可能需要额外配置才能识别并过滤这类注解。

方法3：封装专属的setup/teardown测试函数 #

封装一个专门用于环境准备/清理的测试函数，自动带上排除报告的注解，避免重复写配置：

import { test as baseTest } from '@playwright/test';

// 封装自动带skip-report注解的测试函数
export const setupTest = baseTest.extend({});

// 使用封装后的函数写setup逻辑
setupTest('初始化测试环境', async ({}) => {
  // 这里写你的setup逻辑
}, { annotation: [{ type: 'skip-report' }] });

之后所有用setupTest定义的步骤都会自动标记为排除报告，管理起来更省心。

内容的提问来源于stack exchange，提问作者טל שטרנשוס