Uso con Puppeteer

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Con las APIs de Configuración/Desmontaje Global y Entorno de Pruebas Asíncrono, Jest puede funcionar perfectamente con Puppeteer.

Actualmente no es posible generar cobertura de código para archivos de prueba usando Puppeteer si tus pruebas utilizan page.$eval, page.$$eval o page.evaluate, ya que la función pasada se ejecuta fuera del alcance de Jest. Consulta el issue #7962 en GitHub para conocer una solución alternativa.

Usar el preset jest-puppeteer

Jest Puppeteer proporciona toda la configuración necesaria para ejecutar tus pruebas usando Puppeteer.

1. Primero, instala 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. Especifica el preset en tu configuración de Jest:

{
  "preset": "jest-puppeteer"
}

3. Escribe tu prueba

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

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

No es necesario cargar dependencias adicionales. Las clases page y browser de Puppeteer se expondrán automáticamente

Consulta la documentación.

Ejemplo personalizado sin el preset jest-puppeteer

También puedes integrar Puppeteer manualmente. La idea básica es:

1. Iniciar y guardar el endpoint WebSocket de Puppeteer mediante Configuración Global

2. Conectarse a Puppeteer desde cada Entorno de Pruebas

3. Cerrar Puppeteer con Desmontaje Global

Aquí tienes un ejemplo del script 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());
};

Luego necesitamos un Entorno de Pruebas personalizado para 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 cerrar la instancia de Puppeteer y limpiar el archivo:

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

Con todo configurado, ahora podemos escribir nuestras pruebas así:

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

Finalmente, configura jest.config.js para leer estos archivos. (El preset jest-puppeteer hace algo similar internamente.)

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

Aquí está el código del ejemplo completo funcional.