Using with puppeteer

    Jest Puppeteer provides all required configuration to run your tests using Puppeteer.

    1. First, install jest-puppeteer
    • npm
    • Yarn
    1. yarn add --dev jest-puppeteer
    1. Specify preset in your :
    1. {
    2.   "preset": "jest-puppeteer"
    3. }
    1. Write your test

    There’s no need to load any dependencies. There’s no need to load any dependencies. Puppeteer’s page and browser classes will automatically be exposed

    See documentation.

    Custom example without jest-puppeteer preset

    1. launch & file the websocket endpoint of puppeteer with Global Setup
    2. connect to puppeteer from each Test Environment
    3. close puppeteer with Global Teardown

    Here’s an example of the GlobalSetup script

    setup.js

    1. const {mkdir, writeFile} = require('fs').promises;
    2. const os = require('os');
    3. const path = require('path');
    4. const puppeteer = require('puppeteer');
    6. const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');
    8. module.exports = async function () {
    9.   const browser = await puppeteer.launch();
    10.   // store the browser instance so we can teardown it later
    11.   // this global is only available in the teardown but not in TestEnvironments
    12.   globalThis.__BROWSER_GLOBAL__ = browser;
    14.   // use the file system to expose the wsEndpoint for TestEnvironments
    15.   await mkdir(DIR, {recursive: true});
    16. };

    Then we need a custom Test Environment for puppeteer

    puppeteer_environment.js

    1. const {readFile} = require('fs').promises;
    2. const os = require('os');
    3. const path = require('path');
    5. const NodeEnvironment = require('jest-environment-node').default;
    7. const DIR = path.join(os.tmpdir(), 'jest_puppeteer_global_setup');
    9. class PuppeteerEnvironment extends NodeEnvironment {
    10.   constructor(config) {
    11.     super(config);
    12.   }
    14.   async setup() {
    15.     await super.setup();
    16.     // get the wsEndpoint
    17.     const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8');
    18.     if (!wsEndpoint) {
    19.       throw new Error('wsEndpoint not found');
    20.     }
    22.     // connect to puppeteer
    23.     this.global.__BROWSER_GLOBAL__ = await puppeteer.connect({
    24.       browserWSEndpoint: wsEndpoint,
    25.     });
    26.   }
    28.   async teardown() {
    29.   }
    31.   getVmContext() {
    32.     return super.getVmContext();
    34. }
    36. module.exports = PuppeteerEnvironment;

    teardown.js

    With all the things set up, we can now write our tests like this:

    test.js

    1. const timeout = 5000;
    3. describe(
    4.   '/ (Home Page)',
    5.   () => {
    6.     let page;
    7.     beforeAll(async () => {
    8.       page = await globalThis.__BROWSER_GLOBAL__.newPage();
    9.       await page.goto('https://google.com');
    10.     }, timeout);
    12.     it('should load without error', async () => {
    13.       const text = await page.evaluate(() => document.body.textContent);
    14.       expect(text).toContain('google');
    15.     });
    16.   },
    17.   timeout,
    18. );

    Finally, set jest.config.js to read from these files. (The jest-puppeteer preset does something like this under the hood.) (The jest-puppeteer preset does something like this under the hood.)

    1. module.exports = {
    2.   globalSetup: './setup.js',
    3.   globalTeardown: './teardown.js',
    4. };