与 Puppeteer 一起使用

使用 全局设置/拆卸 和 异步测试环境 API，Jest 可以与 Puppeteer 顺利协作。

注意

如果您的测试使用 page.$eval、page.$$eval 或 page.evaluate，则目前无法为使用 Puppeteer 的测试文件生成代码覆盖率，因为传递的函数是在 Jest 范围之外执行的。查看 GitHub 上的 问题 #7962 以了解解决方法。

使用 jest-puppeteer 预设

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

1. 首先，安装 jest-puppeteer

npm

npm install --save-dev jest-puppeteer

Yarn

yarn add --dev jest-puppeteer

pnpm

pnpm add --save-dev jest-puppeteer

2. 在您的 Jest 配置 中指定预设

{
  "preset": "jest-puppeteer"
}

3. 编写您的测试

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。基本思路是

1. 使用全局设置启动并记录 Puppeteer 的 websocket 端点
2. 从每个测试环境连接到 Puppeteer
3. 使用全局拆卸关闭 Puppeteer

以下是一个全局设置脚本示例

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',
};

以下是 完整工作示例 的代码。