@hypersprite/jest-runner-electron v3.0.0

@hypersprite/jest-electron-runner - quick and dirty sub in for running old code in Electron 11

Note, this will be depreciated when the parent is updated to work or we no longer need this.

Has the following settings:

app.allowRendererProcessReuse = false;

const win = new BrowserWindow({
  show: false, // (@jest-runner/electron package default)
  webPreferences: {
    // nodeIntegration is turned off by default since Electron 5
    nodeIntegration: true, // (@jest-runner/electron package default)
    // https://github.com/electron/electron/blob/master/docs/tutorial/context-isolation.md
    contextIsolation: false,
    // https://www.electronjs.org/docs/breaking-changes#default-changed-enableremotemodule-defaults-to-false
    enableRemoteModule: true,
  },
});

Setup:

clone repo then

yarn
git submodule init
git submodule update
cd fiddle && yarn
cd ../ && yarn build
yarn test

if you make changes,

yarn build
yarn test

again

Currently there are a lot of test failing, the main reason to run the test is to make sure it can run. Have not spent time to investigate these.

Current results:

Test Suites: 37 failed, 36 passed, 73 total
Tests:       3 failed, 1 skipped, 102 passed, 106 total
Snapshots:   3 failed, 11 passed, 14 total
Time:        72.776s

Only publishing the electron package.

Note: all of this below is from the original readme

Jest electron runner

A custom test runner for Jest that runs tests inside an electron main or renderer process providing the following benefits:

• Main

  • all electron instance modules (ipc, app, etc)

• Renderer

  • full access to a browser environment without the need for jsdom or similar modules

Getting Started

NOTE: for jest@23 use the older version ~@jest-runner/electron@0.2.2

1. Install jest electron runner yarn add @jest-runner/electron --dev

2. Add one of these lines to your jest config (in package.json or inside your jest.config.js file), depending on the process you wish to test. If you wish to test them in parallel, see the tips section below.

   • Main process

       {
         // ...
         runner: '@jest-runner/electron/main',
         testEnvironment: 'node',
       }

   • Renderer Process

       {
         // ...
         runner: '@jest-runner/electron',
         testEnvironment: '@jest-runner/electron/environment',
       }

3. run jest!

Debugging

Normally jest-electron-runner runs a headless instance of electron when testing the renderer process. You may show the UI by adding this to your test:

require('electron').remote.getCurrentWindow().show();

Tips

• The main process runner can be used to test any non-browser related code, which can speed up tests roughly 2x.
• To run the main and renderer process tests in parallel, you can provide a config object to the projects array in a jest javascript config file like so:

// jest.config.js
const common = require('./jest.common.config')

module.exports = {
  projects: [
    {
      ...common,
      runner: '@jest-runner/electron/main',
      testEnvironment: 'node',
      testMatch: ['**/__tests__/**/*.(spec|test).ts']
    },
    {
      ...common,
      runner: '@jest-runner/electron',
      testEnvironment: '@jest-runner/electron/environment',
      testMatch: ['**/__tests__/**/*.(spec|test).tsx']
    }
  ]
}

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Jest.

License

MIT licensed.