test: use node helpers for events.once and setTimeout promise (#37374)
This commit is contained in:
Jeremy Rose
GitHub
parent
46c8b9c728
commit
a3e3efe4c4
47 changed files with 932 additions and 927 deletions
|
|
@ -2,9 +2,9 @@ import { expect } from 'chai';
|
|||
import * as childProcess from 'child_process';
|
||||
import * as path from 'path';
|
||||
import { BrowserWindow, MessageChannelMain, utilityProcess } from 'electron/main';
|
||||
import { emittedOnce } from './lib/events-helpers';
|
||||
import { ifit } from './lib/spec-helpers';
|
||||
import { closeWindow } from './lib/window-helpers';
|
||||
import { once } from 'events';
|
||||
|
||||
const fixturesPath = path.resolve(__dirname, 'fixtures', 'api', 'utility-process');
|
||||
const isWindowsOnArm = process.platform === 'win32' && process.arch === 'arm64';
|
||||
|
|
@ -55,12 +55,12 @@ describe('utilityProcess module', () => {
|
|||
describe('lifecycle events', () => {
|
||||
it('emits \'spawn\' when child process successfully launches', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'empty.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
});
|
||||
|
||||
it('emits \'exit\' when child process exits gracefully', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'empty.js'));
|
||||
const [code] = await emittedOnce(child, 'exit');
|
||||
const [code] = await once(child, 'exit');
|
||||
expect(code).to.equal(0);
|
||||
});
|
||||
|
||||
|
|
@ -68,28 +68,28 @@ describe('utilityProcess module', () => {
|
|||
const child = utilityProcess.fork(path.join(fixturesPath, 'crash.js'));
|
||||
// Do not check for exit code in this case,
|
||||
// SIGSEGV code can be 139 or 11 across our different CI pipeline.
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
|
||||
it('emits \'exit\' corresponding to the child process', async () => {
|
||||
const child1 = utilityProcess.fork(path.join(fixturesPath, 'endless.js'));
|
||||
await emittedOnce(child1, 'spawn');
|
||||
await once(child1, 'spawn');
|
||||
const child2 = utilityProcess.fork(path.join(fixturesPath, 'crash.js'));
|
||||
await emittedOnce(child2, 'exit');
|
||||
await once(child2, 'exit');
|
||||
expect(child1.kill()).to.be.true();
|
||||
await emittedOnce(child1, 'exit');
|
||||
await once(child1, 'exit');
|
||||
});
|
||||
|
||||
it('emits \'exit\' when there is uncaught exception', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'exception.js'));
|
||||
const [code] = await emittedOnce(child, 'exit');
|
||||
const [code] = await once(child, 'exit');
|
||||
expect(code).to.equal(1);
|
||||
});
|
||||
|
||||
it('emits \'exit\' when process.exit is called', async () => {
|
||||
const exitCode = 2;
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'custom-exit.js'), [`--exitCode=${exitCode}`]);
|
||||
const [code] = await emittedOnce(child, 'exit');
|
||||
const [code] = await once(child, 'exit');
|
||||
expect(code).to.equal(exitCode);
|
||||
});
|
||||
});
|
||||
|
|
@ -99,16 +99,16 @@ describe('utilityProcess module', () => {
|
|||
const child = utilityProcess.fork(path.join(fixturesPath, 'endless.js'), [], {
|
||||
serviceName: 'endless'
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.kill()).to.be.true();
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
});
|
||||
|
||||
describe('pid property', () => {
|
||||
it('is valid when child process launches successfully', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'empty.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.pid).to.not.be.null();
|
||||
});
|
||||
|
||||
|
|
@ -121,33 +121,33 @@ describe('utilityProcess module', () => {
|
|||
describe('stdout property', () => {
|
||||
it('is null when child process launches with default stdio', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stdout).to.be.null();
|
||||
expect(child.stderr).to.be.null();
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
|
||||
it('is null when child process launches with ignore stdio configuration', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'), [], {
|
||||
stdio: 'ignore'
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stdout).to.be.null();
|
||||
expect(child.stderr).to.be.null();
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
|
||||
it('is valid when child process launches with pipe stdio configuration', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'), [], {
|
||||
stdio: 'pipe'
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stdout).to.not.be.null();
|
||||
let log = '';
|
||||
child.stdout!.on('data', (chunk) => {
|
||||
log += chunk.toString('utf8');
|
||||
});
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
expect(log).to.equal('hello\n');
|
||||
});
|
||||
});
|
||||
|
|
@ -155,32 +155,32 @@ describe('utilityProcess module', () => {
|
|||
describe('stderr property', () => {
|
||||
it('is null when child process launches with default stdio', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stdout).to.be.null();
|
||||
expect(child.stderr).to.be.null();
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
|
||||
it('is null when child process launches with ignore stdio configuration', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'), [], {
|
||||
stdio: 'ignore'
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stderr).to.be.null();
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
});
|
||||
|
||||
ifit(!isWindowsOnArm)('is valid when child process launches with pipe stdio configuration', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'log.js'), [], {
|
||||
stdio: ['ignore', 'pipe', 'pipe']
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stderr).to.not.be.null();
|
||||
let log = '';
|
||||
child.stderr!.on('data', (chunk) => {
|
||||
log += chunk.toString('utf8');
|
||||
});
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
expect(log).to.equal('world');
|
||||
});
|
||||
});
|
||||
|
|
@ -189,25 +189,25 @@ describe('utilityProcess module', () => {
|
|||
it('establishes a default ipc channel with the child process', async () => {
|
||||
const result = 'I will be echoed.';
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'post-message.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
child.postMessage(result);
|
||||
const [data] = await emittedOnce(child, 'message');
|
||||
const [data] = await once(child, 'message');
|
||||
expect(data).to.equal(result);
|
||||
const exit = emittedOnce(child, 'exit');
|
||||
const exit = once(child, 'exit');
|
||||
expect(child.kill()).to.be.true();
|
||||
await exit;
|
||||
});
|
||||
|
||||
it('supports queuing messages on the receiving end', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'post-message-queue.js'));
|
||||
const p = emittedOnce(child, 'spawn');
|
||||
const p = once(child, 'spawn');
|
||||
child.postMessage('This message');
|
||||
child.postMessage(' is');
|
||||
child.postMessage(' queued');
|
||||
await p;
|
||||
const [data] = await emittedOnce(child, 'message');
|
||||
const [data] = await once(child, 'message');
|
||||
expect(data).to.equal('This message is queued');
|
||||
const exit = emittedOnce(child, 'exit');
|
||||
const exit = once(child, 'exit');
|
||||
expect(child.kill()).to.be.true();
|
||||
await exit;
|
||||
});
|
||||
|
|
@ -270,7 +270,7 @@ describe('utilityProcess module', () => {
|
|||
const appProcess = childProcess.spawn(process.execPath, [path.join(fixturesPath, 'inherit-stdout'), `--payload=${result}`]);
|
||||
let output = '';
|
||||
appProcess.stdout.on('data', (data: Buffer) => { output += data; });
|
||||
await emittedOnce(appProcess, 'exit');
|
||||
await once(appProcess, 'exit');
|
||||
expect(output).to.equal(result);
|
||||
});
|
||||
|
||||
|
|
@ -279,7 +279,7 @@ describe('utilityProcess module', () => {
|
|||
const appProcess = childProcess.spawn(process.execPath, [path.join(fixturesPath, 'inherit-stderr'), `--payload=${result}`]);
|
||||
let output = '';
|
||||
appProcess.stderr.on('data', (data: Buffer) => { output += data; });
|
||||
await emittedOnce(appProcess, 'exit');
|
||||
await once(appProcess, 'exit');
|
||||
expect(output).to.include(result);
|
||||
});
|
||||
|
||||
|
|
@ -297,12 +297,12 @@ describe('utilityProcess module', () => {
|
|||
w.webContents.postMessage('port', result, [rendererPort]);
|
||||
// Send renderer and main channel port to utility process.
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'receive-message.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
child.postMessage('', [childPort1]);
|
||||
const [data] = await emittedOnce(child, 'message');
|
||||
const [data] = await once(child, 'message');
|
||||
expect(data).to.equal(result);
|
||||
// Cleanup.
|
||||
const exit = emittedOnce(child, 'exit');
|
||||
const exit = once(child, 'exit');
|
||||
expect(child.kill()).to.be.true();
|
||||
await exit;
|
||||
await closeWindow(w);
|
||||
|
|
@ -310,10 +310,10 @@ describe('utilityProcess module', () => {
|
|||
|
||||
ifit(process.platform === 'linux')('allows executing a setuid binary with child_process', async () => {
|
||||
const child = utilityProcess.fork(path.join(fixturesPath, 'suid.js'));
|
||||
await emittedOnce(child, 'spawn');
|
||||
const [data] = await emittedOnce(child, 'message');
|
||||
await once(child, 'spawn');
|
||||
const [data] = await once(child, 'message');
|
||||
expect(data).to.not.be.empty();
|
||||
const exit = emittedOnce(child, 'exit');
|
||||
const exit = once(child, 'exit');
|
||||
expect(child.kill()).to.be.true();
|
||||
await exit;
|
||||
});
|
||||
|
|
@ -327,7 +327,7 @@ describe('utilityProcess module', () => {
|
|||
});
|
||||
let output = '';
|
||||
appProcess.stdout.on('data', (data: Buffer) => { output += data; });
|
||||
await emittedOnce(appProcess.stdout, 'end');
|
||||
await once(appProcess.stdout, 'end');
|
||||
const result = process.platform === 'win32' ? '\r\nparent' : 'parent';
|
||||
expect(output).to.equal(result);
|
||||
});
|
||||
|
|
@ -341,7 +341,7 @@ describe('utilityProcess module', () => {
|
|||
});
|
||||
let output = '';
|
||||
appProcess.stdout.on('data', (data: Buffer) => { output += data; });
|
||||
await emittedOnce(appProcess.stdout, 'end');
|
||||
await once(appProcess.stdout, 'end');
|
||||
const result = process.platform === 'win32' ? '\r\nchild' : 'child';
|
||||
expect(output).to.equal(result);
|
||||
});
|
||||
|
|
@ -351,13 +351,13 @@ describe('utilityProcess module', () => {
|
|||
cwd: fixturesPath,
|
||||
stdio: ['ignore', 'pipe', 'ignore']
|
||||
});
|
||||
await emittedOnce(child, 'spawn');
|
||||
await once(child, 'spawn');
|
||||
expect(child.stdout).to.not.be.null();
|
||||
let log = '';
|
||||
child.stdout!.on('data', (chunk) => {
|
||||
log += chunk.toString('utf8');
|
||||
});
|
||||
await emittedOnce(child, 'exit');
|
||||
await once(child, 'exit');
|
||||
expect(log).to.equal('hello\n');
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue