Utilizzo con Puppeteer

Traduzione Beta Non Ufficiale

Questa pagina è stata tradotta da PageTurner AI (beta). Non ufficialmente approvata dal progetto. Hai trovato un errore? Segnala problema →

Grazie alle API Global Setup/Teardown e Async Test Environment, Jest può funzionare perfettamente con Puppeteer.

nota

Attualmente non è possibile generare la copertura del codice per i file di test utilizzando Puppeteer se il tuo test usa page.$eval, page.$$eval o page.evaluate, poiché la funzione passata viene eseguita al di fuori dello scope di Jest. Consulta l'issue #7962 su GitHub per una soluzione alternativa.

Usa il preset jest-puppeteer

Jest Puppeteer fornisce tutta la configurazione necessaria per eseguire i tuoi test utilizzando Puppeteer.

1. Per prima cosa, installa 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. Specifica il preset nella tua configurazione Jest:

{
  "preset": "jest-puppeteer"
}

3. Scrivi il tuo test

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

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

Non è necessario caricare alcuna dipendenza. Le classi page e browser di Puppeteer verranno esposte automaticamente

Consulta la documentazione.

Esempio personalizzato senza preset jest-puppeteer

Puoi anche configurare Puppeteer da zero. L'idea di base è:

1. avviare e salvare l'endpoint WebSocket di Puppeteer con Global Setup

2. connettersi a Puppeteer da ogni Test Environment

3. chiudere Puppeteer con Global Teardown

Ecco un esempio dello 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());
};

Poi abbiamo bisogno di un Test Environment personalizzato per 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;

Infine, possiamo chiudere l'istanza di Puppeteer e pulire il file

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 tutto configurato, ora possiamo scrivere i nostri test così:

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

Infine, configura jest.config.js per leggere questi file. (Il preset jest-puppeteer fa qualcosa di simile dietro le quinte.)

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

Ecco il codice di un esempio funzionante completo.