Skip to main content
Version: 21.5.2

Puppeteer Angular Schematic

Adds Puppeteer-based e2e tests to your Angular project.

Getting started

Run the command below in an Angular CLI app directory and follow the prompts.

Note this will add the schematic as a dependency to your project.

ng add @puppeteer/ng-schematics

Or you can use the same command followed by the options below.

Currently, this schematic supports the following test runners:

With the schematics installed you can run E2E tests:

ng e2e


When adding schematics to your project you can to provide following options:

--testRunnerThe testing framework to install along side Puppeteer."jasmine", "jest", "mocha", "node"true

Creating a single test file

Puppeteer Angular Schematic exposes a method to create a single test file.

ng generate @puppeteer/ng-schematics:test "<TestName>"

Running test server and dev server at the same time

By default the E2E test will run the app on the same port as ng start. To avoid this you can specify the port the an the angular.json Update either e2e or puppeteer (depending on the initial setup) to:

"e2e": {
"builder": "@puppeteer/ng-schematics:puppeteer",
"options": {
"commands": [...],
"devServerTarget": "sandbox:serve",
"testRunner": "<TestRunner>",
"port": 8080

Now update the E2E test file utils.ts baseUrl to:

const baseUrl = 'http://localhost:8080';


Check out our contributing guide to get an overview of what you need to develop in the Puppeteer repo.


For easier development we provide a script to auto-generate the Angular project to test against. Simply run:

npm run sandbox -- --init

After that to run @puppeteer/ng-schematics against the Sandbox Angular project run:

npm run sandbox
# or to auto-build and then run schematics
npm run sandbox -- --build

To run the creating of single test schematic:

npm run sandbox:test

To create a multi project workspace use the following command

npm run sandbox -- --init --multi

Unit Testing

The schematics utilize @angular-devkit/schematics/testing for verifying correct file creation and package.json updates. To execute the test suit:

npm run test

Migrating from Protractor


Puppeteer has its own browser that exposes different API compared to the one exposed by Protractor.

import puppeteer from 'puppeteer';

(async () => {
const browser = await puppeteer.launch();

it('should work', () => {
const page = await browser.newPage();

// Query elements
const element = await page.$('my-component');

// Do actions

await browser.close();

Query Selectors

Puppeteer supports multiple types of selectors, namely, the CSS, ARIA, text, XPath and pierce selectors. The following table shows Puppeteer's equivalents to Protractor By.

For improved reliability and reduced flakiness try our Experimental Locators API

ByProtractor codePuppeteer querySelector
CSS (Single)$(by.css('<CSS>'))page.$('<CSS>')
CSS (Multiple)$$(by.css('<CSS>'))page.$$('<CSS>')
CssContainingText$(by.cssContainingText('<CSS>', '<TEXT>'))page.$('<CSS> ::-p-text(<TEXT>)') `
DeepCss$(by.deepCss('<CSS>'))page.$(':scope >>> <CSS>')
JS$(by.js('document.querySelector("<CSS>")'))page.evaluateHandle(() => document.querySelector('<CSS>'))

For advanced use cases such as Protractor's by.addLocator you can check Puppeteer's Custom selectors.