Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hustcc/jest-electron
❯ ⚛️The easiest way to run and debug test cases in electron with jest.
https://github.com/hustcc/jest-electron
debugger electron jest jest-electron jest-runner
Last synced: 8 days ago
JSON representation
❯ ⚛️The easiest way to run and debug test cases in electron with jest.
- Host: GitHub
- URL: https://github.com/hustcc/jest-electron
- Owner: hustcc
- License: mit
- Created: 2019-09-05T02:20:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-01T09:33:03.000Z (over 2 years ago)
- Last Synced: 2024-04-26T17:41:28.278Z (6 months ago)
- Topics: debugger, electron, jest, jest-electron, jest-runner
- Language: TypeScript
- Homepage: https://github.com/hustcc/jest-electron
- Size: 51.8 KB
- Stars: 154
- Watchers: 5
- Forks: 25
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-electron - jest-electron - Run and debug Jest unit tests in a browser environment. (Tools / Using Electron)
- awesome-electron - jest-electron - Run and debug Jest unit tests in a browser environment.  (Library / Testing)
README
# 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](https://github.com/jest-community/awesome-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`.
[](https://github.com/hustcc/jest-electron/actions)
[](https://www.npmjs.com/package/jest-electron)
[](https://www.npmjs.com/package/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
```bash
$ npm i --save-dev jest-electron
```
- Update Jest config
```diff
{
"jest": {
+ "runner": "jest-electron/runner",
+ "testEnvironment": "jest-electron/environment"
}
}
```
**Notice**: update the `runner` configure, not `testRunner`.
## Related
> Those will be helpful when run test case with `jest-electron`.
- [jest-less-loader](https://github.com/hustcc/jest-less-loader): Run test cases with import `less`, `css` code.
- [jest-url-loader](https://github.com/hustcc/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.
```diff
- runs-on: ubuntu-latest
+ runs-on: macOS-latest
```
- **travis**
Update `.travis.yml` with electron supported.
```diff
language: node_js
node_js:
- "8"
- "9"
- "10"
- "11"
- "12"
+ addons:
+ apt:
+ packages:
+ - xvfb
+ install:
+ - export DISPLAY=':99.0'
+ - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
+ - npm install
script:
- npm run test
```
Depending on your executor, you might need to disable sandbox and shared memory usage:
```bash
export JEST_ELECTRON_STARTUP_ARGS='--disable-dev-shm-usage --no-sandbox'
npm run test
```
## Env
- **debug mode**
Keep the electron browser window for debugging, set process env `DEBUG_MODE=1`.
```bash
DEBUG_MODE=1 jest
```
- **additional startup arguments**
Run electron with arbitrary arguments.
```bash
JEST_ELECTRON_STARTUP_ARGS='--disable-dev-shm-usage'
```
Run electron with `--no-sandbox`, set process env `JEST_ELECTRON_STARTUP_ARGS='--no-sandbox'`.
```bash
JEST_ELECTRON_STARTUP_ARGS='--no-sandbox' jest
```
## License
MIT@[hustcc](https://github.com/hustcc).