How do I debug tests with jest-electron?

Set the DEBUG_MODE=1 environment variable when running jest, which keeps the Electron window open for live inspection, allowing you to interact with the browser and debug test failures directly.

jest-electron vs JSDOM: which is better for my project?

Use jest-electron for accurate testing of browser-specific APIs like Canvas or Storage where real browser behavior is critical; JSDOM is better for faster, simpler DOM simulation without the overhead of a full browser.

How to set up jest-electron in GitHub Actions?

Configure your workflow to run on macOS-latest as recommended in the README, or for Linux, set up xvfb and add JEST_ELECTRON_STARTUP_ARGS like --no-sandbox to handle headless execution and sandbox issues.

Can jest-electron run tests without opening a window?

Yes, by default it runs headlessly in CI environments, but for debugging, enable DEBUG_MODE. Headless operation requires proper CI setup with tools like xvfb on Linux.

What are the performance implications of using jest-electron?

jest-electron introduces significant overhead due to launching Electron, making tests slower than JSDOM. The multi-renderer feature helps, but it's still heavier than mocked environments.

Is jest-electron compatible with Jest plugins like snapshot testing?

Yes, since it integrates with Jest's ecosystem, most plugins like snapshot testing should work, but ensure browser APIs don't cause unexpected behavior in snapshots due to real environment differences.

Open-Awesome

jest-electron

MITTypeScriptv0.1.12

A Jest runner and environment that executes unit tests in a real Electron browser environment instead of mocked Node.js.

Visit Website GitHub

155 stars25 forks0 contributors

What is jest-electron?

jest-electron is a Jest runner and test environment that executes JavaScript unit tests within a real Electron browser environment. It solves the problem of needing extensive mocks for browser APIs when running tests in Node.js or JSDOM, providing a more accurate testing context for code that depends on real browser capabilities.

Target Audience

JavaScript developers writing unit tests with Jest for applications or libraries that rely on browser-specific APIs (like Canvas, Storage, or Web APIs) and need a real browser environment for accurate testing.

Value Proposition

Developers choose jest-electron over standard Jest because it eliminates the need for numerous browser API mocks, provides a real Electron environment for more reliable tests, and offers better debugging with the ability to inspect tests in a live browser window.

Overview

❯ ⚛️The easiest way to run and debug test cases in electron with jest.

Use Cases

Best For

Testing JavaScript code that uses Canvas or WebGL APIs
Unit testing libraries that depend on real browser Storage APIs
Debugging Jest tests in a live browser window
Running tests that require accurate timer or animation behavior
Improving test reliability by reducing mock dependencies
Continuous integration testing with Electron on macOS

Not Ideal For

Projects testing pure Node.js modules with no browser API dependencies
Teams prioritizing fast test execution where JSDOM's lightweight simulation is sufficient
Continuous integration environments that cannot support Electron, such as headless Linux servers without xvfb setup
Developers needing cross-browser testing beyond Electron's specific implementation

Pros & Cons

Pros

Real Browser Context

Provides a complete Electron browser environment, eliminating the need for numerous Jest mocks like jest-canvas-mock for accurate testing of browser APIs, as highlighted in the README.

Enhanced Debugging

Allows keeping the Electron window open with DEBUG_MODE=1, enabling live inspection and better debugging compared to mocked environments, as specified in the env section.

Performance Boost

Supports multiple renderer processes for improved test execution performance in the browser context, a key feature mentioned in the README.

Seamless Jest Integration

Integrates easily into existing Jest setups with simple configuration changes to runner and testEnvironment, requiring no major overhaul.

Cons

Complex CI Setup

Requires specific OS configurations like macOS or xvfb on Linux, and additional arguments such as --no-sandbox, making CI/CD pipeline setup more involved and error-prone.

Performance Overhead

Running a full Electron instance for tests is significantly slower than lightweight alternatives like JSDOM, impacting test suite speed and resource usage.

Electron Limitations

Tests are confined to the Electron browser environment, which may have subtle differences from other browsers, limiting accurate cross-browser testing and potentially missing issues.

Frequently Asked Questions

Related Projects

nativefier

Make any web page a desktop application

Stars35,304

Forks2,240

Last commit2 years ago

Reactotron

A desktop app for inspecting your React JS and React Native projects. macOS, Linux, and Windows.

Stars15,578

Forks971

Last commit1 month ago

electron-pdf

📄 A command line tool to generate PDF from URL, HTML or Markdown files.

Stars1,291

Forks141

Last commit5 months ago

electron-mocha

Run Mocha tests in Electron

Stars345

Forks64

Last commit8 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub