版本：30.0

配合 Puppeteer 使用

非官方测试版翻译

本页面由 PageTurner AI 翻译（测试版）。未经项目官方认可。发现错误？报告问题 →

通过全局设置/拆卸和异步测试环境 API，Jest 可以与 Puppeteer 无缝协作。

备注

如果测试中使用了 page.$eval、page.$$eval 或 page.evaluate，则目前无法为使用 Puppeteer 的测试文件生成代码覆盖率，因为传入的函数是在 Jest 的作用域之外执行的。请查看 GitHub 上的 issue #7962 获取解决方案。

使用 jest-puppeteer 预设

Jest Puppeteer 提供了运行 Puppeteer 测试所需的所有配置。

首先安装 jest-puppeteer

npm
Yarn
pnpm
Bun

npm install --save-dev jest-puppeteer

yarn add --dev jest-puppeteer

pnpm add --save-dev jest-puppeteer

bun add --dev jest-puppeteer

在 Jest 配置中指定预设：

{
  "preset": "jest-puppeteer"
}

编写测试

describe('Google', () => {
  beforeAll(async () => {
    await page.goto('https://google.com');
  });

  it('should be titled "Google"', async () => {
    await expect(page.title()).resolves.toMatch('Google');
  });
});

无需加载任何依赖。Puppeteer 的 page 和 browser 类将自动可用

参见文档。

不使用 jest-puppeteer 预设的自定义示例

你也可以从头配置 Puppeteer 集成。基本思路是：

通过全局设置启动 Puppeteer 并记录其 WebSocket 端点
从每个测试环境连接到 Puppeteer
通过全局拆卸关闭 Puppeteer

以下是 GlobalSetup 脚本的示例

setup.js
const {mkdir, writeFile} = require('fs').promises;
const os = require('os');
const path = require('path');
const puppeteer = require('puppeteer');

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');

module.exports = async function () {
  const browser = await puppeteer.launch();
  // store the browser instance so we can teardown it later
  // this global is only available in the teardown but not in TestEnvironments
  globalThis.__BROWSER_GLOBAL__ = browser;

  // use the file system to expose the wsEndpoint for TestEnvironments
  await mkdir(DIR, {recursive: true});
  await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint());
};

接着我们需要为 Puppeteer 创建自定义测试环境

puppeteer_environment.js
const {readFile} = require('fs').promises;
const os = require('os');
const path = require('path');
const puppeteer = require('puppeteer');
const NodeEnvironment = require('jest-environment-node').TestEnvironment;

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');

class PuppeteerEnvironment extends NodeEnvironment {
  constructor(config) {
    super(config);
  }

  async setup() {
    await super.setup();
    // get the wsEndpoint
    const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8');
    if (!wsEndpoint) {
      throw new Error('wsEndpoint not found');
    }

    // connect to puppeteer
    this.global.__BROWSER_GLOBAL__ = await puppeteer.connect({
      browserWSEndpoint: wsEndpoint,
    });
  }

  async teardown() {
    if (this.global.__BROWSER_GLOBAL__) {
      this.global.__BROWSER_GLOBAL__.disconnect();
    }
    await super.teardown();
  }

  getVmContext() {
    return super.getVmContext();
  }
}

module.exports = PuppeteerEnvironment;

最后关闭 Puppeteer 实例并清理文件

teardown.js
const fs = require('fs').promises;
const os = require('os');
const path = require('path');

const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');
module.exports = async function () {
  // close the browser instance
  await globalThis.__BROWSER_GLOBAL__.close();

  // clean-up the wsEndpoint file
  await fs.rm(DIR, {recursive: true, force: true});
};

完成所有设置后，可以按如下方式编写测试：

test.js
const timeout = 5000;

describe(
  '/ (Home Page)',
  () => {
    let page;
    beforeAll(async () => {
      page = await globalThis.__BROWSER_GLOBAL__.newPage();
      await page.goto('https://google.com');
    }, timeout);

    it('should load without error', async () => {
      const text = await page.evaluate(() => document.body.textContent);
      expect(text).toContain('google');
    });
  },
  timeout,
);

最后配置 jest.config.js 读取这些文件（jest-puppeteer 预设底层也是类似实现）

module.exports = {
  globalSetup: './setup.js',
  globalTeardown: './teardown.js',
  testEnvironment: './puppeteer_environment.js',
};

这里是完整可运行示例的代码。

使用 jest-puppeteer 预设​

不使用 jest-puppeteer 预设的自定义示例​

使用 jest-puppeteer 预设

不使用 jest-puppeteer 预设的自定义示例