Bruke med puppeteer

Unofficial Beta Translation

This page was AI-translated by PageTurner (beta). Not officially endorsed by the project. Found an error? Report issue →

Med Global oppsett/avslutning og Asynkront testmiljø API-er kan Jest fungere sømløst med puppeteer.

notat

Generering av kodedekning for testfiler med Puppeteer er for øyeblikket ikke mulig hvis testen din bruker page.$eval, page.$$eval eller page.evaluate, da den overførte funksjonen kjøres utenfor Jest sin rekkevidde. Se sak #7962 på GitHub for en løsning.

Bruk jest-puppeteer forhåndsinnstilling

Jest Puppeteer tilbyr all nødvendig konfigurasjon for å kjøre testene dine med Puppeteer.

1. Installer først 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. Spesifiser forhåndsinnstilling i din Jest-konfigurasjon:

{
  "preset": "jest-puppeteer"
}

3. Skriv testen din

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

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

Du trenger ikke laste inn noen avhengigheter. Puppeteers page og browser klasser vil automatisk være tilgjengelige

Se dokumentasjonen.

Tilpasset eksempel uten jest-puppeteer forhåndsinnstilling

Du kan også koble til Puppeteer fra bunnen av. Grunnideen er å:

1. starte og lagre websocket-endepunktet til Puppeteer med Globalt oppsett

2. koble til Puppeteer fra hvert testmiljø

3. lukke Puppeteer med Global avslutning

Her er et eksempel på GlobalSetup-skriptet

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

Deretter trenger vi et tilpasset testmiljø for 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;

Til slutt kan vi lukke Puppeteer-forekomsten og rydde opp i filen

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

Når alt er satt opp, kan vi nå skrive testene våre slik:

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

Til slutt, konfigurer jest.config.js til å lese fra disse filene. (jest-puppeteer-forhåndsinnstillingen gjør noe lignende under panseret.)

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

Her er koden for fullt fungerende eksempel.