Verwendung mit Puppeteer

Inoffizielle Beta-Übersetzung

Diese Seite wurde von PageTurner AI übersetzt (Beta). Nicht offiziell vom Projekt unterstützt. Fehler gefunden? Problem melden →

Mit den APIs Global Setup/Teardown und Async Test Environment kann Jest nahtlos mit Puppeteer zusammenarbeiten.

Hinweis

Das Generieren von Code-Coverage für Testdateien mit Puppeteer ist derzeit nicht möglich, wenn Ihr Test page.$eval, page.$$eval oder page.evaluate verwendet, da die übergebene Funktion außerhalb des Jest-Bereichs ausgeführt wird. Siehe Issue #7962 auf GitHub für eine Problemumgehung.

Verwendung der jest-puppeteer-Voreinstellung

Jest Puppeteer bietet alle erforderlichen Konfigurationen, um Ihre Tests mit Puppeteer auszuführen.

1. Installieren Sie zunächst 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. Geben Sie die Voreinstellung in Ihrer Jest-Konfiguration an:

{
  "preset": "jest-puppeteer"
}

3. Schreiben Sie Ihren Test

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

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

Es ist nicht nötig, Abhängigkeiten manuell zu laden. Puppeteers page und browser Klassen werden automatisch verfügbar gemacht.

Siehe Dokumentation.

Benutzerdefiniertes Beispiel ohne jest-puppeteer-Voreinstellung

Sie können Puppeteer auch manuell einrichten. Die grundlegende Vorgehensweise ist:

1. Starten Sie Puppeteer und speichern Sie den Websocket-Endpunkt mit Global Setup

2. Verbinden Sie sich von jeder Testumgebung aus mit Puppeteer

3. Schließen Sie Puppeteer mit Global Teardown

Hier ist ein Beispiel für das GlobalSetup-Skript:

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

Dann benötigen wir eine benutzerdefinierte Testumgebung für 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;

Abschließend können wir die Puppeteer-Instanz schließen und die Datei bereinigen:

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

Nachdem alles eingerichtet ist, können wir unsere Tests wie folgt schreiben:

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

Konfigurieren Sie abschließend jest.config.js zum Lesen dieser Dateien. (Die jest-puppeteer-Voreinstellung macht Ähnliches im Hintergrund.)

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

Hier ist der Code des vollständigen funktionierenden Beispiels.