Usando com puppeteer

Tradução Beta Não Oficial

Esta página foi traduzida por PageTurner AI (beta). Não é oficialmente endossada pelo projeto. Encontrou um erro? Reportar problema →

Com as APIs de Configuração/Encerramento Global e Ambiente de Teste Assíncrono, o Jest pode funcionar perfeitamente com o puppeteer.

"message": "nota"

Atualmente não é possível gerar cobertura de código para arquivos de teste usando Puppeteer se seu teste utilizar page.$eval, page.$$eval ou page.evaluate, pois a função passada é executada fora do escopo do Jest. Confira a issue #7962 no GitHub para uma solução alternativa.

Usando o preset jest-puppeteer

O Jest Puppeteer fornece toda a configuração necessária para executar seus testes usando o Puppeteer.

1. Primeiro, instale o jest-puppeteer

npm

npm install --save-dev jest-puppeteer

Yarn

yarn add --dev jest-puppeteer

pnpm

pnpm add --save-dev jest-puppeteer

Bun

bun add --dev jest-puppeteer

2. Especifique o preset na sua configuração do Jest:

{
  "preset": "jest-puppeteer"
}

3. Escreva seu teste

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

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

Não é necessário carregar dependências adicionais. As classes page e browser do Puppeteer serão automaticamente expostas

Consulte a documentação.

Exemplo personalizado sem o preset jest-puppeteer

Você também pode conectar o Puppeteer manualmente. A ideia básica é:

1. Iniciar e registrar o endpoint websocket do Puppeteer usando Configuração Global

2. Conectar ao Puppeteer a partir de cada Ambiente de Teste

3. Encerrar o Puppeteer com o Encerramento Global

Aqui está um exemplo de script de Configuração Global:

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());
};

Em seguida, precisamos de um Ambiente de Teste personalizado para o 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;

Finalmente, podemos encerrar a instância do Puppeteer e limpar o arquivo

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});
};

Com tudo configurado, agora podemos escrever nossos testes assim:

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,
);

Por fim, configure o jest.config.js para ler esses arquivos. (O preset jest-puppeteer faz algo semelhante internamente.)

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

Aqui está o código do exemplo completo funcional.