Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
jest-environment-puppeteer
Advanced tools
Readme
Run your tests using Jest & Puppeteer 🎪✨
npm install jest-environment-puppeteer puppeteer
Update your Jest configuration:
{
"globalSetup": "jest-environment-puppeteer/setup",
"globalTeardown": "jest-environment-puppeteer/teardown",
"testEnvironment": "jest-environment-puppeteer"
}
Use Puppeteer in your tests:
describe("Google", () => {
beforeAll(async () => {
await page.goto("https://google.com");
});
it('should display "google" text on page', async () => {
const text = await page.evaluate(() => document.body.textContent);
expect(text).toContain("google");
});
});
global.browser
Give access to the Puppeteer Browser.
it("should open a new page", async () => {
const page = await browser.newPage();
await page.goto("https://google.com");
});
global.page
Give access to a Puppeteer Page opened at start (you will use it most of time).
it("should fill an input", async () => {
await page.type("#myinput", "Hello");
});
global.context
Give access to a browser context that is instantiated when the browser is launched. You can control whether each test has its own isolated browser context using the browserContext
option in config.
global.jestPuppeteer.debug()
Put test in debug mode.
debugger
instruction to Chromium, if Puppeteer has been launched with { devtools: true }
it will stopit("should put test in debug mode", async () => {
await jestPuppeteer.debug();
});
global.jestPuppeteer.resetPage()
Reset global.page
beforeEach(async () => {
await jestPuppeteer.resetPage();
});
global.jestPuppeteer.resetBrowser()
Reset global.browser, global.context, and global.page
beforeEach(async () => {
await jestPuppeteer.resetBrowser();
});
Jest Puppeteer uses cosmiconfig for configuration file support. This means you can configure Jest Puppeteer via (in order of precedence):
"jest-puppeteer"
key in your package.json
file..jest-puppeteerrc
file written in JSON or YAML..jest-puppeteerrc.json
, .jest-puppeteerrc.yml
, .jest-puppeteerrc.yaml
, or .jest-puppeteerrc.json5
file..jest-puppeteerrc.js
, .jest-puppeteerrc.cjs
, jest-puppeteer.config.js
, or jest-puppeteer.config.cjs
file that exports an object using module.exports
..jest-puppeteerrc.toml
file.By default it looks for config at the root of the project. You can define a custom path using JEST_PUPPETEER_CONFIG
environment variable.
It should export a config object or a Promise that returns a config object.
interface JestPuppeteerConfig {
/**
* Puppeteer connect options.
* @see https://pptr.dev/api/puppeteer.connectoptions
*/
connect?: ConnectOptions;
/**
* Puppeteer launch options.
* @see https://pptr.dev/api/puppeteer.launchoptions
*/
launch?: PuppeteerLaunchOptions;
/**
* Server config for `jest-dev-server`.
* @see https://www.npmjs.com/package/jest-dev-server
*/
server?: JestDevServerConfig | JestDevServerConfig[];
/**
* Allow to run one browser per worker.
* @default false
*/
browserPerWorker?: boolean;
/**
* Browser context to use.
* @default "default"
*/
browserContext?: "default" | "incognito";
/**
* Exit on page error.
* @default true
*/
exitOnPageError?: boolean;
/**
* Use `runBeforeUnload` in `page.close`.
* @see https://pptr.dev/api/puppeteer.page.close
* @default false
*/
runBeforeUnloadOnClose?: boolean;
}
// jest-puppeteer.config.cjs
/** @type {import('jest-environment-puppeteer').JestPuppeteerConfig} */
module.exports = {
launch: {
dumpio: true,
headless: process.env.HEADLESS !== "false",
},
server: {
command: "node server.js",
port: 4444,
launchTimeout: 10000,
debug: true,
},
};
This example uses an already running instance of Chrome by passing the active web socket endpoint to connect
. This is useful, for example, when you want to connect to Chrome running in the cloud.
// jest-puppeteer.config.cjs
const dockerHost = "http://localhost:9222";
async function getConfig() {
const data = await fetch(`${dockerHost}/json/version`).json();
const browserWSEndpoint = data.webSocketDebuggerUrl;
/** @type {import('jest-environment-puppeteer').JestPuppeteerConfig} */
return {
connect: {
browserWSEndpoint,
},
server: {
command: "node server.js",
port: 3000,
launchTimeout: 10000,
debug: true,
},
};
}
module.exports = getConfig();
It is possible to create a custom environment from the Jest Puppeteer's one. It is not different from creating a custom environment from "jest-environment-node". See Jest testEnvironment
documentation to learn more about it.
// my-custom-environment
const JestPuppeteerEnvironment =
require("jest-environment-puppeteer").TestEnvironment;
class CustomEnvironment extends JestPuppeteerEnvironment {
// Implement your own environment
}
Thanks to Fumihiro Xue for his great Jest example.
FAQs
Puppeteer environment for Jest.
The npm package jest-environment-puppeteer receives a total of 149,930 weekly downloads. As such, jest-environment-puppeteer popularity was classified as popular.
We found that jest-environment-puppeteer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.