jest-electron

Easiest way to run jest unit test cases in electron.

When we run unit test in Jest, it is actually running in the node environment, or virtual browser environment(e.g. JSDOM) mocked by NodeJS. Sometimes we need a lot of Jest mocks for running code with no throw, such as: jest-canvas-mock, jest-storage-mock, @jest/fake-timers and so on. This is solved by Jest-Electron.

1. Technological ecology of Jest.
2. Complete and real browser environment.
3. Multi-renderer for running performance.
4. Running and debug is better then mock.

Installation

• Add into devDependencies

1$ npm i --save-dev jest-electron

• Update Jest config

1{
2  "jest": {
3+    "runner": "jest-electron/runner",
4+    "testEnvironment": "jest-electron/environment"
5  }
6}

Notice: update the runner configure, not testRunner.

Related

Those will be helpful when run test case with jest-electron.

• jest-less-loader: Run test cases with import less, css code.
• jest-url-loader: Run test cases with import svg, png, jpg or other url file..

CI

Run test cases with jest-electron for continuous integration.

• GitHub action

Running on macOS will be ok.

1- runs-on: ubuntu-latest
2+ runs-on: macOS-latest

• travis

Update .travis.yml with electron supported.

1language: node_js
2node_js:
3  - "8"
4  - "9"
5  - "10"
6  - "11"
7  - "12"
8+ addons:
9+   apt:
10+     packages:
11+       - xvfb
12+ install:
13+   - export DISPLAY=':99.0'
14+   - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
15+   - npm install
16script:
17  - npm run test

Depending on your executor, you might need to disable sandbox and shared memory usage:

1export JEST_ELECTRON_STARTUP_ARGS='--disable-dev-shm-usage --no-sandbox'
2npm run test

Env

• debug mode

Keep the electron browser window for debugging, set process env DEBUG_MODE=1.

1DEBUG_MODE=1 jest

• additional startup arguments

Run electron with arbitrary arguments.

1JEST_ELECTRON_STARTUP_ARGS='--disable-dev-shm-usage'

Run electron with --no-sandbox, set process env JEST_ELECTRON_STARTUP_ARGS='--no-sandbox'.

1JEST_ELECTRON_STARTUP_ARGS='--no-sandbox' jest

License

MIT@hustcc.